config.c 199 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2012, 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
13
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
15
#include "addressmap.h"
16
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "circuitlist.h"
19
20
#include "circuitmux.h"
#include "circuitmux_ewma.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "connection_edge.h"
24
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "control.h"
26
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "dns.h"
31
#include "entrynodes.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "networkstatus.h"
36
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
38
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
39
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
40
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
41
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
42
#include "router.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
84
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "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
  { "_UseFilteringSSLBufferevents", "UseFilteringSSLBufferevents", 0, 1},
101
102
  { NULL, NULL, 0, 0},
};
103

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

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

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

valerino's avatar
valerino committed
231
232
233
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
234
  V(FallbackNetworkstatusFile,   FILENAME,
235
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
236
#endif
237
238
239
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
240
  V(FetchDirInfoEarly,           BOOL,     "0"),
241
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
242
243
244
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
245
  V(FetchV2Networkstatus,        BOOL,     "0"),
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(HardwareAccel,               BOOL,     "0"),
258
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
259
260
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
261
  V(HashedControlPassword,       LINELIST, NULL),
262
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
263
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
264
265
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
266
267
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
268
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
269
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
270
  V(HidServAuth,                 LINELIST, NULL),
271
  V(HSAuthoritativeDir,          BOOL,     "0"),
272
  OBSOLETE("HSAuthorityRecordStats"),
273
  V(CloseHSClientCircuitsImmediatelyOnTimeout, BOOL, "0"),
274
  V(CloseHSServiceRendCircuitsImmediatelyOnTimeout, BOOL, "0"),
275
276
277
278
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
279
  V(IPv6Exit,                    BOOL,     "0"),
280
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
281
  V(ServerTransportListenAddr,   LINELIST, NULL),
282
283
284
285
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
286
  OBSOLETE("IgnoreVersion"),
287
288
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
289
  V(LogMessageDomains,           BOOL,     "0"),
290
  OBSOLETE("LinkPadding"),
291
292
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
293
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
294
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
295
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
296
297
298
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
299
  V(MaxClientCircuitsPending,    UINT,     "32"),
300
  V(MaxOnionsPending,            UINT,     "100"),
301
  OBSOLETE("MonthlyAccountingStart"),
302
303
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
304
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
305
  V(NATDListenAddress,           LINELIST, NULL),
306
  VPORT(NATDPort,                    LINELIST, NULL),
307
  V(Nickname,                    STRING,   NULL),
308
  V(WarnUnsafeSocks,              BOOL,     "1"),
Sebastian Hahn's avatar
Sebastian Hahn committed
309
  OBSOLETE("NoPublish"),
310
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
311
  V(NumCPUs,                     UINT,     "0"),
312
313
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
314
  VPORT(ORPort,                      LINELIST, NULL),
315
  V(OutboundBindAddress,         LINELIST,   NULL),
316

317
  OBSOLETE("PathBiasDisableRate"),
318
319
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
320
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
321
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
322
323
  V(PathBiasScaleThreshold,      INT,      "-1"),
  V(PathBiasScaleFactor,         INT,      "-1"),
324
325
  V(PathBiasMultFactor,          INT,      "-1"),
  V(PathBiasDropGuards,          BOOL,      "0"),
326
  V(PathBiasUseCloseCounts,      BOOL,      "1"),
327

328
  OBSOLETE("PathlenCoinWeight"),
329
330
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
331
  V(PidFile,                     STRING,   NULL),
332
  V(TestingTorNetwork,           BOOL,     "0"),
333
  V(OptimisticData,              AUTOBOOL, "auto"),
334
335
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
Roger Dingledine's avatar
Roger Dingledine committed
336
  V(PreferTunneledDirConns,      BOOL,     "1"),
337
  V(ProtocolWarnings,            BOOL,     "0"),
338
  V(PublishServerDescriptor,     CSV,      "1"),
339
340
341
342
343
344
345
  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),
346
  OBSOLETE("RedirectExit"),
347
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
348
  V(RejectPlaintextPorts,        CSV,      ""),
349
350
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
351
352
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
353
354
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
355
  OBSOLETE("RouterFile"),
356
  V(RunAsDaemon,                 BOOL,     "0"),
357
358
//  V(RunTesting,                  BOOL,     "0"),
  OBSOLETE("RunTesting"), // currently unused
359
  V(SafeLogging,                 STRING,   "1"),
360
  V(SafeSocks,                   BOOL,     "0"),
361
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
362
363
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
364
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
365
366
367
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
368
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
369
370
371
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
372
  VPORT(SocksPort,                   LINELIST, NULL),
373
  V(SocksTimeout,                INTERVAL, "2 minutes"),
374
  OBSOLETE("StatusFetchPeriod"),
375
  V(StrictNodes,                 BOOL,     "0"),
376
  OBSOLETE("SysLog"),
377
  V(TestSocks,                   BOOL,     "0"),
378
  OBSOLETE("TestVia"),
379
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
380
  V(Tor2webMode,                 BOOL,     "0"),
381
382
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
383
  OBSOLETE("TrafficShaping"),
384
  V(TransListenAddress,          LINELIST, NULL),
385
  VPORT(TransPort,                   LINELIST, NULL),
Roger Dingledine's avatar
Roger Dingledine committed
386
  V(TunnelDirConns,              BOOL,     "1"),
387
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
388
  V(UseBridges,                  BOOL,     "0"),
389
  V(UseEntryGuards,              BOOL,     "1"),
390
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
391
  V(User,                        STRING,   NULL),
392
  V(UserspaceIOCPBuffers,        BOOL,     "0"),
393
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
394
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
395
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
396
397
398
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
399
400
401
402
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
403
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
404
  V(V3BandwidthsFile,            FILENAME, NULL),
405
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
406
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
407
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
408
  V(UseFilteringSSLBufferevents, BOOL,    "0"),
409
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
410
411
412
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
413
414
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
415
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
416
  V(MinUptimeHidServDirectoryV2, INTERVAL, "25 hours"),
417
  V(VoteOnHidServDirectoriesV2,  BOOL,     "1"),
418
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
419

420
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
421
};
422

423
424
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
425
static const config_var_t testing_tor_network_defaults[] = {
426
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
427
428
429
430
431
432
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
433
  V(ClientRejectInternalAddresses, BOOL,   "0"),
434
  V(CountPrivateBandwidth,       BOOL,     "1"),
435
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
436
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
437
438
439
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
440
441
442
443
444
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
445
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
446
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
447

448
449
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
450

451
#undef VAR
452
#undef V
453
454
#undef OBSOLETE

455
#ifdef _WIN32
456
457
static char *get_windows_conf_root(void);
#endif
458
459
static int options_validate(or_options_t *old_options,
                            or_options_t *options,
460
                            int from_setconf, char **msg);
461
462
463
464
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,
465
                                      char **msg);
466
467
468
469
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);
470
static int check_nickname_list(const char *lst, const char *name, char **msg);
471

472
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
473
static int parse_client_transport_line(const char *line, int validate_only);
474
475

static int parse_server_transport_line(const char *line, int validate_only);
476
477
478
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);

479
static int parse_dir_server_line(const char *line,
480
                                 dirinfo_type_t required_type,
481
                                 int validate_only);
482
static void port_cfg_free(port_cfg_t *port);
483
static int parse_ports(or_options_t *options, int validate_only,
484
                              char **msg_out, int *n_ports_out);
485
486
487
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

488
static int validate_data_directory(or_options_t *options);
489
490
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
491
static int options_init_logs(or_options_t *options, int validate_only);
492

493
static void init_libevent(const or_options_t *options);
494
static int opt_streq(const char *s1, const char *s2);
495
496
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
497
498
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
499

500
/** Magic value for or_options_t. */
501
502
#define OR_OPTIONS_MAGIC 9090909

503
/** Configuration format for or_options_t. */
504
static config_format_t options_format = {
505
506
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
507
508
509
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
510
  (validate_fn_t)options_validate,
511
  NULL
512
513
};

514
515
516
517
518
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
519
static or_options_t *global_options = NULL;
520
521
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
522
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
523
/** Name of most recently read torrc file. */
524
static char *torrc_fname = NULL;
525
/** Name of the most recently read torrc-defaults file.*/
526
static char *torrc_defaults_fname;
527
528
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
529
/** Contents of most recently read DirPortFrontPage file. */
530
static char *global_dirfrontpagecontents = NULL;
531
532
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
533
534
535
536
537
538
539

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

541
542
/** Return the currently configured options. */
or_options_t *
543
get_options_mutable(void)
544
{
545
546
547
  tor_assert(global_options);
  return global_options;
}
548

549
550
551
552
553
554
555
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

556
557
/** 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
558
 * as necessary.  Returns 0 on success, -1 on failure.
559
 */
560
int
561
set_options(or_options_t *new_val, char **msg)
562
{
563
564
565
  int i;
  smartlist_t *elements;
  config_line_t *line;
566
  or_options_t *old_options = global_options;
567
  global_options = new_val;
568
569
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
570
571
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
572
573
574
    global_options = old_options;
    return -1;
  }
575
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
576
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
577
            "Acting on config options left us in a broken state. Dying.");
578
579
    exit(1);
  }
580
581
  /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
   * just starting up then the old_options will be undefined. */
582
  if (old_options && old_options != global_options) {
583
    elements = smartlist_new();
584
    for (i=0; options_format.vars[i].name; ++i) {
585
586
      const config_var_t *var = &options_format.vars[i];
      const char *var_name = var->name;
587
588
589
590
      if (var->type == CONFIG_TYPE_LINELIST_S ||
          var->type == CONFIG_TYPE_OBSOLETE) {
        continue;
      }
591
592
593
      if (!config_is_same(&options_format, new_val, old_options, var_name)) {
        line = config_get_assigned_option(&options_format, new_val,
                                          var_name, 1);
594
595
596

        if (line) {
          for (; line; line = line->next) {
597
598
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
599
600
          }
        } else {
601
          smartlist_add(elements, (char*)options_format.vars[i].name);
602
          smartlist_add(elements, NULL);
603
604
605
        }
      }
    }
606
    control_event_conf_changed(elements);
607
608
    smartlist_free(elements);
  }
609
610
611

  if (old_options != global_options)
    config_free(&options_format, old_options);
612
613

  return 0;
614
615
}

616
extern const char tor_git_revision[]; /* from tor_main.c */
617

618
/** The version of this Tor process, as parsed. */
619
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
620
621
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
622
static char *the_short_tor_version = NULL;
623

624
/** Return the current Tor version. */
625
626
627
const char *
get_version(void)
{
628
  if (the_tor_version == NULL) {
629
    if (strlen(tor_git_revision)) {
630
631
      tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
                   tor_git_revision);
632
    } else {
633
      the_tor_version = tor_strdup(get_short_version());
634
635
    }
  }
636
  return the_tor_version;
637
638
}

639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
/** 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;
}

654
655
656
657
658
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
659
660
661
  if (!options)
    return;

662
  routerset_free(options->ExcludeExitNodesUnion_);
663
664
665
666
667
  if (options->NodeFamilySets) {
    SMARTLIST_FOREACH(options->NodeFamilySets, routerset_t *,
                      rs, routerset_free(rs));
    smartlist_free(options->NodeFamilySets);
  }
668
  tor_free(options->BridgePassword_AuthDigest_);
669
670
671
  config_free(&options_format, options);
}

672
673
/** Release all memory and resources held by global configuration structures.
 */
674
675
676
void
config_free_all(void)
{
677
678
  or_options_free(global_options);
  global_options = NULL;
679
680
  or_options_free(global_default_options);
  global_default_options = NULL;
681
682
683
684

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

685
686
  if (configured_ports) {
    SMARTLIST_FOREACH(configured_ports,
687
                      port_cfg_t *, p, tor_free(p));
688
689
    smartlist_free(configured_ports);
    configured_ports = NULL;
690
691
  }

692
  tor_free(torrc_fname);
693
  tor_free(torrc_defaults_fname);
694
  tor_free(the_tor_version);
695
  tor_free(global_dirfrontpagecontents);
696
697
698

  tor_free(the_short_tor_version);
  tor_free(the_tor_version);
699
700
}

701
702
703
704
705
/** Make <b>address</b> -- a piece of information related to our operation as
 * a client -- safe to log according to the settings in options->SafeLogging,
 * and return it.
 *
 * (We return "[scrubbed]" if SafeLogging is "1", and address otherwise.)
706
707
 */
const char *
708
safe_str_client(const char *address)
709
{
710
  tor_assert(address);
711
  if (get_options()->SafeLogging_ == SAFELOG_SCRUB_ALL)
712
713
714
715
716
    return "[scrubbed]";
  else
    return address;
}

717
718
719
720
721
722
/** Make <b>address</b> -- a piece of information of unspecified sensitivity
 * -- safe to log according to the settings in options->SafeLogging, and
 * return it.
 *
 * (We return "[scrubbed]" if SafeLogging is anything besides "0", and address
 * otherwise.)
723
724
 */
const char *
725
726
safe_str(const char *address)
{
727
  tor_assert(address);
728
  if (get_options()->SafeLogging_ != SAFELOG_SCRUB_NONE)
729
730
731
732
733
    return "[scrubbed]";
  else
    return address;
}

734
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
735
736
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
737
const char *
738
escaped_safe_str_client(const char *address)
739
{
740
  if (get_options()->SafeLogging_ == SAFELOG_SCRUB_ALL)
741
742
743
744
745
    return "[scrubbed]";
  else
    return escaped(address);
}

746
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
747
748
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
749
750
751
const char *
escaped_safe_str(const char *address)
{
752
  if (get_options()->SafeLogging_ != SAFELOG_SCRUB_NONE)
753
754
755
756
757
    return "[scrubbed]";
  else
    return escaped(address);
}

Roger Dingledine's avatar