src/feature/hs/hs_circuit.h

   1 /* Copyright (c) 2017-2021, The Tor Project, Inc. */
   2 /* See LICENSE for licensing information */
   3
   4 /**
   5  * \file hs_circuit.h
   6  * \brief Header file containing circuit data for the whole HS subsystem.
   7  **/
   8
   9 #ifndef TOR_HS_CIRCUIT_H
  10 #define TOR_HS_CIRCUIT_H
  11
  12 #include "core/or/or.h"
  13 #include "lib/crypt_ops/crypto_ed25519.h"
  14
  15 #include "feature/hs/hs_service.h"
  16
  17 /* Cleanup function when the circuit is closed or freed. */
  18 void hs_circ_cleanup_on_close(circuit_t *circ);
  19 void hs_circ_cleanup_on_free(circuit_t *circ);
  20 void hs_circ_cleanup_on_repurpose(circuit_t *circ);
  21
  22 /* Circuit API. */
  23 int hs_circ_service_intro_has_opened(hs_service_t *service,
  24                                      hs_service_intro_point_t *ip,
  25                                      const hs_service_descriptor_t *desc,
  26                                      origin_circuit_t *circ);
  27 void hs_circ_service_rp_has_opened(const hs_service_t *service,
  28                                    origin_circuit_t *circ);
  29 int hs_circ_launch_intro_point(hs_service_t *service,
  30                                const hs_service_intro_point_t *ip,
  31                                extend_info_t *ei,
  32                                bool direct_conn);
  33 int hs_circ_launch_rendezvous_point(const hs_service_t *service,
  34                                     const curve25519_public_key_t *onion_key,
  35                                     const uint8_t *rendezvous_cookie);
  36 void hs_circ_retry_service_rendezvous_point(origin_circuit_t *circ);
  37
  38 origin_circuit_t *hs_circ_service_get_intro_circ(
  39                                       const hs_service_intro_point_t *ip);
  40 origin_circuit_t *hs_circ_service_get_established_intro_circ(
  41                                       const hs_service_intro_point_t *ip);
  42
  43 /* Cell API. */
  44 int hs_circ_handle_intro_established(const hs_service_t *service,
  45                                      const hs_service_intro_point_t *ip,
  46                                      origin_circuit_t *circ,
  47                                      const uint8_t *payload,
  48                                      size_t payload_len);
  49 struct hs_subcredential_t;
  50 int hs_circ_handle_introduce2(const hs_service_t *service,
  51                               const origin_circuit_t *circ,
  52                               hs_service_intro_point_t *ip,
  53                               const struct hs_subcredential_t *subcredential,
  54                               const uint8_t *payload, size_t payload_len);
  55 int hs_circ_send_introduce1(origin_circuit_t *intro_circ,
  56                             origin_circuit_t *rend_circ,
  57                             const hs_desc_intro_point_t *ip,
  58                             const struct hs_subcredential_t *subcredential);
  59 int hs_circ_send_establish_rendezvous(origin_circuit_t *circ);
  60
  61 /* e2e circuit API. */
  62
  63 int hs_circuit_setup_e2e_rend_circ(origin_circuit_t *circ,
  64                                    const uint8_t *ntor_key_seed,
  65                                    size_t seed_len,
  66                                    int is_service_side);
  67 int hs_circuit_setup_e2e_rend_circ_legacy_client(origin_circuit_t *circ,
  68                                           const uint8_t *rend_cell_body);
  69
  70 bool hs_circ_is_rend_sent_in_intro1(const origin_circuit_t *circ);
  71
  72 #ifdef HS_CIRCUIT_PRIVATE
  73
  74 struct hs_ntor_rend_cell_keys_t;
  75
  76 STATIC hs_ident_circuit_t *
  77 create_rp_circuit_identifier(const hs_service_t *service,
  78                              const uint8_t *rendezvous_cookie,
  79                              const curve25519_public_key_t *server_pk,
  80                              const struct hs_ntor_rend_cell_keys_t *keys);
  81
  82 struct hs_cell_introduce2_data_t;
  83 MOCK_DECL(STATIC void,
  84 launch_rendezvous_point_circuit,(const hs_service_t *service,
  85                                  const hs_service_intro_point_t *ip,
  86                                 const struct hs_cell_introduce2_data_t *data));
  87
  88 #endif /* defined(HS_CIRCUIT_PRIVATE) */
  89
  90 #endif /* !defined(TOR_HS_CIRCUIT_H) */