Tor 0.4.9.2-alpha-dev
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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-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
16
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
29time_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
34MOCK_DECL(crypto_pk_t *,get_server_identity_key,(void));
35#else
36#define get_server_identity_key() (tor_abort_(),NULL)
37#endif
46void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last);
47void expire_old_onion_keys(void);
48bool rotate_onion_key(void);
52
53crypto_pk_t *router_get_rsa_onion_pkey(const char *pkey, size_t pkey_len);
54void 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
63int init_keys(void);
64int init_keys_client(void);
65
66uint16_t router_get_active_listener_port_by_type_af(int listener_type,
67 sa_family_t family);
69 tor_addr_port_t *ipv6_ap_out);
70bool routerconf_has_ipv6_orport(const or_options_t *options);
72uint16_t routerconf_find_or_port(const or_options_t *options,
73 sa_family_t family);
74uint16_t routerconf_find_dir_port(const or_options_t *options,
75 uint16_t dirport);
76
78 uint16_t dir_port);
79
80void consider_publishable_server(int force);
82
85
88void mark_my_descriptor_dirty(const char *reason);
89void mark_my_descriptor_if_omit_ipv6_changes(const char *reason,
90 bool omit_ipv6);
94int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port);
99const char *router_get_my_descriptor(void);
100const char *router_get_descriptor_gen_reason(void);
101int router_digest_is_me(const char *digest);
102const uint8_t *router_get_my_id_digest(void);
103int router_extrainfo_digest_is_me(const char *digest);
104int router_is_me(const routerinfo_t *router);
107bool router_rebuild_descriptor(int force);
109 const crypto_pk_t *ident_key,
110 const crypto_pk_t *tap_key,
111 const struct curve25519_keypair_t *ntor_keypair,
112 const struct ed25519_keypair_t *signing_keypair);
114 int include_ipv4,
115 int include_ipv6);
116int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo,
117 crypto_pk_t *ident_key,
118 const struct ed25519_keypair_t *signing_keypair);
119
120const char *routerinfo_err_to_string(int err);
121int routerinfo_err_is_transient(int err);
122
123void log_addr_has_changed(int severity, const tor_addr_t *prev,
124 const tor_addr_t *cur, const char *source);
125
126void router_reset_warnings(void);
127void router_free_all(void);
128
129#ifdef ROUTER_PRIVATE
130/* Used only by router.c and the unit tests */
131STATIC void get_platform_str(char *platform, size_t len);
132STATIC int router_write_fingerprint(int hashed, int ed25519_identity);
135STATIC int load_stats_file(const char *filename, const char *ts_tag,
136 time_t now, char **out);
137
138#ifdef TOR_UNIT_TESTS
139extern time_t desc_clean_since;
140extern const char *desc_dirty_reason;
141void set_server_identity_key_digest_testing(const uint8_t *digest);
144
145MOCK_DECL(STATIC int,
148 const routerinfo_t *ri);
150 const extrainfo_t *ei);
152#endif /* defined(TOR_UNIT_TESTS) */
153
154#endif /* defined(ROUTER_PRIVATE) */
155
156#endif /* !defined(TOR_ROUTER_H) */
uint16_t sa_family_t
Definition: inaddr_st.h:77
STATIC smartlist_t * get_my_declared_family(const or_options_t *options)
Definition: router.c:1997
STATIC extrainfo_t * router_build_fresh_signed_extrainfo(const routerinfo_t *ri)
Definition: router.c:2333
STATIC int router_write_fingerprint(int hashed, int ed25519_identity)
Definition: router.c:901
STATIC void router_update_routerinfo_from_extrainfo(routerinfo_t *ri, const extrainfo_t *ei)
Definition: router.c:2365
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:3569
STATIC int router_dump_and_sign_routerinfo_descriptor_body(routerinfo_t *ri)
Definition: router.c:2393
STATIC void router_announce_bridge_status_page(void)
Definition: router.c:877
STATIC int router_build_fresh_unsigned_routerinfo(routerinfo_t **ri_out)
Definition: router.c:2122
STATIC const char * desc_dirty_reason
Definition: router.c:1673
STATIC const struct curve25519_keypair_t * get_current_curve25519_keypair(void)
Definition: router.c:316
STATIC int load_stats_file(const char *filename, const char *ts_tag, time_t now, char **out)
Definition: router.c:3268
STATIC time_t desc_clean_since
Definition: router.c:1671
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:2815
STATIC void get_platform_str(char *platform, size_t len)
Definition: router.c:2794
int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port)
Definition: router.c:1728
void ntor_key_map_free_(di_digest256_map_t *map)
Definition: router.c:356
void router_reset_warnings(void)
Definition: router.c:3674
void consider_publishable_server(int force)
Definition: router.c:1497
int router_has_bandwidth_to_be_dirserver(const or_options_t *options)
Definition: router.c:1274
void v3_authority_check_key_expiry(void)
Definition: router.c:755
void router_free_all(void)
Definition: router.c:3684
crypto_pk_t * get_tlsclient_identity_key(void)
Definition: router.c:456
uint16_t routerconf_find_or_port(const or_options_t *options, sa_family_t family)
Definition: router.c:1538
const char * router_get_descriptor_gen_reason(void)
Definition: router.c:1902
void router_upload_dir_desc_to_dirservers(int force)
Definition: router.c:1682
void log_addr_has_changed(int severity, const tor_addr_t *prev, const tor_addr_t *cur, const char *source)
Definition: router.c:2696
int init_keys(void)
Definition: router.c:993
int get_onion_key_grace_period(void)
Definition: router.c:828
void check_descriptor_ipaddress_changed(time_t now)
Definition: router.c:2730
const uint8_t * router_get_my_id_digest(void)
Definition: router.c:1783
bool router_addr_is_my_published_addr(const tor_addr_t *addr)
Definition: router.c:1815
crypto_pk_t * get_my_v3_legacy_signing_key(void)
Definition: router.c:498
int router_initialize_tls_context(void)
Definition: router.c:842
void set_client_identity_key(crypto_pk_t *k)
Definition: router.c:446
crypto_pk_t * get_my_v3_authority_signing_key(void)
Definition: router.c:481
void router_new_consensus_params(const networkstatus_t *)
Definition: router.c:2524
void routerconf_find_ipv6_or_ap(const or_options_t *options, tor_addr_port_t *ipv6_ap_out)
Definition: router.c:1558
void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last)
Definition: router.c:252
int router_should_advertise_dirport(const or_options_t *options, uint16_t dir_port)
Definition: router.c:1394
bool routerconf_has_ipv6_orport(const or_options_t *options)
Definition: router.c:1599
void mark_my_descriptor_if_omit_ipv6_changes(const char *reason, bool omit_ipv6)
Definition: router.c:2560
time_t get_onion_key_set_at(void)
Definition: router.c:368
extrainfo_t * router_get_my_extrainfo(void)
Definition: router.c:1890
uint16_t router_get_active_listener_port_by_type_af(int listener_type, sa_family_t family)
Definition: router.c:1518
const routerinfo_t * router_get_my_routerinfo_with_err(int *err)
Definition: router.c:1847
bool should_publish_family_list(const networkstatus_t *ns)
Definition: router.c:2549
bool rotate_onion_key(void)
Definition: router.c:513
crypto_pk_t * get_onion_key(void)
Definition: router.c:222
void expire_old_onion_keys(void)
Definition: router.c:276
int client_identity_key_is_set(void)
Definition: router.c:465
int server_identity_key_is_set(void)
Definition: router.c:436
bool router_rebuild_descriptor(int force)
Definition: router.c:2490
int router_extrainfo_digest_is_me(const char *digest)
Definition: router.c:1791
void check_descriptor_bandwidth_changed(time_t now)
Definition: router.c:2652
int get_onion_key_lifetime(void)
Definition: router.c:818
int router_digest_is_me(const char *digest)
Definition: router.c:1775
const char * router_get_my_descriptor(void)
Definition: router.c:1873
bool router_can_extend_over_ipv6(const or_options_t *options)
Definition: router.c:1630
int router_build_fresh_descriptor(routerinfo_t **r, extrainfo_t **e)
Definition: router.c:2427
void mark_my_descriptor_dirty(const char *reason)
Definition: router.c:2621
void mark_my_descriptor_dirty_if_too_old(time_t now)
Definition: router.c:2582
char * router_dump_exit_policy_to_string(const routerinfo_t *router, int include_ipv4, int include_ipv6)
Definition: router.c:3241
void set_server_identity_key(crypto_pk_t *k)
Definition: router.c:376
int router_is_me(const routerinfo_t *router)
Definition: router.c:1804
const routerinfo_t * router_get_my_routerinfo(void)
Definition: router.c:1837
authority_cert_t * get_my_v3_authority_cert(void)
Definition: router.c:473
uint16_t routerconf_find_dir_port(const or_options_t *options, uint16_t dirport)
Definition: router.c:1643
int routerinfo_err_is_transient(int err)
Definition: router.c:186
const char * routerinfo_err_to_string(int err)
Definition: router.c:157
int router_my_exit_policy_is_reject_star(void)
Definition: router.c:1763
int should_refuse_unknown_exits(const or_options_t *options)
Definition: router.c:1416
authority_cert_t * get_my_v3_legacy_cert(void)
Definition: router.c:490
di_digest256_map_t * construct_ntor_key_map(void)
Definition: router.c:324
Macros to implement mocking and selective exposure for the test code.
#define STATIC
Definition: testsupport.h:32
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127