config.c 222 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
 **/

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

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

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

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

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

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

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

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

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

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

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

458
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
459
};
460

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

502
503
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
504

505
#undef VAR
506
#undef V
507
508
#undef OBSOLETE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return 0;
673
674
}

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

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

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

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

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

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

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

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

744
745
  if (configured_ports) {
    SMARTLIST_FOREACH(configured_ports,
746
                      port_cfg_t *, p, port_cfg_free(p));
747
748
    smartlist_free(configured_ports);
    configured_ports = NULL;