config.c 259 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(DisableNetwork,              BOOL,     "0"),
216
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
217
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
218
219
  V(DirListenAddress,            LINELIST, NULL),
  V(DirPolicy,                   LINELIST, NULL),
220
  VPORT(DirPort,                     LINELIST, NULL),
221
  V(DirPortFrontPage,            FILENAME, NULL),
222
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
223
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
224
  V(DirAuthorityFallbackRate,    DOUBLE,   "1.0"),
225
  V(DisableAllSwap,              BOOL,     "0"),
226
  V(DisableDebuggerAttachment,   BOOL,     "1"),
227
  V(DisableIOCP,                 BOOL,     "1"),
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(ExitPortStatistics,          BOOL,     "0"),
247
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
248
  V(ExitRelay,                   AUTOBOOL, "auto"),
249
  VPORT(ExtORPort,               LINELIST, NULL),
250
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
251
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
252
  V(ExtraInfoStatistics,         BOOL,     "1"),
253
  V(FallbackDir,                 LINELIST, NULL),
254

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

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

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

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

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

374
  V(OptimisticData,              AUTOBOOL, "auto"),
375
376
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
377
  OBSOLETE("PreferTunneledDirConns"),
378
  V(ProtocolWarnings,            BOOL,     "0"),
379
  V(PublishServerDescriptor,     CSV,      "1"),
380
381
382
383
384
385
386
  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),
387
  V(RecommendedPackages,         LINELIST, NULL),
388
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
389
  V(RejectPlaintextPorts,        CSV,      ""),
390
391
392
393
394
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
395
  OBSOLETE("RunTesting"), // currently unused
396
  V(Sandbox,                     BOOL,     "0"),
397
  V(SafeLogging,                 STRING,   "1"),
398
  V(SafeSocks,                   BOOL,     "0"),
399
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
400
401
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
402
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
403
404
405
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
406
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
407
408
409
  V(SchedulerLowWaterMark__,     MEMUNIT,  "100 MB"),
  V(SchedulerHighWaterMark__,    MEMUNIT,  "101 MB"),
  V(SchedulerMaxFlushCells__,    UINT,     "1000"),
410
411
412
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
413
  VPORT(SocksPort,                   LINELIST, NULL),
414
  V(SocksTimeout,                INTERVAL, "2 minutes"),
415
  V(SSLKeyLifetime,              INTERVAL, "0"),
416
417
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
418
  V(StrictNodes,                 BOOL,     "0"),
419
  OBSOLETE("Support022HiddenServices"),
420
  V(TestSocks,                   BOOL,     "0"),
421
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
422
  V(Tor2webMode,                 BOOL,     "0"),
423
  V(Tor2webRendezvousPoints,      ROUTERSET, NULL),
424
  V(TLSECGroup,                  STRING,   NULL),
425
426
427
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
  V(TransListenAddress,          LINELIST, NULL),
428
  VPORT(TransPort,                   LINELIST, NULL),
429
  V(TransProxyType,              STRING,   "default"),
430
  OBSOLETE("TunnelDirConns"),
431
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
432
  V(UseBridges,                  BOOL,     "0"),
433
  V(UseEntryGuards,              BOOL,     "1"),
434
  V(UseEntryGuardsAsDirGuards,   BOOL,     "1"),
435
  V(UseGuardFraction,            AUTOBOOL, "auto"),
436
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
437
  V(UseNTorHandshake,            AUTOBOOL, "1"),
438
  V(User,                        STRING,   NULL),
439
  V(UserspaceIOCPBuffers,        BOOL,     "0"),
440
  OBSOLETE("V1AuthoritativeDirectory"),
441
  OBSOLETE("V2AuthoritativeDirectory"),
442
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
443
444
445
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
446
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
447
448
449
450
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
451
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
452
  V(V3BandwidthsFile,            FILENAME, NULL),
453
  V(GuardfractionFile,           FILENAME, NULL),
454
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
455
  OBSOLETE("VoteOnHidServDirectoriesV2"),
456
457
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
458
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
459
  V(UseFilteringSSLBufferevents, BOOL,    "0"),
460
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
461
462
463
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
464
465
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
466
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
467
  V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
  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"),
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "3600, 900, 900, 3600"),
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
  V(TestingConsensusMaxDownloadTries, UINT, "8"),
  V(TestingDescriptorMaxDownloadTries, UINT, "8"),
  V(TestingMicrodescMaxDownloadTries, UINT, "8"),
  V(TestingCertMaxDownloadTries, UINT, "8"),
485
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
486
  V(TestingDirAuthVoteExitIsStrict,  BOOL,     "0"),
487
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
488
  V(TestingDirAuthVoteGuardIsStrict,  BOOL,     "0"),
489
  V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
490
  V(TestingDirAuthVoteHSDirIsStrict,  BOOL,     "0"),
491
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
492

493
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
494
};
495

496
497
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
498
static const config_var_t testing_tor_network_defaults[] = {
499
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
500
501
502
503
504
505
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
506
  V(ClientRejectInternalAddresses, BOOL,   "0"),
507
  V(CountPrivateBandwidth,       BOOL,     "1"),
508
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
509
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
510
511
512
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
513
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
514
515
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
516
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
517
518
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
519
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
  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"),
535
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
536
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
537
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
538
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
539
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
540

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

544
#undef VAR
545
#undef V
546
547
#undef OBSOLETE

548
#ifdef _WIN32
549
550
static char *get_windows_conf_root(void);
#endif
551
552
553
554
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,
555
                                      char **msg);
556
557
558
559
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);
560
static int check_nickname_list(char **lst, const char *name, char **msg);
561
562
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
563
static int parse_dir_authority_line(const char *line,
564
                                 dirinfo_type_t required_type,
565
                                 int validate_only);
566
static void port_cfg_free(port_cfg_t *port);
567
static int parse_ports(or_options_t *options, int validate_only,
568
569
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
570
static int check_server_ports(const smartlist_t *ports,
571
572
                              const or_options_t *options,
                              int *num_low_ports_out);
573

574
static int validate_data_directory(or_options_t *options);
575
576
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
577
578
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
579

580
static void init_libevent(const or_options_t *options);
581
static int opt_streq(const char *s1, const char *s2);
582
583
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
584
585
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
586
587
588
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
589
590
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
591

592
/** Magic value for or_options_t. */
593
594
#define OR_OPTIONS_MAGIC 9090909

595
/** Configuration format for or_options_t. */
596
STATIC config_format_t options_format = {
597
598
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
599
600
601
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
602
  options_validate_cb,
603
  NULL
604
605
};

606
607
608
609
610
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
611
static or_options_t *global_options = NULL;
612
613
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
614
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
615
/** Name of most recently read torrc file. */
616
static char *torrc_fname = NULL;
617
/** Name of the most recently read torrc-defaults file.*/
618
static char *torrc_defaults_fname;
619
/** Configuration options set by command line. */
620
static config_line_t *global_cmdline_options = NULL;
621
622
623
624
/** 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
625
/** Contents of most recently read DirPortFrontPage file. */
626
static char *global_dirfrontpagecontents = NULL;
627
628
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
629
630

/** Return the contents of our frontpage string, or NULL if not configured. */
631
632
MOCK_IMPL(const char*,
get_dirportfrontpage, (void))
633
634
635
{
  return global_dirfrontpagecontents;
}
636

637
638
/** Return the currently configured options. */
or_options_t *
639
get_options_mutable(void)
640
{
641
642
643
  tor_assert(global_options);
  return global_options;
}
644

645
/** Returns the currently configured options */
646
647
MOCK_IMPL(const or_options_t *,
get_options,(void))
648
649
650
651
{
  return get_options_mutable();
}

652
653
/** 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
654
 * as necessary.  Returns 0 on success, -1 on failure.
655
 */
656
int
657
set_options(or_options_t *new_val, char **msg)
658
{
659
660
661
  int i;
  smartlist_t *elements;
  config_line_t *line;
662
  or_options_t *old_options = global_options;
663
  global_options = new_val;
664
665
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
666
667
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
668
669
670
    global_options = old_options;
    return -1;
  }
671
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
672
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
673
            "Acting on config options left us in a broken state. Dying.");
674
675
    exit(1);
  }
676
677
  /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
   * just starting up then the old_options will be undefined. */
678
  if (old_options && old_options != global_options) {
679
    elements = smartlist_new();
680
    for (i=0; options_format.vars[i].name; ++i) {
681
682
      const config_var_t *var = &options_format.vars[i];
      const char *var_name = var->name;
683
684
685
686
      if (var->type == CONFIG_TYPE_LINELIST_S ||
          var->type == CONFIG_TYPE_OBSOLETE) {
        continue;
      }
687
688
689
      if (!config_is_same(&options_format, new_val, old_options, var_name)) {
        line = config_get_assigned_option(&options_format, new_val,
                                          var_name, 1);
690
691

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
692
693
694
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
695
696
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
Nick Mathewson's avatar
Nick Mathewson committed
697
            tor_free(line);
698
699
          }
        } else {
700
          smartlist_add(elements, tor_strdup(options_format.vars[i].name));
701
          smartlist_add(elements, NULL);
702
703
704
        }
      }
    }
705
    control_event_conf_changed(elements);
706
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
707
708
    smartlist_free(elements);
  }
709
710
711

  if (old_options != global_options)
    config_free(&options_format, old_options);
712
713

  return 0;
Roger Dingledine's avatar