config.c 272 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"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "connection_edge.h"
24
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "control.h"
26
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "dns.h"
31
#include "entrynodes.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "networkstatus.h"
36
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
38
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
39
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
40
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
41
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
42
#include "router.h"
43
#include "sandbox.h"
44
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
45
#include "routerlist.h"
46
#include "routerset.h"
47
#include "scheduler.h"
48
#include "statefile.h"
49
#include "transports.h"
50
#include "ext_orport.h"
51
#include "torgzip.h"
52
#ifdef _WIN32
53
54
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
55

56
57
#include "procmon.h"

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

68
/* Prefix used to indicate a Unix socket in a FooPort configuration. */
69
static const char unix_socket_prefix[] = "unix:";
70

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

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

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

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

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

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

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

363
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
364
365
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
366
  V(PidFile,                     STRING,   NULL),
367
  V(TestingTorNetwork,           BOOL,     "0"),
368
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
369
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
370

371
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
372
373
374
375
376
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

528
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
529
};
530

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

584
585
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
586

587
#undef VAR
588
#undef V
589
590
#undef OBSOLETE

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

  { NULL, NULL }
};

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

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

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

669
/** Magic value for or_options_t. */
670
671
#define OR_OPTIONS_MAGIC 9090909

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

684
685
686
687
688
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

730
731
/** 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
732
 * as necessary.  Returns 0 on success, -1 on failure.