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

54
55
56
57
58
#include "procmon.h"

/* From main.c */
extern int quiet_level;

59
60
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
61
static config_abbrev_t option_abbrevs_[] = {
62
63
64
65
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
66
  PLURAL(ExitNode),
67
  PLURAL(EntryNode),
68
69
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
70
  PLURAL(LongLivedPort),
71
72
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
73
  PLURAL(NumCPU),
74
75
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
76
77
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
78
  PLURAL(StrictNode),
79
  { "l", "Log", 1, 0},
80
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
81
82
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
83
84
85
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
86
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX024 later, make this warn? */
87
  { "MaxConn", "ConnLimit", 0, 1},
88
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
89
90
91
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
92
93
94
95
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
96
97
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
98
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
99
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
100
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
101
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
102
103
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
104
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
105
  { "_UseFilteringSSLBufferevents", "UseFilteringSSLBufferevents", 0, 1},
106
107
  { NULL, NULL, 0, 0},
};
108

Nick Mathewson's avatar
Nick Mathewson committed
109
110
111
112
/** 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>"
 */
113
114
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
115
      initvalue }
116
117
118
/** 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
119
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
120
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
121

122
123
124
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

Nick Mathewson's avatar
Nick Mathewson committed
125
126
127
128
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
129
static config_var_t option_vars_[] = {
130
  OBSOLETE("AccountingMaxKB"),
131
132
133
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
134
  V(AllowDotExit,                BOOL,     "0"),
135
136
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
137
138
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
139
140
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
141
  OBSOLETE("AlternateHSAuthority"),
142
  V(AssumeReachable,             BOOL,     "0"),
143
  V(AuthDirBadDir,               LINELIST, NULL),
144
  V(AuthDirBadDirCCs,            CSV,      ""),
145
  V(AuthDirBadExit,              LINELIST, NULL),
146
  V(AuthDirBadExitCCs,           CSV,      ""),
147
  V(AuthDirInvalid,              LINELIST, NULL),
148
  V(AuthDirInvalidCCs,           CSV,      ""),
149
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
150
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "2 MB"),
151
  V(AuthDirReject,               LINELIST, NULL),
152
  V(AuthDirRejectCCs,            CSV,      ""),
153
  OBSOLETE("AuthDirRejectUnlisted"),
154
  V(AuthDirListBadDirs,          BOOL,     "0"),
155
  V(AuthDirListBadExits,         BOOL,     "0"),
156
157
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
158
  V(AuthDirHasIPv6Connectivity,  BOOL,     "0"),
159
160
161
162
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
163
164
  V(BandwidthBurst,              MEMUNIT,  "1 GB"),
  V(BandwidthRate,               MEMUNIT,  "1 GB"),
165
166
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
167
  V(BridgePassword,              STRING,   NULL),
168
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
169
  V(BridgeRelay,                 BOOL,     "0"),
170
  V(CellStatistics,              BOOL,     "0"),
171
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
172
  V(CircuitBuildTimeout,         INTERVAL, "0"),
173
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
174
  V(CircuitStreamTimeout,        INTERVAL, "0"),
175
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
176
177
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
178
  V(ClientPreferIPv6ORPort,      BOOL,     "0"),
179
  V(ClientRejectInternalAddresses, BOOL,   "1"),
180
  V(ClientTransportPlugin,       LINELIST, NULL),
181
  V(ClientUseIPv6,               BOOL,     "0"),
182
  V(ConsensusParams,             STRING,   NULL),
183
  V(ConnLimit,                   UINT,     "1000"),
184
  V(ConnDirectionStatistics,     BOOL,     "0"),
185
186
187
188
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
189
  VPORT(ControlPort,                 LINELIST, NULL),
190
  V(ControlPortFileGroupReadable,BOOL,     "0"),
191
  V(ControlPortWriteToFile,      FILENAME, NULL),
192
  V(ControlSocket,               LINELIST, NULL),
193
  V(ControlSocketsGroupWritable, BOOL,     "0"),
194
195
196
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
197
  V(CountPrivateBandwidth,       BOOL,     "0"),
198
  V(DataDirectory,               FILENAME, NULL),
199
  OBSOLETE("DebugLogFile"),
200
  V(DisableNetwork,              BOOL,     "0"),
201
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
202
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
203
  V(DirListenAddress,            LINELIST, NULL),
204
  OBSOLETE("DirFetchPeriod"),
205
  V(DirPolicy,                   LINELIST, NULL),
206
  VPORT(DirPort,                     LINELIST, NULL),
207
  V(DirPortFrontPage,            FILENAME, NULL),
208
  OBSOLETE("DirPostPeriod"),
209
210
211
212
  OBSOLETE("DirRecordUsageByCountry"),
  OBSOLETE("DirRecordUsageGranularity"),
  OBSOLETE("DirRecordUsageRetainIPs"),
  OBSOLETE("DirRecordUsageSaveInterval"),
213
  V(DirReqStatistics,            BOOL,     "1"),
214
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
215
  V(DirAuthorityFallbackRate,    DOUBLE,   "1.0"),
216
  V(DisableAllSwap,              BOOL,     "0"),
217
  V(DisableDebuggerAttachment,   BOOL,     "1"),
218
  V(DisableIOCP,                 BOOL,     "1"),
219
  OBSOLETE("DisableV2DirectoryInfo_"),
220
  V(DynamicDHGroups,             BOOL,     "0"),
221
  VPORT(DNSPort,                     LINELIST, NULL),
222
223
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
224
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
225
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
226
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
227
  V(EnforceDistinctSubnets,      BOOL,     "1"),
228
  V(EntryNodes,                  ROUTERSET,   NULL),
229
  V(EntryStatistics,             BOOL,     "0"),
230
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
231
232
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
233
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
234
  V(ExitNodes,                   ROUTERSET, NULL),
235
236
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
237
  V(ExitPortStatistics,          BOOL,     "0"),
238
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
239
  VPORT(ExtORPort,               LINELIST, NULL),
240
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
241
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
242
  V(ExtraInfoStatistics,         BOOL,     "1"),
243
  V(FallbackDir,                 LINELIST, NULL),
244

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

335
  OBSOLETE("PathBiasDisableRate"),
336
337
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
338
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
339
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
340
  V(PathBiasScaleThreshold,      INT,      "-1"),
341
342
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
343
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
344
345
346
347
348
349
  OBSOLETE("PathBiasUseCloseCounts"),

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

351
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
352
  OBSOLETE("PathlenCoinWeight"),
353
354
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
355
  V(PidFile,                     STRING,   NULL),
356
  V(TestingTorNetwork,           BOOL,     "0"),
357
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
358
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
359
  V(OptimisticData,              AUTOBOOL, "auto"),
360
361
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
362
  OBSOLETE("PreferTunneledDirConns"),
363
  V(ProtocolWarnings,            BOOL,     "0"),
364
  V(PublishServerDescriptor,     CSV,      "1"),
365
366
367
368
369
370
371
  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),
372
  OBSOLETE("RedirectExit"),
373
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
374
  V(RejectPlaintextPorts,        CSV,      ""),
375
376
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
377
378
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
379
380
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
381
  OBSOLETE("RouterFile"),
382
  V(RunAsDaemon,                 BOOL,     "0"),
383
384
//  V(RunTesting,                  BOOL,     "0"),
  OBSOLETE("RunTesting"), // currently unused
385
  V(Sandbox,                     BOOL,     "0"),
386
  V(SafeLogging,                 STRING,   "1"),
387
  V(SafeSocks,                   BOOL,     "0"),
388
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
389
390
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
391
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
392
393
394
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
395
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
396
397
398
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
399
  VPORT(SocksPort,                   LINELIST, NULL),
400
  V(SocksTimeout,                INTERVAL, "2 minutes"),
401
  V(SSLKeyLifetime,              INTERVAL, "0"),
402
  OBSOLETE("StatusFetchPeriod"),
403
  V(StrictNodes,                 BOOL,     "0"),
404
  V(Support022HiddenServices,    AUTOBOOL, "auto"),
405
  OBSOLETE("SysLog"),
406
  V(TestSocks,                   BOOL,     "0"),
407
  OBSOLETE("TestVia"),
408
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
409
  V(Tor2webMode,                 BOOL,     "0"),
410
  V(TLSECGroup,                  STRING,   NULL),
411
412
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
413
  OBSOLETE("TrafficShaping"),
414
  V(TransListenAddress,          LINELIST, NULL),
415
  VPORT(TransPort,                   LINELIST, NULL),
416
  V(TransProxyType,              STRING,   "default"),
417
  OBSOLETE("TunnelDirConns"),
418
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
419
  V(UseBridges,                  BOOL,     "0"),
420
  V(UseEntryGuards,              BOOL,     "1"),
421
  V(UseEntryGuardsAsDirGuards,   BOOL,     "1"),
422
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
423
  V(UseNTorHandshake,            AUTOBOOL, "1"),
424
  V(User,                        STRING,   NULL),
425
  V(UserspaceIOCPBuffers,        BOOL,     "0"),
426
  OBSOLETE("V1AuthoritativeDirectory"),
427
  OBSOLETE("V2AuthoritativeDirectory"),
428
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
429
430
431
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
432
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
433
434
435
436
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
437
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
438
  V(V3BandwidthsFile,            FILENAME, NULL),
439
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
440
441
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
442
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
443
  V(UseFilteringSSLBufferevents, BOOL,    "0"),
444
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
445
446
447
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
448
449
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
450
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
451
  V(MinUptimeHidServDirectoryV2, INTERVAL, "25 hours"),
452
  V(VoteOnHidServDirectoriesV2,  BOOL,     "1"),
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
  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"),
470
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
471
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
472

473
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
474
};
475

476
477
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
478
static const config_var_t testing_tor_network_defaults[] = {
479
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
480
481
482
483
484
485
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
486
  V(ClientRejectInternalAddresses, BOOL,   "0"),
487
  V(CountPrivateBandwidth,       BOOL,     "1"),
488
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
489
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
490
491
492
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
493
494
495
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
496
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
497
498
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
499
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
  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"),
515
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
516
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
517
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
518
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
519

520
521
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
522

523
#undef VAR
524
#undef V
525
526
#undef OBSOLETE

527
#ifdef _WIN32
528
529
static char *get_windows_conf_root(void);
#endif
530
531
532
533
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,
534
                                      char **msg);
535
536
537
538
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);
539
static int check_nickname_list(char **lst, const char *name, char **msg);
540

541
542
static int parse_client_transport_line(const or_options_t *options,
                                       const char *line, int validate_only);
543

544
545
static int parse_server_transport_line(const or_options_t *options,
                                       const char *line, int validate_only);
546
547
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
548
static int parse_dir_authority_line(const char *line,
549
                                 dirinfo_type_t required_type,
550
                                 int validate_only);
551
552
static int parse_dir_fallback_line(const char *line,
                                   int validate_only);
553
static void port_cfg_free(port_cfg_t *port);
554
static int parse_ports(or_options_t *options, int validate_only,
555
                              char **msg_out, int *n_ports_out);
556
557
558
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

559
static int validate_data_directory(or_options_t *options);
560
561
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
562
563
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
564

565
static void init_libevent(const or_options_t *options);
566
static int opt_streq(const char *s1, const char *s2);
567
568
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
569
570
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
571
572
573
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
574
575
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
576

577
/** Magic value for or_options_t. */
578
579
#define OR_OPTIONS_MAGIC 9090909

580
/** Configuration format for or_options_t. */
581
STATIC config_format_t options_format = {
582
583
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
584
585
586
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
587
  options_validate_cb,
588
  NULL
589
590
};

591
592
593
594
595
/*
 * Functions to read and write the global options pointer.
 */

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

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

622
623
/** Return the currently configured options. */
or_options_t *
624
get_options_mutable(void)
625
{
626
627
628
  tor_assert(global_options);
  return global_options;
}
629

630
/** Returns the currently configured options */
631
632
MOCK_IMPL(const or_options_t *,
get_options,(void))
633
634
635
636
{
  return get_options_mutable();
}

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

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
677
678
679
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
680
681
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
Nick Mathewson's avatar
Nick Mathewson committed
682
            tor_free(line);
683
684
          }
        } else {
685
          smartlist_add(elements, tor_strdup(options_format.vars[i].name));
686
          smartlist_add(elements, NULL);
687
688
689
        }
      }
    }
690
    control_event_conf_changed(elements);
691
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
692
693
    smartlist_free(elements);
  }
694
695
696

  if (old_options != global_options)
    config_free(&options_format, old_options);
697
698

  return 0;
699
700
}

701
extern const char tor_git_revision[]; /* from tor_main.c */
702

703
/** The version of this Tor process, as parsed. */
704
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
705
706
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
707
static char *the_short_tor_version = NULL;
708

709
/** Return the current Tor version. */
710
711
712
const char *
get_version(void)
{
713
  if (the_tor_version == NULL) {
714
    if (strlen(tor_git_revision)) {
715
716
      tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
                   tor_git_revision);
Nick Mathewson's avatar