config.c 203 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
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
84
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX024 later, make this warn? */
85
  { "MaxConn", "ConnLimit", 0, 1},
86
87
88
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
89
90
91
92
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
93
94
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
95
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
96
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
97
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
98
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
99
100
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
101
  { "_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(DisableAllSwap,              BOOL,     "0"),
212
  V(DisableDebuggerAttachment,   BOOL,     "1"),
213
  V(DisableIOCP,                 BOOL,     "1"),
214
  V(DynamicDHGroups,             BOOL,     "0"),
215
  VPORT(DNSPort,                     LINELIST, NULL),
216
217
218
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
219
  V(EntryNodes,                  ROUTERSET,   NULL),
220
  V(EntryStatistics,             BOOL,     "0"),
221
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
222
223
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
224
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
225
  V(ExitNodes,                   ROUTERSET, NULL),
226
227
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
228
  V(ExitPortStatistics,          BOOL,     "0"),
229
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
230
  V(ExtraInfoStatistics,         BOOL,     "1"),
231
  V(FallbackDir,                 LINELIST, NULL),
232

valerino's avatar
valerino committed
233
234
235
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
236
  V(FallbackNetworkstatusFile,   FILENAME,
237
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
238
#endif
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
#ifdef _WIN32
249
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
250
  V(GeoIPv6File,                 FILENAME, "<default>"),
251
#else
252
253
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
254
255
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
256
#endif
257
  OBSOLETE("GiveGuardFlagTo_CVE_2011_2768_VulnerableRelays"),
258
  OBSOLETE("Group"),
259
  V(HardwareAccel,               BOOL,     "0"),
260
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
261
262
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
263
  V(HashedControlPassword,       LINELIST, NULL),
264
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
265
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
266
267
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
268
269
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
270
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
271
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
272
  V(HidServAuth,                 LINELIST, NULL),
273
  V(HSAuthoritativeDir,          BOOL,     "0"),
274
  OBSOLETE("HSAuthorityRecordStats"),
275
  V(CloseHSClientCircuitsImmediatelyOnTimeout, BOOL, "0"),
276
  V(CloseHSServiceRendCircuitsImmediatelyOnTimeout, BOOL, "0"),
277
278
279
280
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
281
  V(IPv6Exit,                    BOOL,     "0"),
282
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
283
  V(ServerTransportListenAddr,   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(MaxOnionsPending,            UINT,     "100"),
303
  OBSOLETE("MonthlyAccountingStart"),
304
305
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
306
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
307
  V(NATDListenAddress,           LINELIST, NULL),
308
  VPORT(NATDPort,                    LINELIST, NULL),
309
  V(Nickname,                    STRING,   NULL),
310
  V(WarnUnsafeSocks,              BOOL,     "1"),
Sebastian Hahn's avatar
Sebastian Hahn committed
311
  OBSOLETE("NoPublish"),
312
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
313
  V(NumCPUs,                     UINT,     "0"),
314
315
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
316
  VPORT(ORPort,                      LINELIST, NULL),
317
  V(OutboundBindAddress,         LINELIST,   NULL),
318
319
320
321
322
323
324

  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
  V(PathBiasDisableRate,         DOUBLE,   "-1"),
  V(PathBiasScaleThreshold,      INT,      "-1"),
  V(PathBiasScaleFactor,         INT,      "-1"),

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

417
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
418
};
419

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

445
446
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
447

448
#undef VAR
449
#undef V
450
451
#undef OBSOLETE

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

469
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
470
static int parse_client_transport_line(const char *line, int validate_only);
471
472

static int parse_server_transport_line(const char *line, int validate_only);
473
474
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
475
static int parse_dir_authority_line(const char *line,
476
                                 dirinfo_type_t required_type,
477
                                 int validate_only);
478
479
static int parse_dir_fallback_line(const char *line,
                                   int validate_only);
480
static void port_cfg_free(port_cfg_t *port);
481
static int parse_ports(or_options_t *options, int validate_only,
482
                              char **msg_out, int *n_ports_out);
483
484
485
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

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

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

498
/** Magic value for or_options_t. */
499
500
#define OR_OPTIONS_MAGIC 9090909

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

512
513
514
515
516
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

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

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

  if (old_options != global_options)
    config_free(&options_format, old_options);
610
611

  return 0;
612
613
}

614
extern const char tor_git_revision[]; /* from tor_main.c */
615

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

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

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

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

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

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

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

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

690
  tor_free(torrc_fname);
691
  tor_free(torrc_defaults_fname);
692
  tor_free(the_tor_version);
693
  tor_free(global_dirfrontpagecontents);
694
695
696

  tor_free(the_short_tor_version);
  tor_free(the_tor_version);
697
698
}

699
700
701
702
703
/** 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.)
704
705
 */
const char *
706
safe_str_client(const char *address)
707
{
708
  tor_assert(address);
709
  if (get_options()->SafeLogging_ == SAFELOG_SCRUB_ALL)
710
711
712
713
714
    return "[scrubbed]";
  else
    return address;
}

715
716
717
718
719
720
/** 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.)
721
722
 */
const char *
723
724
safe_str(const char *address)
{
725
  tor_assert(address);
726
  if (get_options()->SafeLogging_ != SAFELOG_SCRUB_NONE)
727
728
729
730
731
    return "[scrubbed]";
  else
    return address;
}

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

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

756
757
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */