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-2021, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Header file for config.c.
15 #include "app/config/or_options_st.h"
16 #include "lib/testsupport/testsupport.h"
17 #include "app/config/quiet_level.h"
19 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(DARWIN)
20 #define KERNEL_MAY_SUPPORT_IPFW
23 /** Lowest allowable value for HeartbeatPeriod; if this is too low, we might
24 * expose more information than we're comfortable with. */
25 #define MIN_HEARTBEAT_PERIOD (30*60)
27 /** Maximum default value for MaxMemInQueues, in bytes. */
28 #if SIZEOF_VOID_P >= 8
29 #define MAX_DEFAULT_MEMORY_QUEUE_SIZE (UINT64_C(8) << 30)
31 #define MAX_DEFAULT_MEMORY_QUEUE_SIZE (UINT64_C(2) << 30)
34 MOCK_DECL(const or_options_t
*, get_options
, (void));
35 MOCK_DECL(or_options_t
*, get_options_mutable
, (void));
36 int set_options(or_options_t
*new_val
, char **msg
);
37 void config_free_all(void);
38 const char *safe_str_client(const char *address
);
39 const char *safe_str(const char *address
);
40 const char *escaped_safe_str_client(const char *address
);
41 const char *escaped_safe_str(const char *address
);
42 void init_protocol_warning_severity_level(void);
43 int get_protocol_warning_severity_level(void);
45 #define LOG_PROTOCOL_WARN (get_protocol_warning_severity_level())
47 /** An error from options_trial_assign() or options_init_from_string(). */
48 typedef enum setopt_err_t
{
51 SETOPT_ERR_PARSE
= -2,
52 SETOPT_ERR_TRANSITION
= -3,
53 SETOPT_ERR_SETTING
= -4,
55 setopt_err_t
options_trial_assign(struct config_line_t
*list
, unsigned flags
,
58 void options_init(or_options_t
*options
);
60 #define OPTIONS_DUMP_MINIMAL 1
61 #define OPTIONS_DUMP_ALL 2
62 char *options_dump(const or_options_t
*options
, int how_to_dump
);
63 int options_init_from_torrc(int argc
, char **argv
);
64 setopt_err_t
options_init_from_string(const char *cf_defaults
, const char *cf
,
65 int command
, const char *command_arg
, char **msg
);
66 int option_is_recognized(const char *key
);
67 const char *option_get_canonical_name(const char *key
);
68 struct config_line_t
*option_get_assignment(const or_options_t
*options
,
70 int options_save_current(void);
71 const char *get_torrc_fname(int defaults_fname
);
79 options_get_dir_fname2_suffix
,
80 (const or_options_t
*options
,
81 directory_root_t roottype
,
82 const char *sub1
, const char *sub2
,
85 /* These macros wrap options_get_dir_fname2_suffix to provide a more
86 * convenient API for finding filenames that Tor uses inside its storage
87 * They are named according to a pattern:
88 * (options_)?get_(cache|key|data)dir_fname(2)?(_suffix)?
90 * Macros that begin with options_ take an options argument; the others
91 * work with respect to the global options.
93 * Each macro works relative to the data directory, the key directory,
94 * or the cache directory, as determined by which one is mentioned.
96 * Macro variants with "2" in their name take two path components; others
99 * Macro variants with "_suffix" at the end take an additional suffix
100 * that gets appended to the end of the file
102 #define options_get_datadir_fname2_suffix(options, sub1, sub2, suffix) \
103 options_get_dir_fname2_suffix((options), DIRROOT_DATADIR, \
104 (sub1), (sub2), (suffix))
105 #define options_get_cachedir_fname2_suffix(options, sub1, sub2, suffix) \
106 options_get_dir_fname2_suffix((options), DIRROOT_CACHEDIR, \
107 (sub1), (sub2), (suffix))
108 #define options_get_keydir_fname2_suffix(options, sub1, sub2, suffix) \
109 options_get_dir_fname2_suffix((options), DIRROOT_KEYDIR, \
110 (sub1), (sub2), (suffix))
112 #define options_get_datadir_fname(opts,sub1) \
113 options_get_datadir_fname2_suffix((opts),(sub1), NULL, NULL)
114 #define options_get_datadir_fname2(opts,sub1,sub2) \
115 options_get_datadir_fname2_suffix((opts),(sub1), (sub2), NULL)
117 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
118 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
119 #define get_datadir_fname(sub1) \
120 get_datadir_fname2_suffix((sub1), NULL, NULL)
121 #define get_datadir_fname2(sub1,sub2) \
122 get_datadir_fname2_suffix((sub1), (sub2), NULL)
123 #define get_datadir_fname_suffix(sub1, suffix) \
124 get_datadir_fname2_suffix((sub1), NULL, (suffix))
127 #define options_get_keydir_fname(options, sub1) \
128 options_get_keydir_fname2_suffix((options), (sub1), NULL, NULL)
129 #define get_keydir_fname_suffix(sub1, suffix) \
130 options_get_keydir_fname2_suffix(get_options(), (sub1), NULL, suffix)
131 #define get_keydir_fname(sub1) \
132 options_get_keydir_fname2_suffix(get_options(), (sub1), NULL, NULL)
134 #define get_cachedir_fname(sub1) \
135 options_get_cachedir_fname2_suffix(get_options(), (sub1), NULL, NULL)
136 #define get_cachedir_fname_suffix(sub1, suffix) \
137 options_get_cachedir_fname2_suffix(get_options(), (sub1), NULL, (suffix))
139 #define safe_str_client(address) \
140 safe_str_client_opts(NULL, address)
141 #define safe_str(address) \
142 safe_str_opts(NULL, address)
144 const char * safe_str_client_opts(const or_options_t
*options
,
145 const char *address
);
146 const char * safe_str_opts(const or_options_t
*options
,
147 const char *address
);
149 int using_default_dir_authorities(const or_options_t
*options
);
151 int create_keys_directory(const or_options_t
*options
);
153 int check_or_create_data_subdir(const char *subdir
);
154 int write_to_data_subdir(const char* subdir
, const char* fname
,
155 const char* str
, const char* descr
);
157 int get_num_cpus(const or_options_t
*options
);
159 MOCK_DECL(const smartlist_t
*,get_configured_ports
,(void));
160 int port_binds_ipv4(const port_cfg_t
*port
);
161 int port_binds_ipv6(const port_cfg_t
*port
);
162 int portconf_get_first_advertised_port(int listener_type
,
164 #define portconf_get_primary_dir_port() \
165 (portconf_get_first_advertised_port(CONN_TYPE_DIR_LISTENER, AF_INET))
166 const tor_addr_t
*portconf_get_first_advertised_addr(int listener_type
,
168 int port_exists_by_type_addr_port(int listener_type
, const tor_addr_t
*addr
,
169 int port
, int check_wildcard
);
170 int port_exists_by_type_addr32h_port(int listener_type
, uint32_t addr_ipv4h
,
171 int port
, int check_wildcard
);
173 char *get_first_listener_addrport_string(int listener_type
);
175 int options_need_geoip_info(const or_options_t
*options
,
176 const char **reason_out
);
178 int getinfo_helper_config(control_connection_t
*conn
,
179 const char *question
, char **answer
,
180 const char **errmsg
);
182 int init_cookie_authentication(const char *fname
, const char *header
,
183 int cookie_len
, int group_readable
,
184 uint8_t **cookie_out
, int *cookie_is_set_out
);
186 or_options_t
*options_new(void);
188 /** Options settings parsed from the command-line. */
190 /** List of options that can only be set from the command-line */
191 struct config_line_t
*cmdline_opts
;
192 /** List of other options, to be handled by the general Tor configuration
194 struct config_line_t
*other_opts
;
195 /** Subcommand that Tor has been told to run */
196 tor_cmdline_mode_t command
;
197 /** Argument for the command mode, if any. */
198 const char *command_arg
;
199 /** How quiet have we been told to be? */
200 quiet_level_t quiet_level
;
203 parsed_cmdline_t
*config_parse_commandline(int argc
, char **argv
,
205 void parsed_cmdline_free_(parsed_cmdline_t
*cmdline
);
206 #define parsed_cmdline_free(c) \
207 FREE_AND_NULL(parsed_cmdline_t, parsed_cmdline_free_, (c))
209 void config_register_addressmaps(const or_options_t
*options
);
210 /* XXXX move to connection_edge.h */
211 int addressmap_register_auto(const char *from
, const char *to
,
213 addressmap_entry_source_t addrmap_source
,
216 int port_cfg_line_extract_addrport(const char *line
,
219 const char **rest_out
);
221 /** Represents the information stored in a torrc Bridge line. */
222 typedef struct bridge_line_t
{
223 tor_addr_t addr
; /* The IP address of the bridge. */
224 uint16_t port
; /* The TCP port of the bridge. */
225 char *transport_name
; /* The name of the pluggable transport that
226 should be used to connect to the bridge. */
227 char digest
[DIGEST_LEN
]; /* The bridge's identity key digest. */
228 smartlist_t
*socks_args
; /* SOCKS arguments for the pluggable
232 void bridge_line_free_(bridge_line_t
*bridge_line
);
233 #define bridge_line_free(line) \
234 FREE_AND_NULL(bridge_line_t, bridge_line_free_, (line))
235 bridge_line_t
*parse_bridge_line(const char *line
);
237 /* Port helper functions. */
238 int options_any_client_port_set(const or_options_t
*options
);
239 int port_parse_config(smartlist_t
*out
,
240 const struct config_line_t
*ports
,
241 const char *portname
,
243 const char *defaultaddr
,
245 const unsigned flags
);
247 #define CL_PORT_NO_STREAM_OPTIONS (1u<<0)
248 #define CL_PORT_WARN_NONLOCAL (1u<<1)
249 /* Was CL_PORT_ALLOW_EXTRA_LISTENADDR (1u<<2) */
250 #define CL_PORT_SERVER_OPTIONS (1u<<3)
251 #define CL_PORT_FORBID_NONLOCAL (1u<<4)
252 #define CL_PORT_TAKES_HOSTNAMES (1u<<5)
253 #define CL_PORT_IS_UNIXSOCKET (1u<<6)
254 #define CL_PORT_DFLT_GROUP_WRITABLE (1u<<7)
256 port_cfg_t
*port_cfg_new(size_t namelen
);
257 #define port_cfg_free(port) \
258 FREE_AND_NULL(port_cfg_t, port_cfg_free_, (port))
259 void port_cfg_free_(port_cfg_t
*port
);
261 int port_count_real_listeners(const smartlist_t
*ports
,
264 int pt_parse_transport_line(const or_options_t
*options
,
265 const char *line
, int validate_only
,
267 int config_ensure_bandwidth_cap(uint64_t *value
, const char *desc
, char **msg
);
269 #ifdef CONFIG_PRIVATE
271 MOCK_DECL(STATIC
int, options_act
,(const or_options_t
*old_options
));
272 MOCK_DECL(STATIC
int, options_act_reversible
,(const or_options_t
*old_options
,
275 STATIC
const struct config_mgr_t
*get_options_mgr(void);
277 #define or_options_free(opt) \
278 FREE_AND_NULL(or_options_t, or_options_free_, (opt))
279 STATIC
void or_options_free_(or_options_t
*options
);
280 STATIC
int options_validate_single_onion(or_options_t
*options
,
282 STATIC
int parse_tcp_proxy_line(const char *line
, or_options_t
*options
,
284 STATIC
int consider_adding_dir_servers(const or_options_t
*options
,
285 const or_options_t
*old_options
);
286 STATIC
void add_default_trusted_dir_authorities(dirinfo_type_t type
);
287 MOCK_DECL(STATIC
void, add_default_fallback_dir_servers
, (void));
288 STATIC
int parse_dir_authority_line(const char *line
,
289 dirinfo_type_t required_type
,
291 STATIC
int parse_dir_fallback_line(const char *line
, int validate_only
);
293 STATIC
uint64_t compute_real_max_mem_in_queues(const uint64_t val
,
295 STATIC
int open_and_add_file_log(const log_severity_list_t
*severity
,
298 STATIC
int options_init_logs(const or_options_t
*old_options
,
299 const or_options_t
*options
, int validate_only
);
301 STATIC
int options_create_directories(char **msg_out
);
302 struct log_transaction_t
;
303 STATIC
struct log_transaction_t
*options_start_log_transaction(
304 const or_options_t
*old_options
,
306 STATIC
void options_commit_log_transaction(struct log_transaction_t
*xn
);
307 STATIC
void options_rollback_log_transaction(struct log_transaction_t
*xn
);
309 #ifdef TOR_UNIT_TESTS
310 int options_validate(const or_options_t
*old_options
,
311 or_options_t
*options
,
315 STATIC
int parse_ports(or_options_t
*options
, int validate_only
,
316 char **msg
, int *n_ports_out
,
317 int *world_writable_control_socket
);
319 #endif /* defined(CONFIG_PRIVATE) */
321 #endif /* !defined(TOR_CONFIG_H) */