src/or/directory.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-2015, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file directory.h
   9  * \brief Header file for directory.c.
  10  **/
  11
  12 #ifndef TOR_DIRECTORY_H
  13 #define TOR_DIRECTORY_H
  14
  15 int directories_have_accepted_server_descriptor(void);
  16 void directory_post_to_dirservers(uint8_t dir_purpose, uint8_t router_purpose,
  17                                   dirinfo_type_t type, const char *payload,
  18                                   size_t payload_len, size_t extrainfo_len);
  19 MOCK_DECL(void, directory_get_from_dirserver, (
  20                           uint8_t dir_purpose,
  21                           uint8_t router_purpose,
  22                           const char *resource,
  23                           int pds_flags,
  24                           download_want_authority_t want_authority));
  25 void directory_get_from_all_authorities(uint8_t dir_purpose,
  26                                         uint8_t router_purpose,
  27                                         const char *resource);
  28
  29 /** Enumeration of ways to connect to a directory server */
  30 typedef enum {
  31   /** Default: connect over a one-hop Tor circuit but fall back to direct
  32    * connection */
  33   DIRIND_ONEHOP=0,
  34   /** Connect over a multi-hop anonymizing Tor circuit */
  35   DIRIND_ANONYMOUS=1,
  36   /** Connect to the DirPort directly */
  37   DIRIND_DIRECT_CONN,
  38   /** Connect over a multi-hop anonymizing Tor circuit to our dirport */
  39   DIRIND_ANON_DIRPORT,
  40 } dir_indirection_t;
  41
  42 void directory_initiate_command_routerstatus(const routerstatus_t *status,
  43                                              uint8_t dir_purpose,
  44                                              uint8_t router_purpose,
  45                                              dir_indirection_t indirection,
  46                                              const char *resource,
  47                                              const char *payload,
  48                                              size_t payload_len,
  49                                              time_t if_modified_since);
  50 void directory_initiate_command_routerstatus_rend(const routerstatus_t *status,
  51                                                   uint8_t dir_purpose,
  52                                                   uint8_t router_purpose,
  53                                                  dir_indirection_t indirection,
  54                                                   const char *resource,
  55                                                   const char *payload,
  56                                                   size_t payload_len,
  57                                                   time_t if_modified_since,
  58                                                 const rend_data_t *rend_query);
  59
  60 int parse_http_response(const char *headers, int *code, time_t *date,
  61                         compress_method_t *compression, char **response);
  62
  63 int connection_dir_is_encrypted(dir_connection_t *conn);
  64 int connection_dir_reached_eof(dir_connection_t *conn);
  65 int connection_dir_process_inbuf(dir_connection_t *conn);
  66 int connection_dir_finished_flushing(dir_connection_t *conn);
  67 int connection_dir_finished_connecting(dir_connection_t *conn);
  68 void connection_dir_about_to_close(dir_connection_t *dir_conn);
  69 void directory_initiate_command(const tor_addr_t *or_addr, uint16_t or_port,
  70                                 const tor_addr_t *dir_addr, uint16_t dir_port,
  71                                 const char *digest,
  72                                 uint8_t dir_purpose, uint8_t router_purpose,
  73                                 dir_indirection_t indirection,
  74                                 const char *resource,
  75                                 const char *payload, size_t payload_len,
  76                                 time_t if_modified_since);
  77 int connection_dir_avoid_extra_connection_for_purpose(unsigned int purpose);
  78 int connection_dir_close_consensus_conn_if_extra(dir_connection_t *conn);
  79 void connection_dir_close_extra_consensus_conns(void);
  80
  81 #define DSR_HEX       (1<<0)
  82 #define DSR_BASE64    (1<<1)
  83 #define DSR_DIGEST256 (1<<2)
  84 #define DSR_SORT_UNIQ (1<<3)
  85 int dir_split_resource_into_fingerprints(const char *resource,
  86                                      smartlist_t *fp_out, int *compressed_out,
  87                                      int flags);
  88
  89 int dir_split_resource_into_fingerprint_pairs(const char *res,
  90                                               smartlist_t *pairs_out);
  91 char *directory_dump_request_log(void);
  92 void note_request(const char *key, size_t bytes);
  93 int router_supports_extrainfo(const char *identity_digest, int is_authority);
  94
  95 time_t download_status_increment_failure(download_status_t *dls,
  96                                          int status_code, const char *item,
  97                                          int server, time_t now);
  98 time_t download_status_increment_attempt(download_status_t *dls,
  99                                          const char *item,  time_t now);
 100 /** Increment the failure count of the download_status_t <b>dls</b>, with
 101  * the optional status code <b>sc</b>. */
 102 #define download_status_failed(dls, sc)                                 \
 103   download_status_increment_failure((dls), (sc), NULL,                  \
 104                                     get_options()->DirPort_set, time(NULL))
 105
 106 void download_status_reset(download_status_t *dls);
 107 static int download_status_is_ready(download_status_t *dls, time_t now,
 108                                     int max_failures);
 109 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
 110  * ready to get its download reattempted. */
 111 static inline int
 112 download_status_is_ready(download_status_t *dls, time_t now,
 113                          int max_failures)
 114 {
 115   int under_failure_limit = (dls->n_download_failures <= max_failures
 116                              && dls->n_download_attempts <= max_failures);
 117   return (under_failure_limit && dls->next_attempt_at <= now);
 118 }
 119
 120 static void download_status_mark_impossible(download_status_t *dl);
 121 /** Mark <b>dl</b> as never downloadable. */
 122 static inline void
 123 download_status_mark_impossible(download_status_t *dl)
 124 {
 125   dl->n_download_failures = IMPOSSIBLE_TO_DOWNLOAD;
 126   dl->n_download_attempts = IMPOSSIBLE_TO_DOWNLOAD;
 127 }
 128
 129 int download_status_get_n_failures(const download_status_t *dls);
 130 int download_status_get_n_attempts(const download_status_t *dls);
 131 time_t download_status_get_next_attempt_at(const download_status_t *dls);
 132
 133 #ifdef TOR_UNIT_TESTS
 134 /* Used only by directory.c and test_dir.c */
 135
 136 STATIC int parse_http_url(const char *headers, char **url);
 137 STATIC int purpose_needs_anonymity(uint8_t dir_purpose,
 138                                    uint8_t router_purpose);
 139 STATIC dirinfo_type_t dir_fetch_type(int dir_purpose, int router_purpose,
 140                                      const char *resource);
 141 STATIC int directory_handle_command_get(dir_connection_t *conn,
 142                                         const char *headers,
 143                                         const char *req_body,
 144                                         size_t req_body_len);
 145 STATIC int connection_dir_would_close_consensus_conn_helper(void);
 146 STATIC int download_status_schedule_get_delay(download_status_t *dls,
 147                                               const smartlist_t *schedule,
 148                                               time_t now);
 149 #endif
 150
 151 #endif
 152