config.c 267 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(ClientPreferIPv6DirPort,     BOOL,     "0"),
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(DisableNetwork,              BOOL,     "0"),
219
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
220
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
221
222
  V(DirListenAddress,            LINELIST, NULL),
  V(DirPolicy,                   LINELIST, NULL),
223
  VPORT(DirPort,                     LINELIST, NULL),
224
  V(DirPortFrontPage,            FILENAME, NULL),
225
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
226
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
227
  V(DirAuthorityFallbackRate,    DOUBLE,   "1.0"),
228
  V(DisableAllSwap,              BOOL,     "0"),
229
  V(DisableDebuggerAttachment,   BOOL,     "1"),
230
  V(DisableIOCP,                 BOOL,     "1"),
231
  OBSOLETE("DisableV2DirectoryInfo_"),
232
  OBSOLETE("DynamicDHGroups"),
233
  VPORT(DNSPort,                     LINELIST, NULL),
234
235
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
236
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
237
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
238
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
239
  V(EnforceDistinctSubnets,      BOOL,     "1"),
240
  V(EntryNodes,                  ROUTERSET,   NULL),
241
  V(EntryStatistics,             BOOL,     "0"),
242
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
243
244
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
245
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
246
  V(ExitNodes,                   ROUTERSET, NULL),
247
248
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
249
  V(ExitPortStatistics,          BOOL,     "0"),
250
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
251
  V(ExitRelay,                   AUTOBOOL, "auto"),
252
  VPORT(ExtORPort,               LINELIST, NULL),
253
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
254
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
255
  V(ExtraInfoStatistics,         BOOL,     "1"),
256
  V(FallbackDir,                 LINELIST, NULL),
257
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
258

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

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

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

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

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

378
  V(OptimisticData,              AUTOBOOL, "auto"),
379
380
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
381
  OBSOLETE("PreferTunneledDirConns"),
382
  V(ProtocolWarnings,            BOOL,     "0"),
383
  V(PublishServerDescriptor,     CSV,      "1"),
384
385
386
387
388
389
390
  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),
391
  V(RecommendedPackages,         LINELIST, NULL),
392
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
393
  V(RejectPlaintextPorts,        CSV,      ""),
394
395
396
397
398
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
399
  OBSOLETE("RunTesting"), // currently unused
400
  V(Sandbox,                     BOOL,     "0"),
401
  V(SafeLogging,                 STRING,   "1"),
402
  V(SafeSocks,                   BOOL,     "0"),
403
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
404
405
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
406
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
407
408
409
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
410
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
411
412
413
  V(SchedulerLowWaterMark__,     MEMUNIT,  "100 MB"),
  V(SchedulerHighWaterMark__,    MEMUNIT,  "101 MB"),
  V(SchedulerMaxFlushCells__,    UINT,     "1000"),
414
415
416
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
417
  VPORT(SocksPort,                   LINELIST, NULL),
418
  V(SocksTimeout,                INTERVAL, "2 minutes"),
419
  V(SSLKeyLifetime,              INTERVAL, "0"),
420
421
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
422
  V(StrictNodes,                 BOOL,     "0"),
423
  OBSOLETE("Support022HiddenServices"),
424
  V(TestSocks,                   BOOL,     "0"),
425
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
426
  V(Tor2webMode,                 BOOL,     "0"),
427
  V(Tor2webRendezvousPoints,      ROUTERSET, NULL),
428
  V(TLSECGroup,                  STRING,   NULL),
429
430
431
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
  V(TransListenAddress,          LINELIST, NULL),
432
  VPORT(TransPort,                   LINELIST, NULL),
433
  V(TransProxyType,              STRING,   "default"),
434
  OBSOLETE("TunnelDirConns"),
435
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
436
  V(UseBridges,                  BOOL,     "0"),
437
  V(UseEntryGuards,              BOOL,     "1"),
438
  V(UseEntryGuardsAsDirGuards,   BOOL,     "1"),
439
  V(UseGuardFraction,            AUTOBOOL, "auto"),
440
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
441
  V(UseNTorHandshake,            AUTOBOOL, "1"),
442
  V(User,                        STRING,   NULL),
443
  V(UserspaceIOCPBuffers,        BOOL,     "0"),
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
  V(UseFilteringSSLBufferevents, BOOL,    "0"),
464
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
465
466
467
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
468
469
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
470
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
471
  V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
472
473
474
475
476
477
478
479
480
481
  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"),
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
  /* 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"),
507
508
509
510
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "3600, 900, 900, 3600"),
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
  V(TestingConsensusMaxDownloadTries, UINT, "8"),
511
512
513
514
515
  /* 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"),
516
517
518
  V(TestingDescriptorMaxDownloadTries, UINT, "8"),
  V(TestingMicrodescMaxDownloadTries, UINT, "8"),
  V(TestingCertMaxDownloadTries, UINT, "8"),
519
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
520
  V(TestingDirAuthVoteExitIsStrict,  BOOL,     "0"),
521
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
522
  V(TestingDirAuthVoteGuardIsStrict,  BOOL,     "0"),
523
  V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
524
  V(TestingDirAuthVoteHSDirIsStrict,  BOOL,     "0"),
525
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
526

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

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

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

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

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

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

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

630
/** Magic value for or_options_t. */
631
632
#define OR_OPTIONS_MAGIC 9090909

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

644
645
646
647
648
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

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

        if (line) {
Nick Mathewson's avatar