config.c 270 KB
Newer Older
1
/* Copyright (c) 2001 Matej Pfajfar.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
Nick Mathewson's avatar
Nick Mathewson committed
4
 * Copyright (c) 2007-2016, The Tor Project, Inc. */
5
/* See LICENSE for licensing information */
6

Nick Mathewson's avatar
Nick Mathewson committed
7
/**
8
9
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
10
11
 **/

12
#define CONFIG_PRIVATE
Roger Dingledine's avatar
Roger Dingledine committed
13
#include "or.h"
14
#include "compat.h"
15
#include "addressmap.h"
16
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "circuitlist.h"
19
20
#include "circuitmux.h"
#include "circuitmux_ewma.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "connection_edge.h"
24
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "control.h"
26
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "dns.h"
31
#include "entrynodes.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "networkstatus.h"
36
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
38
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
39
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
40
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
41
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
42
#include "router.h"
43
#include "sandbox.h"
44
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
45
#include "routerlist.h"
46
#include "routerset.h"
47
#include "scheduler.h"
48
#include "statefile.h"
49
#include "transports.h"
50
#include "ext_orport.h"
51
#include "torgzip.h"
52
#ifdef _WIN32
53
54
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
55

56
57
#include "procmon.h"

58
59
60
61
62
63
64
65
66
67
#ifdef HAVE_SYSTEMD
#   if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
/* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
 * Coverity. Here's a kludge to unconfuse it.
 */
#   define __INCLUDE_LEVEL__ 2
#   endif
#include <systemd/sd-daemon.h>
#endif

68
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
194
  V(ClientPreferIPv6ORPort,      AUTOBOOL, "auto"),
  V(ClientPreferIPv6DirPort,     AUTOBOOL, "auto"),
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(DirCache,                    BOOL,     "1"),
228
229
230
231
232
233
234
235
  /* A DirAuthorityFallbackRate of 0.1 means that 0.5% of clients try an
   * authority when all fallbacks are up, and 2% try an authority when 25% of
   * fallbacks are down. (We rebuild the list when 25% of fallbacks are down).
   *
   * We want to reduce load on authorities, but keep these two figures within
   * an order of magnitude, so there isn't too much load shifting to authorities
   * when fallbacks go down. */
  V(DirAuthorityFallbackRate,    DOUBLE,   "0.1"),
236
  V(DisableAllSwap,              BOOL,     "0"),
237
  V(DisableDebuggerAttachment,   BOOL,     "1"),
238
  V(DisableIOCP,                 BOOL,     "1"),
239
  OBSOLETE("DisableV2DirectoryInfo_"),
240
  OBSOLETE("DynamicDHGroups"),
241
  VPORT(DNSPort,                     LINELIST, NULL),
242
243
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
244
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
245
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
246
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
247
  V(EnforceDistinctSubnets,      BOOL,     "1"),
248
  V(EntryNodes,                  ROUTERSET,   NULL),
249
  V(EntryStatistics,             BOOL,     "0"),
250
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
251
252
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
253
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
254
  V(ExitNodes,                   ROUTERSET, NULL),
255
256
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
257
  V(ExitPortStatistics,          BOOL,     "0"),
258
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
259
  V(ExitRelay,                   AUTOBOOL, "auto"),
260
  VPORT(ExtORPort,               LINELIST, NULL),
261
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
262
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
263
  V(ExtraInfoStatistics,         BOOL,     "1"),
264
  V(FallbackDir,                 LINELIST, NULL),
265
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
266

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

356
  OBSOLETE("PathBiasDisableRate"),
357
358
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
359
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
360
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
361
  V(PathBiasScaleThreshold,      INT,      "-1"),
362
363
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
364
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
365
366
367
368
369
370
  OBSOLETE("PathBiasUseCloseCounts"),

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

372
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
373
374
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
375
  V(PidFile,                     STRING,   NULL),
376
  V(TestingTorNetwork,           BOOL,     "0"),
377
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
378
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
379

380
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
381
382
383
384
385
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

535
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
536
};
537

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

591
592
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
593

594
#undef VAR
595
#undef V
596
597
#undef OBSOLETE

598
#ifdef _WIN32
599
600
static char *get_windows_conf_root(void);
#endif
601
602
603
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
604
                                      char **msg);
605
606
607
608
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);
609
static int check_nickname_list(char **lst, const char *name, char **msg);
610
611
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
612
static int parse_ports(or_options_t *options, int validate_only,
613
614
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
615
static int check_server_ports(const smartlist_t *ports,
616
617
                              const or_options_t *options,
                              int *num_low_ports_out);
618

619
static int validate_data_directory(or_options_t *options);
620
621
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
622
623
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
624

625
static void init_libevent(const or_options_t *options);
626
static int opt_streq(const char *s1, const char *s2);
627
628
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
629
630
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
631
632
633
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
634
635
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
636

637
/** Magic value for or_options_t. */
638
639
#define OR_OPTIONS_MAGIC 9090909

640
/** Configuration format for or_options_t. */
641
STATIC config_format_t options_format = {
642
643
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
644
645
646
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
647
  options_validate_cb,
648
  NULL
649
650
};

651
652
653
654
655
/*
 * Functions to read and write the global options pointer.
 */

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

/** Return the contents of our frontpage string, or NULL if not configured. */
676
677
MOCK_IMPL(const char*,
get_dirportfrontpage, (void))
678
679
680
{
  return global_dirfrontpagecontents;
}
681

Ola Bini's avatar
Ola Bini committed
682
683
684
/** Returns the currently configured options. */
MOCK_IMPL(or_options_t *,
get_options_mutable, (void))
685
{
686
687
688
  tor_assert(global_options);
  return global_options;
}
689

690
/** Returns the currently configured options */
691
692
MOCK_IMPL(const or_options_t *,
get_options,(void))
693
694
695
696
{
  return get_options_mutable();
}

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