config.c 284 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"
Sebastian Hahn's avatar
Sebastian Hahn committed
94
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
95
#include "router.h"
96
#include "sandbox.h"
97
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
98
#include "routerlist.h"
99
#include "routerset.h"
100
#include "scheduler.h"
101
#include "statefile.h"
102
#include "transports.h"
103
#include "ext_orport.h"
104
#ifdef _WIN32
105
106
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
107

108
109
#include "procmon.h"

110
111
112
113
114
115
116
117
118
119
#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
#   endif
#include <systemd/sd-daemon.h>
#endif

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

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

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

187
188
189
190
191
192
193
194
195
196
197
/**
 * 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)
198

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

324
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
325

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

420
  OBSOLETE("PathBiasDisableRate"),
421
422
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
423
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
424
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
425
  V(PathBiasScaleThreshold,      INT,      "-1"),
426
427
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
428
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
429
430
431
432
433
434
  OBSOLETE("PathBiasUseCloseCounts"),

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

436
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
437
438
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
439
  V(PidFile,                     STRING,   NULL),
440
  V(TestingTorNetwork,           BOOL,     "0"),
441
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
442
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
443

444
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
445
446
447
448
449
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

606
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
607
};
608

609
610
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
611
static const config_var_t testing_tor_network_defaults[] = {
612
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
613
614
615
616
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
617
618
619
620
621
622
623
624
  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"),
625
  V(ClientDNSRejectInternalAddresses, BOOL,"0"), // deprecated in 0.2.9.2-alpha
626
  V(ClientRejectInternalAddresses, BOOL,   "0"),
627
  V(CountPrivateBandwidth,       BOOL,     "1"),
628
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
629
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
630
631
632
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
633
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
634
635
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
636
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
637
638
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
639
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
  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"),
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "60, 30, 30, 60"),
  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"),
655
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
656
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
657
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
658
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
659
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
660

661
662
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
663

664
#undef VAR
665
#undef V
666
667
#undef OBSOLETE

668
static const config_deprecation_t option_deprecation_notes_[] = {
669
  /* Deprecated since 0.2.9.2-alpha... */
670
671
672
673
  { "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." },
674
  /* End of options deprecated since 0.2.9.2-alpha. */
675

Nick Mathewson's avatar
Nick Mathewson committed
676
  /* Deprecated since 0.3.2.0-alpha. */
677
678
679
680
  { "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." },
Nick Mathewson's avatar
Nick Mathewson committed
681
  /* End of options deprecated since 0.3.2.0-alpha. */
682

683
684
685
  { NULL, NULL }
};

686
#ifdef _WIN32
687
688
static char *get_windows_conf_root(void);
#endif
689
690
691
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,
692
                                      char **msg);
693
694
695
696
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);
697
698
699
static int normalize_nickname_list(config_line_t **normalized_out,
                                   const config_line_t *lst, const char *name,
                                   char **msg);
700
701
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
702
static int parse_ports(or_options_t *options, int validate_only,
703
704
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
705
static int check_server_ports(const smartlist_t *ports,
706
707
                              const or_options_t *options,
                              int *num_low_ports_out);
708

709
static int validate_data_directory(or_options_t *options);
710
711
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
712
713
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
714

715
static void init_libevent(const or_options_t *options);
716
static int opt_streq(const char *s1, const char *s2);
717
718
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
719
720
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
721
722
723
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
724
725
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
726

727
/** Magic value for or_options_t. */
728
729
#define OR_OPTIONS_MAGIC 9090909

730
/** Configuration format for or_options_t. */
731
STATIC config_format_t options_format = {
732
733
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
734
735
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
736
  option_deprecation_notes_,
737
  option_vars_,