src/or/hs_circuitmap.h

   1 /* Copyright (c) 2016-2017, The Tor Project, Inc. */
   2 /* See LICENSE for licensing information */
   3
   4 /**
   5  * \file hs_circuitmap.h
   6  * \brief Header file for hs_circuitmap.c.
   7  **/
   8
   9 #ifndef TOR_HS_CIRCUITMAP_H
  10 #define TOR_HS_CIRCUITMAP_H
  11
  12 typedef HT_HEAD(hs_circuitmap_ht, circuit_t) hs_circuitmap_ht;
  13
  14 typedef struct hs_token_s hs_token_t;
  15 struct or_circuit_t;
  16 struct origin_circuit_t;
  17
  18 /** Public HS circuitmap API: */
  19
  20 /** Public relay-side API: */
  21
  22 struct or_circuit_t *
  23 hs_circuitmap_get_intro_circ_v3_relay_side(const
  24                                            ed25519_public_key_t *auth_key);
  25 struct or_circuit_t *
  26 hs_circuitmap_get_intro_circ_v2_relay_side(const uint8_t *digest);
  27 struct or_circuit_t *
  28 hs_circuitmap_get_rend_circ_relay_side(const uint8_t *cookie);
  29
  30 void hs_circuitmap_register_rend_circ_relay_side(struct or_circuit_t *circ,
  31                                                  const uint8_t *cookie);
  32 void hs_circuitmap_register_intro_circ_v2_relay_side(struct or_circuit_t *circ,
  33                                                      const uint8_t *digest);
  34 void hs_circuitmap_register_intro_circ_v3_relay_side(struct or_circuit_t *circ,
  35                                          const ed25519_public_key_t *auth_key);
  36
  37 /** Public service-side API: */
  38
  39 struct origin_circuit_t *
  40 hs_circuitmap_get_intro_circ_v3_service_side(const
  41                                              ed25519_public_key_t *auth_key);
  42 struct origin_circuit_t *
  43 hs_circuitmap_get_intro_circ_v2_service_side(const uint8_t *digest);
  44 struct origin_circuit_t *
  45 hs_circuitmap_get_rend_circ_service_side(const uint8_t *cookie);
  46 struct origin_circuit_t *
  47 hs_circuitmap_get_rend_circ_client_side(const uint8_t *cookie);
  48
  49 void hs_circuitmap_register_intro_circ_v2_service_side(
  50                                         struct origin_circuit_t *circ,
  51                                         const uint8_t *digest);
  52 void hs_circuitmap_register_intro_circ_v3_service_side(
  53                                         struct origin_circuit_t *circ,
  54                                         const ed25519_public_key_t *auth_key);
  55 void hs_circuitmap_register_rend_circ_service_side(
  56                                         struct origin_circuit_t *circ,
  57                                         const uint8_t *cookie);
  58 void hs_circuitmap_register_rend_circ_client_side(
  59                                       struct origin_circuit_t *circ,
  60                                       const uint8_t *cookie);
  61
  62 void hs_circuitmap_remove_circuit(struct circuit_t *circ);
  63
  64 void hs_circuitmap_init(void);
  65 void hs_circuitmap_free_all(void);
  66
  67 #ifdef HS_CIRCUITMAP_PRIVATE
  68
  69 /** Represents the type of HS token. */
  70 typedef enum {
  71   /** A rendezvous cookie on a relay (128bit)*/
  72   HS_TOKEN_REND_RELAY_SIDE,
  73   /** A v2 introduction point pubkey on a relay (160bit) */
  74   HS_TOKEN_INTRO_V2_RELAY_SIDE,
  75   /** A v3 introduction point pubkey on a relay (256bit) */
  76   HS_TOKEN_INTRO_V3_RELAY_SIDE,
  77
  78   /** A rendezvous cookie on a hidden service (128bit)*/
  79   HS_TOKEN_REND_SERVICE_SIDE,
  80   /** A v2 introduction point pubkey on a hidden service (160bit) */
  81   HS_TOKEN_INTRO_V2_SERVICE_SIDE,
  82   /** A v3 introduction point pubkey on a hidden service (256bit) */
  83   HS_TOKEN_INTRO_V3_SERVICE_SIDE,
  84
  85   /** A rendezvous cookie on the client side (128bit) */
  86   HS_TOKEN_REND_CLIENT_SIDE,
  87 } hs_token_type_t;
  88
  89 /** Represents a token used in the HS protocol. Each such token maps to a
  90  *  specific introduction or rendezvous circuit. */
  91 struct hs_token_s {
  92   /* Type of HS token. */
  93   hs_token_type_t type;
  94
  95   /* The size of the token (depends on the type). */
  96   size_t token_len;
  97
  98   /* The token itself. Memory allocated at runtime. */
  99   uint8_t *token;
 100 };
 101
 102 #endif /* defined(HS_CIRCUITMAP_PRIVATE) */
 103
 104 #ifdef TOR_UNIT_TESTS
 105
 106 hs_circuitmap_ht *get_hs_circuitmap(void);
 107
 108 #endif /* TOR_UNIT_TESTS */
 109
 110 #endif /* !defined(TOR_HS_CIRCUITMAP_H) */
 111