config.c 223 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
#ifdef _WIN32
49
50
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
51

52
53
54
55
56
#include "procmon.h"

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

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

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

119
120
121
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

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

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

325
  OBSOLETE("PathBiasDisableRate"),
326
327
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
328
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
329
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
330
  V(PathBiasScaleThreshold,      INT,      "-1"),
331
332
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
333
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
334
335
336
337
338
339
  OBSOLETE("PathBiasUseCloseCounts"),

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

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

460
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
461
};
462

463
464
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
465
static const config_var_t testing_tor_network_defaults[] = {
466
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
467
468
469
470
471
472
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
473
  V(ClientRejectInternalAddresses, BOOL,   "0"),
474
  V(CountPrivateBandwidth,       BOOL,     "1"),
475
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
476
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
477
478
479
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
480
481
482
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
483
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
484
485
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
486
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
  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"),
502
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
503

504
505
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
506

507
#undef VAR
508
#undef V
509
510
#undef OBSOLETE

511
#ifdef _WIN32
512
513
static char *get_windows_conf_root(void);
#endif
514
515
516
517
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,
518
                                      char **msg);
519
520
521
522
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);
523
static int check_nickname_list(const char *lst, const char *name, char **msg);
524

George Kadianakis's avatar
George Kadianakis committed
525
static int parse_client_transport_line(const char *line, int validate_only);
526
527

static int parse_server_transport_line(const char *line, int validate_only);
528
529
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
530
static int parse_dir_authority_line(const char *line,
531
                                 dirinfo_type_t required_type,
532
                                 int validate_only);
533
534
static int parse_dir_fallback_line(const char *line,
                                   int validate_only);
535
static void port_cfg_free(port_cfg_t *port);
536
static int parse_ports(or_options_t *options, int validate_only,
537
                              char **msg_out, int *n_ports_out);
538
539
540
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

541
static int validate_data_directory(or_options_t *options);
542
543
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
544
static int options_init_logs(or_options_t *options, int validate_only);
545

546
static void init_libevent(const or_options_t *options);
547
static int opt_streq(const char *s1, const char *s2);
548
549
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
550
551
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
552

553
/** Magic value for or_options_t. */
554
555
#define OR_OPTIONS_MAGIC 9090909

556
/** Configuration format for or_options_t. */
557
STATIC config_format_t options_format = {
558
559
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
560
561
562
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
563
  (validate_fn_t)options_validate,
564
  NULL
565
566
};

567
568
569
570
571
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
572
static or_options_t *global_options = NULL;
573
574
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
575
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
576
/** Name of most recently read torrc file. */
577
static char *torrc_fname = NULL;
578
/** Name of the most recently read torrc-defaults file.*/
579
static char *torrc_defaults_fname;
580
581
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
582
/** Contents of most recently read DirPortFrontPage file. */
583
static char *global_dirfrontpagecontents = NULL;
584
585
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
586
587
588
589
590
591
592

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

594
595
/** Return the currently configured options. */
or_options_t *
596
get_options_mutable(void)
597
{
598
599
600
  tor_assert(global_options);
  return global_options;
}
601

602
603
604
605
606
607
608
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

609
610
/** 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
611
 * as necessary.  Returns 0 on success, -1 on failure.
612
 */
613
int
614
set_options(or_options_t *new_val, char **msg)
615
{
616
617
618
  int i;
  smartlist_t *elements;
  config_line_t *line;
619
  or_options_t *old_options = global_options;
620
  global_options = new_val;
621
622
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
623
624
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
625
626
627
    global_options = old_options;
    return -1;
  }
628
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
629
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
630
            "Acting on config options left us in a broken state. Dying.");
631
632
    exit(1);
  }
633
634
  /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
   * just starting up then the old_options will be undefined. */
635
  if (old_options && old_options != global_options) {
636
    elements = smartlist_new();
637
    for (i=0; options_format.vars[i].name; ++i) {
638
639
      const config_var_t *var = &options_format.vars[i];
      const char *var_name = var->name;
640
641
642
643
      if (var->type == CONFIG_TYPE_LINELIST_S ||
          var->type == CONFIG_TYPE_OBSOLETE) {
        continue;
      }
644
645
646
      if (!config_is_same(&options_format, new_val, old_options, var_name)) {
        line = config_get_assigned_option(&options_format, new_val,
                                          var_name, 1);
647
648

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
649
650
651
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
652
653
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
Nick Mathewson's avatar
Nick Mathewson committed
654
            tor_free(line);
655
656
          }
        } else {
657
          smartlist_add(elements, tor_strdup(options_format.vars[i].name));
658
          smartlist_add(elements, NULL);
659
660
661
        }
      }
    }
662
    control_event_conf_changed(elements);
663
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
664
665
    smartlist_free(elements);
  }
666
667
668

  if (old_options != global_options)
    config_free(&options_format, old_options);
669
670

  return 0;
671
672
}

673
extern const char tor_git_revision[]; /* from tor_main.c */
674

675
/** The version of this Tor process, as parsed. */
676
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
677
678
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
679
static char *the_short_tor_version = NULL;
680

681
/** Return the current Tor version. */
682
683
684
const char *
get_version(void)
{
685
  if (the_tor_version == NULL) {
686
    if (strlen(tor_git_revision)) {
687
688
      tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
                   tor_git_revision);
689
    } else {
690
      the_tor_version = tor_strdup(get_short_version());
691
692
    }
  }
693
  return the_tor_version;
694
695
}

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
/** 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 the_short_tor_version;
}

711
712
/** Release additional memory allocated in options
 */
713
STATIC void
714
715
or_options_free(or_options_t *options)
{
716
717
718
  if (!options)
    return;

719
  routerset_free(options->ExcludeExitNodesUnion_);
720
721
722
723
724
  if (options->NodeFamilySets) {
    SMARTLIST_FOREACH(options->NodeFamilySets, routerset_t *,
                      rs, routerset_free(rs));
    smartlist_free(options->NodeFamilySets);
  }
725
  tor_free(options->BridgePassword_AuthDigest_);
726
727
728
  config_free(&options_format, options);
}

729
730
/** Release all memory and resources held by global configuration structures.
 */
731
732
733
void
config_free_all(void)
{
734
735
  or_options_free(global_options);
  global_options = NULL;
736
737
  or_options_free(global_default_options);
  global_default_options = NULL;
738
739
740
741

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

742
743
  if (configured_ports) {
    SMARTLIST_FOREACH(configured_ports,