Tor  0.4.4.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-2020, 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 
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 
29 time_t get_onion_key_set_at(void);
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
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);
50 int get_onion_key_lifetime(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 
59 #define ntor_key_map_free(map) \
60  FREE_AND_NULL(di_digest256_map_t, ntor_key_map_free_, (map))
61 
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 uint16_t router_get_advertised_or_port(const or_options_t *options);
70  tor_addr_port_t *ipv6_ap_out);
72  sa_family_t family);
73 uint16_t router_get_advertised_dir_port(const or_options_t *options,
74  uint16_t dirport);
75 
77  uint16_t dir_port);
78 
79 void consider_publishable_server(int force);
80 int should_refuse_unknown_exits(const or_options_t *options);
81 
84 void mark_my_descriptor_dirty(const char *reason);
85 void check_descriptor_bandwidth_changed(time_t now);
86 void check_descriptor_ipaddress_changed(time_t now);
88 void router_new_address_suggestion(const char *suggestion,
89  const dir_connection_t *d_conn);
90 int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port);
95 const char *router_get_my_descriptor(void);
96 const char *router_get_descriptor_gen_reason(void);
97 int router_digest_is_me(const char *digest);
98 const uint8_t *router_get_my_id_digest(void);
99 int router_extrainfo_digest_is_me(const char *digest);
100 int router_is_me(const routerinfo_t *router);
102  uint32_t *addr,
103  int cache_only));
105 int router_rebuild_descriptor(int force);
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);
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 router_reset_warnings(void);
122 void router_free_all(void);
123 
124 #ifdef ROUTER_PRIVATE
125 /* Used only by router.c and the unit tests */
126 STATIC void get_platform_str(char *platform, size_t len);
127 STATIC int router_write_fingerprint(int hashed);
129 
130 #ifdef TOR_UNIT_TESTS
131 extern time_t desc_clean_since;
132 extern const char *desc_dirty_reason;
133 void set_server_identity_key_digest_testing(const uint8_t *digest);
134 MOCK_DECL(STATIC const struct curve25519_keypair_t *,
136 
137 MOCK_DECL(STATIC int,
140  const routerinfo_t *ri);
142  const extrainfo_t *ei);
144 #endif /* defined(TOR_UNIT_TESTS) */
145 
146 #endif /* defined(ROUTER_PRIVATE) */
147 
148 #endif /* !defined(TOR_ROUTER_H) */
crypto_pk_t * get_my_v3_authority_signing_key(void)
Definition: router.c:438
const char * router_get_my_descriptor(void)
Definition: router.c:1714
authority_cert_t * get_my_v3_legacy_cert(void)
Definition: router.c:447
int client_identity_key_is_set(void)
Definition: router.c:422
int router_my_exit_policy_is_reject_star(void)
Definition: router.c:1619
int router_build_fresh_descriptor(routerinfo_t **r, extrainfo_t **e)
Definition: router.c:2286
void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last)
Definition: router.c:212
int router_initialize_tls_context(void)
Definition: router.c:794
uint16_t sa_family_t
Definition: inaddr_st.h:77
const uint8_t * router_get_my_id_digest(void)
Definition: router.c:1639
void router_get_advertised_ipv6_or_ap(const or_options_t *options, tor_addr_port_t *ipv6_ap_out)
Definition: router.c:1453
int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port)
Definition: router.c:1584
STATIC int router_build_fresh_unsigned_routerinfo(routerinfo_t **ri_out)
Definition: router.c:1995
void check_descriptor_ipaddress_changed(time_t now)
Definition: router.c:2540
extrainfo_t * router_get_my_extrainfo(void)
Definition: router.c:1731
STATIC void router_update_routerinfo_from_extrainfo(routerinfo_t *ri, const extrainfo_t *ei)
Definition: router.c:2224
int init_keys(void)
Definition: router.c:920
int router_is_me(const routerinfo_t *router)
Definition: router.c:1660
void router_new_address_suggestion(const char *suggestion, const dir_connection_t *d_conn)
Definition: router.c:2589
crypto_pk_t * get_onion_key(void)
Definition: router.c:201
STATIC time_t desc_clean_since
Definition: router.c:1527
void router_upload_dir_desc_to_dirservers(int force)
Definition: router.c:1538
int should_refuse_unknown_exits(const or_options_t *options)
Definition: router.c:1327
void expire_old_onion_keys(void)
Definition: router.c:236
uint16_t router_get_advertised_dir_port(const or_options_t *options, uint16_t dirport)
Definition: router.c:1499
const routerinfo_t * router_get_my_routerinfo_with_err(int *err)
Definition: router.c:1678
#define STATIC
Definition: testsupport.h:32
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:2686
int router_has_bandwidth_to_be_dirserver(const or_options_t *options)
Definition: router.c:1185
STATIC void get_platform_str(char *platform, size_t len)
Definition: router.c:2665
time_t get_onion_key_set_at(void)
Definition: router.c:328
crypto_pk_t * get_tlsclient_identity_key(void)
Definition: router.c:413
int router_rebuild_descriptor(int force)
Definition: router.c:2348
uint16_t router_get_active_listener_port_by_type_af(int listener_type, sa_family_t family)
Definition: router.c:1405
const char * routerinfo_err_to_string(int err)
Definition: router.c:141
void set_client_identity_key(crypto_pk_t *k)
Definition: router.c:403
int router_digest_is_me(const char *digest)
Definition: router.c:1631
void router_reset_warnings(void)
Definition: router.c:3472
void router_free_all(void)
Definition: router.c:3482
STATIC int router_write_fingerprint(int hashed)
Definition: router.c:832
crypto_pk_t * get_my_v3_legacy_signing_key(void)
Definition: router.c:455
void set_server_identity_key(crypto_pk_t *k)
Definition: router.c:336
void rotate_onion_key(void)
Definition: router.c:468
char * router_dump_exit_policy_to_string(const routerinfo_t *router, int include_ipv4, int include_ipv6)
Definition: router.c:3070
int router_should_advertise_dirport(const or_options_t *options, uint16_t dir_port)
Definition: router.c:1305
int server_identity_key_is_set(void)
Definition: router.c:395
STATIC extrainfo_t * router_build_fresh_signed_extrainfo(const routerinfo_t *ri)
Definition: router.c:2192
const char * router_get_descriptor_gen_reason(void)
Definition: router.c:1743
di_digest256_map_t * construct_ntor_key_map(void)
Definition: router.c:284
int get_onion_key_lifetime(void)
Definition: router.c:770
void consider_publishable_server(int force)
Definition: router.c:1383
Macros to implement mocking and selective exposure for the test code.
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
void mark_my_descriptor_dirty(const char *reason)
Definition: router.c:2443
int router_pick_published_address(const or_options_t *options, uint32_t *addr, int cache_only)
Definition: router.c:1760
const routerinfo_t * router_get_my_routerinfo(void)
Definition: router.c:1668
int get_onion_key_grace_period(void)
Definition: router.c:780
authority_cert_t * get_my_v3_authority_cert(void)
Definition: router.c:430
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:3367
int router_extrainfo_digest_is_me(const char *digest)
Definition: router.c:1647
void ntor_key_map_free_(di_digest256_map_t *map)
Definition: router.c:316
STATIC smartlist_t * get_my_declared_family(const or_options_t *options)
Definition: router.c:1870
uint16_t router_get_advertised_or_port(const or_options_t *options)
Definition: router.c:1425
STATIC int router_dump_and_sign_routerinfo_descriptor_body(routerinfo_t *ri)
Definition: router.c:2252
void check_descriptor_bandwidth_changed(time_t now)
Definition: router.c:2472
void mark_my_descriptor_dirty_if_too_old(time_t now)
Definition: router.c:2402
int routerinfo_err_is_transient(int err)
Definition: router.c:170
STATIC const struct curve25519_keypair_t * get_current_curve25519_keypair(void)
Definition: router.c:276
uint16_t router_get_advertised_or_port_by_af(const or_options_t *options, sa_family_t family)
Definition: router.c:1433
void v3_authority_check_key_expiry(void)
Definition: router.c:707
STATIC const char * desc_dirty_reason
Definition: router.c:1529