config.c 299 KB
Newer Older
1
/* Copyright (c) 2001 Matej Pfajfar.
Roger Dingledine's avatar
Roger Dingledine committed
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

Nick Mathewson's avatar
Nick Mathewson committed
7
/**
8
 * \file config.c
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 * \brief Code to interpret the user's configuration of Tor.
 *
 * This module handles torrc configuration file, including parsing it,
 * combining it with torrc.defaults and the command line, allowing
 * user changes to it (via editing and SIGHUP or via the control port),
 * writing it back to disk (because of SAVECONF from the control port),
 * and -- most importantly, acting on it.
 *
 * The module additionally has some tools for manipulating and
 * inspecting values that are calculated as a result of the
 * configured options.
 *
 * <h3>How to add  new options</h3>
 *
 * To add new items to the torrc, there are a minimum of three places to edit:
 * <ul>
 *   <li>The or_options_t structure in or.h, where the options are stored.
 *   <li>The option_vars_ array below in this module, which configures
 *       the names of the torrc options, their types, their multiplicities,
 *       and their mappings to fields in or_options_t.
 *   <li>The manual in doc/tor.1.txt, to document what the new option
 *       is, and how it works.
 * </ul>
 *
 * Additionally, you might need to edit these places too:
 * <ul>
 *   <li>options_validate() below, in case you want to reject some possible
 *       values of the new configuration option.
 *   <li>options_transition_allowed() below, in case you need to
 *       forbid some or all changes in the option while Tor is
 *       running.
 *   <li>options_transition_affects_workers(), in case changes in the option
 *       might require Tor to relaunch or reconfigure its worker threads.
 *   <li>options_transition_affects_descriptor(), in case changes in the
 *       option might require a Tor relay to build and publish a new server
 *       descriptor.
 *   <li>options_act() and/or options_act_reversible(), in case there's some
 *       action that needs to be taken immediately based on the option's
 *       value.
 * </ul>
 *
 * <h3>Changing the value of an option</h3>
 *
 * Because of the SAVECONF command from the control port, it's a bad
 * idea to change the value of any user-configured option in the
 * or_options_t.  If you want to sometimes do this anyway, we recommend
 * that you create a secondary field in or_options_t; that you have the
 * user option linked only to the secondary field; that you use the
 * secondary field to initialize the one that Tor actually looks at; and that
 * you use the one Tor looks as the one that you modify.
Nick Mathewson's avatar
Nick Mathewson committed
59
60
 **/

61
#define CONFIG_PRIVATE
Roger Dingledine's avatar
Roger Dingledine committed
62
#include "or.h"
63
#include "bridges.h"
64
#include "compat.h"
65
#include "addressmap.h"
66
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
67
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
68
#include "circuitlist.h"
69
70
#include "circuitmux.h"
#include "circuitmux_ewma.h"
71
#include "circuitstats.h"
72
#include "compress.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
73
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
74
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
75
#include "connection_edge.h"
76
#include "connection_or.h"
77
#include "consdiffmgr.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
78
#include "control.h"
79
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
80
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
81
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
82
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
83
#include "dns.h"
84
#include "entrynodes.h"
85
#include "git_revision.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
86
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
87
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
88
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
89
#include "networkstatus.h"
90
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
91
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
92
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
93
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
94
#include "rendservice.h"
95
#include "hs_config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
96
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
97
#include "router.h"
98
#include "sandbox.h"
99
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
100
#include "routerlist.h"
101
#include "routerset.h"
102
#include "scheduler.h"
103
#include "statefile.h"
104
#include "transports.h"
105
#include "ext_orport.h"
106
#ifdef _WIN32
107
108
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
109

110
111
#include "procmon.h"

112
113
114
115
116
117
#ifdef HAVE_SYSTEMD
#   if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
/* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
 * Coverity. Here's a kludge to unconfuse it.
 */
#   define __INCLUDE_LEVEL__ 2
118
#endif /* defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__) */
119
#include <systemd/sd-daemon.h>
120
#endif /* defined(HAVE_SYSTEMD) */
121

122
/* Prefix used to indicate a Unix socket in a FooPort configuration. */
123
static const char unix_socket_prefix[] = "unix:";
124
125
126
/* Prefix used to indicate a Unix socket with spaces in it, in a FooPort
 * configuration. */
static const char unix_q_socket_prefix[] = "unix:\"";
127

128
129
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
130
static config_abbrev_t option_abbrevs_[] = {
131
132
133
134
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
135
  PLURAL(EntryNode),
136
  PLURAL(ExcludeNode),
137
  PLURAL(Tor2webRendezvousPoint),
138
  PLURAL(FirewallPort),
139
  PLURAL(LongLivedPort),
140
141
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
142
  PLURAL(NumCPU),
143
  PLURAL(RendNode),
144
  PLURAL(RecommendedPackage),
145
  PLURAL(RendExcludeNode),
146
147
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
148
  PLURAL(StrictNode),
149
  { "l", "Log", 1, 0},
150
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
151
152
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
153
154
155
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
156
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX later, make this warn? */
157
  { "MaxConn", "ConnLimit", 0, 1},
158
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
159
160
161
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
162
163
164
165
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
166
167
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
168
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
169
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
170
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
171
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
172
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
173
174
  { NULL, NULL, 0, 0},
};
175

176
177
178
179
/** dummy instance of or_options_t, used for type-checking its
 * members with CONF_CHECK_VAR_TYPE. */
DUMMY_TYPECHECK_INSTANCE(or_options_t);

Nick Mathewson's avatar
Nick Mathewson committed
180
181
182
183
/** An entry for config_vars: "The option <b>name</b> has type
 * CONFIG_TYPE_<b>conftype</b>, and corresponds to
 * or_options_t.<b>member</b>"
 */
184
#define VAR(name,conftype,member,initvalue)                             \
Neel Chauhan's avatar
Neel Chauhan committed
185
  { name, CONFIG_TYPE_ ## conftype, offsetof(or_options_t, member),     \
186
      initvalue CONF_TEST_MEMBERS(or_options_t, conftype, member) }
187
188
189
/** As VAR, but the option name and member name are the same. */
#define V(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member, initvalue)
Nick Mathewson's avatar
Nick Mathewson committed
190
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
191
192
193
#ifdef TOR_UNIT_TESTS
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL, {.INT=NULL} }
#else
194
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
195
#endif
196

197
198
199
200
201
202
203
204
205
206
207
/**
 * Macro to declare *Port options.  Each one comes in three entries.
 * For example, most users should use "SocksPort" to configure the
 * socks port, but TorBrowser wants to use __SocksPort so that it
 * isn't stored by SAVECONF.  The SocksPortLines virtual option is
 * used to query both options from the controller.
 */
#define VPORT(member)                                           \
  VAR(#member "Lines", LINELIST_V, member ## _lines, NULL),     \
  VAR(#member, LINELIST_S, member ## _lines, NULL),             \
  VAR("__" #member, LINELIST_S, member ## _lines, NULL)
208

Nick Mathewson's avatar
Nick Mathewson committed
209
210
211
212
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
213
static config_var_t option_vars_[] = {
214
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
215
  VAR("AccountingRule",          STRING,   AccountingRule_option,  "max"),
216
217
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
Nick Mathewson's avatar
Nick Mathewson committed
218
  OBSOLETE("AllowDotExit"),
219
  OBSOLETE("AllowInvalidNodes"),
220
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
221
  OBSOLETE("AllowSingleHopCircuits"),
222
  OBSOLETE("AllowSingleHopExits"),
223
224
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
225
  OBSOLETE("AlternateHSAuthority"),
226
  V(AssumeReachable,             BOOL,     "0"),
227
228
  OBSOLETE("AuthDirBadDir"),
  OBSOLETE("AuthDirBadDirCCs"),
229
  V(AuthDirBadExit,              LINELIST, NULL),
230
  V(AuthDirBadExitCCs,           CSV,      ""),
231
  V(AuthDirInvalid,              LINELIST, NULL),
232
  V(AuthDirInvalidCCs,           CSV,      ""),
233
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
234
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "2 MB"),
235
  V(AuthDirPinKeys,              BOOL,     "1"),
236
  V(AuthDirReject,               LINELIST, NULL),
237
  V(AuthDirRejectCCs,            CSV,      ""),
238
  OBSOLETE("AuthDirRejectUnlisted"),
239
  OBSOLETE("AuthDirListBadDirs"),
240
  V(AuthDirListBadExits,         BOOL,     "0"),
241
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
242
  OBSOLETE("AuthDirMaxServersPerAuthAddr"),
243
  V(AuthDirHasIPv6Connectivity,  BOOL,     "0"),
244
245
246
247
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
248
249
  V(BandwidthBurst,              MEMUNIT,  "1 GB"),
  V(BandwidthRate,               MEMUNIT,  "1 GB"),
250
251
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
252
  V(BridgePassword,              STRING,   NULL),
253
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
254
  V(BridgeRelay,                 BOOL,     "0"),
255
  V(BridgeDistribution,          STRING,   NULL),
256
257
  VAR("CacheDirectory",          FILENAME, CacheDirectory_option, NULL),
  V(CacheDirectoryGroupReadable, BOOL,     "0"),
258
  V(CellStatistics,              BOOL,     "0"),
259
  V(PaddingStatistics,           BOOL,     "1"),
260
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
261
  V(CircuitBuildTimeout,         INTERVAL, "0"),
262
263
  OBSOLETE("CircuitIdleTimeout"),
  V(CircuitsAvailableTimeout,    INTERVAL, "0"),
264
  V(CircuitStreamTimeout,        INTERVAL, "0"),
265
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
266
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
267
  V(ClientOnly,                  BOOL,     "0"),
268
269
  V(ClientPreferIPv6ORPort,      AUTOBOOL, "auto"),
  V(ClientPreferIPv6DirPort,     AUTOBOOL, "auto"),
270
  V(ClientRejectInternalAddresses, BOOL,   "1"),
271
  V(ClientTransportPlugin,       LINELIST, NULL),
272
  V(ClientUseIPv6,               BOOL,     "0"),
273
  V(ClientUseIPv4,               BOOL,     "1"),
274
  V(ConsensusParams,             STRING,   NULL),
275
  V(ConnLimit,                   UINT,     "1000"),
276
  V(ConnDirectionStatistics,     BOOL,     "0"),
277
278
279
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
280
  OBSOLETE("ControlListenAddress"),
281
  VPORT(ControlPort),
282
  V(ControlPortFileGroupReadable,BOOL,     "0"),
283
  V(ControlPortWriteToFile,      FILENAME, NULL),
284
  V(ControlSocket,               LINELIST, NULL),
285
  V(ControlSocketsGroupWritable, BOOL,     "0"),
286
  V(SocksSocketsGroupWritable,   BOOL,     "0"),
287
288
289
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
290
  V(CountPrivateBandwidth,       BOOL,     "0"),
291
  VAR("DataDirectory",           FILENAME, DataDirectory_option, NULL),
292
  V(DataDirectoryGroupReadable,  BOOL,     "0"),
293
  V(DisableOOSCheck,             BOOL,     "1"),
294
  V(DisableNetwork,              BOOL,     "0"),
295
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
296
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
297
  OBSOLETE("DirListenAddress"),
298
  V(DirPolicy,                   LINELIST, NULL),
299
  VPORT(DirPort),
300
  V(DirPortFrontPage,            FILENAME, NULL),
301
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
302
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
303
  V(DirCache,                    BOOL,     "1"),
304
  V(DirAuthorityFallbackRate,    DOUBLE,   "1.0"),
305
  V(DisableAllSwap,              BOOL,     "0"),
306
  V(DisableDebuggerAttachment,   BOOL,     "1"),
307
  OBSOLETE("DisableIOCP"),
308
  OBSOLETE("DisableV2DirectoryInfo_"),
309
  OBSOLETE("DynamicDHGroups"),
310
  VPORT(DNSPort),
311
  OBSOLETE("DNSListenAddress"),
312
  V(DownloadExtraInfo,           BOOL,     "0"),
313
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
314
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
315
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
316
  V(EnforceDistinctSubnets,      BOOL,     "1"),
317
  V(EntryNodes,                  ROUTERSET,   NULL),
318
  V(EntryStatistics,             BOOL,     "0"),
319
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
320
321
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
322
  OBSOLETE("ExcludeSingleHopRelays"),
323
  V(ExitNodes,                   ROUTERSET, NULL),
324
325
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
326
  V(ExitPolicyRejectLocalInterfaces, BOOL, "0"),
327
  V(ExitPortStatistics,          BOOL,     "0"),
328
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
329
  V(ExitRelay,                   AUTOBOOL, "auto"),
330
  VPORT(ExtORPort),
331
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
332
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
333
  V(ExtraInfoStatistics,         BOOL,     "1"),
334
  V(ExtendByEd25519ID,           AUTOBOOL, "auto"),
335
  V(FallbackDir,                 LINELIST, NULL),
336

337
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
338

339
  OBSOLETE("FallbackNetworkstatusFile"),
340
341
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
342
  OBSOLETE("FastFirstHopPK"),
343
  V(FetchDirInfoEarly,           BOOL,     "0"),
344
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
345
346
347
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
348
  OBSOLETE("FetchV2Networkstatus"),
349
  V(GeoIPExcludeUnknown,         AUTOBOOL, "auto"),
350
#ifdef _WIN32
351
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
352
  V(GeoIPv6File,                 FILENAME, "<default>"),
353
#else
354
355
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
356
357
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
358
#endif /* defined(_WIN32) */
359
  OBSOLETE("Group"),
360
  V(GuardLifetime,               INTERVAL, "0 minutes"),
361
  V(HardwareAccel,               BOOL,     "0"),
362
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
363
364
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
365
  V(HashedControlPassword,       LINELIST, NULL),
366
  OBSOLETE("HidServDirectoryV2"),
Nick Mathewson's avatar
Nick Mathewson committed
367
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
368
  VAR("HiddenServiceDirGroupReadable",  LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
369
370
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
371
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
372
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
373
  VAR("HiddenServiceAllowUnknownPorts",LINELIST_S, RendConfigLines, NULL),
374
375
  VAR("HiddenServiceMaxStreams",LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceMaxStreamsCloseCircuit",LINELIST_S, RendConfigLines, NULL),
376
  VAR("HiddenServiceNumIntroductionPoints", LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
377
  VAR("HiddenServiceStatistics", BOOL, HiddenServiceStatistics_option, "1"),
378
  V(HidServAuth,                 LINELIST, NULL),
379
  OBSOLETE("CloseHSClientCircuitsImmediatelyOnTimeout"),
380
  OBSOLETE("CloseHSServiceRendCircuitsImmediatelyOnTimeout"),
381
382
  V(HiddenServiceSingleHopMode,  BOOL,     "0"),
  V(HiddenServiceNonAnonymousMode,BOOL,    "0"),
383
384
385
386
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
387
  VPORT(HTTPTunnelPort),
388
  V(IPv6Exit,                    BOOL,     "0"),
389
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
390
  V(ServerTransportListenAddr,   LINELIST, NULL),
391
  V(ServerTransportOptions,      LINELIST, NULL),
392
  V(SigningKeyLifetime,          INTERVAL, "30 days"),
393
394
395
396
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
397
398
  VAR("KeyDirectory",            FILENAME, KeyDirectory_option, NULL),
  V(KeyDirectoryGroupReadable,   BOOL,     "0"),
399
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
400
  V(KeepBindCapabilities,            AUTOBOOL, "auto"),
401
  VAR("Log",                     LINELIST, Logs,             NULL),
402
  V(LogMessageDomains,           BOOL,     "0"),
403
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
Arlo Breault's avatar
Arlo Breault committed
404
  V(TruncateLogFile,             BOOL,     "0"),
Peter Palfrader's avatar
Peter Palfrader committed
405
  V(SyslogIdentityTag,           STRING,   NULL),
406
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
407
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
408
409
410
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
411
  V(MaxClientCircuitsPending,    UINT,     "32"),
412
  V(MaxConsensusAgeForDiffs,     INTERVAL, "0 seconds"),
413
  VAR("MaxMemInQueues",          MEMUNIT,   MaxMemInQueues_raw, "0"),
414
415
  OBSOLETE("MaxOnionsPending"),
  V(MaxOnionQueueDelay,          MSEC_INTERVAL, "1750 msec"),
416
  V(MaxUnparseableDescSizeToLog, MEMUNIT, "10 MB"),
417
  V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
418
  VAR("MyFamily",                LINELIST, MyFamily_lines,       NULL),
419
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
420
  OBSOLETE("NamingAuthoritativeDirectory"),
421
  OBSOLETE("NATDListenAddress"),
422
  VPORT(NATDPort),
423
  V(Nickname,                    STRING,   NULL),
424
  OBSOLETE("PredictedPortsRelevanceTime"),
425
  OBSOLETE("WarnUnsafeSocks"),
426
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
427
  V(NoExec,                      BOOL,     "0"),
428
  V(NumCPUs,                     UINT,     "0"),
429
  V(NumDirectoryGuards,          UINT,     "0"),
430
  V(NumEntryGuards,              UINT,     "0"),
Nick Mathewson's avatar
Nick Mathewson committed
431
  V(OfflineMasterKey,            BOOL,     "0"),
432
  OBSOLETE("ORListenAddress"),
433
  VPORT(ORPort),
434
  V(OutboundBindAddress,         LINELIST,   NULL),
435
436
  V(OutboundBindAddressOR,       LINELIST,   NULL),
  V(OutboundBindAddressExit,     LINELIST,   NULL),
437

438
  OBSOLETE("PathBiasDisableRate"),
439
440
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
441
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
442
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
443
  V(PathBiasScaleThreshold,      INT,      "-1"),
444
445
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
446
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
447
448
449
450
451
452
  OBSOLETE("PathBiasUseCloseCounts"),

  V(PathBiasUseThreshold,       INT,      "-1"),
  V(PathBiasNoticeUseRate,          DOUBLE,   "-1"),
  V(PathBiasExtremeUseRate,         DOUBLE,   "-1"),
  V(PathBiasScaleUseThreshold,      INT,      "-1"),
453

454
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
455
456
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
457
  V(PidFile,                     STRING,   NULL),
458
  V(TestingTorNetwork,           BOOL,     "0"),
459
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
460
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
461

462
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
463
464
465
466
467
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

468
  V(OptimisticData,              AUTOBOOL, "auto"),
469
470
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
471
  OBSOLETE("PreferTunneledDirConns"),
472
  V(ProtocolWarnings,            BOOL,     "0"),
473
  V(PublishServerDescriptor,     CSV,      "1"),
474
475
476
477
478
479
480
  V(PublishHidServDescriptors,   BOOL,     "1"),
  V(ReachableAddresses,          LINELIST, NULL),
  V(ReachableDirAddresses,       LINELIST, NULL),
  V(ReachableORAddresses,        LINELIST, NULL),
  V(RecommendedVersions,         LINELIST, NULL),
  V(RecommendedClientVersions,   LINELIST, NULL),
  V(RecommendedServerVersions,   LINELIST, NULL),
481
  V(RecommendedPackages,         LINELIST, NULL),
482
483
  V(ReducedConnectionPadding,    BOOL,     "0"),
  V(ConnectionPadding,           AUTOBOOL, "auto"),
484
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
485
  V(RejectPlaintextPorts,        CSV,      ""),
486
487
488
489
490
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
491
  V(ReducedExitPolicy,           BOOL,     "0"),
492
  OBSOLETE("RunTesting"), // currently unused
493
  V(Sandbox,                     BOOL,     "0"),
494
  V(SafeLogging,                 STRING,   "1"),
495
  V(SafeSocks,                   BOOL,     "0"),
496
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
497
498
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
499
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
500
501
502
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
503
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
504
505
506
507
508
  OBSOLETE("SchedulerLowWaterMark__"),
  OBSOLETE("SchedulerHighWaterMark__"),
  OBSOLETE("SchedulerMaxFlushCells__"),
  V(KISTSchedRunInterval,        MSEC_INTERVAL, "0 msec"),
  V(KISTSockBufSizeFactor,       DOUBLE,   "1.0"),
509
  V(Schedulers,                  CSV,      "KIST,KISTLite,Vanilla"),
510
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
511
  OBSOLETE("SocksListenAddress"),
512
  V(SocksPolicy,                 LINELIST, NULL),
513
  VPORT(SocksPort),
514
  V(SocksTimeout,                INTERVAL, "2 minutes"),
515
  V(SSLKeyLifetime,              INTERVAL, "0"),
516
517
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
518
  V(StrictNodes,                 BOOL,     "0"),
519
  OBSOLETE("Support022HiddenServices"),
520
  V(TestSocks,                   BOOL,     "0"),
521
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
522
  V(Tor2webMode,                 BOOL,     "0"),
523
  V(Tor2webRendezvousPoints,      ROUTERSET, NULL),
524
  OBSOLETE("TLSECGroup"),
525
526
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
527
  OBSOLETE("TransListenAddress"),
528
  VPORT(TransPort),
529
  V(TransProxyType,              STRING,   "default"),
530
  OBSOLETE("TunnelDirConns"),
531
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
532
  V(UseBridges,                  BOOL,     "0"),
533
  VAR("UseEntryGuards",          BOOL,     UseEntryGuards_option, "1"),
Nick Mathewson's avatar
Nick Mathewson committed
534
  OBSOLETE("UseEntryGuardsAsDirGuards"),
535
  V(UseGuardFraction,            AUTOBOOL, "auto"),
536
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
537
  OBSOLETE("UseNTorHandshake"),
538
  V(User,                        STRING,   NULL),
539
  OBSOLETE("UserspaceIOCPBuffers"),
540
  V(AuthDirSharedRandomness,     BOOL,     "1"),
541
  V(AuthDirTestEd25519LinkKeys,  BOOL,     "1"),
542
  OBSOLETE("V1AuthoritativeDirectory"),
543
  OBSOLETE("V2AuthoritativeDirectory"),
544
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
545
546
547
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
548
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
549
550
551
552
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
553
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
554
  V(V3BandwidthsFile,            FILENAME, NULL),
555
  V(GuardfractionFile,           FILENAME, NULL),
556
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
557
  OBSOLETE("VoteOnHidServDirectoriesV2"),
558
559
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
560
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
561
562
  OBSOLETE("UseFilteringSSLBufferevents"),
  OBSOLETE("__UseFilteringSSLBufferevents"),
563
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
564
565
566
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
567
568
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
569
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
570
  VAR("__OwningControllerFD",INT,OwningControllerFD, "-1"),
571
  V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
572
573
574
575
576
577
578
579
580
581
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 60, 60, 120, "
                                 "300, 900, 2147483647"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 60, 300, 600, "
                                 "2147483647"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 1800, 1800, 1800, "
                                 "1800, 3600, 7200"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 3600, 3600, 3600, "
                                 "10800, 21600, 43200"),
582
  /* With the ClientBootstrapConsensus*Download* below:
583
   * Clients with only authorities will try:
584
585
   *  - at least 3 authorities over 10 seconds, then exponentially backoff,
   *    with the next attempt 3-21 seconds later,
586
   * Clients with authorities and fallbacks will try:
587
588
   *  - at least 2 authorities and 4 fallbacks over 21 seconds, then
   *    exponentially backoff, with the next attempts 4-33 seconds later,
589
   * Clients will also retry when an application request arrives.
590
   * After a number of failed requests, clients retry every 3 days + 1 hour.
591
592
593
594
595
596
   *
   * Clients used to try 2 authorities over 10 seconds, then wait for
   * 60 minutes or an application request.
   *
   * When clients have authorities and fallbacks available, they use these
   * schedules: (we stagger the times to avoid thundering herds) */
597
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
598
    "6, 11, 3600, 10800, 25200, 54000, 111600, 262800" /* 3 days + 1 hour */),
599
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
600
601
    "0, 1, 4, 11, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* When clients only have authorities available, they use this schedule: */
602
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
603
604
605
606
607
    "0, 3, 7, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* We don't want to overwhelm slow networks (or mirrors whose replies are
   * blocked), but we also don't want to fail if only some mirrors are
   * blackholed. Clients will try 3 directories simultaneously.
   * (Relays never use simultaneous connections.) */
608
  V(ClientBootstrapConsensusMaxInProgressTries, UINT, "3"),
609
610
  /* When a client has any running bridges, check each bridge occasionally,
    * whether or not that bridge is actually up. */
611
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL,
612
613
614
615
616
617
618
    "10800, 25200, 54000, 111600, 262800"),
  /* When a client is just starting, or has no running bridges, check each
   * bridge a few times quickly, and then try again later. These schedules
   * are much longer than the other schedules, because we try each and every
   * configured bridge with this schedule. */
  V(TestingBridgeBootstrapDownloadSchedule, CSV_INTERVAL,
    "0, 30, 90, 600, 3600, 10800, 25200, 54000, 111600, 262800"),
619
620
621
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
  V(TestingConsensusMaxDownloadTries, UINT, "8"),
622
623
  /* Since we try connections rapidly and simultaneously, we can afford
   * to give up earlier. (This protects against overloading directories.) */
624
  V(ClientBootstrapConsensusMaxDownloadTries, UINT, "7"),
625
  /* We want to give up much earlier if we're only using authorities. */
626
  V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "4"),
627
628
629
  V(TestingDescriptorMaxDownloadTries, UINT, "8"),
  V(TestingMicrodescMaxDownloadTries, UINT, "8"),
  V(TestingCertMaxDownloadTries, UINT, "8"),
630
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
631
  V(TestingDirAuthVoteExitIsStrict,  BOOL,     "0"),
632
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
633
  V(TestingDirAuthVoteGuardIsStrict,  BOOL,     "0"),
634
  V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
635
  V(TestingDirAuthVoteHSDirIsStrict,  BOOL,     "0"),
636
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
637

638
  END_OF_CONFIG_VARS
639
};
640

641
642
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
643
static const config_var_t testing_tor_network_defaults[] = {
644
645
646
647
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
648
649
650
651
652
653
654
655
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
    "0, 2, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusMaxDownloadTries, UINT, "80"),
  V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "80"),
656
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
657
  V(ClientRejectInternalAddresses, BOOL,   "0"),
658
  V(CountPrivateBandwidth,       BOOL,     "1"),
659
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
660
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
661
662
663
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
664
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
665
666
667
668
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
669
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
670
671
672
673
674
675
676
677
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 5, 10, 15, "
                                 "20, 30, 60"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, 15, 20, "
                                 "30, 60"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
678
679
680
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "10, 30, 60"),
  V(TestingBridgeBootstrapDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
681
682
683
684
685
686
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "5 seconds"),
  V(TestingDirConnectionMaxStall, INTERVAL, "30 seconds"),
  V(TestingConsensusMaxDownloadTries, UINT, "80"),
  V(TestingDescriptorMaxDownloadTries, UINT, "80"),
  V(TestingMicrodescMaxDownloadTries, UINT, "80"),
  V(TestingCertMaxDownloadTries, UINT, "80"),
687
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
688
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
689
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
690
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
691
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
692

693
  END_OF_CONFIG_VARS
694
};
695

696
#undef VAR
697
#undef V
698
699
#undef OBSOLETE

700
static const config_deprecation_t option_deprecation_notes_[] = {
701
  /* Deprecated since 0.3.2.0-alpha. */
702
703
704
705
  { "HTTPProxy", "It only applies to direct unencrypted HTTP connections "
    "to your directory server, which your Tor probably wasn't using." },
  { "HTTPProxyAuthenticator", "HTTPProxy is deprecated in favor of HTTPSProxy "
    "which should be used with HTTPSProxyAuthenticator." },
706
707
708
  /* End of options deprecated since 0.3.2.1-alpha */

  /* Options deprecated since 0.3.2.2-alpha */
709
710
711
712
  { "ReachableDirAddresses", "It has no effect on relays, and has had no "
    "effect on clients since 0.2.8." },
  { "ClientPreferIPv6DirPort", "It has no effect on relays, and has had no "
    "effect on clients since 0.2.8." },
713
  /* End of options deprecated since 0.3.2.2-alpha. */
714

715
716
717
  { NULL, NULL }
};

718
#ifdef _WIN32
719
720
static char *get_windows_conf_root(void);
#endif
721
722
723
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
724
                                      char **msg);
725
726
727
728
static int options_transition_affects_workers(
      const or_options_t *old_options, const or_options_t *new_options);
static int options_transition_affects_descriptor(
      const or_options_t *old_options, const or_options_t *new_options);
729
730
731
static int normalize_nickname_list(config_line_t **normalized_out,
                                   const config_line_t *lst, const char *name,
                                   char **msg);
732
733
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
734
static int parse_ports(or_options_t *options, int validate_only,
735
736
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
737
static int check_server_ports(const smartlist_t *ports,
738
739
                              const or_options_t *options,
                              int *num_low_ports_out);
740
static int validate_data_directories(or_options_t *options);
741
742
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);