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

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

133
134
135
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

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

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

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

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

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

375
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
376
377
378
379
380
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

532
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
533
};
534

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

588
589
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
590

591
#undef VAR
592
#undef V
593
594
#undef OBSOLETE

595
static const config_deprecation_t option_deprecation_notes_[] = {
596
  /* Deprecated since 0.2.9.2-alpha... */
597
598
599
600
601
602
603
604
605
606
607
608
609
610
  { "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." },
611
  { "CloseHSClientCircuitsImmediatelyOnTimeout", "This option makes your "
612
    "client easier to fingerprint." },
613
  { "CloseHSServiceRendCircuitsImmediatelyOnTimeout", "This option makes "
614
615
616
617
618
619
620
621
622
623
624
625
626
627
    "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" },
628
  /* End of options deprecated since 0.2.9.2-alpha. */
629
630
631
632

  { NULL, NULL }
};

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

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

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

672
/** Magic value for or_options_t. */
673
674
#define OR_OPTIONS_MAGIC 9090909

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

687
688
689
690
691
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
692
static or_options_t *global_options = NULL;
693
694
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
695
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
696
/** Name of most recently read torrc file. */
697
static char *torrc_fname = NULL;
698
/** Name of the most recently read torrc-defaults file.*/
699
static char *torrc_defaults_fname;
700
/** Configuration options set by command line. */
701
static config_line_t *global_cmdline_options = NULL;
702
703
704
705
/** 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
706
/** Contents of most recently read DirPortFrontPage file. */
707
static char *global_dirfrontpagecontents = NULL;
708
709
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
710
711

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

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

726
/** Returns the currently configured options */
727
728
MOCK_IMPL(const or_options_t *,
get_options,(void))
729
730
731
732
{
  return get_options_mutable();
}

733
734
/** Change the current global options to contain <b>new_val</b> instead of
 * their current value; take action based on the new value; free the old value