|
Tor 0.4.9.3-alpha-dev
|
Header file for router.c. More...
#include "lib/testsupport/testsupport.h"Go to the source code of this file.
Macros | |
| #define | TOR_ROUTERINFO_ERROR_NO_EXT_ADDR (-1) |
| #define | TOR_ROUTERINFO_ERROR_CANNOT_PARSE (-2) |
| #define | TOR_ROUTERINFO_ERROR_NOT_A_SERVER (-3) |
| #define | TOR_ROUTERINFO_ERROR_DIGEST_FAILED (-4) |
| #define | TOR_ROUTERINFO_ERROR_CANNOT_GENERATE (-5) |
| #define | TOR_ROUTERINFO_ERROR_DESC_REBUILDING (-6) |
| #define | TOR_ROUTERINFO_ERROR_INTERNAL_BUG (-7) |
| #define | get_server_identity_key() (tor_abort_(),NULL) |
| #define | ntor_key_map_free(map) FREE_AND_NULL(di_digest256_map_t, ntor_key_map_free_, (map)) |
| #define get_server_identity_key | ( | ) | (tor_abort_(),NULL) |
| #define ntor_key_map_free | ( | map | ) | FREE_AND_NULL(di_digest256_map_t, ntor_key_map_free_, (map)) |
| void check_descriptor_bandwidth_changed | ( | time_t | now | ) |
Check whether bandwidth has changed a lot since the last time we announced bandwidth while the uptime is smaller than MAX_UPTIME_BANDWIDTH_CHANGE. If so, mark our descriptor dirty.
Definition at line 2632 of file router.c.
Referenced by check_descriptor_callback().
| void check_descriptor_ipaddress_changed | ( | time_t | now | ) |
Check whether our own address has changed versus the one we have in our current descriptor.
If our address has changed, call ip_address_changed() which takes appropriate actions.
Definition at line 2710 of file router.c.
Referenced by check_descriptor_callback().
| int client_identity_key_is_set | ( | void | ) |
| void consider_publishable_server | ( | int | force | ) |
Initiate server descriptor upload as reasonable (if server is publishable, etc). force is as for router_upload_dir_desc_to_dirservers.
We need to rebuild the descriptor if it's dirty even if we're not uploading, because our reachability testing uses our descriptor to determine what IP address and ports to test.
Definition at line 1477 of file router.c.
Referenced by check_descriptor_callback().
| di_digest256_map_t * construct_ntor_key_map | ( | void | ) |
Return a map from KEYID (the key itself) to keypairs for use in the ntor handshake. Must only be called from the main thread.
Definition at line 324 of file router.c.
Referenced by server_onion_keys_new().
| void dup_onion_keys | ( | crypto_pk_t ** | key, |
| crypto_pk_t ** | last | ||
| ) |
Store a full copy of the current onion key into *key, and a full copy of the most recent onion key into *last. Store NULL into a pointer if the corresponding key does not exist.
Definition at line 252 of file router.c.
Referenced by server_onion_keys_new().
| void expire_old_onion_keys | ( | void | ) |
| authority_cert_t * get_my_v3_authority_cert | ( | void | ) |
Return the key certificate for this v3 (voting) authority, or NULL if we have no such certificate.
Definition at line 474 of file router.c.
Referenced by authority_cert_get_by_sk_digest(), dirvote_act(), dirvote_compute_consensuses(), dirvote_get_vote(), dirvote_perform_vote(), handle_get_keys(), init_keys(), new_protocol_run(), and sr_state_update().
| crypto_pk_t * get_my_v3_authority_signing_key | ( | void | ) |
Return the v3 signing key for this v3 (voting) authority, or NULL if we have no such key.
Definition at line 482 of file router.c.
Referenced by dirvote_compute_consensuses(), and dirvote_perform_vote().
| authority_cert_t * get_my_v3_legacy_cert | ( | void | ) |
If we're an authority, and we're using a legacy authority identity key for emergency migration purposes, return the certificate associated with that key.
Definition at line 491 of file router.c.
Referenced by authority_cert_get_by_sk_digest(), dirserv_generate_networkstatus_vote_obj(), and dirvote_compute_consensuses().
| crypto_pk_t * get_my_v3_legacy_signing_key | ( | void | ) |
If we're an authority, and we're using a legacy authority identity key for emergency migration purposes, return that key.
Definition at line 499 of file router.c.
Referenced by dirvote_compute_consensuses().
| crypto_pk_t * get_onion_key | ( | void | ) |
Return the current TAP onion key. Requires that the onion key has been loaded or generated.
Note that this key is no longer used for anything; we only keep it around because (as of June 2024) other Tor instances all expect to find it in our routerdescs.
Definition at line 222 of file router.c.
Referenced by router_build_fresh_unsigned_routerinfo(), and router_dump_and_sign_routerinfo_descriptor_body().
| int get_onion_key_grace_period | ( | void | ) |
| int get_onion_key_lifetime | ( | void | ) |
Get the current lifetime of an onion key in seconds. This value is defined by the network consensus parameter "onion-key-rotation-days", but the value is converted to seconds.
Definition at line 819 of file router.c.
Referenced by router_dump_router_to_string().
| time_t get_onion_key_set_at | ( | void | ) |
| crypto_pk_t * get_tlsclient_identity_key | ( | void | ) |
Returns the current client identity key for use on outgoing TLS connections; requires that the key has been set.
Definition at line 457 of file router.c.
Referenced by channel_set_circid_type(), and router_initialize_tls_context().
| int init_keys | ( | void | ) |
Initialize all OR private keys, and the TLS context, as necessary. On OPs, this only initializes the tls context. Return 0 on success, or -1 if Tor should die.
Definition at line 994 of file router.c.
Referenced by accounting_set_wakeup_time(), do_list_fingerprint(), options_act_relay(), and tor_run_main().
| void log_addr_has_changed | ( | int | severity, |
| const tor_addr_t * | prev, | ||
| const tor_addr_t * | cur, | ||
| const char * | source | ||
| ) |
Note at log level severity that our best guess of address has changed from prev to cur.
Definition at line 2676 of file router.c.
Referenced by check_descriptor_ipaddress_changed().
| void mark_my_descriptor_dirty | ( | const char * | reason | ) |
Call when the current descriptor is out of date.
Definition at line 2601 of file router.c.
Referenced by add_wildcarded_test_address(), check_descriptor_bandwidth_changed(), configure_nameservers(), ip_address_changed(), mark_my_descriptor_dirty_if_too_old(), mark_my_descriptor_if_omit_ipv6_changes(), options_act_relay_desc(), pt_configure_remaining_proxies(), retry_all_listeners(), rotate_onion_key(), router_orport_found_reachable(), and set_onion_key().
| void mark_my_descriptor_dirty_if_too_old | ( | time_t | now | ) |
Mark descriptor out of date if it's been "too long" since we last tried to upload one.
Definition at line 2562 of file router.c.
Referenced by check_descriptor_callback().
| void mark_my_descriptor_if_omit_ipv6_changes | ( | const char * | reason, |
| bool | omit_ipv6 | ||
| ) |
Mark our descriptor out of data iff the IPv6 omit status flag is flipped it changes from its previous value.
This is used when our IPv6 port is found reachable or not.
Definition at line 2540 of file router.c.
Referenced by reachability_warnings_callback(), and router_orport_found_reachable().
| void ntor_key_map_free_ | ( | di_digest256_map_t * | map | ) |
| bool rotate_onion_key | ( | void | ) |
Replace the previous onion key with the current onion key, and generate a new previous onion key. Immediately after calling this function, the OR should:
Return true on success, else false on error.
| bool router_addr_is_my_published_addr | ( | const tor_addr_t * | addr | ) |
Return true if we are a server, and if addr is an address we are currently publishing (or trying to publish) in our descriptor. Return false otherwise.
Definition at line 1795 of file router.c.
Referenced by onionskin_answer().
| int router_build_fresh_descriptor | ( | routerinfo_t ** | r, |
| extrainfo_t ** | e | ||
| ) |
Build a fresh routerinfo, signed server descriptor, and signed extrainfo document for this OR.
Set r to the generated routerinfo, e to the generated extrainfo document. Failure to generate an extra-info document is not an error and is indicated by setting e to NULL. Return 0 on success, and a negative value on temporary error. Caller is responsible for freeing generated documents on success.
Definition at line 2407 of file router.c.
Referenced by getinfo_helper_events(), and router_rebuild_descriptor().
| bool router_can_extend_over_ipv6 | ( | const or_options_t * | options | ) |
Returns true if this router can extend over IPv6.
This check should only be performed by relay extend code.
Clients should check if relays can initiate and accept IPv6 extends using node_supports_initiating_ipv6_extends() and node_supports_accepting_ipv6_extends().
As with other extends, relays should assume the client has already performed the relevant checks for the next hop. (Otherwise, relays that have just added IPv6 ORPorts won't be able to self-test those ORPorts.)
Accepting relays don't need to perform any IPv6-specific checks before accepting a connection, because having an IPv6 ORPort implies support for the relevant protocol version.
Definition at line 1610 of file router.c.
Referenced by extend_info_pick_orport().
| int router_compare_to_my_exit_policy | ( | const tor_addr_t * | addr, |
| uint16_t | port | ||
| ) |
OR only: Check whether my exit policy says to allow connection to conn. Return 0 if we accept; non-0 if we reject.
Definition at line 1708 of file router.c.
Referenced by my_exit_policy_rejects(), and set_exitconn_info_from_resolve().
| int router_digest_is_me | ( | const char * | digest | ) |
Return true iff I'm a server and digest is equal to my server identity key digest.
Definition at line 1755 of file router.c.
Referenced by choose_good_exit_server_general(), connection_or_connect(), controller_get_routerdescs(), directory_get_from_all_authorities(), directory_post_to_dirservers(), get_signed_descriptor_by_fp(), node_is_me(), node_is_possible_guard(), router_digest_is_trusted_dir_type(), router_is_me(), router_pick_directory_server_impl(), and router_pick_trusteddirserver_impl().
| char * router_dump_exit_policy_to_string | ( | const routerinfo_t * | router, |
| int | include_ipv4, | ||
| int | include_ipv6 | ||
| ) |
OR only: Given router, produce a string with its exit policy. If include_ipv4 is true, include IPv4 entries. If include_ipv6 is true, include IPv6 entries.
Definition at line 3221 of file router.c.
Referenced by getinfo_helper_policies(), and router_dump_router_to_string().
| int router_extrainfo_digest_is_me | ( | const char * | digest | ) |
Return true iff I'm a server and digest is equal to my identity digest.
Definition at line 1771 of file router.c.
Referenced by getinfo_helper_dir().
| void router_free_all | ( | void | ) |
| uint16_t router_get_active_listener_port_by_type_af | ( | int | listener_type, |
| sa_family_t | family | ||
| ) |
Return the port of the first active listener of type listener_type. Returns 0 if no port is found. XXX not a very good interface. it's not reliable when there are multiple listeners.
Definition at line 1498 of file router.c.
Referenced by get_first_listener_addrport_string(), routerconf_find_dir_port(), and routerconf_find_or_port().
| const char * router_get_descriptor_gen_reason | ( | void | ) |
Return a human-readable string describing what triggered us to generate our current descriptor, or NULL if we don't know.
Definition at line 1882 of file router.c.
Referenced by directory_send_command().
| const char * router_get_my_descriptor | ( | void | ) |
OR only: Return a signed server descriptor for this OR, rebuilding a fresh one if necessary. Return NULL on error.
Definition at line 1853 of file router.c.
Referenced by init_keys().
| extrainfo_t * router_get_my_extrainfo | ( | void | ) |
Return the extrainfo document for this OR, or NULL if we have none. Rebuilt it (and the server descriptor) if necessary.
Definition at line 1870 of file router.c.
Referenced by extrainfo_insert(), get_signed_descriptor_by_fp(), getinfo_helper_dir(), router_extrainfo_digest_is_me(), and router_upload_dir_desc_to_dirservers().
| const uint8_t * router_get_my_id_digest | ( | void | ) |
Return my identity digest.
Definition at line 1763 of file router.c.
Referenced by fill_relay_flags(), get_my_declared_family(), and server_onion_keys_new().
| const routerinfo_t * router_get_my_routerinfo | ( | void | ) |
Return a routerinfo for this OR, rebuilding a fresh one if necessary. Return NULL on error, or if called on an OP.
Definition at line 1817 of file router.c.
Referenced by bridgeauth_dump_bridge_status_to_file(), channel_tls_process_netinfo_cell(), check_descriptor_bandwidth_changed(), check_descriptor_ipaddress_changed(), check_for_reachability_bw_callback(), connection_or_send_netinfo(), controller_get_routerdescs(), dirclient_fetches_from_authorities(), dirserv_get_routerdesc_spool(), get_signed_descriptor_by_fp(), have_orport_for_family(), inform_testing_reachability(), log_heartbeat(), reachability_warnings_callback(), router_addr_is_my_published_addr(), router_choose_random_node(), router_compare_to_my_exit_policy(), router_do_reachability_checks(), router_get_my_descriptor(), router_my_exit_policy_is_reject_star(), router_orport_found_reachable(), router_pick_trusteddirserver_impl(), router_should_check_reachability(), router_upload_dir_desc_to_dirservers(), routerlist_insert(), routerlist_insert_old(), and routerlist_replace().
| const routerinfo_t * router_get_my_routerinfo_with_err | ( | int * | err | ) |
Return routerinfo of this OR. Rebuild it from scratch if needed. Set *err to 0 on success or to appropriate TOR_ROUTERINFO_ERROR_* value on failure.
Definition at line 1827 of file router.c.
Referenced by getinfo_helper_policies(), and router_get_my_routerinfo().
| crypto_pk_t * router_get_rsa_onion_pkey | ( | const char * | pkey, |
| size_t | pkey_len | ||
| ) |
| int router_has_bandwidth_to_be_dirserver | ( | const or_options_t * | options | ) |
Return true iff we have enough configured bandwidth to advertise or automatically provide directory services from cache directory information.
Definition at line 1275 of file router.c.
Referenced by dir_server_mode(), and router_should_be_dirserver().
| int router_initialize_tls_context | ( | void | ) |
Set up Tor's TLS contexts, based on our configuration and keys. Return 0 on success, and -1 on failure.
Definition at line 843 of file router.c.
Referenced by init_keys(), and rotate_x509_certificate_callback().
| int router_is_me | ( | const routerinfo_t * | router | ) |
A wrapper around router_digest_is_me().
Definition at line 1784 of file router.c.
Referenced by dirserv_add_descriptor(), dirserv_set_router_is_running(), dirserv_test_reachability(), and router_load_single_router().
| int router_my_exit_policy_is_reject_star | ( | void | ) |
Return true iff my exit policy is reject *:*. Return -1 if we don't have a descriptor
Definition at line 1743 of file router.c.
Referenced by check_dns_honesty_callback(), dirclient_fetches_from_authorities(), directory_caches_dir_info(), and dns_resolve_impl().
| void router_new_consensus_params | ( | const networkstatus_t * | ns | ) |
| bool router_rebuild_descriptor | ( | int | force | ) |
If force is true, or our descriptor is out-of-date, rebuild a fresh routerinfo, signed server descriptor, and extra-info document for this OR.
Return true on success, else false on temporary error.
Definition at line 2470 of file router.c.
Referenced by consider_publishable_server(), and router_get_my_extrainfo().
| void router_reset_warnings | ( | void | ) |
| void router_set_rsa_onion_pkey | ( | const crypto_pk_t * | pk, |
| char ** | onion_pkey_out, | ||
| size_t * | onion_pkey_len | ||
| ) |
| int router_should_advertise_dirport | ( | const or_options_t * | options, |
| uint16_t | dir_port | ||
| ) |
Return 0 if we don't want to advertise the fact that we have a DirPort open, else return the DirPort we want to advertise.
Definition at line 1384 of file router.c.
Referenced by router_dump_router_to_string().
| void router_upload_dir_desc_to_dirservers | ( | int | force | ) |
OR only: If force is true, or we haven't uploaded this descriptor successfully yet, try to upload our signed descriptor to all the directory servers we know about.
Definition at line 1662 of file router.c.
Referenced by consider_publishable_server().
| uint16_t routerconf_find_dir_port | ( | const or_options_t * | options, |
| uint16_t | dirport | ||
| ) |
Return the port that we should advertise as our DirPort; this is one of three possibilities: The one that is passed as dirport if the DirPort option is 0, or the one configured in the DirPort option, or the one we actually bound to if DirPort is "auto".
Definition at line 1623 of file router.c.
Referenced by dirserv_generate_networkstatus_vote_obj(), init_keys(), retry_all_listeners(), and router_build_fresh_unsigned_routerinfo().
| void routerconf_find_ipv6_or_ap | ( | const or_options_t * | options, |
| tor_addr_port_t * | ipv6_ap_out | ||
| ) |
As routerconf_find_or_port(), but returns the IPv6 address and port in ipv6_ap_out, which must not be NULL. Returns a null address and zero port, if no ORPort is found.
Definition at line 1538 of file router.c.
Referenced by init_keys().
| uint16_t routerconf_find_or_port | ( | const or_options_t * | options, |
| sa_family_t | family | ||
| ) |
Return the port that we should advertise as our ORPort in a given address family; this is either the one configured in the ORPort option, or the one we actually bound to if ORPort is "auto". Returns 0 if no port is found.
Definition at line 1518 of file router.c.
Referenced by decide_if_publishable_server(), decide_to_advertise_dir_impl(), dirserv_generate_networkstatus_vote_obj(), init_keys(), relay_find_addr_to_publish(), retry_all_listeners(), router_build_fresh_unsigned_routerinfo(), routerconf_find_ipv6_or_ap(), and routerconf_has_ipv6_orport().
| bool routerconf_has_ipv6_orport | ( | const or_options_t * | options | ) |
Returns true if this router has an advertised IPv6 ORPort.
Definition at line 1579 of file router.c.
Referenced by router_can_extend_over_ipv6().
| int routerinfo_err_is_transient | ( | int | err | ) |
Return true if we expect given error to be transient. Return false otherwise.
For simplicity, we consider all errors other than "not a server" transient - see discussion on https://bugs.torproject.org/tpo/core/tor/27034.
Definition at line 186 of file router.c.
Referenced by getinfo_helper_policies().
| const char * routerinfo_err_to_string | ( | int | err | ) |
Return a readonly string with human readable description of err.
Definition at line 157 of file router.c.
Referenced by getinfo_helper_policies().
| int server_identity_key_is_set | ( | void | ) |
Return true iff we are a server and the server identity key has been set.
Definition at line 437 of file router.c.
Referenced by accounting_set_wakeup_time(), log_master_signing_key_cert_expiration(), and pt_update_bridge_lines().
| void set_client_identity_key | ( | crypto_pk_t * | k | ) |
Set the current client identity key to k.
Definition at line 447 of file router.c.
Referenced by init_keys().
| void set_server_identity_key | ( | crypto_pk_t * | k | ) |
Set the current server identity key to k.
Definition at line 376 of file router.c.
Referenced by init_keys().
| bool should_publish_family_list | ( | const networkstatus_t * | ns | ) |
Return true if the parameters in ns say that we should publish a legacy family list.
Use the latest networkstatus (or returns the default) if ns is NULL.
Definition at line 2529 of file router.c.
Referenced by warn_about_family_id_config().
| int should_refuse_unknown_exits | ( | const or_options_t * | options | ) |
Return true iff the combination of options in options and parameters in the consensus mean that we don't want to allow exits from circuits we got from addresses not known to be servers.
Definition at line 1405 of file router.c.
Referenced by connection_exit_begin_conn(), dirclient_fetches_from_authorities(), and directory_caches_dir_info().
| void v3_authority_check_key_expiry | ( | void | ) |
If we're a v3 authority, check whether we have a certificate that's likely to expire soon. Warn if we do, but not too often.
Definition at line 756 of file router.c.
Referenced by check_authority_cert_callback().
1.9.8