config.c 294 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"
Sebastian Hahn's avatar
Sebastian Hahn committed
85
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
86
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
87
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
88
#include "networkstatus.h"
89
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
90
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
91
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
92
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
93
#include "rendservice.h"
94
#include "hs_config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
95
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
96
#include "router.h"
97
#include "sandbox.h"
98
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
99
#include "routerlist.h"
100
#include "routerset.h"
101
#include "scheduler.h"
102
#include "statefile.h"
103
#include "transports.h"
104
#include "ext_orport.h"
105
#ifdef _WIN32
106
107
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
108

109
110
#include "procmon.h"

111
112
113
114
115
116
#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
117
#endif /* defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__) */
118
#include <systemd/sd-daemon.h>
119
#endif /* defined(HAVE_SYSTEMD) */
120

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

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

177
178
179
180
/** 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
181
182
183
184
/** 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>"
 */
185
#define VAR(name,conftype,member,initvalue)                             \
Neel Chauhan's avatar
Neel Chauhan committed
186
  { name, CONFIG_TYPE_ ## conftype, offsetof(or_options_t, member),     \
187
      initvalue CONF_TEST_MEMBERS(or_options_t, conftype, member) }
188
189
190
/** 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
191
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
192
193
194
#ifdef TOR_UNIT_TESTS
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL, {.INT=NULL} }
#else
195
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
196
#endif
197

198
199
200
201
202
203
204
205
206
207
208
/**
 * 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)
209

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

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

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

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

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

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

459
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
460
461
462
463
464
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

633
  END_OF_CONFIG_VARS
634
};
635

636
637
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
638
static const config_var_t testing_tor_network_defaults[] = {
639
640
641
642
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
643
644
645
646
647
648
649
650
  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"),
651
  V(TestingClientDNSRejectInternalAddresses, BOOL,"0"),
652
  V(ClientRejectInternalAddresses, BOOL,   "0"),
653
  V(CountPrivateBandwidth,       BOOL,     "1"),
654
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
655
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
656
657
658
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
659
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
660
661
662
663
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
664
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
665
666
667
668
669
670
671
672
  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"),
673
674
675
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "10, 30, 60"),
  V(TestingBridgeBootstrapDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
676
677
678
679
680
681
  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"),
682
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
683
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
684
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
685
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
686
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
687

688
  END_OF_CONFIG_VARS
689
};
690

691
#undef VAR
692
#undef V
693
694
#undef OBSOLETE

695
static const config_deprecation_t option_deprecation_notes_[] = {
696
  /* Deprecated since 0.3.2.1-alpha. */
697
698
699
700
  { "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." },
701
702
703
  /* End of options deprecated since 0.3.2.1-alpha */

  /* Options deprecated since 0.3.2.2-alpha */
704
705
706
707
  { "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." },
708
  /* End of options deprecated since 0.3.2.2-alpha. */
709

710
711
712
  { NULL, NULL }
};

713
#ifdef _WIN32
714
715
static char *get_windows_conf_root(void);
#endif
716
717
718
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,
719
                                      char **msg);
720
721
722
723
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);
724
725
726
static int normalize_nickname_list(config_line_t **normalized_out,
                                   const config_line_t *lst, const char *name,
                                   char **msg);
727
728
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
729
static int parse_ports(or_options_t *options, int validate_only,
730
731
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
732
static int check_server_ports(const smartlist_t *ports,
733
734
                              const or_options_t *options,
                              int *num_low_ports_out);
735
static int validate_data_directory(or_options_t *options);
736
737
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
738
739
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
740

741
static void init_libevent(const or_options_t *options);
742
static int opt_streq(const char *s1, const char *s2);