config.c 207 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"
Sebastian Hahn's avatar
Sebastian Hahn committed
15
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
19
#include "connection_edge.h"
20
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "control.h"
22
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "networkstatus.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
36
#include "router.h"
37
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
38
#include "routerlist.h"
39
#include "transports.h"
40
#ifdef _WIN32
41
42
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
43

44
45
46
47
48
#include "procmon.h"

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

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

/** A list of state-file "abbreviations," for compatibility. */
97
static config_abbrev_t _state_abbrevs[] = {
98
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
99
100
101
102
103
104
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
105
  { NULL, NULL, 0, 0},
106
107
};

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

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

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

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

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

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

414
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
415
};
416

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

442
443
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
444
445
#undef VAR

446
447
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
448
      initvalue }
449
450

/** Array of "state" variables saved to the ~/.tor/state file. */
451
static config_var_t _state_vars[] = {
452
453
  /* Remember to document these in state-contents.txt ! */

454
455
456
457
458
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
459
460
461
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
462

463
464
465
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
466
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
467
  VAR("EntryGuardPathBias",      LINELIST_S,  EntryGuards,             NULL),
468
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
469

470
471
472
  VAR("TransportProxy",               LINELIST_S, TransportProxies, NULL),
  V(TransportProxies,                 LINELIST_V, NULL),

473
474
475
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
476
  V(BWHistoryReadMaxima,              CSV,      ""),
477
478
479
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
480
  V(BWHistoryWriteMaxima,             CSV,      ""),
481
482
483
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
484
  V(BWHistoryDirReadMaxima,           CSV,      ""),
485
486
487
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
488
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
489

490
  V(TorVersion,                       STRING,   NULL),
491

492
493
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
494

495
  V(TotalBuildTimes,                  UINT,     NULL),
496
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
497
498
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
499
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
500
501
};

502
#undef VAR
503
#undef V
504
505
#undef OBSOLETE

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

523
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
524
static int parse_client_transport_line(const char *line, int validate_only);
525
526

static int parse_server_transport_line(const char *line, int validate_only);
527
static int parse_dir_server_line(const char *line,
528
                                 dirinfo_type_t required_type,
529
                                 int validate_only);
530
static void port_cfg_free(port_cfg_t *port);
531
static int parse_ports(or_options_t *options, int validate_only,
532
                              char **msg_out, int *n_ports_out);
533
534
535
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

536
static int validate_data_directory(or_options_t *options);
537
538
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
539
static int or_state_validate(or_state_t *old_options, or_state_t *options,
540
                             int from_setconf, char **msg);
541
542
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
543

544
static void init_libevent(const or_options_t *options);
545
static int opt_streq(const char *s1, const char *s2);
546

547
/** Magic value for or_options_t. */
548
549
#define OR_OPTIONS_MAGIC 9090909

550
/** Configuration format for or_options_t. */
551
static config_format_t options_format = {
552
553
554
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
555
556
557
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
558
  NULL
559
560
};

561
/** Magic value for or_state_t. */
562
563
#define OR_STATE_MAGIC 0x57A73f57

564
565
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
566
567
568
569
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

570
/** Configuration format for or_state_t. */
571
static const config_format_t state_format = {
572
573
574
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
575
  _state_abbrevs,
576
577
  _state_vars,
  (validate_fn_t)or_state_validate,
578
  &state_extra_var,
579
580
};

581
582
583
584
585
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
586
static or_options_t *global_options = NULL;
587
588
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
589
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
590
/** Name of most recently read torrc file. */
591
static char *torrc_fname = NULL;
592
/** Name of the most recently read torrc-defaults file.*/
593
static char *torrc_defaults_fname;
594
/** Persistent serialized state. */
595
static or_state_t *global_state = NULL;
596
597
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
598
/** Contents of most recently read DirPortFrontPage file. */
599
static char *global_dirfrontpagecontents = NULL;
600
601
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
602
603
604
605
606
607
608

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

610
611
/** Return the currently configured options. */
or_options_t *
612
get_options_mutable(void)
613
{
614
615
616
  tor_assert(global_options);
  return global_options;
}
617

618
619
620
621
622
623
624
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

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

        if (line) {
          for (; line; line = line->next) {
666
667
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
668
669
          }
        } else {
670
          smartlist_add(elements, (char*)options_format.vars[i].name);
671
          smartlist_add(elements, NULL);
672
673
674
        }
      }
    }
675
    control_event_conf_changed(elements);
676
677
    smartlist_free(elements);
  }
678
679
680

  if (old_options != global_options)
    config_free(&options_format, old_options);
681
682

  return 0;
683
684
}

685
extern const char tor_git_revision[]; /* from tor_main.c */
686

687
/** The version of this Tor process, as parsed. */
688
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
689
690
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
691
static char *the_short_tor_version = NULL;
692

693
/** Return the current Tor version. */
694
695
696
const char *
get_version(void)
{
697
  if (the_tor_version == NULL) {
698
    if (strlen(tor_git_revision)) {
699
700
      tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
                   tor_git_revision);
701
    } else {
702
      the_tor_version = tor_strdup(get_short_version());
703
704
    }
  }
705
  return the_tor_version;
706
707
}

708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
/** 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;
}

723
724
725
726
727
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
728
729
730
  if (!options)
    return;

731
  routerset_free(options->_ExcludeExitNodesUnion);
732
733
734
735
736
  if (options->NodeFamilySets) {
    SMARTLIST_FOREACH(options->NodeFamilySets, routerset_t *,
                      rs, routerset_free(rs));
    smartlist_free(options->NodeFamilySets);
  }
737
  tor_free(options->_BridgePassword_AuthDigest);
738
739
740
  config_free(&options_format, options);
}

741
742
/** Release all memory and resources held by global configuration structures.
 */
743
744
745
void
config_free_all(void)
{
746
747
  or_options_free(global_options);
  global_options = NULL;
748
749
  or_options_free(global_default_options);
  global_default_options = NULL;
750
751
752
753
754
755
756

  config_free(&state_format, global_state);
  global_state = NULL;

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;