tor  0.4.2.0-alpha-dev
router.h
Go to the documentation of this file.
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-2019, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
6 
12 #ifndef TOR_ROUTER_H
13 #define TOR_ROUTER_H
14 
16 
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);
31 MOCK_DECL(crypto_pk_t *,get_server_identity_key,(void));
36 MOCK_DECL(authority_cert_t *, get_my_v3_authority_cert, (void));
40 void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last);
41 void expire_old_onion_keys(void);
42 void rotate_onion_key(void);
44 int get_onion_key_lifetime(void);
46 
47 crypto_pk_t *router_get_rsa_onion_pkey(const char *pkey, size_t pkey_len);
48 void router_set_rsa_onion_pkey(const crypto_pk_t *pk, char **onion_pkey_out,
49  size_t *onion_pkey_len);
50 
53 #define ntor_key_map_free(map) \
54  FREE_AND_NULL(di_digest256_map_t, ntor_key_map_free_, (map))
55 
57 int init_keys(void);
58 int init_keys_client(void);
59 
60 uint16_t router_get_active_listener_port_by_type_af(int listener_type,
61  sa_family_t family);
62 uint16_t router_get_advertised_or_port(const or_options_t *options);
64  sa_family_t family);
65 uint16_t router_get_advertised_dir_port(const or_options_t *options,
66  uint16_t dirport);
67 
69  uint16_t dir_port);
70 
71 void consider_publishable_server(int force);
72 int should_refuse_unknown_exits(const or_options_t *options);
73 
76 void mark_my_descriptor_dirty(const char *reason);
77 void check_descriptor_bandwidth_changed(time_t now);
78 void check_descriptor_ipaddress_changed(time_t now);
80 void router_new_address_suggestion(const char *suggestion,
81  const dir_connection_t *d_conn);
82 int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port);
83 MOCK_DECL(int, router_my_exit_policy_is_reject_star,(void));
84 MOCK_DECL(const routerinfo_t *, router_get_my_routerinfo, (void));
85 MOCK_DECL(const routerinfo_t *, router_get_my_routerinfo_with_err,(int *err));
87 const char *router_get_my_descriptor(void);
88 const char *router_get_descriptor_gen_reason(void);
89 int router_digest_is_me(const char *digest);
90 const uint8_t *router_get_my_id_digest(void);
91 int router_extrainfo_digest_is_me(const char *digest);
92 int router_is_me(const routerinfo_t *router);
93 MOCK_DECL(int,router_pick_published_address,(const or_options_t *options,
94  uint32_t *addr,
95  int cache_only));
97 int router_rebuild_descriptor(int force);
99  const crypto_pk_t *ident_key,
100  const crypto_pk_t *tap_key,
101  const struct curve25519_keypair_t *ntor_keypair,
102  const struct ed25519_keypair_t *signing_keypair);
104  int include_ipv4,
105  int include_ipv6);
106 int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo,
107  crypto_pk_t *ident_key,
108  const struct ed25519_keypair_t *signing_keypair);
109 
110 const char *routerinfo_err_to_string(int err);
111 int routerinfo_err_is_transient(int err);
112 
113 void router_reset_warnings(void);
114 void router_reset_reachability(void);
115 void router_free_all(void);
116 
117 #ifdef ROUTER_PRIVATE
118 /* Used only by router.c and the unit tests */
119 STATIC void get_platform_str(char *platform, size_t len);
120 STATIC int router_write_fingerprint(int hashed);
121 STATIC smartlist_t *get_my_declared_family(const or_options_t *options);
122 
123 #ifdef TOR_UNIT_TESTS
124 extern time_t desc_clean_since;
125 extern const char *desc_dirty_reason;
126 void set_server_identity_key_digest_testing(const uint8_t *digest);
127 MOCK_DECL(STATIC const struct curve25519_keypair_t *,
128  get_current_curve25519_keypair,(void));
129 
130 MOCK_DECL(STATIC int,
131  router_build_fresh_unsigned_routerinfo,(routerinfo_t **ri_out));
133  const routerinfo_t *ri);
135  const extrainfo_t *ei);
137 #endif /* defined(TOR_UNIT_TESTS) */
138 
139 #endif /* defined(ROUTER_PRIVATE) */
140 
141 #endif /* !defined(TOR_ROUTER_H) */
crypto_pk_t * get_my_v3_authority_signing_key(void)
Definition: router.c:435
const char * router_get_my_descriptor(void)
Definition: router.c:1675
authority_cert_t * get_my_v3_legacy_cert(void)
Definition: router.c:444
int client_identity_key_is_set(void)
Definition: router.c:419
int router_build_fresh_descriptor(routerinfo_t **r, extrainfo_t **e)
Definition: router.c:2270
void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last)
Definition: router.c:211
int router_initialize_tls_context(void)
Definition: router.c:791
uint16_t sa_family_t
Definition: inaddr_st.h:77
const uint8_t * router_get_my_id_digest(void)
Definition: router.c:1600
int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port)
Definition: router.c:1545
void check_descriptor_ipaddress_changed(time_t now)
Definition: router.c:2524
extrainfo_t * router_get_my_extrainfo(void)
Definition: router.c:1692
STATIC void router_update_routerinfo_from_extrainfo(routerinfo_t *ri, const extrainfo_t *ei)
Definition: router.c:2208
int init_keys(void)
Definition: router.c:926
int router_is_me(const routerinfo_t *router)
Definition: router.c:1621
void router_new_address_suggestion(const char *suggestion, const dir_connection_t *d_conn)
Definition: router.c:2573
STATIC time_t desc_clean_since
Definition: router.c:1488
void router_upload_dir_desc_to_dirservers(int force)
Definition: router.c:1499
int should_refuse_unknown_exits(const or_options_t *options)
Definition: router.c:1331
void expire_old_onion_keys(void)
Definition: router.c:235
uint16_t router_get_advertised_dir_port(const or_options_t *options, uint16_t dirport)
Definition: router.c:1460
void router_reset_reachability(void)
Definition: selftest.c:49
char * router_dump_router_to_string(routerinfo_t *router, const crypto_pk_t *ident_key, const crypto_pk_t *tap_key, const curve25519_keypair_t *ntor_keypair, const ed25519_keypair_t *signing_keypair)
Definition: router.c:2670
int router_has_bandwidth_to_be_dirserver(const or_options_t *options)
Definition: router.c:1189
STATIC void get_platform_str(char *platform, size_t len)
Definition: router.c:2649
time_t get_onion_key_set_at(void)
Definition: router.c:329
crypto_pk_t * get_tlsclient_identity_key(void)
Definition: router.c:410
int router_rebuild_descriptor(int force)
Definition: router.c:2332
uint16_t router_get_active_listener_port_by_type_af(int listener_type, sa_family_t family)
Definition: router.c:1409
const char * routerinfo_err_to_string(int err)
Definition: router.c:140
void set_client_identity_key(crypto_pk_t *k)
Definition: router.c:400
int router_digest_is_me(const char *digest)
Definition: router.c:1592
void router_reset_warnings(void)
Definition: router.c:3451
void router_free_all(void)
Definition: router.c:3461
STATIC int router_write_fingerprint(int hashed)
Definition: router.c:829
crypto_pk_t * get_my_v3_legacy_signing_key(void)
Definition: router.c:452
void set_server_identity_key(crypto_pk_t *k)
Definition: router.c:337
void rotate_onion_key(void)
Definition: router.c:465
char * router_dump_exit_policy_to_string(const routerinfo_t *router, int include_ipv4, int include_ipv6)
Definition: router.c:3049
int router_should_advertise_dirport(const or_options_t *options, uint16_t dir_port)
Definition: router.c:1309
int server_identity_key_is_set(void)
Definition: router.c:392
STATIC extrainfo_t * router_build_fresh_signed_extrainfo(const routerinfo_t *ri)
Definition: router.c:2176
const char * router_get_descriptor_gen_reason(void)
Definition: router.c:1704
di_digest256_map_t * construct_ntor_key_map(void)
Definition: router.c:283
int get_onion_key_lifetime(void)
Definition: router.c:767
void consider_publishable_server(int force)
Definition: router.c:1387
Macros to implement mocking and selective exposure for the test code.
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:94
void mark_my_descriptor_dirty(const char *reason)
Definition: router.c:2427
int get_onion_key_grace_period(void)
Definition: router.c:777
int extrainfo_dump_to_string(char **s_out, extrainfo_t *extrainfo, crypto_pk_t *ident_key, const ed25519_keypair_t *signing_keypair)
Definition: router.c:3346
int router_extrainfo_digest_is_me(const char *digest)
Definition: router.c:1608
void ntor_key_map_free_(di_digest256_map_t *map)
Definition: router.c:317
STATIC smartlist_t * get_my_declared_family(const or_options_t *options)
Definition: router.c:1831
uint16_t router_get_advertised_or_port(const or_options_t *options)
Definition: router.c:1430
STATIC int router_dump_and_sign_routerinfo_descriptor_body(routerinfo_t *ri)
Definition: router.c:2236
void check_descriptor_bandwidth_changed(time_t now)
Definition: router.c:2456
void mark_my_descriptor_dirty_if_too_old(time_t now)
Definition: router.c:2386
int routerinfo_err_is_transient(int err)
Definition: router.c:169
uint16_t router_get_advertised_or_port_by_af(const or_options_t *options, sa_family_t family)
Definition: router.c:1438
void v3_authority_check_key_expiry(void)
Definition: router.c:704
STATIC const char * desc_dirty_reason
Definition: router.c:1490