src/or/control.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-2017, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file control.h
   9  * \brief Header file for control.c.
  10  **/
  11
  12 #ifndef TOR_CONTROL_H
  13 #define TOR_CONTROL_H
  14
  15 void control_initialize_event_queue(void);
  16
  17 void control_update_global_event_mask(void);
  18 void control_adjust_event_log_severity(void);
  19
  20 void control_ports_write_to_file(void);
  21
  22 /** Log information about the connection <b>conn</b>, protecting it as with
  23  * CONN_LOG_PROTECT. Example:
  24  *
  25  * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
  26  **/
  27 #define LOG_FN_CONN(conn, args)                 \
  28   CONN_LOG_PROTECT(conn, log_fn args)
  29
  30 #define CC_LOCAL_FD_IS_OWNER (1u<<0)
  31 #define CC_LOCAL_FD_IS_AUTHENTICATED (1u<<1)
  32 int control_connection_add_local_fd(tor_socket_t sock, unsigned flags);
  33
  34 int connection_control_finished_flushing(control_connection_t *conn);
  35 int connection_control_reached_eof(control_connection_t *conn);
  36 void connection_control_closed(control_connection_t *conn);
  37
  38 int connection_control_process_inbuf(control_connection_t *conn);
  39
  40 #define EVENT_NS 0x000F
  41 int control_event_is_interesting(int event);
  42
  43 int control_event_circuit_status(origin_circuit_t *circ,
  44                                  circuit_status_event_t e, int reason);
  45 int control_event_circuit_purpose_changed(origin_circuit_t *circ,
  46                                           int old_purpose);
  47 int control_event_circuit_cannibalized(origin_circuit_t *circ,
  48                                        int old_purpose,
  49                                        const struct timeval *old_tv_created);
  50 int control_event_stream_status(entry_connection_t *conn,
  51                                 stream_status_event_t e,
  52                                 int reason);
  53 int control_event_or_conn_status(or_connection_t *conn,
  54                                  or_conn_status_event_t e, int reason);
  55 int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written);
  56 int control_event_stream_bandwidth(edge_connection_t *edge_conn);
  57 int control_event_stream_bandwidth_used(void);
  58 int control_event_circ_bandwidth_used(void);
  59 int control_event_conn_bandwidth(connection_t *conn);
  60 int control_event_conn_bandwidth_used(void);
  61 int control_event_circuit_cell_stats(void);
  62 void control_event_logmsg(int severity, uint32_t domain, const char *msg);
  63 int control_event_descriptors_changed(smartlist_t *routers);
  64 int control_event_address_mapped(const char *from, const char *to,
  65                                  time_t expires, const char *error,
  66                                  const int cached);
  67 int control_event_my_descriptor_changed(void);
  68 int control_event_network_liveness_update(int liveness);
  69 int control_event_networkstatus_changed(smartlist_t *statuses);
  70
  71 int control_event_newconsensus(const networkstatus_t *consensus);
  72 int control_event_networkstatus_changed_single(const routerstatus_t *rs);
  73 int control_event_general_status(int severity, const char *format, ...)
  74   CHECK_PRINTF(2,3);
  75 int control_event_client_status(int severity, const char *format, ...)
  76   CHECK_PRINTF(2,3);
  77 int control_event_server_status(int severity, const char *format, ...)
  78   CHECK_PRINTF(2,3);
  79
  80 int control_event_general_error(const char *format, ...)
  81   CHECK_PRINTF(1,2);
  82 int control_event_client_error(const char *format, ...)
  83   CHECK_PRINTF(1,2);
  84 int control_event_server_error(const char *format, ...)
  85   CHECK_PRINTF(1,2);
  86
  87 int control_event_guard(const char *nickname, const char *digest,
  88                         const char *status);
  89 int control_event_conf_changed(const smartlist_t *elements);
  90 int control_event_buildtimeout_set(buildtimeout_set_event_t type,
  91                                    const char *args);
  92 int control_event_signal(uintptr_t signal);
  93
  94 int init_control_cookie_authentication(int enabled);
  95 char *get_controller_cookie_file_name(void);
  96 smartlist_t *decode_hashed_passwords(config_line_t *passwords);
  97 void disable_control_logging(void);
  98 void enable_control_logging(void);
  99
 100 void monitor_owning_controller_process(const char *process_spec);
 101
 102 int control_event_bootstrap(bootstrap_status_t status, int progress);
 103 MOCK_DECL(void, control_event_bootstrap_prob_or,(const char *warn,
 104                                                  int reason,
 105                                                  or_connection_t *or_conn));
 106 void control_event_bootstrap_problem(const char *warn, const char *reason,
 107                                      const connection_t *conn, int dowarn);
 108
 109 void control_event_clients_seen(const char *controller_str);
 110 void control_event_transport_launched(const char *mode,
 111                                       const char *transport_name,
 112                                       tor_addr_t *addr, uint16_t port);
 113 const char *rend_auth_type_to_string(rend_auth_type_t auth_type);
 114 MOCK_DECL(const char *, node_describe_longname_by_id,(const char *id_digest));
 115 void control_event_hs_descriptor_requested(const char *onion_address,
 116                                            rend_auth_type_t auth_type,
 117                                            const char *id_digest,
 118                                            const char *desc_id,
 119                                            const char *hsdir_index);
 120 void control_event_hs_descriptor_created(const char *onion_address,
 121                                          const char *desc_id,
 122                                          int replica);
 123 void control_event_hs_descriptor_upload(const char *onion_address,
 124                                         const char *desc_id,
 125                                         const char *hs_dir,
 126                                         const char *hsdir_index);
 127 void control_event_hs_descriptor_upload_end(const char *action,
 128                                             const char *onion_address,
 129                                             const char *hs_dir,
 130                                             const char *reason);
 131 void control_event_hs_descriptor_uploaded(const char *hs_dir,
 132                                           const char *onion_address);
 133 /* Hidden service v2 HS_DESC specific. */
 134 void control_event_hsv2_descriptor_failed(const rend_data_t *rend_data,
 135                                           const char *id_digest,
 136                                           const char *reason);
 137 void control_event_hsv2_descriptor_received(const char *onion_address,
 138                                             const rend_data_t *rend_data,
 139                                             const char *id_digest);
 140 /* Hidden service v3 HS_DESC specific. */
 141 void control_event_hsv3_descriptor_failed(const char *onion_address,
 142                                           const char *desc_id,
 143                                           const char *hsdir_id_digest,
 144                                           const char *reason);
 145 void control_event_hsv3_descriptor_received(const char *onion_address,
 146                                             const char *desc_id,
 147                                             const char *hsdir_id_digest);
 148 void control_event_hs_descriptor_upload_failed(const char *hs_dir,
 149                                                const char *onion_address,
 150                                                const char *reason);
 151 void control_event_hs_descriptor_content(const char *onion_address,
 152                                          const char *desc_id,
 153                                          const char *hsdir_fp,
 154                                          const char *content);
 155
 156 void control_free_all(void);
 157
 158 #ifdef CONTROL_PRIVATE
 159 /* Recognized asynchronous event types.  It's okay to expand this list
 160  * because it is used both as a list of v0 event types, and as indices
 161  * into the bitfield to determine which controllers want which events.
 162  */
 163 /* This bitfield has no event zero    0x0000 */
 164 #define EVENT_MIN_                    0x0001
 165 #define EVENT_CIRCUIT_STATUS          0x0001
 166 #define EVENT_STREAM_STATUS           0x0002
 167 #define EVENT_OR_CONN_STATUS          0x0003
 168 #define EVENT_BANDWIDTH_USED          0x0004
 169 #define EVENT_CIRCUIT_STATUS_MINOR    0x0005
 170 #define EVENT_NEW_DESC                0x0006
 171 #define EVENT_DEBUG_MSG               0x0007
 172 #define EVENT_INFO_MSG                0x0008
 173 #define EVENT_NOTICE_MSG              0x0009
 174 #define EVENT_WARN_MSG                0x000A
 175 #define EVENT_ERR_MSG                 0x000B
 176 #define EVENT_ADDRMAP                 0x000C
 177 /* There was an AUTHDIR_NEWDESCS event, but it no longer exists.  We
 178    can reclaim 0x000D. */
 179 #define EVENT_DESCCHANGED             0x000E
 180 /* Exposed above */
 181 // #define EVENT_NS                   0x000F
 182 #define EVENT_STATUS_CLIENT           0x0010
 183 #define EVENT_STATUS_SERVER           0x0011
 184 #define EVENT_STATUS_GENERAL          0x0012
 185 #define EVENT_GUARD                   0x0013
 186 #define EVENT_STREAM_BANDWIDTH_USED   0x0014
 187 #define EVENT_CLIENTS_SEEN            0x0015
 188 #define EVENT_NEWCONSENSUS            0x0016
 189 #define EVENT_BUILDTIMEOUT_SET        0x0017
 190 #define EVENT_GOT_SIGNAL              0x0018
 191 #define EVENT_CONF_CHANGED            0x0019
 192 #define EVENT_CONN_BW                 0x001A
 193 #define EVENT_CELL_STATS              0x001B
 194 /* UNUSED :                           0x001C */
 195 #define EVENT_CIRC_BANDWIDTH_USED     0x001D
 196 #define EVENT_TRANSPORT_LAUNCHED      0x0020
 197 #define EVENT_HS_DESC                 0x0021
 198 #define EVENT_HS_DESC_CONTENT         0x0022
 199 #define EVENT_NETWORK_LIVENESS        0x0023
 200 #define EVENT_MAX_                    0x0023
 201
 202 /* sizeof(control_connection_t.event_mask) in bits, currently a uint64_t */
 203 #define EVENT_CAPACITY_               0x0040
 204
 205 /* If EVENT_MAX_ ever hits 0x0040, we need to make the mask into a
 206  * different structure, as it can only handle a maximum left shift of 1<<63. */
 207
 208 #if EVENT_MAX_ >= EVENT_CAPACITY_
 209 #error control_connection_t.event_mask has an event greater than its capacity
 210 #endif
 211
 212 #define EVENT_MASK_(e)               (((uint64_t)1)<<(e))
 213
 214 #define EVENT_MASK_NONE_             ((uint64_t)0x0)
 215
 216 #define EVENT_MASK_ABOVE_MIN_        ((~((uint64_t)0x0)) << EVENT_MIN_)
 217 #define EVENT_MASK_BELOW_MAX_        ((~((uint64_t)0x0)) \
 218                                       >> (EVENT_CAPACITY_ - EVENT_MAX_ \
 219                                           - EVENT_MIN_))
 220
 221 #define EVENT_MASK_ALL_              (EVENT_MASK_ABOVE_MIN_ \
 222                                       & EVENT_MASK_BELOW_MAX_)
 223
 224 /* Used only by control.c and test.c */
 225 STATIC size_t write_escaped_data(const char *data, size_t len, char **out);
 226 STATIC size_t read_escaped_data(const char *data, size_t len, char **out);
 227
 228 #ifdef TOR_UNIT_TESTS
 229 MOCK_DECL(STATIC void,
 230           send_control_event_string,(uint16_t event, const char *msg));
 231
 232 MOCK_DECL(STATIC void,
 233           queue_control_event_string,(uint16_t event, char *msg));
 234
 235 void control_testing_set_global_event_mask(uint64_t mask);
 236 #endif /* defined(TOR_UNIT_TESTS) */
 237
 238 /** Helper structure: temporarily stores cell statistics for a circuit. */
 239 typedef struct cell_stats_t {
 240   /** Number of cells added in app-ward direction by command. */
 241   uint64_t added_cells_appward[CELL_COMMAND_MAX_ + 1];
 242   /** Number of cells added in exit-ward direction by command. */
 243   uint64_t added_cells_exitward[CELL_COMMAND_MAX_ + 1];
 244   /** Number of cells removed in app-ward direction by command. */
 245   uint64_t removed_cells_appward[CELL_COMMAND_MAX_ + 1];
 246   /** Number of cells removed in exit-ward direction by command. */
 247   uint64_t removed_cells_exitward[CELL_COMMAND_MAX_ + 1];
 248   /** Total waiting time of cells in app-ward direction by command. */
 249   uint64_t total_time_appward[CELL_COMMAND_MAX_ + 1];
 250   /** Total waiting time of cells in exit-ward direction by command. */
 251   uint64_t total_time_exitward[CELL_COMMAND_MAX_ + 1];
 252 } cell_stats_t;
 253 void sum_up_cell_stats_by_command(circuit_t *circ,
 254                                   cell_stats_t *cell_stats);
 255 void append_cell_stats_by_command(smartlist_t *event_parts,
 256                                   const char *key,
 257                                   const uint64_t *include_if_non_zero,
 258                                   const uint64_t *number_to_include);
 259 void format_cell_stats(char **event_string, circuit_t *circ,
 260                        cell_stats_t *cell_stats);
 261 STATIC char *get_bw_samples(void);
 262
 263 /* ADD_ONION secret key to create an ephemeral service. The command supports
 264  * multiple versions so this union stores the key and passes it to the HS
 265  * subsystem depending on the requested version. */
 266 typedef union add_onion_secret_key_t {
 267   /* Hidden service v2 secret key. */
 268   crypto_pk_t *v2;
 269   /* Hidden service v3 secret key. */
 270   ed25519_secret_key_t *v3;
 271 } add_onion_secret_key_t;
 272
 273 STATIC int add_onion_helper_keyarg(const char *arg, int discard_pk,
 274                                    const char **key_new_alg_out,
 275                                    char **key_new_blob_out,
 276                                    add_onion_secret_key_t *decoded_key,
 277                                    int *hs_version, char **err_msg_out);
 278
 279 STATIC rend_authorized_client_t *
 280 add_onion_helper_clientauth(const char *arg, int *created, char **err_msg_out);
 281
 282 STATIC int getinfo_helper_onions(
 283     control_connection_t *control_conn,
 284     const char *question,
 285     char **answer,
 286     const char **errmsg);
 287 STATIC void getinfo_helper_downloads_networkstatus(
 288     const char *flavor,
 289     download_status_t **dl_to_emit,
 290     const char **errmsg);
 291 STATIC void getinfo_helper_downloads_cert(
 292     const char *fp_sk_req,
 293     download_status_t **dl_to_emit,
 294     smartlist_t **digest_list,
 295     const char **errmsg);
 296 STATIC void getinfo_helper_downloads_desc(
 297     const char *desc_req,
 298     download_status_t **dl_to_emit,
 299     smartlist_t **digest_list,
 300     const char **errmsg);
 301 STATIC void getinfo_helper_downloads_bridge(
 302     const char *bridge_req,
 303     download_status_t **dl_to_emit,
 304     smartlist_t **digest_list,
 305     const char **errmsg);
 306 STATIC int getinfo_helper_downloads(
 307     control_connection_t *control_conn,
 308     const char *question, char **answer,
 309     const char **errmsg);
 310 STATIC int getinfo_helper_dir(
 311     control_connection_t *control_conn,
 312     const char *question, char **answer,
 313     const char **errmsg);
 314 STATIC int getinfo_helper_current_time(
 315     control_connection_t *control_conn,
 316     const char *question, char **answer,
 317     const char **errmsg);
 318
 319 #endif /* defined(CONTROL_PRIVATE) */
 320
 321 #endif /* !defined(TOR_CONTROL_H) */
 322