src/feature/relay/router.h

   1 /* Copyright (c) 2001 Matej Pfajfar.
   2  * Copyright (c) 2001-2004, Roger Dingledine.
   3  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   4  * Copyright (c) 2007-2021, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file router.h
   9  * \brief Header file for router.c.
  10  **/
  11
  12 #ifndef TOR_ROUTER_H
  13 #define TOR_ROUTER_H
  14
  15 #include "lib/testsupport/testsupport.h"
  16
  17 struct curve25519_keypair_t;
  18 struct ed25519_keypair_t;
  19
  20 #define TOR_ROUTERINFO_ERROR_NO_EXT_ADDR     (-1)
  21 #define TOR_ROUTERINFO_ERROR_CANNOT_PARSE    (-2)
  22 #define TOR_ROUTERINFO_ERROR_NOT_A_SERVER    (-3)
  23 #define TOR_ROUTERINFO_ERROR_DIGEST_FAILED   (-4)
  24 #define TOR_ROUTERINFO_ERROR_CANNOT_GENERATE (-5)
  25 #define TOR_ROUTERINFO_ERROR_DESC_REBUILDING (-6)
  26 #define TOR_ROUTERINFO_ERROR_INTERNAL_BUG    (-7)
  27
  28 MOCK_DECL(crypto_pk_t *,get_onion_key,(void));
  29 time_t get_onion_key_set_at(void);
  30 void set_server_identity_key(crypto_pk_t *k);
  31 /* Some compilers are clever enough to know that when relay mode is disabled,
  32  * this function never returns. */
  33 #ifdef HAVE_MODULE_RELAY
  34 MOCK_DECL(crypto_pk_t *,get_server_identity_key,(void));
  35 #else
  36 #define get_server_identity_key() (tor_abort_(),NULL)
  37 #endif
  38 int server_identity_key_is_set(void);
  39 void set_client_identity_key(crypto_pk_t *k);
  40 crypto_pk_t *get_tlsclient_identity_key(void);
  41 int client_identity_key_is_set(void);
  42 MOCK_DECL(authority_cert_t *, get_my_v3_authority_cert, (void));
  43 crypto_pk_t *get_my_v3_authority_signing_key(void);
  44 authority_cert_t *get_my_v3_legacy_cert(void);
  45 crypto_pk_t *get_my_v3_legacy_signing_key(void);
  46 void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last);
  47 void expire_old_onion_keys(void);
  48 void rotate_onion_key(void);
  49 void v3_authority_check_key_expiry(void);
  50 int get_onion_key_lifetime(void);
  51 int get_onion_key_grace_period(void);
  52
  53 crypto_pk_t *router_get_rsa_onion_pkey(const char *pkey, size_t pkey_len);
  54 void router_set_rsa_onion_pkey(const crypto_pk_t *pk, char **onion_pkey_out,
  55                                size_t *onion_pkey_len);
  56
  57 di_digest256_map_t *construct_ntor_key_map(void);
  58 void ntor_key_map_free_(di_digest256_map_t *map);
  59 #define ntor_key_map_free(map) \
  60   FREE_AND_NULL(di_digest256_map_t, ntor_key_map_free_, (map))
  61
  62 int router_initialize_tls_context(void);
  63 int init_keys(void);
  64 int init_keys_client(void);
  65
  66 uint16_t router_get_active_listener_port_by_type_af(int listener_type,
  67                                                     sa_family_t family);
  68 void routerconf_find_ipv6_or_ap(const or_options_t *options,
  69                                       tor_addr_port_t *ipv6_ap_out);
  70 bool routerconf_has_ipv6_orport(const or_options_t *options);
  71 MOCK_DECL(bool, router_can_extend_over_ipv6,(const or_options_t *options));
  72 uint16_t routerconf_find_or_port(const or_options_t *options,
  73                                        sa_family_t family);
  74 uint16_t routerconf_find_dir_port(const or_options_t *options,
  75                                         uint16_t dirport);
  76
  77 int router_should_advertise_dirport(const or_options_t *options,
  78                                     uint16_t dir_port);
  79
  80 void consider_publishable_server(int force);
  81 int should_refuse_unknown_exits(const or_options_t *options);
  82
  83 void router_new_consensus_params(const networkstatus_t *);
  84 void router_upload_dir_desc_to_dirservers(int force);
  85 void mark_my_descriptor_dirty_if_too_old(time_t now);
  86 void mark_my_descriptor_dirty(const char *reason);
  87 void mark_my_descriptor_if_omit_ipv6_changes(const char *reason,
  88                                                bool omit_ipv6);
  89 void check_descriptor_bandwidth_changed(time_t now);
  90 void check_descriptor_ipaddress_changed(time_t now);
  91 int router_has_bandwidth_to_be_dirserver(const or_options_t *options);
  92 int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port);
  93 MOCK_DECL(int, router_my_exit_policy_is_reject_star,(void));
  94 MOCK_DECL(const routerinfo_t *, router_get_my_routerinfo, (void));
  95 MOCK_DECL(const routerinfo_t *, router_get_my_routerinfo_with_err,(int *err));
  96 extrainfo_t *router_get_my_extrainfo(void);
  97 const char *router_get_my_descriptor(void);
  98 const char *router_get_descriptor_gen_reason(void);
  99 int router_digest_is_me(const char *digest);
 100 const uint8_t *router_get_my_id_digest(void);
 101 int router_extrainfo_digest_is_me(const char *digest);
 102 int router_is_me(const routerinfo_t *router);
 103 bool router_addr_is_my_published_addr(const tor_addr_t *addr);
 104 int router_build_fresh_descriptor(routerinfo_t **r, extrainfo_t **e);
 105 bool router_rebuild_descriptor(int force);
 106 char *router_dump_router_to_string(routerinfo_t *router,
 107                              const crypto_pk_t *ident_key,
 108                              const crypto_pk_t *tap_key,
 109                              const struct curve25519_keypair_t *ntor_keypair,
 110                              const struct ed25519_keypair_t *signing_keypair);
 111 char *router_dump_exit_policy_to_string(const routerinfo_t *router,
 112                                          int include_ipv4,
 113                                          int include_ipv6);
 114 int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo,
 115                              crypto_pk_t *ident_key,
 116                              const struct ed25519_keypair_t *signing_keypair);
 117
 118 const char *routerinfo_err_to_string(int err);
 119 int routerinfo_err_is_transient(int err);
 120
 121 void log_addr_has_changed(int severity, const tor_addr_t *prev,
 122                           const tor_addr_t *cur, const char *source);
 123
 124 void router_reset_warnings(void);
 125 void router_free_all(void);
 126
 127 #ifdef ROUTER_PRIVATE
 128 /* Used only by router.c and the unit tests */
 129 STATIC void get_platform_str(char *platform, size_t len);
 130 STATIC int router_write_fingerprint(int hashed, int ed25519_identity);
 131 STATIC smartlist_t *get_my_declared_family(const or_options_t *options);
 132 STATIC void router_announce_bridge_status_page(void);
 133 STATIC int load_stats_file(const char *filename, const char *ts_tag,
 134                            time_t now, char **out);
 135
 136 #ifdef TOR_UNIT_TESTS
 137 extern time_t desc_clean_since;
 138 extern const char *desc_dirty_reason;
 139 void set_server_identity_key_digest_testing(const uint8_t *digest);
 140 MOCK_DECL(STATIC const struct curve25519_keypair_t *,
 141                                        get_current_curve25519_keypair,(void));
 142
 143 MOCK_DECL(STATIC int,
 144               router_build_fresh_unsigned_routerinfo,(routerinfo_t **ri_out));
 145 STATIC extrainfo_t *router_build_fresh_signed_extrainfo(
 146                                                       const routerinfo_t *ri);
 147 STATIC void router_update_routerinfo_from_extrainfo(routerinfo_t *ri,
 148                                                     const extrainfo_t *ei);
 149 STATIC int router_dump_and_sign_routerinfo_descriptor_body(routerinfo_t *ri);
 150 #endif /* defined(TOR_UNIT_TESTS) */
 151
 152 #endif /* defined(ROUTER_PRIVATE) */
 153
 154 #endif /* !defined(TOR_ROUTER_H) */