config.c 265 KB
Newer Older
1
/* Copyright (c) 2001 Matej Pfajfar.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2015, 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
69
70
/* From main.c */
extern int quiet_level;

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

74
75
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
76
static config_abbrev_t option_abbrevs_[] = {
77
78
79
80
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
81
  PLURAL(EntryNode),
82
  PLURAL(ExcludeNode),
83
  PLURAL(Tor2webRendezvousPoint),
84
  PLURAL(FirewallPort),
85
  PLURAL(LongLivedPort),
86
87
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
88
  PLURAL(NumCPU),
89
  PLURAL(RendNode),
90
  PLURAL(RecommendedPackage),
91
  PLURAL(RendExcludeNode),
92
93
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
94
  PLURAL(StrictNode),
95
  { "l", "Log", 1, 0},
96
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
97
98
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
99
100
101
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
102
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX024 later, make this warn? */
103
  { "MaxConn", "ConnLimit", 0, 1},
104
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
105
106
107
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
108
109
110
111
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
112
113
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
114
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
115
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
116
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
117
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
118
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
119
  { "_UseFilteringSSLBufferevents", "UseFilteringSSLBufferevents", 0, 1},
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
  V(ClientPreferIPv6ORPort,      BOOL,     "0"),
194
  V(ClientRejectInternalAddresses, BOOL,   "1"),
195
  V(ClientTransportPlugin,       LINELIST, NULL),
196
  V(ClientUseIPv6,               BOOL,     "0"),
197
  V(ConsensusParams,             STRING,   NULL),
198
  V(ConnLimit,                   UINT,     "1000"),
199
  V(ConnDirectionStatistics,     BOOL,     "0"),
200
201
202
203
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
204
  VPORT(ControlPort,                 LINELIST, NULL),
205
  V(ControlPortFileGroupReadable,BOOL,     "0"),
206
  V(ControlPortWriteToFile,      FILENAME, NULL),
207
  V(ControlSocket,               LINELIST, NULL),
208
  V(ControlSocketsGroupWritable, BOOL,     "0"),
209
  V(SocksSocketsGroupWritable,   BOOL,     "0"),
210
211
212
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
213
  V(CountPrivateBandwidth,       BOOL,     "0"),
214
  V(DataDirectory,               FILENAME, NULL),
215
  V(DataDirectoryGroupReadable,  BOOL,     "0"),
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(DirAuthorityFallbackRate,    DOUBLE,   "1.0"),
226
  V(DisableAllSwap,              BOOL,     "0"),
227
  V(DisableDebuggerAttachment,   BOOL,     "1"),
228
  V(DisableIOCP,                 BOOL,     "1"),
229
  OBSOLETE("DisableV2DirectoryInfo_"),
230
  OBSOLETE("DynamicDHGroups"),
231
  VPORT(DNSPort,                     LINELIST, NULL),
232
233
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
234
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
235
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
236
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
237
  V(EnforceDistinctSubnets,      BOOL,     "1"),
238
  V(EntryNodes,                  ROUTERSET,   NULL),
239
  V(EntryStatistics,             BOOL,     "0"),
240
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
241
242
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
243
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
244
  V(ExitNodes,                   ROUTERSET, NULL),
245
246
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
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(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
329
330
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
331
  OBSOLETE("NamingAuthoritativeDirectory"),
332
  V(NATDListenAddress,           LINELIST, NULL),
333
  VPORT(NATDPort,                    LINELIST, NULL),
334
  V(Nickname,                    STRING,   NULL),
335
  V(PredictedPortsRelevanceTime,  INTERVAL, "1 hour"),
336
  V(WarnUnsafeSocks,              BOOL,     "1"),
337
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
338
  V(NumCPUs,                     UINT,     "0"),
339
  V(NumDirectoryGuards,          UINT,     "0"),
340
  V(NumEntryGuards,              UINT,     "0"),
Nick Mathewson's avatar
Nick Mathewson committed
341
  V(OfflineMasterKey,            BOOL,     "0"),
342
  V(ORListenAddress,             LINELIST, NULL),
343
  VPORT(ORPort,                      LINELIST, NULL),
344
  V(OutboundBindAddress,         LINELIST,   NULL),
345

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

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

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

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

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

525
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
526
};
527

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

581
582
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
583

584
#undef VAR
585
#undef V
586
587
#undef OBSOLETE

588
#ifdef _WIN32
589
590
static char *get_windows_conf_root(void);
#endif
591
592
593
594
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_act(const or_options_t *old_options);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
595
                                      char **msg);
596
597
598
599
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);
600
static int check_nickname_list(char **lst, const char *name, char **msg);
601
602
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
603
static int parse_ports(or_options_t *options, int validate_only,
604
605
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
606
static int check_server_ports(const smartlist_t *ports,
607
608
                              const or_options_t *options,
                              int *num_low_ports_out);
609

610
static int validate_data_directory(or_options_t *options);
611
612
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
613
614
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
615

616
static void init_libevent(const or_options_t *options);
617
static int opt_streq(const char *s1, const char *s2);
618
619
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
620
621
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
622
623
624
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
625
626
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
627

628
/** Magic value for or_options_t. */
629
630
#define OR_OPTIONS_MAGIC 9090909

631
/** Configuration format for or_options_t. */
632
STATIC config_format_t options_format = {
633
634
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
635
636
637
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
638
  options_validate_cb,
639
  NULL
640
641
};

642
643
644
645
646
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
647
static or_options_t *global_options = NULL;
648
649
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
650
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
651
/** Name of most recently read torrc file. */
652
static char *torrc_fname = NULL;
653
/** Name of the most recently read torrc-defaults file.*/
654
static char *torrc_defaults_fname;
655
/** Configuration options set by command line. */
656
static config_line_t *global_cmdline_options = NULL;
657
658
659
660
/** 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
661
/** Contents of most recently read DirPortFrontPage file. */
662
static char *global_dirfrontpagecontents = NULL;
663
664
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
665
666

/** Return the contents of our frontpage string, or NULL if not configured. */
667
668
MOCK_IMPL(const char*,
get_dirportfrontpage, (void))
669
670
671
{
  return global_dirfrontpagecontents;
}
672

673
674
/** Return the currently configured options. */
or_options_t *
675
get_options_mutable(void)
676
{
677
678
679
  tor_assert(global_options);
  return global_options;
}
680

681
/** Returns the currently configured options */
682
683
MOCK_IMPL(const or_options_t *,
get_options,(void))
684
685
686
687
{
  return get_options_mutable();
}

688
689
/** 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
690
 * as necessary.  Returns 0 on success, -1 on failure.
691
 */
692
int
693
set_options(or_options_t *new_val, char **msg)
694
{
695
696
697
  int i;
  smartlist_t *elements;
  config_line_t *line;
698
  or_options_t *old_options = global_options;
699
  global_options = new_val;
700
701
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
702
703
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
704
705
706
    global_options = old_options;
    return -1;
  }
707
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
708
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
709
            "Acting on config options left us in a broken state. Dying.");
710
711
    exit(1);
  }
712
713
  /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
   * just starting up then the old_options will be undefined. */
714
  if (old_options && old_options != global_options) {
715
    elements = smartlist_new();
716
    for (i=0; options_format.vars[i].name; ++i) {
717
718
      const config_var_t *var = &options_format.vars[i];
      const char *var_name = var->name;
719
720
721
722
      if (var->type == CONFIG_TYPE_LINELIST_S ||
          var->type == CONFIG_TYPE_OBSOLETE) {
        continue;
      }
723
724
725
      if (!config_is_same(&options_format, new_val, old_options, var_name)) {
        line = config_get_assigned_option(&options_format, new_val,
                                          var_name, 1);
726
727

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
728
729
730
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
731
732
            smartlist_add(