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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return 0;
711
712
}

713
extern const char tor_git_revision[]; /* from tor_main.c */
714

715
/** The version of this Tor process, as parsed. */
716
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
717
718
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */