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
  { "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

valerino's avatar
valerino committed
232
233
234
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
235
  V(FallbackNetworkstatusFile,   FILENAME,
236
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
237
#endif
238
239
240
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
241
  V(FetchDirInfoEarly,           BOOL,     "0"),
242
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
243
244
245
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
246
  V(FetchV2Networkstatus,        BOOL,     "0"),
247
#ifdef _WIN32
248
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
249
  V(GeoIPv6File,                 FILENAME, "<default>"),
250
#else
251
252
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
253
254
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
255
#endif
256
  OBSOLETE("GiveGuardFlagTo_CVE_2011_2768_VulnerableRelays"),
257
  OBSOLETE("Group"),
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
284
285
286
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
287
  OBSOLETE("IgnoreVersion"),
288
289
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
290
  V(LogMessageDomains,           BOOL,     "0"),
291
  OBSOLETE("LinkPadding"),
292
293
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
294
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
295
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
296
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
297
298
299
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
300
  V(MaxClientCircuitsPending,    UINT,     "32"),
301
  V(MaxOnionsPending,            UINT,     "100"),
302
  OBSOLETE("MonthlyAccountingStart"),
303
304
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
305
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
306
  V(NATDListenAddress,           LINELIST, NULL),
307
  VPORT(NATDPort,                    LINELIST, NULL),
308
  V(Nickname,                    STRING,   NULL),
309
  V(WarnUnsafeSocks,              BOOL,     "1"),
Sebastian Hahn's avatar
Sebastian Hahn committed
310
  OBSOLETE("NoPublish"),
311
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
312
  V(NumCPUs,                     UINT,     "0"),
313
314
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
315
  VPORT(ORPort,                      LINELIST, NULL),
316
  V(OutboundBindAddress,         LINELIST,   NULL),
317
318
319
320
321
322
323

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

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

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

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

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

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

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

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

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

483
static int validate_data_directory(or_options_t *options);
484
485
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
486
static int options_init_logs(or_options_t *options, int validate_only);
487

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

495
/** Magic value for or_options_t. */
496
497
#define OR_OPTIONS_MAGIC 9090909

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

509
510
511
512
513
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

544
545
546
547
548
549
550
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

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

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

  if (old_options != global_options)
    config_free(&options_format, old_options);
607
608

  return 0;
609
610
}

611
extern const char tor_git_revision[]; /* from tor_main.c */
612

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

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

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

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

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

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

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

680
681
  if (configured_ports) {
    SMARTLIST_FOREACH(configured_ports,
682
                      port_cfg_t *, p, tor_free(p));
683
684
    smartlist_free(configured_ports);
    configured_ports = NULL;
685
686
  }

687
  tor_free(torrc_fname);
688
  tor_free(torrc_defaults_fname);
689
  tor_free(the_tor_version);
690
  tor_free(global_dirfrontpagecontents);
691
692
693

  tor_free(the_short_tor_version);
  tor_free(the_tor_version);
694
695
}

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

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

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

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

753
754
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
755
static void
756
add_default_trusted_dir_authorities(dirinfo_type_t type)
757
{
758
  int i;
759
  const char *dirservers[] = {