config.c 257 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
311
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
312
  V(LogMessageDomains,           BOOL,     "0"),
313
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
Arlo Breault's avatar
Arlo Breault committed
314
  V(TruncateLogFile,             BOOL,     "0"),
Peter Palfrader's avatar
Peter Palfrader committed
315
  V(SyslogIdentityTag,           STRING,   NULL),
316
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
317
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
318
319
320
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
321
  V(MaxClientCircuitsPending,    UINT,     "32"),
322
  VAR("MaxMemInQueues",          MEMUNIT,   MaxMemInQueues_raw, "0"),
323
324
  OBSOLETE("MaxOnionsPending"),
  V(MaxOnionQueueDelay,          MSEC_INTERVAL, "1750 msec"),
325
  V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
326
327
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
328
  OBSOLETE("NamingAuthoritativeDirectory"),
329
  V(NATDListenAddress,           LINELIST, NULL),
330
  VPORT(NATDPort,                    LINELIST, NULL),
331
  V(Nickname,                    STRING,   NULL),
332
  V(PredictedPortsRelevanceTime,  INTERVAL, "1 hour"),
333
  V(WarnUnsafeSocks,              BOOL,     "1"),
334
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
335
  V(NumCPUs,                     UINT,     "0"),
336
  V(NumDirectoryGuards,          UINT,     "0"),
337
  V(NumEntryGuards,              UINT,     "0"),
Nick Mathewson's avatar
Nick Mathewson committed
338
  V(OfflineMasterKey,            BOOL,     "0"),
339
  V(ORListenAddress,             LINELIST, NULL),
340
  VPORT(ORPort,                      LINELIST, NULL),
341
  V(OutboundBindAddress,         LINELIST,   NULL),
342

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

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

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

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

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

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

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

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

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

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

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

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

590
/** Magic value for or_options_t. */
591
592
#define OR_OPTIONS_MAGIC 9090909

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

604
605
606
607
608
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

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

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

  if (old_options != global_options)
    config_free(&options_format, old_options);
710
711

  return 0;
712
713
}