src/or/circuitbuild.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-2017, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file circuitbuild.h
   9  * \brief Header file for circuitbuild.c.
  10  **/
  11
  12 #ifndef TOR_CIRCUITBUILD_H
  13 #define TOR_CIRCUITBUILD_H
  14
  15 char *circuit_list_path(origin_circuit_t *circ, int verbose);
  16 char *circuit_list_path_for_controller(origin_circuit_t *circ);
  17 void circuit_log_path(int severity, unsigned int domain,
  18                       origin_circuit_t *circ);
  19 void circuit_rep_hist_note_result(origin_circuit_t *circ);
  20 origin_circuit_t *origin_circuit_init(uint8_t purpose, int flags);
  21 origin_circuit_t *circuit_establish_circuit(uint8_t purpose,
  22                                             extend_info_t *exit,
  23                                             int flags);
  24 struct circuit_guard_state_t *origin_circuit_get_guard_state(
  25                                             origin_circuit_t *circ);
  26 int circuit_handle_first_hop(origin_circuit_t *circ);
  27 void circuit_n_chan_done(channel_t *chan, int status,
  28                          int close_origin_circuits);
  29 int inform_testing_reachability(void);
  30 int circuit_timeout_want_to_count_circ(origin_circuit_t *circ);
  31 int circuit_send_next_onion_skin(origin_circuit_t *circ);
  32 void circuit_note_clock_jumped(int seconds_elapsed);
  33 int circuit_extend(cell_t *cell, circuit_t *circ);
  34 int circuit_init_cpath_crypto(crypt_path_t *cpath,
  35                               const char *key_data, size_t key_data_len,
  36                               int reverse, int is_hs_v3);
  37 struct created_cell_t;
  38 int circuit_finish_handshake(origin_circuit_t *circ,
  39                              const struct created_cell_t *created_cell);
  40 int circuit_truncated(origin_circuit_t *circ, crypt_path_t *layer,
  41                       int reason);
  42 int onionskin_answer(or_circuit_t *circ,
  43                      const struct created_cell_t *created_cell,
  44                      const char *keys, size_t keys_len,
  45                      const uint8_t *rend_circ_nonce);
  46 MOCK_DECL(int, circuit_all_predicted_ports_handled, (time_t now,
  47                                                      int *need_uptime,
  48                                                      int *need_capacity));
  49
  50 int circuit_append_new_exit(origin_circuit_t *circ, extend_info_t *info);
  51 int circuit_extend_to_new_exit(origin_circuit_t *circ, extend_info_t *info);
  52 void onion_append_to_cpath(crypt_path_t **head_ptr, crypt_path_t *new_hop);
  53 extend_info_t *extend_info_new(const char *nickname,
  54                                const char *rsa_id_digest,
  55                                const ed25519_public_key_t *ed_id,
  56                                crypto_pk_t *onion_key,
  57                                const curve25519_public_key_t *ntor_key,
  58                                const tor_addr_t *addr, uint16_t port);
  59 extend_info_t *extend_info_from_node(const node_t *r, int for_direct_connect);
  60 extend_info_t *extend_info_dup(extend_info_t *info);
  61 void extend_info_free(extend_info_t *info);
  62 int extend_info_addr_is_allowed(const tor_addr_t *addr);
  63 int extend_info_supports_tap(const extend_info_t* ei);
  64 int extend_info_supports_ntor(const extend_info_t* ei);
  65 int circuit_can_use_tap(const origin_circuit_t *circ);
  66 int circuit_has_usable_onion_key(const origin_circuit_t *circ);
  67 int extend_info_has_preferred_onion_key(const extend_info_t* ei);
  68 const uint8_t *build_state_get_exit_rsa_id(cpath_build_state_t *state);
  69 const node_t *build_state_get_exit_node(cpath_build_state_t *state);
  70 const char *build_state_get_exit_nickname(cpath_build_state_t *state);
  71
  72 struct circuit_guard_state_t;
  73
  74 const node_t *choose_good_entry_server(uint8_t purpose,
  75                            cpath_build_state_t *state,
  76                            struct circuit_guard_state_t **guard_state_out);
  77 void circuit_upgrade_circuits_from_guard_wait(void);
  78
  79 #ifdef CIRCUITBUILD_PRIVATE
  80 STATIC circid_t get_unique_circ_id_by_chan(channel_t *chan);
  81 STATIC int new_route_len(uint8_t purpose, extend_info_t *exit_ei,
  82                          smartlist_t *nodes);
  83 MOCK_DECL(STATIC int, count_acceptable_nodes, (smartlist_t *nodes));
  84 #if defined(ENABLE_TOR2WEB_MODE) || defined(TOR_UNIT_TESTS)
  85 STATIC const node_t *pick_tor2web_rendezvous_node(router_crn_flags_t flags,
  86                                                   const or_options_t *options);
  87 unsigned int cpath_get_n_hops(crypt_path_t **head_ptr);
  88
  89 #endif
  90
  91 #endif
  92
  93 #endif
  94