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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return 0;
672
673
}

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

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

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

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

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

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

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

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;