src/core/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-2019, 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 struct ed25519_public_key_t;
  16 struct curve25519_public_key_t;
  17
  18 int route_len_for_purpose(uint8_t purpose, extend_info_t *exit_ei);
  19 char *circuit_list_path(origin_circuit_t *circ, int verbose);
  20 char *circuit_list_path_for_controller(origin_circuit_t *circ);
  21 void circuit_log_path(int severity, unsigned int domain,
  22                       origin_circuit_t *circ);
  23 origin_circuit_t *origin_circuit_init(uint8_t purpose, int flags);
  24 origin_circuit_t *circuit_establish_circuit(uint8_t purpose,
  25                                             extend_info_t *exit,
  26                                             int flags);
  27 struct circuit_guard_state_t *origin_circuit_get_guard_state(
  28                                             origin_circuit_t *circ);
  29 int circuit_handle_first_hop(origin_circuit_t *circ);
  30 void circuit_n_chan_done(channel_t *chan, int status,
  31                          int close_origin_circuits);
  32 int inform_testing_reachability(void);
  33 int circuit_timeout_want_to_count_circ(const origin_circuit_t *circ);
  34 int circuit_send_next_onion_skin(origin_circuit_t *circ);
  35 void circuit_note_clock_jumped(int64_t seconds_elapsed, bool was_idle);
  36 int circuit_extend(cell_t *cell, circuit_t *circ);
  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, int reason);
  41 int onionskin_answer(or_circuit_t *circ,
  42                      const struct created_cell_t *created_cell,
  43                      const char *keys, size_t keys_len,
  44                      const uint8_t *rend_circ_nonce);
  45 MOCK_DECL(int, circuit_all_predicted_ports_handled, (time_t now,
  46                                                      int *need_uptime,
  47                                                      int *need_capacity));
  48
  49 int circuit_append_new_exit(origin_circuit_t *circ, extend_info_t *info);
  50 int circuit_extend_to_new_exit(origin_circuit_t *circ, extend_info_t *info);
  51 extend_info_t *extend_info_new(const char *nickname,
  52                                const char *rsa_id_digest,
  53                                const struct ed25519_public_key_t *ed_id,
  54                                crypto_pk_t *onion_key,
  55                                const struct curve25519_public_key_t *ntor_key,
  56                                const tor_addr_t *addr, uint16_t port);
  57 extend_info_t *extend_info_from_node(const node_t *r, int for_direct_connect);
  58 extend_info_t *extend_info_dup(extend_info_t *info);
  59 void extend_info_free_(extend_info_t *info);
  60 #define extend_info_free(info) \
  61   FREE_AND_NULL(extend_info_t, extend_info_free_, (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                          const smartlist_t *nodes);
  83 MOCK_DECL(STATIC int, count_acceptable_nodes, (const smartlist_t *nodes,
  84                                                int direct));
  85
  86 STATIC int onion_extend_cpath(origin_circuit_t *circ);
  87
  88 STATIC int
  89 onion_pick_cpath_exit(origin_circuit_t *circ, extend_info_t *exit_ei,
  90                       int is_hs_v3_rp_circuit);
  91
  92 #endif /* defined(CIRCUITBUILD_PRIVATE) */
  93
  94 #endif /* !defined(TOR_CIRCUITBUILD_H) */