Tor  0.4.4.0-alpha-dev
hs_client.h
Go to the documentation of this file.
1 /* Copyright (c) 2017-2020, 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 
13 
14 #include "feature/hs/hs_circuit.h"
16 #include "feature/hs/hs_ident.h"
17 
18 /** Status code of a descriptor fetch request. */
19 typedef enum {
20  /** Something internally went wrong. */
22  /** The fetch request has been launched successfully. */
24  /** We already have a usable descriptor. No fetch. */
26  /** No more HSDir available to query. */
28  /** The fetch request is not allowed. */
30  /** We are missing information to be able to launch a request. */
32  /** There is a pending fetch for the requested service. */
35 
36 /* Status code of client auth credential registration */
37 typedef enum {
38  /* We successfuly registered these credentials */
39  REGISTER_SUCCESS,
40  /* We successfully registered these credentials, but had to replace some
41  * existing ones. */
42  REGISTER_SUCCESS_ALREADY_EXISTS,
43  /* We successfuly registered these credentials, and also decrypted a cached
44  * descriptor. */
45  REGISTER_SUCCESS_AND_DECRYPTED,
46  /* We failed to register these credentials, because of a bad HS address. */
47  REGISTER_FAIL_BAD_ADDRESS,
48  /* We failed to register these credentials, because of a bad HS address. */
49  REGISTER_FAIL_PERMANENT_STORAGE,
50 } hs_client_register_auth_status_t;
51 
52 /* Status code of client auth credential removal */
53 typedef enum {
54  /* We successfuly removed these credentials */
55  REMOVAL_SUCCESS,
56  /* No need to remove those credentials, because they were not there. */
57  REMOVAL_SUCCESS_NOT_FOUND,
58  /* We failed to register these credentials, because of a bad HS address. */
59  REMOVAL_BAD_ADDRESS,
60 } hs_client_removal_auth_status_t;
61 
62 /** Flag to set when a client auth is permanent (saved on disk). */
63 #define CLIENT_AUTH_FLAG_IS_PERMANENT (1<<0)
64 
65 /** Client-side configuration of client authorization */
67  /** An curve25519 secret key used to compute decryption keys that
68  * allow the client to decrypt the hidden service descriptor. */
70 
71  /** An onion address that is used to connect to the onion service. */
73 
74  /* Optional flags for this client. */
75  int flags;
77 
78 hs_client_register_auth_status_t
80 
81 hs_client_removal_auth_status_t
82 hs_client_remove_auth_credentials(const char *hsaddress);
83 
84 digest256map_t *get_hs_client_auths_map(void);
85 
86 #define client_service_authorization_free(auth) \
87  FREE_AND_NULL(hs_client_service_authorization_t, \
88  client_service_authorization_free_, (auth))
89 
90 void
91 client_service_authorization_free_(hs_client_service_authorization_t *auth);
92 
94  const edge_connection_t *conn);
95 
97  const ed25519_public_key_t *onion_identity_pk,
98  const smartlist_t *hsdirs);
99 
101  const char *desc_str,
102  const ed25519_public_key_t *service_identity_pk,
103  hs_descriptor_t **desc);
105  const hs_descriptor_t *desc);
106 int hs_client_refetch_hsdesc(const ed25519_public_key_t *identity_pk);
107 void hs_client_dir_info_changed(void);
108 
110  origin_circuit_t *rend_circ);
111 
115 
117  const uint8_t *payload,
118  size_t payload_len);
120  const uint8_t *payload,
121  size_t payload_len);
123  const uint8_t *payload,
124  size_t payload_len);
125 
126 void hs_client_dir_fetch_done(dir_connection_t *dir_conn, const char *reason,
127  const char *body, const int status_code);
128 
130  const edge_connection_t *edge_conn);
131 
133  int validate_only);
134 
137 
138 void hs_client_purge_state(void);
139 
140 void hs_client_free_all(void);
141 
142 #ifdef HS_CLIENT_PRIVATE
143 
144 STATIC int auth_key_filename_is_valid(const char *filename);
145 
147 parse_auth_file_content(const char *client_key_str);
148 
150 pick_hsdir_v3(const ed25519_public_key_t *onion_identity_pk);
151 
154 
157 
158 STATIC int handle_rendezvous2(origin_circuit_t *circ, const uint8_t *payload,
159  size_t payload_len);
160 
162  fetch_v3_desc, (const ed25519_public_key_t *onion_identity_pk));
163 
165 
167 
168 #ifdef TOR_UNIT_TESTS
169 
170 STATIC void set_hs_client_auths_map(digest256map_t *map);
171 
172 #endif /* defined(TOR_UNIT_TESTS) */
173 
174 #endif /* defined(HS_CLIENT_PRIVATE) */
175 
176 #endif /* !defined(TOR_HS_CLIENT_H) */
int hs_client_any_intro_points_usable(const ed25519_public_key_t *service_pk, const hs_descriptor_t *desc)
Definition: hs_client.c:2010
hs_client_removal_auth_status_t hs_client_remove_auth_credentials(const char *hsaddress)
Definition: hs_client.c:1800
void hs_client_dir_info_changed(void)
Definition: hs_client.c:2582
int hs_client_reextend_intro_circuit(origin_circuit_t *circ)
Definition: hs_client.c:2475
void hs_client_circuit_cleanup_on_close(const circuit_t *circ)
Definition: hs_client.c:1846
curve25519_secret_key_t enc_seckey
Definition: hs_client.h:69
int hs_client_send_introduce1(origin_circuit_t *intro_circ, origin_circuit_t *rend_circ)
Definition: hs_client.c:2064
void hs_client_free_all(void)
Definition: hs_client.c:2550
hs_client_register_auth_status_t hs_client_register_auth_credentials(hs_client_service_authorization_t *creds)
Definition: hs_client.c:1631
#define STATIC
Definition: testsupport.h:32
void hs_client_circuit_cleanup_on_free(const circuit_t *circ)
Definition: hs_client.c:1877
void hs_client_purge_state(void)
Definition: hs_client.c:2560
int hs_client_receive_rendezvous_acked(origin_circuit_t *circ, const uint8_t *payload, size_t payload_len)
Definition: hs_client.c:2106
hs_desc_decode_status_t hs_client_decode_descriptor(const char *desc_str, const ed25519_public_key_t *service_identity_pk, hs_descriptor_t **desc)
Definition: hs_client.c:1953
int hs_client_receive_introduce_ack(origin_circuit_t *circ, const uint8_t *payload, size_t payload_len)
Definition: hs_client.c:2408
STATIC extend_info_t * desc_intro_point_to_extend_info(const hs_desc_intro_point_t *ip)
Definition: hs_client.c:801
void hs_client_dir_fetch_done(dir_connection_t *dir_conn, const char *reason, const char *body, const int status_code)
Definition: hs_client.c:2361
Header file containing circuit and connection identifier data for the whole HS subsytem.
STATIC routerstatus_t * pick_hsdir_v3(const ed25519_public_key_t *onion_identity_pk)
Definition: hs_client.c:429
Header for crypto_ed25519.c.
char onion_address[HS_SERVICE_ADDR_LEN_BASE32+1]
Definition: hs_client.h:72
Header file for hs_descriptor.c.
STATIC hs_client_fetch_status_t fetch_v3_desc(const ed25519_public_key_t *onion_identity_pk)
Definition: hs_client.c:466
STATIC void retry_all_socks_conn_waiting_for_desc(void)
Definition: hs_client.c:298
int hs_client_receive_rendezvous2(origin_circuit_t *circ, const uint8_t *payload, size_t payload_len)
Definition: hs_client.c:2437
Header file containing circuit data for the whole HS subsytem.
#define HS_SERVICE_ADDR_LEN_BASE32
Definition: hs_common.h:83
STATIC void purge_ephemeral_client_auth(void)
Definition: hs_client.c:1337
void hs_client_close_intro_circuits_from_desc(const hs_descriptor_t *desc)
Definition: hs_client.c:2524
int hs_client_refetch_hsdesc(const ed25519_public_key_t *identity_pk)
Definition: hs_client.c:2033
void hs_client_circuit_has_opened(origin_circuit_t *circ)
Definition: hs_client.c:2076
STATIC int handle_rendezvous2(origin_circuit_t *circ, const uint8_t *payload, size_t payload_len)
Definition: hs_client.c:1207
digest256map_t * get_hs_client_auths_map(void)
Definition: hs_client.c:1834
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
extend_info_t * hs_client_get_random_intro_from_edge(const edge_connection_t *edge_conn)
Definition: hs_client.c:2395
STATIC int auth_key_filename_is_valid(const char *filename)
Definition: hs_client.c:2174
void hs_client_launch_v3_desc_fetch(const ed25519_public_key_t *onion_identity_pk, const smartlist_t *hsdirs)
Definition: hs_client.c:485
STATIC extend_info_t * client_get_random_intro(const ed25519_public_key_t *service_pk)
Definition: hs_client.c:863
int hs_config_client_authorization(const or_options_t *options, int validate_only)
Definition: hs_client.c:2271
hs_desc_decode_status_t
Definition: hs_descriptor.h:74
STATIC hs_client_service_authorization_t * parse_auth_file_content(const char *client_key_str)
Definition: hs_client.c:2201
hs_client_fetch_status_t
Definition: hs_client.h:19
void hs_client_note_connection_attempt_succeeded(const edge_connection_t *conn)
Definition: hs_client.c:1927