config.c 290 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

Nick Mathewson's avatar
Nick Mathewson committed
177
178
179
180
/** 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>"
 */
181
#define VAR(name,conftype,member,initvalue)                             \
Neel Chauhan's avatar
Neel Chauhan committed
182
  { name, CONFIG_TYPE_ ## conftype, offsetof(or_options_t, member),     \
183
      initvalue }
184
185
186
/** 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
187
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
188
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
189

190
191
192
193
194
195
196
197
198
199
200
/**
 * 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)
201

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

327
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
328

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

426
  OBSOLETE("PathBiasDisableRate"),
427
428
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
429
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
430
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
431
  V(PathBiasScaleThreshold,      INT,      "-1"),
432
433
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
434
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
435
436
437
438
439
440
  OBSOLETE("PathBiasUseCloseCounts"),

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

442
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
443
444
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
445
  V(PidFile,                     STRING,   NULL),
446
  V(TestingTorNetwork,           BOOL,     "0"),
447
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
448
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
449

450
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
451
452
453
454
455
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

624
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
625
};
626

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

679
680
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
681

682
#undef VAR
683
#undef V
684
685
#undef OBSOLETE

686
static const config_deprecation_t option_deprecation_notes_[] = {
Nick Mathewson's avatar
Nick Mathewson committed
687
  /* Deprecated since 0.3.2.0-alpha. */
688
689
690
691
  { "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." },
692
693
694
695
  { "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." },
Nick Mathewson's avatar
Nick Mathewson committed
696
  /* End of options deprecated since 0.3.2.0-alpha. */
697

698
699
700
  { NULL, NULL }
};

701
#ifdef _WIN32
702
703
static char *get_windows_conf_root(void);
#endif
704
705
706
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,
707
                                      char **msg);
708
709
710
711
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);
712
713
714
static int normalize_nickname_list(config_line_t **normalized_out,
                                   const config_line_t *lst, const char *name,
                                   char **msg);
715
716
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
717
static int parse_ports(or_options_t *options, int validate_only,
718
719
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
720
static int check_server_ports(const smartlist_t *ports,
721
722
                              const or_options_t *options,
                              int *num_low_ports_out);
723

724
static int validate_data_directory(or_options_t *options);
725
726
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
727
728
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
729

730
static void init_libevent(const or_options_t *options);
731
static int opt_streq(const char *s1, const char *s2);
732
733
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
734
735
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
736
737
738
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
739
740
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);