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.
Nick Mathewson's avatar
Nick Mathewson committed
4
 * Copyright (c) 2007-2016, The Tor Project, Inc. */
5
/* See LICENSE for licensing information */
6

Nick Mathewson's avatar
Nick Mathewson committed
7
/**
8
9
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
10
11
 **/

12
#define CONFIG_PRIVATE
Roger Dingledine's avatar
Roger Dingledine committed
13
#include "or.h"
14
#include "compat.h"
15
#include "addressmap.h"
16
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "circuitlist.h"
19
20
#include "circuitmux.h"
#include "circuitmux_ewma.h"
21
#include "circuitstats.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "connection_edge.h"
25
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "control.h"
27
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "dns.h"
32
#include "entrynodes.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
36
#include "networkstatus.h"
37
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
38
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
39
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
40
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
41
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
42
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
43
#include "router.h"
44
#include "sandbox.h"
45
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
46
#include "routerlist.h"
47
#include "routerset.h"
48
#include "scheduler.h"
49
#include "statefile.h"
50
#include "transports.h"
51
#include "ext_orport.h"
52
#include "torgzip.h"
53
#ifdef _WIN32
54
55
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
56

57
58
#include "procmon.h"

59
60
61
62
63
64
65
66
67
68
#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

69
/* Prefix used to indicate a Unix socket in a FooPort configuration. */
70
static const char unix_socket_prefix[] = "unix:";
71
72
73
/* Prefix used to indicate a Unix socket with spaces in it, in a FooPort
 * configuration. */
static const char unix_q_socket_prefix[] = "unix:\"";
74

75
76
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
77
static config_abbrev_t option_abbrevs_[] = {
78
79
80
81
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
82
  PLURAL(EntryNode),
83
  PLURAL(ExcludeNode),
84
  PLURAL(Tor2webRendezvousPoint),
85
  PLURAL(FirewallPort),
86
  PLURAL(LongLivedPort),
87
88
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
89
  PLURAL(NumCPU),
90
  PLURAL(RendNode),
91
  PLURAL(RecommendedPackage),
92
  PLURAL(RendExcludeNode),
93
94
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
95
  PLURAL(StrictNode),
96
  { "l", "Log", 1, 0},
97
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
98
99
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
100
101
102
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
103
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX later, make this warn? */
104
  { "MaxConn", "ConnLimit", 0, 1},
105
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
106
107
108
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
109
110
111
112
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
113
114
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
115
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
116
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
117
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
118
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
119
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
120
121
  { NULL, NULL, 0, 0},
};
122

Nick Mathewson's avatar
Nick Mathewson committed
123
124
125
126
/** 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>"
 */
127
128
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
129
      initvalue }
130
131
132
/** 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
133
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
134
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
135

136
137
138
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

Nick Mathewson's avatar
Nick Mathewson committed
139
140
141
142
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
143
static config_var_t option_vars_[] = {
144
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
145
  VAR("AccountingRule",          STRING,   AccountingRule_option,  "max"),
146
147
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
148
  V(AllowDotExit,                BOOL,     "0"),
149
150
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
151
152
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
153
154
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
155
  OBSOLETE("AlternateHSAuthority"),
156
  V(AssumeReachable,             BOOL,     "0"),
157
158
  OBSOLETE("AuthDirBadDir"),
  OBSOLETE("AuthDirBadDirCCs"),
159
  V(AuthDirBadExit,              LINELIST, NULL),
160
  V(AuthDirBadExitCCs,           CSV,      ""),
161
  V(AuthDirInvalid,              LINELIST, NULL),
162
  V(AuthDirInvalidCCs,           CSV,      ""),
163
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
164
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "2 MB"),
165
  V(AuthDirPinKeys,              BOOL,     "0"),
166
  V(AuthDirReject,               LINELIST, NULL),
167
  V(AuthDirRejectCCs,            CSV,      ""),
168
  OBSOLETE("AuthDirRejectUnlisted"),
169
  OBSOLETE("AuthDirListBadDirs"),
170
  V(AuthDirListBadExits,         BOOL,     "0"),
171
172
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
173
  V(AuthDirHasIPv6Connectivity,  BOOL,     "0"),
174
175
176
177
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
178
179
  V(BandwidthBurst,              MEMUNIT,  "1 GB"),
  V(BandwidthRate,               MEMUNIT,  "1 GB"),
180
181
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
182
  V(BridgePassword,              STRING,   NULL),
183
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
184
  V(BridgeRelay,                 BOOL,     "0"),
185
  V(CellStatistics,              BOOL,     "0"),
186
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
187
  V(CircuitBuildTimeout,         INTERVAL, "0"),
188
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
189
  V(CircuitStreamTimeout,        INTERVAL, "0"),
190
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
191
192
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
193
194
  V(ClientPreferIPv6ORPort,      AUTOBOOL, "auto"),
  V(ClientPreferIPv6DirPort,     AUTOBOOL, "auto"),
195
  V(ClientRejectInternalAddresses, BOOL,   "1"),
196
  V(ClientTransportPlugin,       LINELIST, NULL),
197
  V(ClientUseIPv6,               BOOL,     "0"),
198
  V(ClientUseIPv4,               BOOL,     "1"),
199
  V(ConsensusParams,             STRING,   NULL),
200
  V(ConnLimit,                   UINT,     "1000"),
201
  V(ConnDirectionStatistics,     BOOL,     "0"),
202
203
204
205
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
206
  VPORT(ControlPort,                 LINELIST, NULL),
207
  V(ControlPortFileGroupReadable,BOOL,     "0"),
208
  V(ControlPortWriteToFile,      FILENAME, NULL),
209
  V(ControlSocket,               LINELIST, NULL),
210
  V(ControlSocketsGroupWritable, BOOL,     "0"),
211
  V(SocksSocketsGroupWritable,   BOOL,     "0"),
212
213
214
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
215
  V(CountPrivateBandwidth,       BOOL,     "0"),
216
  V(DataDirectory,               FILENAME, NULL),
217
  V(DataDirectoryGroupReadable,  BOOL,     "0"),
218
  V(DisableOOSCheck,             BOOL,     "1"),
219
  V(DisableNetwork,              BOOL,     "0"),
220
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
221
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
222
223
  V(DirListenAddress,            LINELIST, NULL),
  V(DirPolicy,                   LINELIST, NULL),
224
  VPORT(DirPort,                     LINELIST, NULL),
225
  V(DirPortFrontPage,            FILENAME, NULL),
226
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
227
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
228
  V(DirCache,                    BOOL,     "1"),
229
  V(DirAuthorityFallbackRate,    DOUBLE,   "1.0"),
230
  V(DisableAllSwap,              BOOL,     "0"),
231
  V(DisableDebuggerAttachment,   BOOL,     "1"),
232
  OBSOLETE("DisableIOCP"),
233
  OBSOLETE("DisableV2DirectoryInfo_"),
234
  OBSOLETE("DynamicDHGroups"),
235
  VPORT(DNSPort,                     LINELIST, NULL),
236
237
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
238
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
239
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
240
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
241
  V(EnforceDistinctSubnets,      BOOL,     "1"),
242
  V(EntryNodes,                  ROUTERSET,   NULL),
243
  V(EntryStatistics,             BOOL,     "0"),
244
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
245
246
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
247
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
248
  V(ExitNodes,                   ROUTERSET, NULL),
249
250
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
251
  V(ExitPolicyRejectLocalInterfaces, BOOL, "0"),
252
  V(ExitPortStatistics,          BOOL,     "0"),
253
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
254
  V(ExitRelay,                   AUTOBOOL, "auto"),
255
  VPORT(ExtORPort,               LINELIST, NULL),
256
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
257
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
258
  V(ExtraInfoStatistics,         BOOL,     "1"),
259
  V(FallbackDir,                 LINELIST, NULL),
260
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
261

262
  OBSOLETE("FallbackNetworkstatusFile"),
263
264
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
265
  V(FastFirstHopPK,              AUTOBOOL, "auto"),
266
  V(FetchDirInfoEarly,           BOOL,     "0"),
267
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
268
269
270
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
271
  OBSOLETE("FetchV2Networkstatus"),
272
  V(GeoIPExcludeUnknown,         AUTOBOOL, "auto"),
273
#ifdef _WIN32
274
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
275
  V(GeoIPv6File,                 FILENAME, "<default>"),
276
#else
277
278
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
279
280
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
281
#endif
282
  OBSOLETE("Group"),
283
  V(GuardLifetime,               INTERVAL, "0 minutes"),
284
  V(HardwareAccel,               BOOL,     "0"),
285
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
286
287
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
288
  V(HashedControlPassword,       LINELIST, NULL),
289
  OBSOLETE("HidServDirectoryV2"),
Nick Mathewson's avatar
Nick Mathewson committed
290
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
291
  VAR("HiddenServiceDirGroupReadable",  LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
292
293
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
294
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
295
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
296
  VAR("HiddenServiceAllowUnknownPorts",LINELIST_S, RendConfigLines, NULL),
297
298
  VAR("HiddenServiceMaxStreams",LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceMaxStreamsCloseCircuit",LINELIST_S, RendConfigLines, NULL),
299
  VAR("HiddenServiceNumIntroductionPoints", LINELIST_S, RendConfigLines, NULL),
300
  V(HiddenServiceStatistics,     BOOL,     "1"),
301
  V(HidServAuth,                 LINELIST, NULL),
302
  V(CloseHSClientCircuitsImmediatelyOnTimeout, BOOL, "0"),
303
  V(CloseHSServiceRendCircuitsImmediatelyOnTimeout, BOOL, "0"),
304
305
  V(HiddenServiceSingleHopMode,  BOOL,     "0"),
  V(HiddenServiceNonAnonymousMode,BOOL,    "0"),
306
307
308
309
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
310
  V(IPv6Exit,                    BOOL,     "0"),
311
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
312
  V(ServerTransportListenAddr,   LINELIST, NULL),
313
  V(ServerTransportOptions,      LINELIST, NULL),
314
  V(SigningKeyLifetime,          INTERVAL, "30 days"),
315
316
317
318
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
319
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
320
  V(KeepBindCapabilities,            AUTOBOOL, "auto"),
321
  VAR("Log",                     LINELIST, Logs,             NULL),
322
  V(LogMessageDomains,           BOOL,     "0"),
323
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
Arlo Breault's avatar
Arlo Breault committed
324
  V(TruncateLogFile,             BOOL,     "0"),
Peter Palfrader's avatar
Peter Palfrader committed
325
  V(SyslogIdentityTag,           STRING,   NULL),
326
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
327
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
328
329
330
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
331
  V(MaxClientCircuitsPending,    UINT,     "32"),
332
  VAR("MaxMemInQueues",          MEMUNIT,   MaxMemInQueues_raw, "0"),
333
334
  OBSOLETE("MaxOnionsPending"),
  V(MaxOnionQueueDelay,          MSEC_INTERVAL, "1750 msec"),
335
  V(MaxUnparseableDescSizeToLog, MEMUNIT, "10 MB"),
336
  V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
337
338
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
339
  OBSOLETE("NamingAuthoritativeDirectory"),
340
  V(NATDListenAddress,           LINELIST, NULL),
341
  VPORT(NATDPort,                    LINELIST, NULL),
342
  V(Nickname,                    STRING,   NULL),
343
  V(PredictedPortsRelevanceTime,  INTERVAL, "1 hour"),
344
  V(WarnUnsafeSocks,              BOOL,     "1"),
345
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
346
  V(NumCPUs,                     UINT,     "0"),
347
  V(NumDirectoryGuards,          UINT,     "0"),
348
  V(NumEntryGuards,              UINT,     "0"),
Nick Mathewson's avatar
Nick Mathewson committed
349
  V(OfflineMasterKey,            BOOL,     "0"),
350
  V(ORListenAddress,             LINELIST, NULL),
351
  VPORT(ORPort,                      LINELIST, NULL),
352
  V(OutboundBindAddress,         LINELIST,   NULL),
353

354
  OBSOLETE("PathBiasDisableRate"),
355
356
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
357
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
358
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
359
  V(PathBiasScaleThreshold,      INT,      "-1"),
360
361
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
362
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
363
364
365
366
367
368
  OBSOLETE("PathBiasUseCloseCounts"),

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

370
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
371
372
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
373
  V(PidFile,                     STRING,   NULL),
374
  V(TestingTorNetwork,           BOOL,     "0"),
375
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
376
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
377

378
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
379
380
381
382
383
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

384
  V(OptimisticData,              AUTOBOOL, "auto"),
385
386
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
387
  OBSOLETE("PreferTunneledDirConns"),
388
  V(ProtocolWarnings,            BOOL,     "0"),
389
  V(PublishServerDescriptor,     CSV,      "1"),
390
391
392
393
394
395
396
  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),
397
  V(RecommendedPackages,         LINELIST, NULL),
398
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
399
  V(RejectPlaintextPorts,        CSV,      ""),
400
401
402
403
404
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
405
  OBSOLETE("RunTesting"), // currently unused
406
  V(Sandbox,                     BOOL,     "0"),
407
  V(SafeLogging,                 STRING,   "1"),
408
  V(SafeSocks,                   BOOL,     "0"),
409
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
410
411
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
412
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
413
414
415
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
416
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
417
418
419
  V(SchedulerLowWaterMark__,     MEMUNIT,  "100 MB"),
  V(SchedulerHighWaterMark__,    MEMUNIT,  "101 MB"),
  V(SchedulerMaxFlushCells__,    UINT,     "1000"),
420
421
422
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
423
  VPORT(SocksPort,                   LINELIST, NULL),
424
  V(SocksTimeout,                INTERVAL, "2 minutes"),
425
  V(SSLKeyLifetime,              INTERVAL, "0"),
426
427
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
428
  V(StrictNodes,                 BOOL,     "0"),
429
  OBSOLETE("Support022HiddenServices"),
430
  V(TestSocks,                   BOOL,     "0"),
431
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
432
  V(Tor2webMode,                 BOOL,     "0"),
433
  V(Tor2webRendezvousPoints,      ROUTERSET, NULL),
434
  V(TLSECGroup,                  STRING,   NULL),
435
436
437
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
  V(TransListenAddress,          LINELIST, NULL),
438
  VPORT(TransPort,                   LINELIST, NULL),
439
  V(TransProxyType,              STRING,   "default"),
440
  OBSOLETE("TunnelDirConns"),
441
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
442
  V(UseBridges,                  BOOL,     "0"),
443
  VAR("UseEntryGuards",          BOOL,     UseEntryGuards_option, "1"),
444
  V(UseEntryGuardsAsDirGuards,   BOOL,     "1"),
445
  V(UseGuardFraction,            AUTOBOOL, "auto"),
446
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
447
  OBSOLETE("UseNTorHandshake"),
448
  V(User,                        STRING,   NULL),
449
  OBSOLETE("UserspaceIOCPBuffers"),
450
  V(AuthDirSharedRandomness,     BOOL,     "1"),
451
  OBSOLETE("V1AuthoritativeDirectory"),
452
  OBSOLETE("V2AuthoritativeDirectory"),
453
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
454
455
456
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
457
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
458
459
460
461
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
462
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
463
  V(V3BandwidthsFile,            FILENAME, NULL),
464
  V(GuardfractionFile,           FILENAME, NULL),
465
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
466
  OBSOLETE("VoteOnHidServDirectoriesV2"),
467
468
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
469
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
470
471
  OBSOLETE("UseFilteringSSLBufferevents"),
  OBSOLETE("__UseFilteringSSLBufferevents"),
472
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
473
474
475
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
476
477
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
478
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
479
  V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
480
481
482
483
484
485
486
487
488
489
  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"),
490
  /* With the ClientBootstrapConsensus*Download* below:
491
492
493
494
495
496
497
498
499
500
501
502
   * Clients with only authorities will try:
   *  - 3 authorities over 10 seconds, then wait 60 minutes.
   * Clients with authorities and fallbacks will try:
   *  - 2 authorities and 4 fallbacks over 21 seconds, then wait 60 minutes.
   * Clients will also retry when an application request arrives.
   * After a number of failed reqests, clients retry every 3 days + 1 hour.
   *
   * 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) */
503
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
504
    "10, 11, 3600, 10800, 25200, 54000, 111600, 262800" /* 3 days + 1 hour */),
505
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
506
507
    "0, 1, 4, 11, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* When clients only have authorities available, they use this schedule: */
508
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
509
510
511
512
513
    "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.) */
514
  V(ClientBootstrapConsensusMaxInProgressTries, UINT, "3"),
515
516
517
518
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "3600, 900, 900, 3600"),
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
  V(TestingConsensusMaxDownloadTries, UINT, "8"),
519
520
  /* Since we try connections rapidly and simultaneously, we can afford
   * to give up earlier. (This protects against overloading directories.) */
521
  V(ClientBootstrapConsensusMaxDownloadTries, UINT, "7"),
522
  /* We want to give up much earlier if we're only using authorities. */
523
  V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "4"),
524
525
526
  V(TestingDescriptorMaxDownloadTries, UINT, "8"),
  V(TestingMicrodescMaxDownloadTries, UINT, "8"),
  V(TestingCertMaxDownloadTries, UINT, "8"),
527
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
528
  V(TestingDirAuthVoteExitIsStrict,  BOOL,     "0"),
529
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
530
  V(TestingDirAuthVoteGuardIsStrict,  BOOL,     "0"),
531
  V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
532
  V(TestingDirAuthVoteHSDirIsStrict,  BOOL,     "0"),
533
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
534

535
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
536
};
537

538
539
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
540
static const config_var_t testing_tor_network_defaults[] = {
541
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
542
543
544
545
546
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
547
548
549
550
551
552
553
554
  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"),
555
  V(ClientDNSRejectInternalAddresses, BOOL,"0"), // deprecated in 0.2.9.2-alpha
556
  V(ClientRejectInternalAddresses, BOOL,   "0"),
557
  V(CountPrivateBandwidth,       BOOL,     "1"),
558
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
559
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
560
561
562
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
563
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
564
565
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
566
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
567
568
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
569
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
  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"),
585
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
586
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
587
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
588
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
589
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
590

591
592
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
593

594
#undef VAR
595
#undef V
596
597
#undef OBSOLETE

598
static const config_deprecation_t option_deprecation_notes_[] = {
599
  /* Deprecated since 0.2.9.2-alpha... */
600
601
602
603
604
605
606
607
608
609
610
611
612
613
  { "AllowDotExit", "Unrestricted use of the .exit notation can be used for "
    "a wide variety of application-level attacks." },
  { "AllowInvalidNodes", "There is no reason to enable this option; at best "
    "it will make you easier to track." },
  { "AllowSingleHopCircuits", "Almost no relays actually allow single-hop "
    "exits, making this option pointless." },
  { "AllowSingleHopExits", "Turning this on will make your relay easier "
    "to abuse." },
  { "ClientDNSRejectInternalAddresses", "Turning this on makes your client "
    "easier to fingerprint, and may open you to esoteric attacks." },
  { "ExcludeSingleHopRelays", "Turning it on makes your client easier to "
    "fingerprint." },
  { "FastFirstHopPK", "Changing this option does not make your client more "
    "secure, but does make it easier to fingerprint." },
614
  { "CloseHSClientCircuitsImmediatelyOnTimeout", "This option makes your "
615
    "client easier to fingerprint." },
616
  { "CloseHSServiceRendCircuitsImmediatelyOnTimeout", "This option makes "
617
618
619
620
621
622
623
624
625
626
627
628
629
630
    "your hidden services easier to fingerprint." },
  { "WarnUnsafeSocks", "Changing this option makes it easier for you "
    "to accidentally lose your anonymity by leaking DNS information" },
  { "TLSECGroup", "The default is a nice secure choice; the other option "
    "is less secure." },
  { "ControlListenAddress", "Use ControlPort instead." },
  { "DirListenAddress", "Use DirPort instead, possibly with the "
    "NoAdvertise sub-option" },
  { "DNSListenAddress", "Use DNSPort instead." },
  { "SocksListenAddress", "Use SocksPort instead." },
  { "TransListenAddress", "Use TransPort instead." },
  { "NATDListenAddress", "Use NATDPort instead." },
  { "ORListenAddress", "Use ORPort instead, possibly with the "
    "NoAdvertise sub-option" },
631
  /* End of options deprecated since 0.2.9.2-alpha. */
632
633
634
635

  { NULL, NULL }
};

636
#ifdef _WIN32
637
638
static char *get_windows_conf_root(void);
#endif
639
640
641
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,
642
                                      char **msg);
643
644
645
646
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);
647
static int check_nickname_list(char **lst, const char *name, char **msg);
648
649
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
650
static int parse_ports(or_options_t *options, int validate_only,
651
652
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
653
static int check_server_ports(const smartlist_t *ports,
654
655
                              const or_options_t *options,
                              int *num_low_ports_out);
656

657
static int validate_data_directory(or_options_t *options);
658
659
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
660
661
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
662

663
static void init_libevent(const or_options_t *options);
664
static int opt_streq(const char *s1, const char *s2);
665
666
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
667
668
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
669
670
671
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
672
673
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
674

675
/** Magic value for or_options_t. */
676
677
#define OR_OPTIONS_MAGIC 9090909

678
/** Configuration format for or_options_t. */
679
STATIC config_format_t options_format = {
680
681
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
682
683
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
684
  option_deprecation_notes_,
685
  option_vars_,
686
  options_validate_cb,
687
  NULL
688
689
};

690
691
692
693
694
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
695
static or_options_t *global_options = NULL;
696
697
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
698
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
699
/** Name of most recently read torrc file. */
700
static char *torrc_fname = NULL;
701
/** Name of the most recently read torrc-defaults file.*/
702
static char *torrc_defaults_fname;
703
/** Configuration options set by command line. */
704
static config_line_t *global_cmdline_options = NULL;
705
706
707
708
/** Non-configuration options set by the command line */
static config_line_t *global_cmdline_only_options = NULL;
/** Boolean: Have we parsed the command line? */
static int have_parsed_cmdline = 0;
Roger Dingledine's avatar
Roger Dingledine committed
709
/** Contents of most recently read DirPortFrontPage file. */
710
static char *global_dirfrontpagecontents = NULL;
711
712
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
713
714

/** Return the contents of our frontpage string, or NULL if not configured. */
715
716
MOCK_IMPL(const char*,
get_dirportfrontpage, (void))
717
718
719
{
  return global_dirfrontpagecontents;
}
720

Ola Bini's avatar
Ola Bini committed
721
722
723
/** Returns the currently configured options. */
MOCK_IMPL(or_options_t *,
get_options_mutable, (void))
724
{
725
726
727
  tor_assert(global_options);
  return global_options;
}
728

729
/** Returns the currently configured options */
730
731
MOCK_IMPL(const or_options_t *,
get_options,(void))
732
733
734
735