src/feature/dirparse/routerparse.h

   1 /* Copyright (c) 2001 Matej Pfajfar.
   2  * Copyright (c) 2001-2004, Roger Dingledine.
   3  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   4  * Copyright (c) 2007-2018, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file routerparse.h
   9  * \brief Header file for routerparse.c.
  10  **/
  11
  12 #ifndef TOR_ROUTERPARSE_H
  13 #define TOR_ROUTERPARSE_H
  14
  15 #include "core/or/versions.h"
  16
  17 enum networkstatus_type_t;
  18
  19 int router_get_router_hash(const char *s, size_t s_len, char *digest);
  20 int router_get_dir_hash(const char *s, char *digest);
  21 int router_get_networkstatus_v3_hashes(const char *s,
  22                                        common_digests_t *digests);
  23 int router_get_networkstatus_v3_signed_boundaries(const char *s,
  24                                                   const char **start_out,
  25                                                   const char **end_out);
  26 int router_get_networkstatus_v3_sha3_as_signed(uint8_t *digest_out,
  27                                                const char *s);
  28 int router_get_extrainfo_hash(const char *s, size_t s_len, char *digest);
  29
  30 int router_parse_list_from_string(const char **s, const char *eos,
  31                                   smartlist_t *dest,
  32                                   saved_location_t saved_location,
  33                                   int is_extrainfo,
  34                                   int allow_annotations,
  35                                   const char *prepend_annotations,
  36                                   smartlist_t *invalid_digests_out);
  37
  38 routerinfo_t *router_parse_entry_from_string(const char *s, const char *end,
  39                                              int cache_copy,
  40                                              int allow_annotations,
  41                                              const char *prepend_annotations,
  42                                              int *can_dl_again_out);
  43 struct digest_ri_map_t;
  44 extrainfo_t *extrainfo_parse_entry_from_string(const char *s, const char *end,
  45                              int cache_copy, struct digest_ri_map_t *routermap,
  46                              int *can_dl_again_out);
  47 MOCK_DECL(addr_policy_t *, router_parse_addr_policy_item_from_string,
  48          (const char *s, int assume_action, int *malformed_list));
  49
  50 void assert_addr_policy_ok(smartlist_t *t);
  51 void dump_distinct_digest_count(int severity);
  52
  53 int compare_vote_routerstatus_entries(const void **_a, const void **_b);
  54 int networkstatus_verify_bw_weights(networkstatus_t *ns, int);
  55 networkstatus_t *networkstatus_parse_vote_from_string(const char *s,
  56                                            const char **eos_out,
  57                                            enum networkstatus_type_t ns_type);
  58 ns_detached_signatures_t *networkstatus_parse_detached_signatures(
  59                                           const char *s, const char *eos);
  60
  61 smartlist_t *microdescs_parse_from_string(const char *s, const char *eos,
  62                                           int allow_annotations,
  63                                           saved_location_t where,
  64                                           smartlist_t *invalid_digests_out);
  65
  66 int rend_parse_v2_service_descriptor(rend_service_descriptor_t **parsed_out,
  67                                      char *desc_id_out,
  68                                      char **intro_points_encrypted_out,
  69                                      size_t *intro_points_encrypted_size_out,
  70                                      size_t *encoded_size_out,
  71                                      const char **next_out, const char *desc,
  72                                      int as_hsdir);
  73 int rend_decrypt_introduction_points(char **ipos_decrypted,
  74                                      size_t *ipos_decrypted_size,
  75                                      const char *descriptor_cookie,
  76                                      const char *ipos_encrypted,
  77                                      size_t ipos_encrypted_size);
  78 int rend_parse_introduction_points(rend_service_descriptor_t *parsed,
  79                                    const char *intro_points_encoded,
  80                                    size_t intro_points_encoded_size);
  81 int rend_parse_client_keys(strmap_t *parsed_clients, const char *str);
  82
  83 void routerparse_init(void);
  84 void routerparse_free_all(void);
  85
  86 #ifdef ROUTERPARSE_PRIVATE
  87 STATIC int routerstatus_parse_guardfraction(const char *guardfraction_str,
  88                                             networkstatus_t *vote,
  89                                             vote_routerstatus_t *vote_rs,
  90                                             routerstatus_t *rs);
  91 struct memarea_t;
  92 STATIC routerstatus_t *routerstatus_parse_entry_from_string(
  93                                      struct memarea_t *area,
  94                                      const char **s, smartlist_t *tokens,
  95                                      networkstatus_t *vote,
  96                                      vote_routerstatus_t *vote_rs,
  97                                      int consensus_method,
  98                                      consensus_flavor_t flav);
  99 STATIC void summarize_protover_flags(protover_summary_flags_t *out,
 100                                      const char *protocols,
 101                                      const char *version);
 102 #endif /* defined(ROUTERPARSE_PRIVATE) */
 103
 104 #define ED_DESC_SIGNATURE_PREFIX "Tor router descriptor signature v1"
 105
 106 #endif /* !defined(TOR_ROUTERPARSE_H) */