279 lines
12 KiB
C
279 lines
12 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 config.h
|
|
* \brief Header file for config.c.
|
|
**/
|
|
|
|
#ifndef TOR_CONFIG_H
|
|
#define TOR_CONFIG_H
|
|
|
|
#include "testsupport.h"
|
|
|
|
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(DARWIN)
|
|
#define KERNEL_MAY_SUPPORT_IPFW
|
|
#endif
|
|
|
|
/** Lowest allowable value for HeartbeatPeriod; if this is too low, we might
|
|
* expose more information than we're comfortable with. */
|
|
#define MIN_HEARTBEAT_PERIOD (30*60)
|
|
|
|
/** Maximum default value for MaxMemInQueues, in bytes. */
|
|
#if SIZEOF_VOID_P >= 8
|
|
#define MAX_DEFAULT_MEMORY_QUEUE_SIZE (U64_LITERAL(8) << 30)
|
|
#else
|
|
#define MAX_DEFAULT_MEMORY_QUEUE_SIZE (U64_LITERAL(2) << 30)
|
|
#endif
|
|
|
|
MOCK_DECL(const char*, get_dirportfrontpage, (void));
|
|
MOCK_DECL(const or_options_t *, get_options, (void));
|
|
MOCK_DECL(or_options_t *, get_options_mutable, (void));
|
|
int set_options(or_options_t *new_val, char **msg);
|
|
void config_free_all(void);
|
|
const char *safe_str_client(const char *address);
|
|
const char *safe_str(const char *address);
|
|
const char *escaped_safe_str_client(const char *address);
|
|
const char *escaped_safe_str(const char *address);
|
|
void init_protocol_warning_severity_level(void);
|
|
int get_protocol_warning_severity_level(void);
|
|
const char *get_version(void);
|
|
const char *get_short_version(void);
|
|
setopt_err_t options_trial_assign(config_line_t *list, unsigned flags,
|
|
char **msg);
|
|
|
|
uint32_t get_last_resolved_addr(void);
|
|
void reset_last_resolved_addr(void);
|
|
int resolve_my_address(int warn_severity, const or_options_t *options,
|
|
uint32_t *addr_out,
|
|
const char **method_out, char **hostname_out);
|
|
MOCK_DECL(int, is_local_addr, (const tor_addr_t *addr));
|
|
void options_init(or_options_t *options);
|
|
|
|
#define OPTIONS_DUMP_MINIMAL 1
|
|
#define OPTIONS_DUMP_DEFAULTS 2
|
|
#define OPTIONS_DUMP_ALL 3
|
|
char *options_dump(const or_options_t *options, int how_to_dump);
|
|
int options_init_from_torrc(int argc, char **argv);
|
|
setopt_err_t options_init_from_string(const char *cf_defaults, const char *cf,
|
|
int command, const char *command_arg, char **msg);
|
|
int option_is_recognized(const char *key);
|
|
const char *option_get_canonical_name(const char *key);
|
|
config_line_t *option_get_assignment(const or_options_t *options,
|
|
const char *key);
|
|
int options_save_current(void);
|
|
const char *get_torrc_fname(int defaults_fname);
|
|
typedef enum {
|
|
DIRROOT_DATADIR,
|
|
DIRROOT_CACHEDIR,
|
|
DIRROOT_KEYDIR
|
|
} directory_root_t;
|
|
|
|
MOCK_DECL(char *,
|
|
options_get_dir_fname2_suffix,
|
|
(const or_options_t *options,
|
|
directory_root_t roottype,
|
|
const char *sub1, const char *sub2,
|
|
const char *suffix));
|
|
|
|
/* These macros wrap options_get_dir_fname2_suffix to provide a more
|
|
* convenient API for finding filenames that Tor uses inside its storage
|
|
* They are named according to a pattern:
|
|
* (options_)?get_(cache|key|data)dir_fname(2)?(_suffix)?
|
|
*
|
|
* Macros that begin with options_ take an options argument; the others
|
|
* work with respect to the global options.
|
|
*
|
|
* Each macro works relative to the data directory, the key directory,
|
|
* or the cache directory, as determined by which one is mentioned.
|
|
*
|
|
* Macro variants with "2" in their name take two path components; others
|
|
* take one.
|
|
*
|
|
* Macro variants with "_suffix" at the end take an additional suffix
|
|
* that gets appended to the end of the file
|
|
*/
|
|
#define options_get_datadir_fname2_suffix(options, sub1, sub2, suffix) \
|
|
options_get_dir_fname2_suffix((options), DIRROOT_DATADIR, \
|
|
(sub1), (sub2), (suffix))
|
|
#define options_get_cachedir_fname2_suffix(options, sub1, sub2, suffix) \
|
|
options_get_dir_fname2_suffix((options), DIRROOT_CACHEDIR, \
|
|
(sub1), (sub2), (suffix))
|
|
#define options_get_keydir_fname2_suffix(options, sub1, sub2, suffix) \
|
|
options_get_dir_fname2_suffix((options), DIRROOT_KEYDIR, \
|
|
(sub1), (sub2), (suffix))
|
|
|
|
#define options_get_datadir_fname(opts,sub1) \
|
|
options_get_datadir_fname2_suffix((opts),(sub1), NULL, NULL)
|
|
#define options_get_datadir_fname2(opts,sub1,sub2) \
|
|
options_get_datadir_fname2_suffix((opts),(sub1), (sub2), NULL)
|
|
|
|
#define get_datadir_fname2_suffix(sub1, sub2, suffix) \
|
|
options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
|
|
#define get_datadir_fname(sub1) \
|
|
get_datadir_fname2_suffix((sub1), NULL, NULL)
|
|
#define get_datadir_fname2(sub1,sub2) \
|
|
get_datadir_fname2_suffix((sub1), (sub2), NULL)
|
|
#define get_datadir_fname_suffix(sub1, suffix) \
|
|
get_datadir_fname2_suffix((sub1), NULL, (suffix))
|
|
|
|
/** DOCDOC */
|
|
#define options_get_keydir_fname(options, sub1) \
|
|
options_get_keydir_fname2_suffix((options), (sub1), NULL, NULL)
|
|
#define get_keydir_fname_suffix(sub1, suffix) \
|
|
options_get_keydir_fname2_suffix(get_options(), (sub1), NULL, suffix)
|
|
#define get_keydir_fname(sub1) \
|
|
options_get_keydir_fname2_suffix(get_options(), (sub1), NULL, NULL)
|
|
|
|
#define get_cachedir_fname(sub1) \
|
|
options_get_cachedir_fname2_suffix(get_options(), (sub1), NULL, NULL)
|
|
#define get_cachedir_fname_suffix(sub1, suffix) \
|
|
options_get_cachedir_fname2_suffix(get_options(), (sub1), NULL, (suffix))
|
|
|
|
int using_default_dir_authorities(const or_options_t *options);
|
|
|
|
int create_keys_directory(const or_options_t *options);
|
|
|
|
int check_or_create_data_subdir(const char *subdir);
|
|
int write_to_data_subdir(const char* subdir, const char* fname,
|
|
const char* str, const char* descr);
|
|
|
|
int get_num_cpus(const or_options_t *options);
|
|
|
|
MOCK_DECL(const smartlist_t *,get_configured_ports,(void));
|
|
int get_first_advertised_port_by_type_af(int listener_type,
|
|
int address_family);
|
|
#define get_primary_or_port() \
|
|
(get_first_advertised_port_by_type_af(CONN_TYPE_OR_LISTENER, AF_INET))
|
|
#define get_primary_dir_port() \
|
|
(get_first_advertised_port_by_type_af(CONN_TYPE_DIR_LISTENER, AF_INET))
|
|
const tor_addr_t *get_first_advertised_addr_by_type_af(int listener_type,
|
|
int address_family);
|
|
int port_exists_by_type_addr_port(int listener_type, const tor_addr_t *addr,
|
|
int port, int check_wildcard);
|
|
int port_exists_by_type_addr32h_port(int listener_type, uint32_t addr_ipv4h,
|
|
int port, int check_wildcard);
|
|
|
|
char *get_first_listener_addrport_string(int listener_type);
|
|
|
|
int options_need_geoip_info(const or_options_t *options,
|
|
const char **reason_out);
|
|
|
|
smartlist_t *get_list_of_ports_to_forward(void);
|
|
|
|
int getinfo_helper_config(control_connection_t *conn,
|
|
const char *question, char **answer,
|
|
const char **errmsg);
|
|
|
|
uint32_t get_effective_bwrate(const or_options_t *options);
|
|
uint32_t get_effective_bwburst(const or_options_t *options);
|
|
|
|
char *get_transport_bindaddr_from_config(const char *transport);
|
|
|
|
int init_cookie_authentication(const char *fname, const char *header,
|
|
int cookie_len, int group_readable,
|
|
uint8_t **cookie_out, int *cookie_is_set_out);
|
|
|
|
or_options_t *options_new(void);
|
|
|
|
int config_parse_commandline(int argc, char **argv, int ignore_errors,
|
|
config_line_t **result,
|
|
config_line_t **cmdline_result);
|
|
|
|
void config_register_addressmaps(const or_options_t *options);
|
|
/* XXXX move to connection_edge.h */
|
|
int addressmap_register_auto(const char *from, const char *to,
|
|
time_t expires,
|
|
addressmap_entry_source_t addrmap_source,
|
|
const char **msg);
|
|
|
|
int port_cfg_line_extract_addrport(const char *line,
|
|
char **addrport_out,
|
|
int *is_unix_out,
|
|
const char **rest_out);
|
|
|
|
/** Represents the information stored in a torrc Bridge line. */
|
|
typedef struct bridge_line_t {
|
|
tor_addr_t addr; /* The IP address of the bridge. */
|
|
uint16_t port; /* The TCP port of the bridge. */
|
|
char *transport_name; /* The name of the pluggable transport that
|
|
should be used to connect to the bridge. */
|
|
char digest[DIGEST_LEN]; /* The bridge's identity key digest. */
|
|
smartlist_t *socks_args; /* SOCKS arguments for the pluggable
|
|
transport proxy. */
|
|
} bridge_line_t;
|
|
|
|
void bridge_line_free_(bridge_line_t *bridge_line);
|
|
#define bridge_line_free(line) \
|
|
FREE_AND_NULL(bridge_line_t, bridge_line_free_, (line))
|
|
bridge_line_t *parse_bridge_line(const char *line);
|
|
smartlist_t *get_options_from_transport_options_line(const char *line,
|
|
const char *transport);
|
|
smartlist_t *get_options_for_server_transport(const char *transport);
|
|
|
|
/* Port helper functions. */
|
|
int options_any_client_port_set(const or_options_t *options);
|
|
|
|
#ifdef CONFIG_PRIVATE
|
|
|
|
#define CL_PORT_NO_STREAM_OPTIONS (1u<<0)
|
|
#define CL_PORT_WARN_NONLOCAL (1u<<1)
|
|
/* Was CL_PORT_ALLOW_EXTRA_LISTENADDR (1u<<2) */
|
|
#define CL_PORT_SERVER_OPTIONS (1u<<3)
|
|
#define CL_PORT_FORBID_NONLOCAL (1u<<4)
|
|
#define CL_PORT_TAKES_HOSTNAMES (1u<<5)
|
|
#define CL_PORT_IS_UNIXSOCKET (1u<<6)
|
|
#define CL_PORT_DFLT_GROUP_WRITABLE (1u<<7)
|
|
|
|
STATIC int options_act(const or_options_t *old_options);
|
|
#ifdef TOR_UNIT_TESTS
|
|
extern struct config_format_t options_format;
|
|
#endif
|
|
|
|
STATIC port_cfg_t *port_cfg_new(size_t namelen);
|
|
#define port_cfg_free(port) \
|
|
FREE_AND_NULL(port_cfg_t, port_cfg_free_, (port))
|
|
STATIC void port_cfg_free_(port_cfg_t *port);
|
|
#define or_options_free(opt) \
|
|
FREE_AND_NULL(or_options_t, or_options_free_, (opt))
|
|
STATIC void or_options_free_(or_options_t *options);
|
|
STATIC int options_validate_single_onion(or_options_t *options,
|
|
char **msg);
|
|
STATIC int options_validate(or_options_t *old_options,
|
|
or_options_t *options,
|
|
or_options_t *default_options,
|
|
int from_setconf, char **msg);
|
|
STATIC int parse_transport_line(const or_options_t *options,
|
|
const char *line, int validate_only,
|
|
int server);
|
|
STATIC int consider_adding_dir_servers(const or_options_t *options,
|
|
const or_options_t *old_options);
|
|
STATIC void add_default_trusted_dir_authorities(dirinfo_type_t type);
|
|
MOCK_DECL(STATIC void, add_default_fallback_dir_servers, (void));
|
|
STATIC int parse_dir_authority_line(const char *line,
|
|
dirinfo_type_t required_type,
|
|
int validate_only);
|
|
STATIC int parse_dir_fallback_line(const char *line, int validate_only);
|
|
STATIC int have_enough_mem_for_dircache(const or_options_t *options,
|
|
size_t total_mem, char **msg);
|
|
STATIC int parse_port_config(smartlist_t *out,
|
|
const config_line_t *ports,
|
|
const char *portname,
|
|
int listener_type,
|
|
const char *defaultaddr,
|
|
int defaultport,
|
|
const unsigned flags);
|
|
|
|
STATIC int check_bridge_distribution_setting(const char *bd);
|
|
|
|
STATIC uint64_t compute_real_max_mem_in_queues(const uint64_t val,
|
|
int log_guess);
|
|
|
|
#endif /* defined(CONFIG_PRIVATE) */
|
|
|
|
#endif /* !defined(TOR_CONFIG_H) */
|
|
|