src/feature/hs/hs_client.h

   1 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
   2 /* See LICENSE for licensing information */
   3
   4 /**
   5  * \file hs_client.h
   6  * \brief Header file containing client data for the HS subsytem.
   7  **/
   8
   9 #ifndef TOR_HS_CLIENT_H
  10 #define TOR_HS_CLIENT_H
  11
  12 #include "lib/crypt_ops/crypto_ed25519.h"
  13 #include "feature/hs/hs_descriptor.h"
  14 #include "feature/hs/hs_ident.h"
  15
  16 /* Status code of a descriptor fetch request. */
  17 typedef enum {
  18   /* Something internally went wrong. */
  19   HS_CLIENT_FETCH_ERROR        = -1,
  20   /* The fetch request has been launched successfully. */
  21   HS_CLIENT_FETCH_LAUNCHED     = 0,
  22   /* We already have a usable descriptor. No fetch. */
  23   HS_CLIENT_FETCH_HAVE_DESC    = 1,
  24   /* No more HSDir available to query. */
  25   HS_CLIENT_FETCH_NO_HSDIRS    = 2,
  26   /* The fetch request is not allowed. */
  27   HS_CLIENT_FETCH_NOT_ALLOWED  = 3,
  28   /* We are missing information to be able to launch a request. */
  29   HS_CLIENT_FETCH_MISSING_INFO = 4,
  30   /* There is a pending fetch for the requested service. */
  31   HS_CLIENT_FETCH_PENDING      = 5,
  32 } hs_client_fetch_status_t;
  33
  34 /** Client-side configuration of authorization for a service. */
  35 typedef struct hs_client_service_authorization_t {
  36   /* An curve25519 secret key used to compute decryption keys that
  37    * allow the client to decrypt the hidden service descriptor. */
  38   curve25519_secret_key_t enc_seckey;
  39
  40   /* An onion address that is used to connect to the onion service. */
  41   char onion_address[HS_SERVICE_ADDR_LEN_BASE32+1];
  42 } hs_client_service_authorization_t;
  43
  44 void hs_client_note_connection_attempt_succeeded(
  45                                        const edge_connection_t *conn);
  46
  47 int hs_client_decode_descriptor(
  48                      const char *desc_str,
  49                      const ed25519_public_key_t *service_identity_pk,
  50                      hs_descriptor_t **desc);
  51 int hs_client_any_intro_points_usable(const ed25519_public_key_t *service_pk,
  52                                       const hs_descriptor_t *desc);
  53 int hs_client_refetch_hsdesc(const ed25519_public_key_t *identity_pk);
  54 void hs_client_dir_info_changed(void);
  55
  56 int hs_client_send_introduce1(origin_circuit_t *intro_circ,
  57                               origin_circuit_t *rend_circ);
  58
  59 void hs_client_circuit_has_opened(origin_circuit_t *circ);
  60
  61 int hs_client_receive_rendezvous_acked(origin_circuit_t *circ,
  62                                        const uint8_t *payload,
  63                                        size_t payload_len);
  64 int hs_client_receive_introduce_ack(origin_circuit_t *circ,
  65                                     const uint8_t *payload,
  66                                     size_t payload_len);
  67 int hs_client_receive_rendezvous2(origin_circuit_t *circ,
  68                                   const uint8_t *payload,
  69                                   size_t payload_len);
  70
  71 void hs_client_desc_has_arrived(const hs_ident_dir_conn_t *ident);
  72
  73 extend_info_t *hs_client_get_random_intro_from_edge(
  74                                           const edge_connection_t *edge_conn);
  75
  76 int hs_config_client_authorization(const or_options_t *options,
  77                                    int validate_only);
  78
  79 int hs_client_reextend_intro_circuit(origin_circuit_t *circ);
  80 void hs_client_close_intro_circuits_from_desc(const hs_descriptor_t *desc);
  81
  82 void hs_client_purge_state(void);
  83
  84 void hs_client_free_all(void);
  85
  86 #ifdef HS_CLIENT_PRIVATE
  87
  88 STATIC int auth_key_filename_is_valid(const char *filename);
  89
  90 STATIC hs_client_service_authorization_t *
  91 parse_auth_file_content(const char *client_key_str);
  92
  93 STATIC routerstatus_t *
  94 pick_hsdir_v3(const ed25519_public_key_t *onion_identity_pk);
  95
  96 STATIC extend_info_t *
  97 client_get_random_intro(const ed25519_public_key_t *service_pk);
  98
  99 STATIC extend_info_t *
 100 desc_intro_point_to_extend_info(const hs_desc_intro_point_t *ip);
 101
 102 STATIC int handle_rendezvous2(origin_circuit_t *circ, const uint8_t *payload,
 103                               size_t payload_len);
 104
 105 MOCK_DECL(STATIC hs_client_fetch_status_t,
 106           fetch_v3_desc, (const ed25519_public_key_t *onion_identity_pk));
 107
 108 STATIC void retry_all_socks_conn_waiting_for_desc(void);
 109
 110 #ifdef TOR_UNIT_TESTS
 111
 112 STATIC digest256map_t *get_hs_client_auths_map(void);
 113
 114 #endif /* defined(TOR_UNIT_TESTS) */
 115
 116 #endif /* defined(HS_CLIENT_PRIVATE) */
 117
 118 #endif /* !defined(TOR_HS_CLIENT_H) */
 119