router.h 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  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. #define TOR_ROUTERINFO_ERROR_NO_EXT_ADDR (-1)
  14. #define TOR_ROUTERINFO_ERROR_CANNOT_PARSE (-2)
  15. #define TOR_ROUTERINFO_ERROR_NOT_A_SERVER (-3)
  16. #define TOR_ROUTERINFO_ERROR_DIGEST_FAILED (-4)
  17. #define TOR_ROUTERINFO_ERROR_CANNOT_GENERATE (-5)
  18. #define TOR_ROUTERINFO_ERROR_DESC_REBUILDING (-6)
  19. crypto_pk_t *get_onion_key(void);
  20. time_t get_onion_key_set_at(void);
  21. void set_server_identity_key(crypto_pk_t *k);
  22. crypto_pk_t *get_server_identity_key(void);
  23. int server_identity_key_is_set(void);
  24. void set_client_identity_key(crypto_pk_t *k);
  25. crypto_pk_t *get_tlsclient_identity_key(void);
  26. int client_identity_key_is_set(void);
  27. MOCK_DECL(authority_cert_t *, get_my_v3_authority_cert, (void));
  28. crypto_pk_t *get_my_v3_authority_signing_key(void);
  29. authority_cert_t *get_my_v3_legacy_cert(void);
  30. crypto_pk_t *get_my_v3_legacy_signing_key(void);
  31. void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last);
  32. void expire_old_onion_keys(void);
  33. void rotate_onion_key(void);
  34. crypto_pk_t *init_key_from_file(const char *fname, int generate,
  35. int severity, int log_greeting);
  36. void v3_authority_check_key_expiry(void);
  37. int get_onion_key_lifetime(void);
  38. int get_onion_key_grace_period(void);
  39. di_digest256_map_t *construct_ntor_key_map(void);
  40. void ntor_key_map_free_(di_digest256_map_t *map);
  41. #define ntor_key_map_free(map) \
  42. FREE_AND_NULL(di_digest256_map_t, ntor_key_map_free_, (map))
  43. int router_initialize_tls_context(void);
  44. int init_keys(void);
  45. int init_keys_client(void);
  46. int check_whether_orport_reachable(const or_options_t *options);
  47. int check_whether_dirport_reachable(const or_options_t *options);
  48. int dir_server_mode(const or_options_t *options);
  49. void router_do_reachability_checks(int test_or, int test_dir);
  50. void router_orport_found_reachable(void);
  51. void router_dirport_found_reachable(void);
  52. void router_perform_bandwidth_test(int num_circs, time_t now);
  53. int net_is_disabled(void);
  54. int net_is_completely_disabled(void);
  55. int authdir_mode(const or_options_t *options);
  56. int authdir_mode_handles_descs(const or_options_t *options, int purpose);
  57. int authdir_mode_publishes_statuses(const or_options_t *options);
  58. int authdir_mode_tests_reachability(const or_options_t *options);
  59. int authdir_mode_bridge(const or_options_t *options);
  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);
  63. uint16_t router_get_advertised_or_port_by_af(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. MOCK_DECL(int, server_mode, (const or_options_t *options));
  68. MOCK_DECL(int, public_server_mode, (const or_options_t *options));
  69. MOCK_DECL(int, advertised_server_mode, (void));
  70. int proxy_mode(const or_options_t *options);
  71. void consider_publishable_server(int force);
  72. int should_refuse_unknown_exits(const or_options_t *options);
  73. void router_upload_dir_desc_to_dirservers(int force);
  74. void mark_my_descriptor_dirty_if_too_old(time_t now);
  75. void mark_my_descriptor_dirty(const char *reason);
  76. void check_descriptor_bandwidth_changed(time_t now);
  77. void check_descriptor_ipaddress_changed(time_t now);
  78. void router_new_address_suggestion(const char *suggestion,
  79. const dir_connection_t *d_conn);
  80. int router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port);
  81. MOCK_DECL(int, router_my_exit_policy_is_reject_star,(void));
  82. MOCK_DECL(const routerinfo_t *, router_get_my_routerinfo, (void));
  83. MOCK_DECL(const routerinfo_t *, router_get_my_routerinfo_with_err,(int *err));
  84. extrainfo_t *router_get_my_extrainfo(void);
  85. const char *router_get_my_descriptor(void);
  86. const char *router_get_descriptor_gen_reason(void);
  87. int router_digest_is_me(const char *digest);
  88. const uint8_t *router_get_my_id_digest(void);
  89. int router_extrainfo_digest_is_me(const char *digest);
  90. int router_is_me(const routerinfo_t *router);
  91. MOCK_DECL(int,router_pick_published_address,(const or_options_t *options,
  92. uint32_t *addr,
  93. int cache_only));
  94. int router_build_fresh_descriptor(routerinfo_t **r, extrainfo_t **e);
  95. int router_rebuild_descriptor(int force);
  96. char *router_dump_router_to_string(routerinfo_t *router,
  97. const crypto_pk_t *ident_key,
  98. const crypto_pk_t *tap_key,
  99. const curve25519_keypair_t *ntor_keypair,
  100. const ed25519_keypair_t *signing_keypair);
  101. char *router_dump_exit_policy_to_string(const routerinfo_t *router,
  102. int include_ipv4,
  103. int include_ipv6);
  104. void router_get_prim_orport(const routerinfo_t *router,
  105. tor_addr_port_t *addr_port_out);
  106. void router_get_pref_orport(const routerinfo_t *router,
  107. tor_addr_port_t *addr_port_out);
  108. void router_get_pref_ipv6_orport(const routerinfo_t *router,
  109. tor_addr_port_t *addr_port_out);
  110. int router_ipv6_preferred(const routerinfo_t *router);
  111. int router_has_addr(const routerinfo_t *router, const tor_addr_t *addr);
  112. int router_has_orport(const routerinfo_t *router,
  113. const tor_addr_port_t *orport);
  114. int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo,
  115. crypto_pk_t *ident_key,
  116. const ed25519_keypair_t *signing_keypair);
  117. int is_legal_nickname(const char *s);
  118. int is_legal_nickname_or_hexdigest(const char *s);
  119. int is_legal_hexdigest(const char *s);
  120. const char *router_describe(const routerinfo_t *ri);
  121. const char *node_describe(const node_t *node);
  122. const char *routerstatus_describe(const routerstatus_t *ri);
  123. const char *extend_info_describe(const extend_info_t *ei);
  124. const char *routerinfo_err_to_string(int err);
  125. int routerinfo_err_is_transient(int err);
  126. void router_get_verbose_nickname(char *buf, const routerinfo_t *router);
  127. void router_reset_warnings(void);
  128. void router_reset_reachability(void);
  129. void router_free_all(void);
  130. const char *router_purpose_to_string(uint8_t p);
  131. uint8_t router_purpose_from_string(const char *s);
  132. smartlist_t *router_get_all_orports(const routerinfo_t *ri);
  133. #ifdef ROUTER_PRIVATE
  134. /* Used only by router.c and test.c */
  135. STATIC void get_platform_str(char *platform, size_t len);
  136. STATIC int router_write_fingerprint(int hashed);
  137. #endif
  138. #endif /* !defined(TOR_ROUTER_H) */