config.c 285 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
117
118
119
120
#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

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

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

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

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

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

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

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

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

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

447
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
448
449
450
451
452
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

612
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
613
};
614

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

669
670
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
671

672
#undef VAR
673
#undef V
674
675
#undef OBSOLETE

676
static const config_deprecation_t option_deprecation_notes_[] = {
677
  /* Deprecated since 0.2.9.2-alpha... */
678
679
680
681
  { "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." },
682
  /* End of options deprecated since 0.2.9.2-alpha. */
683

Nick Mathewson's avatar
Nick Mathewson committed
684
  /* Deprecated since 0.3.2.0-alpha. */
685
686
687
688
  { "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
689
  /* End of options deprecated since 0.3.2.0-alpha. */
690

691
692
693
  { NULL, NULL }
};

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

717
static int validate_data_directory(or_options_t *options);
718
719
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
720
721
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
722

723
static void init_libevent(const or_options_t *options);
724
static int opt_streq(const char *s1, const char *s2);
725
726
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
727
728
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
729
730
731
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
732
733
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
734

735
/** Magic value for or_options_t. */
736
737
#define OR_OPTIONS_MAGIC 9090909

738
/** Configuration format for or_options_t. */
739
STATIC config_format_t options_format = {
Nick Mathewson's avatar