tor  0.4.1.0-alpha-dev
hs_client.h
Go to the documentation of this file.
1 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
2 /* See LICENSE for licensing information */
3 
9 #ifndef TOR_HS_CLIENT_H
10 #define TOR_HS_CLIENT_H
11 
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 
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];
43 
45  const edge_connection_t *conn);
46 
47 void hs_client_launch_v3_desc_fetch(
48  const ed25519_public_key_t *onion_identity_pk,
49  const smartlist_t *hsdirs);
50 
51 int hs_client_decode_descriptor(
52  const char *desc_str,
53  const ed25519_public_key_t *service_identity_pk,
54  hs_descriptor_t **desc);
55 int hs_client_any_intro_points_usable(const ed25519_public_key_t *service_pk,
56  const hs_descriptor_t *desc);
57 int hs_client_refetch_hsdesc(const ed25519_public_key_t *identity_pk);
58 void hs_client_dir_info_changed(void);
59 
60 int hs_client_send_introduce1(origin_circuit_t *intro_circ,
61  origin_circuit_t *rend_circ);
62 
63 void hs_client_circuit_has_opened(origin_circuit_t *circ);
64 
65 int hs_client_receive_rendezvous_acked(origin_circuit_t *circ,
66  const uint8_t *payload,
67  size_t payload_len);
68 int hs_client_receive_introduce_ack(origin_circuit_t *circ,
69  const uint8_t *payload,
70  size_t payload_len);
71 int hs_client_receive_rendezvous2(origin_circuit_t *circ,
72  const uint8_t *payload,
73  size_t payload_len);
74 
75 void hs_client_desc_has_arrived(const hs_ident_dir_conn_t *ident);
76 
77 extend_info_t *hs_client_get_random_intro_from_edge(
78  const edge_connection_t *edge_conn);
79 
80 int hs_config_client_authorization(const or_options_t *options,
81  int validate_only);
82 
83 int hs_client_reextend_intro_circuit(origin_circuit_t *circ);
84 void hs_client_close_intro_circuits_from_desc(const hs_descriptor_t *desc);
85 
86 void hs_client_purge_state(void);
87 
88 void hs_client_free_all(void);
89 
90 #ifdef HS_CLIENT_PRIVATE
91 
92 STATIC int auth_key_filename_is_valid(const char *filename);
93 
95 parse_auth_file_content(const char *client_key_str);
96 
97 STATIC routerstatus_t *
98 pick_hsdir_v3(const ed25519_public_key_t *onion_identity_pk);
99 
100 STATIC extend_info_t *
101 client_get_random_intro(const ed25519_public_key_t *service_pk);
102 
103 STATIC extend_info_t *
104 desc_intro_point_to_extend_info(const hs_desc_intro_point_t *ip);
105 
106 STATIC int handle_rendezvous2(origin_circuit_t *circ, const uint8_t *payload,
107  size_t payload_len);
108 
109 MOCK_DECL(STATIC hs_client_fetch_status_t,
110  fetch_v3_desc, (const ed25519_public_key_t *onion_identity_pk));
111 
112 STATIC void retry_all_socks_conn_waiting_for_desc(void);
113 
114 #ifdef TOR_UNIT_TESTS
115 
116 STATIC digest256map_t *get_hs_client_auths_map(void);
117 
118 #endif /* defined(TOR_UNIT_TESTS) */
119 
120 #endif /* defined(HS_CLIENT_PRIVATE) */
121 
122 #endif /* !defined(TOR_HS_CLIENT_H) */
123 
struct hs_client_service_authorization_t hs_client_service_authorization_t
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:406
Header for crypto_ed25519.c.
Header file for hs_descriptor.c.
int hs_client_refetch_hsdesc(const ed25519_public_key_t *identity_pk)
Definition: hs_client.c:1354
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:94
void hs_client_note_connection_attempt_succeeded(const edge_connection_t *conn)
Definition: hs_client.c:1251