config.c 233 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,  "250 KB"),
151
  V(AuthDirReject,               LINELIST, NULL),
152
  V(AuthDirRejectCCs,            CSV,      ""),
153
  V(AuthDirRejectUnlisted,       BOOL,     "0"),
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(ExtraInfoStatistics,         BOOL,     "1"),
241
  V(FallbackDir,                 LINELIST, NULL),
242

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

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

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

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

470
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
471
};
472

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

517
518
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
519

520
#undef VAR
521
#undef V
522
523
#undef OBSOLETE

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

George Kadianakis's avatar
George Kadianakis committed
538
static int parse_client_transport_line(const char *line, int validate_only);
539
540

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

554
static int validate_data_directory(or_options_t *options);
555
556
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
557
static int options_init_logs(or_options_t *options, int validate_only);
558

559
static void init_libevent(const or_options_t *options);
560
static int opt_streq(const char *s1, const char *s2);
561
562
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
563
564
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
565
566
567
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
568

569
/** Magic value for or_options_t. */
570
571
#define OR_OPTIONS_MAGIC 9090909

572
/** Configuration format for or_options_t. */
573
STATIC config_format_t options_format = {
574
575
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
576
577
578
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
579
  options_validate_cb,
580
  NULL
581
582
};

583
584
585
586
587
/*
 * Functions to read and write the global options pointer.
 */

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

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

614
615
/** Return the currently configured options. */
or_options_t *
616
get_options_mutable(void)
617
{
618
619
620
  tor_assert(global_options);
  return global_options;
}
621

622
623
624
625
626
627
628
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

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

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
669
670
671
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
672
673
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
Nick Mathewson's avatar
Nick Mathewson committed
674
            tor_free(line);
675
676
          }
        } else {
677
          smartlist_add(elements, tor_strdup(options_format.vars[i].name));
678
          smartlist_add(elements, NULL);
679
680
681
        }
      }
    }
682
    control_event_conf_changed(elements);
683
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
684
685
    smartlist_free(elements);
  }
686
687
688

  if (old_options != global_options)
    config_free(&options_format, old_options);
689
690

  return 0;
691
692
}

693
extern const char tor_git_revision[]; /* from tor_main.c */
694

695
/** The version of this Tor process, as parsed. */
696
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
697
698
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
699
static char *the_short_tor_version = NULL;
700

701
/** Return the current Tor version. */
702
703
704
const char *
get_version(void)
{
705
  if (the_tor_version == NULL) {
706
    if (strlen(tor_git_revision)) {
707
708
      tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
                   tor_git_revision);
709
    } else {
710
      the_tor_version = tor_strdup(get_short_version());
711
712
    }
  }
713
  return the_tor_version;
714
715
}

716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
/** Return the current Tor version, without any git tag. */
const char *
get_short_version(void)
{

  if (the_short_tor_version == NULL) {
#ifdef TOR_BUILD_TAG
    tor_asprintf(&the_short_tor_version, "%s (%s)", VERSION, TOR_BUILD_TAG);
#else
    the_short_tor_version = tor_strdup(VERSION);
#endif
  }
  return