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
/* 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
230
231
232
233
  /* A DirAuthorityFallbackRate of 0.1 means that 0.5% of clients try an
   * authority when all fallbacks are up, and 2% try an authority when 25% of
   * fallbacks are down. (We rebuild the list when 25% of fallbacks are down).
   *
   * We want to reduce load on authorities, but keep these two figures within
Nick Mathewson's avatar
Nick Mathewson committed
234
235
   * an order of magnitude, so there isn't too much load shifting to
   * authorities when fallbacks go down. */
236
  V(DirAuthorityFallbackRate,    DOUBLE,   "0.1"),
237
  V(DisableAllSwap,              BOOL,     "0"),
238
  V(DisableDebuggerAttachment,   BOOL,     "1"),
239
  OBSOLETE("DisableIOCP"),
240
  OBSOLETE("DisableV2DirectoryInfo_"),
241
  OBSOLETE("DynamicDHGroups"),
242
  VPORT(DNSPort,                     LINELIST, NULL),
243
244
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
245
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
246
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
247
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
248
  V(EnforceDistinctSubnets,      BOOL,     "1"),
249
  V(EntryNodes,                  ROUTERSET,   NULL),
250
  V(EntryStatistics,             BOOL,     "0"),
251
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
252
253
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
254
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
255
  V(ExitNodes,                   ROUTERSET, NULL),
256
257
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
258
  V(ExitPolicyRejectLocalInterfaces, BOOL, "0"),
259
  V(ExitPortStatistics,          BOOL,     "0"),
260
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
261
  V(ExitRelay,                   AUTOBOOL, "auto"),
262
  VPORT(ExtORPort,               LINELIST, NULL),
263
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
264
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
265
  V(ExtraInfoStatistics,         BOOL,     "1"),
266
  V(FallbackDir,                 LINELIST, NULL),
267
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
268

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

361
  OBSOLETE("PathBiasDisableRate"),
362
363
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
364
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
365
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
366
  V(PathBiasScaleThreshold,      INT,      "-1"),
367
368
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
369
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
370
371
372
373
374
375
  OBSOLETE("PathBiasUseCloseCounts"),

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

377
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
378
379
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
380
  V(PidFile,                     STRING,   NULL),
381
  V(TestingTorNetwork,           BOOL,     "0"),
382
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
383
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
384

385
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
386
387
388
389
390
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

542
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
543
};
544

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

598
599
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
600

601
#undef VAR
602
#undef V
603
604
#undef OBSOLETE

605
static const config_deprecation_t option_deprecation_notes_[] = {
606
  /* Deprecated since 0.2.9.2-alpha... */
607
608
609
610
611
612
613
614
615
616
617
618
619
620
  { "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." },
621
  { "CloseHSClientCircuitsImmediatelyOnTimeout", "This option makes your "
622
    "client easier to fingerprint." },
623
  { "CloseHSServiceRendCircuitsImmediatelyOnTimeout", "This option makes "
624
625
626
627
628
629
630
631
632
633
634
635
636
637
    "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" },
638
  /* End of options deprecated since 0.2.9.2-alpha. */
639
640
641
642

  { NULL, NULL }
};

643
#ifdef _WIN32
644
645
static char *get_windows_conf_root(void);
#endif
646
647
648
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,
649
                                      char **msg);
650
651
652
653
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);
654
static int check_nickname_list(char **lst, const char *name, char **msg);
655
656
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
657
static int parse_ports(or_options_t *options, int validate_only,
658
659
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
660
static int check_server_ports(const smartlist_t *ports,
661
662
                              const or_options_t *options,
                              int *num_low_ports_out);
663

664
static int validate_data_directory(or_options_t *options);
665
666
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
667
668
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
669

670
static void init_libevent(const or_options_t *options);
671
static int opt_streq(const char *s1, const char *s2);
672
673
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
674
675
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
676
677
678
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
679
680
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
681

682
/** Magic value for or_options_t. */
683
684
#define OR_OPTIONS_MAGIC 9090909

685
/** Configuration format for or_options_t. */
686
STATIC config_format_t options_format = {
687
688
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
689
690
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
691
  option_deprecation_notes_,
692
  option_vars_,
693
  options_validate_cb,
694
  NULL
695
696
};

697
698
699
700
701
/*
 * Functions to read and write the global options pointer.
 */

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

/** Return the contents of our frontpage string, or NULL if not configured. */
722
723
MOCK_IMPL(const char*,
get_dirportfrontpage, (void))
724
725
726
{
  return global_dirfrontpagecontents;
}
727

Ola Bini's avatar
Ola Bini committed
728
729
730
/** Returns the currently configured options. */
MOCK_IMPL(or_options_t *,
get_options_mutable, (void))
731
{
732
733
734
  tor_assert(global_options);
  return global_options;
}