src/or/router.h

   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-2012, 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
  15 crypto_pk_t *get_onion_key(void);
  16 time_t get_onion_key_set_at(void);
  17 void set_server_identity_key(crypto_pk_t *k);
  18 crypto_pk_t *get_server_identity_key(void);
  19 int server_identity_key_is_set(void);
  20 void set_client_identity_key(crypto_pk_t *k);
  21 crypto_pk_t *get_tlsclient_identity_key(void);
  22 int client_identity_key_is_set(void);
  23 authority_cert_t *get_my_v3_authority_cert(void);
  24 crypto_pk_t *get_my_v3_authority_signing_key(void);
  25 authority_cert_t *get_my_v3_legacy_cert(void);
  26 crypto_pk_t *get_my_v3_legacy_signing_key(void);
  27 void dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last);
  28 void rotate_onion_key(void);
  29 crypto_pk_t *init_key_from_file(const char *fname, int generate,
  30                                     int severity);
  31 void v3_authority_check_key_expiry(void);
  32
  33 int router_initialize_tls_context(void);
  34 int init_keys(void);
  35
  36 int check_whether_orport_reachable(void);
  37 int check_whether_dirport_reachable(void);
  38 void consider_testing_reachability(int test_or, int test_dir);
  39 void router_orport_found_reachable(void);
  40 void router_dirport_found_reachable(void);
  41 void router_perform_bandwidth_test(int num_circs, time_t now);
  42
  43 int net_is_disabled(void);
  44
  45 int authdir_mode(const or_options_t *options);
  46 int authdir_mode_v1(const or_options_t *options);
  47 int authdir_mode_v2(const or_options_t *options);
  48 int authdir_mode_v3(const or_options_t *options);
  49 int authdir_mode_any_main(const or_options_t *options);
  50 int authdir_mode_any_nonhidserv(const or_options_t *options);
  51 int authdir_mode_handles_descs(const or_options_t *options, int purpose);
  52 int authdir_mode_publishes_statuses(const or_options_t *options);
  53 int authdir_mode_tests_reachability(const or_options_t *options);
  54 int authdir_mode_bridge(const or_options_t *options);
  55
  56 uint16_t router_get_active_listener_port_by_type(int listener_type);
  57 uint16_t router_get_advertised_or_port(const or_options_t *options);
  58 uint16_t router_get_advertised_dir_port(const or_options_t *options,
  59                                         uint16_t dirport);
  60
  61 int server_mode(const or_options_t *options);
  62 int public_server_mode(const or_options_t *options);
  63 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
  68 void router_upload_dir_desc_to_dirservers(int force);
  69 void mark_my_descriptor_dirty_if_too_old(time_t now);
  70 void mark_my_descriptor_dirty(const char *reason);
  71 void check_descriptor_bandwidth_changed(time_t now);
  72 void check_descriptor_ipaddress_changed(time_t now);
  73 void router_new_address_suggestion(const char *suggestion,
  74                                    const dir_connection_t *d_conn);
  75 int router_compare_to_my_exit_policy(edge_connection_t *conn);
  76 int router_my_exit_policy_is_reject_star(void);
  77 const routerinfo_t *router_get_my_routerinfo(void);
  78 extrainfo_t *router_get_my_extrainfo(void);
  79 const char *router_get_my_descriptor(void);
  80 const char *router_get_descriptor_gen_reason(void);
  81 int router_digest_is_me(const char *digest);
  82 int router_extrainfo_digest_is_me(const char *digest);
  83 int router_is_me(const routerinfo_t *router);
  84 int router_fingerprint_is_me(const char *fp);
  85 int router_pick_published_address(const or_options_t *options, uint32_t *addr);
  86 int router_rebuild_descriptor(int force);
  87 int router_dump_router_to_string(char *s, size_t maxlen, routerinfo_t *router,
  88                                  crypto_pk_t *ident_key);
  89 void router_get_prim_orport(const routerinfo_t *router,
  90                             tor_addr_port_t *addr_port_out);
  91 void router_get_pref_orport(const routerinfo_t *router,
  92                             tor_addr_port_t *addr_port_out);
  93 void router_get_pref_ipv6_orport(const routerinfo_t *router,
  94                                  tor_addr_port_t *addr_port_out);
  95 int router_ipv6_preferred(const routerinfo_t *router);
  96 int extrainfo_dump_to_string(char **s, extrainfo_t *extrainfo,
  97                              crypto_pk_t *ident_key);
  98 int is_legal_nickname(const char *s);
  99 int is_legal_nickname_or_hexdigest(const char *s);
 100 int is_legal_hexdigest(const char *s);
 101
 102 /**
 103  * Longest allowed output of format_node_description, plus 1 character for
 104  * NUL.  This allows space for:
 105  * "$FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF~xxxxxxxxxxxxxxxxxxx at"
 106  * " [ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255]"
 107  * plus a terminating NUL.
 108  */
 109 #define NODE_DESC_BUF_LEN (MAX_VERBOSE_NICKNAME_LEN+4+TOR_ADDR_BUF_LEN)
 110 const char *format_node_description(char *buf,
 111                                     const char *id_digest,
 112                                     int is_named,
 113                                     const char *nickname,
 114                                     const tor_addr_t *addr,
 115                                     uint32_t addr32h);
 116 const char *router_get_description(char *buf, const routerinfo_t *ri);
 117 const char *node_get_description(char *buf, const node_t *node);
 118 const char *routerstatus_get_description(char *buf, const routerstatus_t *rs);
 119 const char *extend_info_get_description(char *buf, const extend_info_t *ei);
 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
 125 void router_get_verbose_nickname(char *buf, const routerinfo_t *router);
 126 void routerstatus_get_verbose_nickname(char *buf,
 127                                        const routerstatus_t *router);
 128 void router_reset_warnings(void);
 129 void router_reset_reachability(void);
 130 void router_free_all(void);
 131
 132 const char *router_purpose_to_string(uint8_t p);
 133 uint8_t router_purpose_from_string(const char *s);
 134
 135 #ifdef ROUTER_PRIVATE
 136 /* Used only by router.c and test.c */
 137 void get_platform_str(char *platform, size_t len);
 138 #endif
 139
 140 #endif
 141