src/core/or/connection_or.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-2021, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file connection_or.h
   9  * \brief Header file for connection_or.c.
  10  **/
  11
  12 #ifndef TOR_CONNECTION_OR_H
  13 #define TOR_CONNECTION_OR_H
  14
  15 struct ed25519_public_key_t;
  16 struct ed25519_keypair_t;
  17
  18 or_connection_t *TO_OR_CONN(connection_t *);
  19 const or_connection_t *CONST_TO_OR_CONN(const connection_t *);
  20
  21 #include "core/or/orconn_event.h"
  22
  23 void connection_or_clear_identity(or_connection_t *conn);
  24 void connection_or_clear_identity_map(void);
  25 void clear_broken_connection_map(int disable);
  26
  27 void connection_or_block_renegotiation(or_connection_t *conn);
  28 int connection_or_reached_eof(or_connection_t *conn);
  29 int connection_or_process_inbuf(or_connection_t *conn);
  30 ssize_t connection_or_num_cells_writeable(or_connection_t *conn);
  31 int connection_or_flushed_some(or_connection_t *conn);
  32 int connection_or_finished_flushing(or_connection_t *conn);
  33 int connection_or_finished_connecting(or_connection_t *conn);
  34 void connection_or_about_to_close(or_connection_t *conn);
  35 int connection_or_digest_is_known_relay(const char *id_digest);
  36 void connection_or_update_token_buckets(smartlist_t *conns,
  37                                         const or_options_t *options);
  38
  39 void connection_or_connect_failed(or_connection_t *conn,
  40                                   int reason, const char *msg);
  41 void connection_or_notify_error(or_connection_t *conn,
  42                                 int reason, const char *msg);
  43 MOCK_DECL(or_connection_t *,
  44           connection_or_connect,
  45           (const tor_addr_t *addr, uint16_t port,
  46            const char *id_digest,
  47            const struct ed25519_public_key_t *ed_id,
  48            channel_tls_t *chan));
  49
  50 void connection_or_close_normally(or_connection_t *orconn, int flush);
  51 MOCK_DECL(void,connection_or_close_for_error,
  52           (or_connection_t *orconn, int flush));
  53
  54 void connection_or_report_broken_states(int severity, int domain);
  55
  56 void connection_or_event_status(or_connection_t *conn,
  57                                 or_conn_status_event_t tp, int reason);
  58
  59 MOCK_DECL(int,connection_tls_start_handshake,(or_connection_t *conn,
  60                                               int receiving));
  61 int connection_tls_continue_handshake(or_connection_t *conn);
  62 void connection_or_set_canonical(or_connection_t *or_conn,
  63                                  int is_canonical);
  64
  65 int connection_init_or_handshake_state(or_connection_t *conn,
  66                                        int started_here);
  67 void connection_or_init_conn_from_address(or_connection_t *conn,
  68                                     const tor_addr_t *addr,
  69                                     uint16_t port,
  70                                     const char *rsa_id_digest,
  71                                     const struct ed25519_public_key_t *ed_id,
  72                                     int started_here);
  73 int connection_or_client_learned_peer_id(or_connection_t *conn,
  74                               const uint8_t *rsa_peer_id,
  75                               const struct ed25519_public_key_t *ed_peer_id);
  76 const struct ed25519_public_key_t *connection_or_get_alleged_ed25519_id(
  77                               const or_connection_t *conn);
  78 time_t connection_or_client_used(or_connection_t *conn);
  79 MOCK_DECL(int, connection_or_get_num_circuits, (or_connection_t *conn));
  80 void or_handshake_state_free_(or_handshake_state_t *state);
  81 #define or_handshake_state_free(state) \
  82   FREE_AND_NULL(or_handshake_state_t, or_handshake_state_free_, (state))
  83 void or_handshake_state_record_cell(or_connection_t *conn,
  84                                     or_handshake_state_t *state,
  85                                     const cell_t *cell,
  86                                     int incoming);
  87 void or_handshake_state_record_var_cell(or_connection_t *conn,
  88                                         or_handshake_state_t *state,
  89                                         const var_cell_t *cell,
  90                                         int incoming);
  91
  92 int connection_or_set_state_open(or_connection_t *conn);
  93 void connection_or_write_cell_to_buf(const cell_t *cell,
  94                                      or_connection_t *conn);
  95 MOCK_DECL(void,connection_or_write_var_cell_to_buf,(const var_cell_t *cell,
  96                                                    or_connection_t *conn));
  97 int connection_or_send_versions(or_connection_t *conn, int v3_plus);
  98 MOCK_DECL(int,connection_or_send_netinfo,(or_connection_t *conn));
  99
 100 int is_or_protocol_version_known(uint16_t version);
 101
 102 void cell_pack(packed_cell_t *dest, const cell_t *src, int wide_circ_ids);
 103 int var_cell_pack_header(const var_cell_t *cell, char *hdr_out,
 104                          int wide_circ_ids);
 105 var_cell_t *var_cell_new(uint16_t payload_len);
 106 var_cell_t *var_cell_copy(const var_cell_t *src);
 107 void var_cell_free_(var_cell_t *cell);
 108 #define var_cell_free(cell) FREE_AND_NULL(var_cell_t, var_cell_free_, (cell))
 109
 110 /* DOCDOC */
 111 #define MIN_LINK_PROTO_FOR_WIDE_CIRC_IDS 4
 112 #define MIN_LINK_PROTO_FOR_CHANNEL_PADDING 5
 113 #define MAX_LINK_PROTO MIN_LINK_PROTO_FOR_CHANNEL_PADDING
 114
 115 int connection_or_single_set_badness_(time_t now,
 116                                       or_connection_t *or_conn,
 117                                       int force);
 118 void connection_or_group_set_badness_(smartlist_t *group, int force);
 119
 120 #ifdef CONNECTION_OR_PRIVATE
 121 STATIC int should_connect_to_relay(const or_connection_t *or_conn);
 122 STATIC void note_or_connect_failed(const or_connection_t *or_conn);
 123 #endif /* defined(CONNECTION_OR_PRIVATE) */
 124
 125 /*
 126  * Call this when changing connection state, so notifications to the owning
 127  * channel can be handled.
 128  */
 129 MOCK_DECL(void, connection_or_change_state,
 130           (or_connection_t *conn, uint8_t state));
 131
 132 #ifdef TOR_UNIT_TESTS
 133 extern int testing__connection_or_pretend_TLSSECRET_is_supported;
 134 #endif
 135
 136 #endif /* !defined(TOR_CONNECTION_OR_H) */