router.h 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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-2017, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file router.h
  8. * \brief Header file for router.c.
  9. **/
  10. #ifndef TOR_ROUTER_H
  11. #define TOR_ROUTER_H
  12. #include "testsupport.h"
  13. crypto_pk_t *get_onion_key(void);
  14. time_t get_onion_key_set_at(void);
  15. void set_server_identity_key(crypto_pk_t *k);
  16. crypto_pk_t *get_server_identity_key(void);
  17. int server_identity_key_is_set(void);
  18. void set_client_identity_key(crypto_pk_t *k);
  19. crypto_pk_t *get_tlsclient_identity_key(void);
  20. int client_identity_key_is_set(void);
  21. MOCK_DECL(authority_cert_t *, get_my_v3_authority_cert, (void));
  22. crypto_pk_t *get_my_v3_authority_signing_key(void);
  23. authority_cert_t *get_my_v3_legacy_cert(void);
  24. crypto_pk_t *get_my_v3_legacy_signing_key(void);
  25. void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last);
  26. void expire_old_onion_keys(void);
  27. void rotate_onion_key(void);
  28. crypto_pk_t *init_key_from_file(const char *fname, int generate,
  29. int severity, int log_greeting);
  30. void v3_authority_check_key_expiry(void);
  31. int get_onion_key_lifetime(void);
  32. int get_onion_key_grace_period(void);
  33. di_digest256_map_t *construct_ntor_key_map(void);
  34. void ntor_key_map_free_(di_digest256_map_t *map);
  35. #define ntor_key_map_free(map) \
  36. FREE_AND_NULL(di_digest256_map_t, ntor_key_map_free_, (map))
  37. int router_initialize_tls_context(void);
  38. int init_keys(void);
  39. int init_keys_client(void);
  40. int check_whether_orport_reachable(const or_options_t *options);
  41. int check_whether_dirport_reachable(const or_options_t *options);
  42. int dir_server_mode(const or_options_t *options);
  43. void consider_testing_reachability(int test_or, int test_dir);
  44. void router_orport_found_reachable(void);
  45. void router_dirport_found_reachable(void);
  46. void router_perform_bandwidth_test(int num_circs, time_t now);
  47. int net_is_disabled(void);
  48. int authdir_mode(const or_options_t *options);
  49. int authdir_mode_v3(const or_options_t *options);
  50. int authdir_mode_handles_descs(const or_options_t *options, int purpose);
  51. int authdir_mode_publishes_statuses(const or_options_t *options);
  52. int authdir_mode_tests_reachability(const or_options_t *options);
  53. int authdir_mode_bridge(const or_options_t *options);
  54. uint16_t router_get_active_listener_port_by_type_af(int listener_type,
  55. sa_family_t family);
  56. uint16_t router_get_advertised_or_port(const or_options_t *options);
  57. uint16_t router_get_advertised_or_port_by_af(const or_options_t *options,
  58. sa_family_t family);
  59. uint16_t router_get_advertised_dir_port(const or_options_t *options,
  60. uint16_t dirport);
  61. MOCK_DECL(int, server_mode, (const or_options_t *options));
  62. MOCK_DECL(int, public_server_mode, (const or_options_t *options));
  63. MOCK_DECL(int, advertised_server_mode, (void));
  64. int proxy_mode(const or_options_t *options);
  65. void consider_publishable_server(int force);
  66. int should_refuse_unknown_exits(const or_options_t *options);
  67. void router_upload_dir_desc_to_dirservers(int force);
  68. void mark_my_descriptor_dirty_if_too_old(time_t now);
  69. void mark_my_descriptor_dirty(const char *reason);
  70. void check_descriptor_bandwidth_changed(time_t now);
  71. void check_descriptor_ipaddress_changed(time_t now);
  72. void router_new_address_suggestion(const char *suggestion,
  73. const dir_connection_t *d_conn);
  74. int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port);
  75. MOCK_DECL(int, router_my_exit_policy_is_reject_star,(void));
  76. MOCK_DECL(const routerinfo_t *, router_get_my_routerinfo, (void));
  77. extrainfo_t *router_get_my_extrainfo(void);
  78. const char *router_get_my_descriptor(void);
  79. const char *router_get_descriptor_gen_reason(void);
  80. int router_digest_is_me(const char *digest);
  81. const uint8_t *router_get_my_id_digest(void);
  82. int router_extrainfo_digest_is_me(const char *digest);
  83. int router_is_me(const routerinfo_t *router);
  84. MOCK_DECL(int,router_pick_published_address,(const or_options_t *options,
  85. uint32_t *addr,
  86. int cache_only));
  87. int router_build_fresh_descriptor(routerinfo_t **r, extrainfo_t **e);
  88. int router_rebuild_descriptor(int force);
  89. char *router_dump_router_to_string(routerinfo_t *router,
  90. const crypto_pk_t *ident_key,
  91. const crypto_pk_t *tap_key,
  92. const curve25519_keypair_t *ntor_keypair,
  93. const ed25519_keypair_t *signing_keypair);
  94. char *router_dump_exit_policy_to_string(const routerinfo_t *router,
  95. int include_ipv4,
  96. int include_ipv6);
  97. void router_get_prim_orport(const routerinfo_t *router,
  98. tor_addr_port_t *addr_port_out);
  99. void router_get_pref_orport(const routerinfo_t *router,
  100. tor_addr_port_t *addr_port_out);
  101. void router_get_pref_ipv6_orport(const routerinfo_t *router,
  102. tor_addr_port_t *addr_port_out);
  103. int router_ipv6_preferred(const routerinfo_t *router);
  104. int router_has_addr(const routerinfo_t *router, const tor_addr_t *addr);
  105. int router_has_orport(const routerinfo_t *router,
  106. const tor_addr_port_t *orport);
  107. int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo,
  108. crypto_pk_t *ident_key,
  109. const ed25519_keypair_t *signing_keypair);
  110. int is_legal_nickname(const char *s);
  111. int is_legal_nickname_or_hexdigest(const char *s);
  112. int is_legal_hexdigest(const char *s);
  113. /**
  114. * Longest allowed output of format_node_description, plus 1 character for
  115. * NUL. This allows space for:
  116. * "$FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF~xxxxxxxxxxxxxxxxxxx at"
  117. * " [ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255]"
  118. * plus a terminating NUL.
  119. */
  120. #define NODE_DESC_BUF_LEN (MAX_VERBOSE_NICKNAME_LEN+4+TOR_ADDR_BUF_LEN)
  121. const char *format_node_description(char *buf,
  122. const char *id_digest,
  123. int is_named,
  124. const char *nickname,
  125. const tor_addr_t *addr,
  126. uint32_t addr32h);
  127. const char *router_get_description(char *buf, const routerinfo_t *ri);
  128. const char *node_get_description(char *buf, const node_t *node);
  129. const char *routerstatus_get_description(char *buf, const routerstatus_t *rs);
  130. const char *extend_info_get_description(char *buf, const extend_info_t *ei);
  131. const char *router_describe(const routerinfo_t *ri);
  132. const char *node_describe(const node_t *node);
  133. const char *routerstatus_describe(const routerstatus_t *ri);
  134. const char *extend_info_describe(const extend_info_t *ei);
  135. void router_get_verbose_nickname(char *buf, const routerinfo_t *router);
  136. void router_reset_warnings(void);
  137. void router_reset_reachability(void);
  138. void router_free_all(void);
  139. const char *router_purpose_to_string(uint8_t p);
  140. uint8_t router_purpose_from_string(const char *s);
  141. smartlist_t *router_get_all_orports(const routerinfo_t *ri);
  142. #ifdef ROUTER_PRIVATE
  143. /* Used only by router.c and test.c */
  144. STATIC void get_platform_str(char *platform, size_t len);
  145. STATIC int router_write_fingerprint(int hashed);
  146. #endif
  147. #endif /* !defined(TOR_ROUTER_H) */