config.c 293 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
  { NULL, NULL, 0, 0},
};
174

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

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

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

334
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
335

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

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

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

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

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

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

631
  END_OF_CONFIG_VARS
632
};
633

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

686
  END_OF_CONFIG_VARS
687
};
688

689
#undef VAR
690
#undef V
691
692
#undef OBSOLETE

693
static const config_deprecation_t option_deprecation_notes_[] = {
694
695
696
697
698
699
700
701
  /* Deprecated since 0.2.9.2-alpha... */
  { "AllowDotExit", "Unrestricted use of the .exit notation can be used for "
    "a wide variety of application-level attacks." },
  { "ClientDNSRejectInternalAddresses", "Turning this on makes your client "
    "easier to fingerprint, and may open you to esoteric attacks." },
  /* End of options deprecated since 0.2.9.2-alpha. */

  /* 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_directory(or_options_t *options);
741
742
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
743
744
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
745

746
static void init_libevent(const or_options_t *options);
747
static int opt_streq(const char *s1, const char *s2);
Linus Nordberg's avatar