327 lines
14 KiB
C
327 lines
14 KiB
C
/* Copyright (c) 2001 Matej Pfajfar.
|
|
* Copyright (c) 2001-2004, Roger Dingledine.
|
|
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
|
* Copyright (c) 2007-2017, The Tor Project, Inc. */
|
|
/* See LICENSE for licensing information */
|
|
|
|
/**
|
|
* \file control.h
|
|
* \brief Header file for control.c.
|
|
**/
|
|
|
|
#ifndef TOR_CONTROL_H
|
|
#define TOR_CONTROL_H
|
|
|
|
void control_initialize_event_queue(void);
|
|
|
|
void control_update_global_event_mask(void);
|
|
void control_adjust_event_log_severity(void);
|
|
|
|
void control_ports_write_to_file(void);
|
|
|
|
/** Log information about the connection <b>conn</b>, protecting it as with
|
|
* CONN_LOG_PROTECT. Example:
|
|
*
|
|
* LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
|
|
**/
|
|
#define LOG_FN_CONN(conn, args) \
|
|
CONN_LOG_PROTECT(conn, log_fn args)
|
|
|
|
#define CC_LOCAL_FD_IS_OWNER (1u<<0)
|
|
#define CC_LOCAL_FD_IS_AUTHENTICATED (1u<<1)
|
|
int control_connection_add_local_fd(tor_socket_t sock, unsigned flags);
|
|
|
|
int connection_control_finished_flushing(control_connection_t *conn);
|
|
int connection_control_reached_eof(control_connection_t *conn);
|
|
void connection_control_closed(control_connection_t *conn);
|
|
|
|
int connection_control_process_inbuf(control_connection_t *conn);
|
|
|
|
#define EVENT_NS 0x000F
|
|
int control_event_is_interesting(int event);
|
|
|
|
void control_per_second_events(void);
|
|
int control_any_per_second_event_enabled(void);
|
|
|
|
int control_event_circuit_status(origin_circuit_t *circ,
|
|
circuit_status_event_t e, int reason);
|
|
int control_event_circuit_purpose_changed(origin_circuit_t *circ,
|
|
int old_purpose);
|
|
int control_event_circuit_cannibalized(origin_circuit_t *circ,
|
|
int old_purpose,
|
|
const struct timeval *old_tv_created);
|
|
int control_event_stream_status(entry_connection_t *conn,
|
|
stream_status_event_t e,
|
|
int reason);
|
|
int control_event_or_conn_status(or_connection_t *conn,
|
|
or_conn_status_event_t e, int reason);
|
|
int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written);
|
|
int control_event_stream_bandwidth(edge_connection_t *edge_conn);
|
|
int control_event_stream_bandwidth_used(void);
|
|
int control_event_circ_bandwidth_used(void);
|
|
int control_event_conn_bandwidth(connection_t *conn);
|
|
int control_event_conn_bandwidth_used(void);
|
|
int control_event_circuit_cell_stats(void);
|
|
void control_event_logmsg(int severity, uint32_t domain, const char *msg);
|
|
void control_event_logmsg_pending(void);
|
|
int control_event_descriptors_changed(smartlist_t *routers);
|
|
int control_event_address_mapped(const char *from, const char *to,
|
|
time_t expires, const char *error,
|
|
const int cached);
|
|
int control_event_my_descriptor_changed(void);
|
|
int control_event_network_liveness_update(int liveness);
|
|
int control_event_networkstatus_changed(smartlist_t *statuses);
|
|
|
|
int control_event_newconsensus(const networkstatus_t *consensus);
|
|
int control_event_networkstatus_changed_single(const routerstatus_t *rs);
|
|
int control_event_general_status(int severity, const char *format, ...)
|
|
CHECK_PRINTF(2,3);
|
|
int control_event_client_status(int severity, const char *format, ...)
|
|
CHECK_PRINTF(2,3);
|
|
int control_event_server_status(int severity, const char *format, ...)
|
|
CHECK_PRINTF(2,3);
|
|
|
|
int control_event_general_error(const char *format, ...)
|
|
CHECK_PRINTF(1,2);
|
|
int control_event_client_error(const char *format, ...)
|
|
CHECK_PRINTF(1,2);
|
|
int control_event_server_error(const char *format, ...)
|
|
CHECK_PRINTF(1,2);
|
|
|
|
int control_event_guard(const char *nickname, const char *digest,
|
|
const char *status);
|
|
int control_event_conf_changed(const smartlist_t *elements);
|
|
int control_event_buildtimeout_set(buildtimeout_set_event_t type,
|
|
const char *args);
|
|
int control_event_signal(uintptr_t signal);
|
|
|
|
int init_control_cookie_authentication(int enabled);
|
|
char *get_controller_cookie_file_name(void);
|
|
smartlist_t *decode_hashed_passwords(config_line_t *passwords);
|
|
void disable_control_logging(void);
|
|
void enable_control_logging(void);
|
|
|
|
void monitor_owning_controller_process(const char *process_spec);
|
|
|
|
int control_event_bootstrap(bootstrap_status_t status, int progress);
|
|
MOCK_DECL(void, control_event_bootstrap_prob_or,(const char *warn,
|
|
int reason,
|
|
or_connection_t *or_conn));
|
|
void control_event_bootstrap_problem(const char *warn, const char *reason,
|
|
const connection_t *conn, int dowarn);
|
|
|
|
void control_event_clients_seen(const char *controller_str);
|
|
void control_event_transport_launched(const char *mode,
|
|
const char *transport_name,
|
|
tor_addr_t *addr, uint16_t port);
|
|
const char *rend_auth_type_to_string(rend_auth_type_t auth_type);
|
|
MOCK_DECL(const char *, node_describe_longname_by_id,(const char *id_digest));
|
|
void control_event_hs_descriptor_requested(const char *onion_address,
|
|
rend_auth_type_t auth_type,
|
|
const char *id_digest,
|
|
const char *desc_id,
|
|
const char *hsdir_index);
|
|
void control_event_hs_descriptor_created(const char *onion_address,
|
|
const char *desc_id,
|
|
int replica);
|
|
void control_event_hs_descriptor_upload(const char *onion_address,
|
|
const char *desc_id,
|
|
const char *hs_dir,
|
|
const char *hsdir_index);
|
|
void control_event_hs_descriptor_upload_end(const char *action,
|
|
const char *onion_address,
|
|
const char *hs_dir,
|
|
const char *reason);
|
|
void control_event_hs_descriptor_uploaded(const char *hs_dir,
|
|
const char *onion_address);
|
|
/* Hidden service v2 HS_DESC specific. */
|
|
void control_event_hsv2_descriptor_failed(const rend_data_t *rend_data,
|
|
const char *id_digest,
|
|
const char *reason);
|
|
void control_event_hsv2_descriptor_received(const char *onion_address,
|
|
const rend_data_t *rend_data,
|
|
const char *id_digest);
|
|
/* Hidden service v3 HS_DESC specific. */
|
|
void control_event_hsv3_descriptor_failed(const char *onion_address,
|
|
const char *desc_id,
|
|
const char *hsdir_id_digest,
|
|
const char *reason);
|
|
void control_event_hsv3_descriptor_received(const char *onion_address,
|
|
const char *desc_id,
|
|
const char *hsdir_id_digest);
|
|
void control_event_hs_descriptor_upload_failed(const char *hs_dir,
|
|
const char *onion_address,
|
|
const char *reason);
|
|
void control_event_hs_descriptor_content(const char *onion_address,
|
|
const char *desc_id,
|
|
const char *hsdir_fp,
|
|
const char *content);
|
|
|
|
void control_free_all(void);
|
|
|
|
#ifdef CONTROL_PRIVATE
|
|
/* Recognized asynchronous event types. It's okay to expand this list
|
|
* because it is used both as a list of v0 event types, and as indices
|
|
* into the bitfield to determine which controllers want which events.
|
|
*/
|
|
/* This bitfield has no event zero 0x0000 */
|
|
#define EVENT_MIN_ 0x0001
|
|
#define EVENT_CIRCUIT_STATUS 0x0001
|
|
#define EVENT_STREAM_STATUS 0x0002
|
|
#define EVENT_OR_CONN_STATUS 0x0003
|
|
#define EVENT_BANDWIDTH_USED 0x0004
|
|
#define EVENT_CIRCUIT_STATUS_MINOR 0x0005
|
|
#define EVENT_NEW_DESC 0x0006
|
|
#define EVENT_DEBUG_MSG 0x0007
|
|
#define EVENT_INFO_MSG 0x0008
|
|
#define EVENT_NOTICE_MSG 0x0009
|
|
#define EVENT_WARN_MSG 0x000A
|
|
#define EVENT_ERR_MSG 0x000B
|
|
#define EVENT_ADDRMAP 0x000C
|
|
/* There was an AUTHDIR_NEWDESCS event, but it no longer exists. We
|
|
can reclaim 0x000D. */
|
|
#define EVENT_DESCCHANGED 0x000E
|
|
/* Exposed above */
|
|
// #define EVENT_NS 0x000F
|
|
#define EVENT_STATUS_CLIENT 0x0010
|
|
#define EVENT_STATUS_SERVER 0x0011
|
|
#define EVENT_STATUS_GENERAL 0x0012
|
|
#define EVENT_GUARD 0x0013
|
|
#define EVENT_STREAM_BANDWIDTH_USED 0x0014
|
|
#define EVENT_CLIENTS_SEEN 0x0015
|
|
#define EVENT_NEWCONSENSUS 0x0016
|
|
#define EVENT_BUILDTIMEOUT_SET 0x0017
|
|
#define EVENT_GOT_SIGNAL 0x0018
|
|
#define EVENT_CONF_CHANGED 0x0019
|
|
#define EVENT_CONN_BW 0x001A
|
|
#define EVENT_CELL_STATS 0x001B
|
|
/* UNUSED : 0x001C */
|
|
#define EVENT_CIRC_BANDWIDTH_USED 0x001D
|
|
#define EVENT_TRANSPORT_LAUNCHED 0x0020
|
|
#define EVENT_HS_DESC 0x0021
|
|
#define EVENT_HS_DESC_CONTENT 0x0022
|
|
#define EVENT_NETWORK_LIVENESS 0x0023
|
|
#define EVENT_MAX_ 0x0023
|
|
|
|
/* sizeof(control_connection_t.event_mask) in bits, currently a uint64_t */
|
|
#define EVENT_CAPACITY_ 0x0040
|
|
|
|
/* If EVENT_MAX_ ever hits 0x0040, we need to make the mask into a
|
|
* different structure, as it can only handle a maximum left shift of 1<<63. */
|
|
|
|
#if EVENT_MAX_ >= EVENT_CAPACITY_
|
|
#error control_connection_t.event_mask has an event greater than its capacity
|
|
#endif
|
|
|
|
#define EVENT_MASK_(e) (((uint64_t)1)<<(e))
|
|
|
|
#define EVENT_MASK_NONE_ ((uint64_t)0x0)
|
|
|
|
#define EVENT_MASK_ABOVE_MIN_ ((~((uint64_t)0x0)) << EVENT_MIN_)
|
|
#define EVENT_MASK_BELOW_MAX_ ((~((uint64_t)0x0)) \
|
|
>> (EVENT_CAPACITY_ - EVENT_MAX_ \
|
|
- EVENT_MIN_))
|
|
|
|
#define EVENT_MASK_ALL_ (EVENT_MASK_ABOVE_MIN_ \
|
|
& EVENT_MASK_BELOW_MAX_)
|
|
|
|
/* Used only by control.c and test.c */
|
|
STATIC size_t write_escaped_data(const char *data, size_t len, char **out);
|
|
STATIC size_t read_escaped_data(const char *data, size_t len, char **out);
|
|
|
|
#ifdef TOR_UNIT_TESTS
|
|
MOCK_DECL(STATIC void,
|
|
send_control_event_string,(uint16_t event, const char *msg));
|
|
|
|
MOCK_DECL(STATIC void,
|
|
queue_control_event_string,(uint16_t event, char *msg));
|
|
|
|
void control_testing_set_global_event_mask(uint64_t mask);
|
|
#endif /* defined(TOR_UNIT_TESTS) */
|
|
|
|
/** Helper structure: temporarily stores cell statistics for a circuit. */
|
|
typedef struct cell_stats_t {
|
|
/** Number of cells added in app-ward direction by command. */
|
|
uint64_t added_cells_appward[CELL_COMMAND_MAX_ + 1];
|
|
/** Number of cells added in exit-ward direction by command. */
|
|
uint64_t added_cells_exitward[CELL_COMMAND_MAX_ + 1];
|
|
/** Number of cells removed in app-ward direction by command. */
|
|
uint64_t removed_cells_appward[CELL_COMMAND_MAX_ + 1];
|
|
/** Number of cells removed in exit-ward direction by command. */
|
|
uint64_t removed_cells_exitward[CELL_COMMAND_MAX_ + 1];
|
|
/** Total waiting time of cells in app-ward direction by command. */
|
|
uint64_t total_time_appward[CELL_COMMAND_MAX_ + 1];
|
|
/** Total waiting time of cells in exit-ward direction by command. */
|
|
uint64_t total_time_exitward[CELL_COMMAND_MAX_ + 1];
|
|
} cell_stats_t;
|
|
void sum_up_cell_stats_by_command(circuit_t *circ,
|
|
cell_stats_t *cell_stats);
|
|
void append_cell_stats_by_command(smartlist_t *event_parts,
|
|
const char *key,
|
|
const uint64_t *include_if_non_zero,
|
|
const uint64_t *number_to_include);
|
|
void format_cell_stats(char **event_string, circuit_t *circ,
|
|
cell_stats_t *cell_stats);
|
|
STATIC char *get_bw_samples(void);
|
|
|
|
/* ADD_ONION secret key to create an ephemeral service. The command supports
|
|
* multiple versions so this union stores the key and passes it to the HS
|
|
* subsystem depending on the requested version. */
|
|
typedef union add_onion_secret_key_t {
|
|
/* Hidden service v2 secret key. */
|
|
crypto_pk_t *v2;
|
|
/* Hidden service v3 secret key. */
|
|
ed25519_secret_key_t *v3;
|
|
} add_onion_secret_key_t;
|
|
|
|
STATIC int add_onion_helper_keyarg(const char *arg, int discard_pk,
|
|
const char **key_new_alg_out,
|
|
char **key_new_blob_out,
|
|
add_onion_secret_key_t *decoded_key,
|
|
int *hs_version, char **err_msg_out);
|
|
|
|
STATIC rend_authorized_client_t *
|
|
add_onion_helper_clientauth(const char *arg, int *created, char **err_msg_out);
|
|
|
|
STATIC int getinfo_helper_onions(
|
|
control_connection_t *control_conn,
|
|
const char *question,
|
|
char **answer,
|
|
const char **errmsg);
|
|
STATIC void getinfo_helper_downloads_networkstatus(
|
|
const char *flavor,
|
|
download_status_t **dl_to_emit,
|
|
const char **errmsg);
|
|
STATIC void getinfo_helper_downloads_cert(
|
|
const char *fp_sk_req,
|
|
download_status_t **dl_to_emit,
|
|
smartlist_t **digest_list,
|
|
const char **errmsg);
|
|
STATIC void getinfo_helper_downloads_desc(
|
|
const char *desc_req,
|
|
download_status_t **dl_to_emit,
|
|
smartlist_t **digest_list,
|
|
const char **errmsg);
|
|
STATIC void getinfo_helper_downloads_bridge(
|
|
const char *bridge_req,
|
|
download_status_t **dl_to_emit,
|
|
smartlist_t **digest_list,
|
|
const char **errmsg);
|
|
STATIC int getinfo_helper_downloads(
|
|
control_connection_t *control_conn,
|
|
const char *question, char **answer,
|
|
const char **errmsg);
|
|
STATIC int getinfo_helper_dir(
|
|
control_connection_t *control_conn,
|
|
const char *question, char **answer,
|
|
const char **errmsg);
|
|
STATIC int getinfo_helper_current_time(
|
|
control_connection_t *control_conn,
|
|
const char *question, char **answer,
|
|
const char **errmsg);
|
|
|
|
#endif /* defined(CONTROL_PRIVATE) */
|
|
|
|
#endif /* !defined(TOR_CONTROL_H) */
|
|
|