config.c 285 KB
Newer Older
1
/* Copyright (c) 2001 Matej Pfajfar.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
Nick Mathewson's avatar
Nick Mathewson committed
4
 * Copyright (c) 2007-2016, 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
#define CONFIG_PRIVATE
Roger Dingledine's avatar
Roger Dingledine committed
13
#include "or.h"
14
#include "compat.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"
21
#include "circuitstats.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "connection_edge.h"
25
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "control.h"
27
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "dns.h"
32
#include "dos.h"
33
#include "entrynodes.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
36
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "networkstatus.h"
38
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
39
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
40
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
41
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
42
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
43
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
44
#include "router.h"
45
#include "sandbox.h"
46
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
47
#include "routerlist.h"
48
#include "routerset.h"
49
#include "scheduler.h"
50
#include "statefile.h"
51
#include "transports.h"
52
#include "ext_orport.h"
53
#include "torgzip.h"
54
#ifdef _WIN32
55
56
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
57

58
59
#include "procmon.h"

60
61
62
63
64
65
66
67
68
69
#ifdef HAVE_SYSTEMD
#   if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
/* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
 * Coverity. Here's a kludge to unconfuse it.
 */
#   define __INCLUDE_LEVEL__ 2
#   endif
#include <systemd/sd-daemon.h>
#endif

70
/* Prefix used to indicate a Unix socket in a FooPort configuration. */
71
static const char unix_socket_prefix[] = "unix:";
72
73
74
/* Prefix used to indicate a Unix socket with spaces in it, in a FooPort
 * configuration. */
static const char unix_q_socket_prefix[] = "unix:\"";
75

76
77
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
78
static config_abbrev_t option_abbrevs_[] = {
79
80
81
82
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
83
  PLURAL(EntryNode),
84
  PLURAL(ExcludeNode),
85
  PLURAL(Tor2webRendezvousPoint),
86
  PLURAL(FirewallPort),
87
  PLURAL(LongLivedPort),
88
89
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
90
  PLURAL(NumCPU),
91
  PLURAL(RendNode),
92
  PLURAL(RecommendedPackage),
93
  PLURAL(RendExcludeNode),
94
95
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
96
  PLURAL(StrictNode),
97
  { "l", "Log", 1, 0},
98
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
99
100
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
101
102
103
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
104
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX later, make this warn? */
105
  { "MaxConn", "ConnLimit", 0, 1},
106
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
107
108
109
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
110
111
112
113
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
114
115
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
116
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
117
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
118
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
119
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
120
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
121
122
  { NULL, NULL, 0, 0},
};
123

Nick Mathewson's avatar
Nick Mathewson committed
124
125
126
127
/** 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>"
 */
128
129
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
130
      initvalue }
131
132
133
/** 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
134
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
135
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
136

137
138
139
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

Nick Mathewson's avatar
Nick Mathewson committed
140
141
142
143
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
144
static config_var_t option_vars_[] = {
145
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
146
  VAR("AccountingRule",          STRING,   AccountingRule_option,  "max"),
147
148
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
149
  V(AllowDotExit,                BOOL,     "0"),
150
151
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
152
153
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
154
155
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
156
  OBSOLETE("AlternateHSAuthority"),
157
  V(AssumeReachable,             BOOL,     "0"),
158
159
  OBSOLETE("AuthDirBadDir"),
  OBSOLETE("AuthDirBadDirCCs"),
160
  V(AuthDirBadExit,              LINELIST, NULL),
161
  V(AuthDirBadExitCCs,           CSV,      ""),
162
  V(AuthDirInvalid,              LINELIST, NULL),
163
  V(AuthDirInvalidCCs,           CSV,      ""),
164
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
165
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "2 MB"),
166
  V(AuthDirPinKeys,              BOOL,     "0"),
167
  V(AuthDirReject,               LINELIST, NULL),
168
  V(AuthDirRejectCCs,            CSV,      ""),
169
  OBSOLETE("AuthDirRejectUnlisted"),
170
  OBSOLETE("AuthDirListBadDirs"),
171
  V(AuthDirListBadExits,         BOOL,     "0"),
172
173
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
174
  V(AuthDirHasIPv6Connectivity,  BOOL,     "0"),
175
176
177
178
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
179
180
  V(BandwidthBurst,              MEMUNIT,  "1 GB"),
  V(BandwidthRate,               MEMUNIT,  "1 GB"),
181
182
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
183
  V(BridgePassword,              STRING,   NULL),
184
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
185
  V(BridgeRelay,                 BOOL,     "0"),
186
  V(CellStatistics,              BOOL,     "0"),
187
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
188
  V(CircuitBuildTimeout,         INTERVAL, "0"),
189
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
190
  V(CircuitStreamTimeout,        INTERVAL, "0"),
191
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
192
193
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
194
195
  V(ClientPreferIPv6ORPort,      AUTOBOOL, "auto"),
  V(ClientPreferIPv6DirPort,     AUTOBOOL, "auto"),
196
  V(ClientRejectInternalAddresses, BOOL,   "1"),
197
  V(ClientTransportPlugin,       LINELIST, NULL),
198
  V(ClientUseIPv6,               BOOL,     "0"),
199
  V(ClientUseIPv4,               BOOL,     "1"),
200
  V(ConsensusParams,             STRING,   NULL),
201
  V(ConnLimit,                   UINT,     "1000"),
202
  V(ConnDirectionStatistics,     BOOL,     "0"),
203
204
205
206
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
207
  VPORT(ControlPort,                 LINELIST, NULL),
208
  V(ControlPortFileGroupReadable,BOOL,     "0"),
209
  V(ControlPortWriteToFile,      FILENAME, NULL),
210
  V(ControlSocket,               LINELIST, NULL),
211
  V(ControlSocketsGroupWritable, BOOL,     "0"),
212
  V(SocksSocketsGroupWritable,   BOOL,     "0"),
213
214
215
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
216
  V(CountPrivateBandwidth,       BOOL,     "0"),
217
  V(DataDirectory,               FILENAME, NULL),
218
  V(DataDirectoryGroupReadable,  BOOL,     "0"),
219
  V(DisableOOSCheck,             BOOL,     "1"),
220
  V(DisableNetwork,              BOOL,     "0"),
221
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
222
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
223
224
  V(DirListenAddress,            LINELIST, NULL),
  V(DirPolicy,                   LINELIST, NULL),
225
  VPORT(DirPort,                     LINELIST, NULL),
226
  V(DirPortFrontPage,            FILENAME, NULL),
227
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
228
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
229
  V(DirCache,                    BOOL,     "1"),
230
231
232
233
234
  /* A DirAuthorityFallbackRate of 0.1 means that 0.5% of clients try an
   * authority when all fallbacks are up, and 2% try an authority when 25% of
   * fallbacks are down. (We rebuild the list when 25% of fallbacks are down).
   *
   * We want to reduce load on authorities, but keep these two figures within
Nick Mathewson's avatar
Nick Mathewson committed
235
236
   * an order of magnitude, so there isn't too much load shifting to
   * authorities when fallbacks go down. */
237
  V(DirAuthorityFallbackRate,    DOUBLE,   "0.1"),
238
  V(DisableAllSwap,              BOOL,     "0"),
239
  V(DisableDebuggerAttachment,   BOOL,     "1"),
240
  OBSOLETE("DisableIOCP"),
241
  OBSOLETE("DisableV2DirectoryInfo_"),
242
  OBSOLETE("DynamicDHGroups"),
243
  VPORT(DNSPort,                     LINELIST, NULL),
244
  V(DNSListenAddress,            LINELIST, NULL),
245
246
247
248
249
250
251
252
253
254
255
256
257
  /* DoS circuit creation options. */
  V(DoSCircuitCreationEnabled,   AUTOBOOL, "auto"),
  V(DoSCircuitCreationMinConnections,      UINT, "0"),
  V(DoSCircuitCreationRateTenths,          UINT, "0"),
  V(DoSCircuitCreationBurst,     UINT,     "0"),
  V(DoSCircuitCreationDefenseType,         INT,  "0"),
  V(DoSCircuitCreationDefenseTimePeriod,   INTERVAL, "0"),
  /* DoS connection options. */
  V(DoSConnectionEnabled,        AUTOBOOL, "auto"),
  V(DoSConnectionMaxConcurrentCount,       UINT, "0"),
  V(DoSConnectionDefenseType,    INT,      "0"),
  /* DoS single hop client options. */
  V(DoSRefuseSingleHopClientRendezvous,    AUTOBOOL, "auto"),
258
  V(DownloadExtraInfo,           BOOL,     "0"),
259
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
260
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
261
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
262
  V(EnforceDistinctSubnets,      BOOL,     "1"),
263
  V(EntryNodes,                  ROUTERSET,   NULL),
264
  V(EntryStatistics,             BOOL,     "0"),
265
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
266
267
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
268
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
269
  V(ExitNodes,                   ROUTERSET, NULL),
270
271
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
272
  V(ExitPolicyRejectLocalInterfaces, BOOL, "0"),
273
  V(ExitPortStatistics,          BOOL,     "0"),
274
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
275
  V(ExitRelay,                   AUTOBOOL, "auto"),
276
  VPORT(ExtORPort,               LINELIST, NULL),
277
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
278
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
279
  V(ExtraInfoStatistics,         BOOL,     "1"),
280
  V(FallbackDir,                 LINELIST, NULL),
281
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
282

283
  OBSOLETE("FallbackNetworkstatusFile"),
284
285
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
286
  V(FastFirstHopPK,              AUTOBOOL, "auto"),
287
  V(FetchDirInfoEarly,           BOOL,     "0"),
288
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
289
290
291
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
292
  OBSOLETE("FetchV2Networkstatus"),
293
  V(GeoIPExcludeUnknown,         AUTOBOOL, "auto"),
294
#ifdef _WIN32
295
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
296
  V(GeoIPv6File,                 FILENAME, "<default>"),
297
#else
298
299
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
300
301
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
302
#endif
303
  OBSOLETE("Group"),
304
  V(GuardLifetime,               INTERVAL, "0 minutes"),
305
  V(HardwareAccel,               BOOL,     "0"),
306
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
307
308
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
309
  V(HashedControlPassword,       LINELIST, NULL),
310
  OBSOLETE("HidServDirectoryV2"),
Nick Mathewson's avatar
Nick Mathewson committed
311
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
312
  VAR("HiddenServiceDirGroupReadable",  LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
313
314
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
315
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
316
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
317
  VAR("HiddenServiceAllowUnknownPorts",LINELIST_S, RendConfigLines, NULL),
318
319
  VAR("HiddenServiceMaxStreams",LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceMaxStreamsCloseCircuit",LINELIST_S, RendConfigLines, NULL),
320
  VAR("HiddenServiceNumIntroductionPoints", LINELIST_S, RendConfigLines, NULL),
321
  V(HiddenServiceStatistics,     BOOL,     "1"),
322
  V(HidServAuth,                 LINELIST, NULL),
323
  V(CloseHSClientCircuitsImmediatelyOnTimeout, BOOL, "0"),
324
  V(CloseHSServiceRendCircuitsImmediatelyOnTimeout, BOOL, "0"),
325
326
  V(HiddenServiceSingleHopMode,  BOOL,     "0"),
  V(HiddenServiceNonAnonymousMode,BOOL,    "0"),
327
328
329
330
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
331
  V(IPv6Exit,                    BOOL,     "0"),
332
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
333
  V(ServerTransportListenAddr,   LINELIST, NULL),
334
  V(ServerTransportOptions,      LINELIST, NULL),
335
  V(SigningKeyLifetime,          INTERVAL, "30 days"),
336
337
338
339
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
340
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
341
  V(KeepBindCapabilities,            AUTOBOOL, "auto"),
342
  VAR("Log",                     LINELIST, Logs,             NULL),
343
  V(LogMessageDomains,           BOOL,     "0"),
344
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
Arlo Breault's avatar
Arlo Breault committed
345
  V(TruncateLogFile,             BOOL,     "0"),
Peter Palfrader's avatar
Peter Palfrader committed
346
  V(SyslogIdentityTag,           STRING,   NULL),
347
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
348
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
349
350
351
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
352
  V(MaxClientCircuitsPending,    UINT,     "32"),
353
  VAR("MaxMemInQueues",          MEMUNIT,   MaxMemInQueues_raw, "0"),
354
355
  OBSOLETE("MaxOnionsPending"),
  V(MaxOnionQueueDelay,          MSEC_INTERVAL, "1750 msec"),
356
  V(MaxUnparseableDescSizeToLog, MEMUNIT, "10 MB"),
357
  V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
358
359
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
360
  OBSOLETE("NamingAuthoritativeDirectory"),
361
  V(NATDListenAddress,           LINELIST, NULL),
362
  VPORT(NATDPort,                    LINELIST, NULL),
363
  V(Nickname,                    STRING,   NULL),
364
  V(PredictedPortsRelevanceTime,  INTERVAL, "1 hour"),
365
  V(WarnUnsafeSocks,              BOOL,     "1"),
366
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
367
  V(NumCPUs,                     UINT,     "0"),
368
  V(NumDirectoryGuards,          UINT,     "0"),
369
  V(NumEntryGuards,              UINT,     "0"),
Nick Mathewson's avatar
Nick Mathewson committed
370
  V(OfflineMasterKey,            BOOL,     "0"),
371
  V(ORListenAddress,             LINELIST, NULL),
372
  VPORT(ORPort,                      LINELIST, NULL),
373
  V(OutboundBindAddress,         LINELIST,   NULL),
374

375
  OBSOLETE("PathBiasDisableRate"),
376
377
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
378
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
379
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
380
  V(PathBiasScaleThreshold,      INT,      "-1"),
381
382
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
383
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
384
385
386
387
388
389
  OBSOLETE("PathBiasUseCloseCounts"),

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

391
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
392
393
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
394
  V(PidFile,                     STRING,   NULL),
395
  V(TestingTorNetwork,           BOOL,     "0"),
396
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
397
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
398

399
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
400
401
402
403
404
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

405
  V(OptimisticData,              AUTOBOOL, "auto"),
406
407
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
408
  OBSOLETE("PreferTunneledDirConns"),
409
  V(ProtocolWarnings,            BOOL,     "0"),
410
  V(PublishServerDescriptor,     CSV,      "1"),
411
412
413
414
415
416
417
  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),
418
  V(RecommendedPackages,         LINELIST, NULL),
419
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
420
  V(RejectPlaintextPorts,        CSV,      ""),
421
422
423
424
425
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
426
  OBSOLETE("RunTesting"), // currently unused
427
  V(Sandbox,                     BOOL,     "0"),
428
  V(SafeLogging,                 STRING,   "1"),
429
  V(SafeSocks,                   BOOL,     "0"),
430
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
431
432
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
433
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
434
435
436
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
437
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
438
439
440
  V(SchedulerLowWaterMark__,     MEMUNIT,  "100 MB"),
  V(SchedulerHighWaterMark__,    MEMUNIT,  "101 MB"),
  V(SchedulerMaxFlushCells__,    UINT,     "1000"),
441
442
443
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
444
  VPORT(SocksPort,                   LINELIST, NULL),
445
  V(SocksTimeout,                INTERVAL, "2 minutes"),
446
  V(SSLKeyLifetime,              INTERVAL, "0"),
447
448
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
449
  V(StrictNodes,                 BOOL,     "0"),
450
  OBSOLETE("Support022HiddenServices"),
451
  V(TestSocks,                   BOOL,     "0"),
452
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
453
  V(Tor2webMode,                 BOOL,     "0"),
454
  V(Tor2webRendezvousPoints,      ROUTERSET, NULL),
455
  V(TLSECGroup,                  STRING,   NULL),
456
457
458
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
  V(TransListenAddress,          LINELIST, NULL),
459
  VPORT(TransPort,                   LINELIST, NULL),
460
  V(TransProxyType,              STRING,   "default"),
461
  OBSOLETE("TunnelDirConns"),
462
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
463
  V(UseBridges,                  BOOL,     "0"),
464
  VAR("UseEntryGuards",          BOOL,     UseEntryGuards_option, "1"),
465
  V(UseEntryGuardsAsDirGuards,   BOOL,     "1"),
466
  V(UseGuardFraction,            AUTOBOOL, "auto"),
467
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
468
  OBSOLETE("UseNTorHandshake"),
469
  V(User,                        STRING,   NULL),
470
  OBSOLETE("UserspaceIOCPBuffers"),
471
  V(AuthDirSharedRandomness,     BOOL,     "1"),
472
  OBSOLETE("V1AuthoritativeDirectory"),
473
  OBSOLETE("V2AuthoritativeDirectory"),
474
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
475
476
477
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
478
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
479
480
481
482
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
483
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
484
  V(V3BandwidthsFile,            FILENAME, NULL),
485
  V(GuardfractionFile,           FILENAME, NULL),
486
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
487
  OBSOLETE("VoteOnHidServDirectoriesV2"),
488
489
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
490
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
491
492
  OBSOLETE("UseFilteringSSLBufferevents"),
  OBSOLETE("__UseFilteringSSLBufferevents"),
493
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
494
495
496
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
497
498
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
499
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
500
  V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
501
502
503
504
505
506
507
508
509
510
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 60, 60, 120, "
                                 "300, 900, 2147483647"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 60, 300, 600, "
                                 "2147483647"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 1800, 1800, 1800, "
                                 "1800, 3600, 7200"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 3600, 3600, 3600, "
                                 "10800, 21600, 43200"),
511
  /* With the ClientBootstrapConsensus*Download* below:
512
513
514
515
516
517
518
519
520
521
522
523
   * Clients with only authorities will try:
   *  - 3 authorities over 10 seconds, then wait 60 minutes.
   * Clients with authorities and fallbacks will try:
   *  - 2 authorities and 4 fallbacks over 21 seconds, then wait 60 minutes.
   * Clients will also retry when an application request arrives.
   * After a number of failed reqests, clients retry every 3 days + 1 hour.
   *
   * Clients used to try 2 authorities over 10 seconds, then wait for
   * 60 minutes or an application request.
   *
   * When clients have authorities and fallbacks available, they use these
   * schedules: (we stagger the times to avoid thundering herds) */
524
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
525
    "6, 11, 3600, 10800, 25200, 54000, 111600, 262800" /* 3 days + 1 hour */),
526
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
527
528
    "0, 1, 4, 11, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* When clients only have authorities available, they use this schedule: */
529
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
530
531
532
533
534
    "0, 3, 7, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* We don't want to overwhelm slow networks (or mirrors whose replies are
   * blocked), but we also don't want to fail if only some mirrors are
   * blackholed. Clients will try 3 directories simultaneously.
   * (Relays never use simultaneous connections.) */
535
  V(ClientBootstrapConsensusMaxInProgressTries, UINT, "3"),
536
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "1200, 900, 900, 3600"),
537
538
539
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
  V(TestingConsensusMaxDownloadTries, UINT, "8"),
540
541
  /* Since we try connections rapidly and simultaneously, we can afford
   * to give up earlier. (This protects against overloading directories.) */
542
  V(ClientBootstrapConsensusMaxDownloadTries, UINT, "7"),
543
  /* We want to give up much earlier if we're only using authorities. */
544
  V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "4"),
545
546
547
  V(TestingDescriptorMaxDownloadTries, UINT, "8"),
  V(TestingMicrodescMaxDownloadTries, UINT, "8"),
  V(TestingCertMaxDownloadTries, UINT, "8"),
548
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
549
  V(TestingDirAuthVoteExitIsStrict,  BOOL,     "0"),
550
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
551
  V(TestingDirAuthVoteGuardIsStrict,  BOOL,     "0"),
552
  V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
553
  V(TestingDirAuthVoteHSDirIsStrict,  BOOL,     "0"),
554
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
555

556
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
557
};
558

559
560
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
561
static const config_var_t testing_tor_network_defaults[] = {
562
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
563
564
565
566
567
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
568
569
570
571
572
573
574
575
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
    "0, 2, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusMaxDownloadTries, UINT, "80"),
  V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "80"),
576
  V(ClientDNSRejectInternalAddresses, BOOL,"0"), // deprecated in 0.2.9.2-alpha
577
  V(ClientRejectInternalAddresses, BOOL,   "0"),
578
  V(CountPrivateBandwidth,       BOOL,     "1"),
579
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
580
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
581
582
583
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
584
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
585
586
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
587
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
588
589
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
590
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 5, 10, 15, "
                                 "20, 30, 60"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, 15, 20, "
                                 "30, 60"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "60, 30, 30, 60"),
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "5 seconds"),
  V(TestingDirConnectionMaxStall, INTERVAL, "30 seconds"),
  V(TestingConsensusMaxDownloadTries, UINT, "80"),
  V(TestingDescriptorMaxDownloadTries, UINT, "80"),
  V(TestingMicrodescMaxDownloadTries, UINT, "80"),
  V(TestingCertMaxDownloadTries, UINT, "80"),
606
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
607
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
608
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
609
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
610
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
611

612
613
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
614

615
#undef VAR
616
#undef V
617
618
#undef OBSOLETE

619
static const config_deprecation_t option_deprecation_notes_[] = {
620
  /* Deprecated since 0.2.9.2-alpha... */
621
622
623
624
625
626
627
628
629
630
631
632
633
634
  { "AllowDotExit", "Unrestricted use of the .exit notation can be used for "
    "a wide variety of application-level attacks." },
  { "AllowInvalidNodes", "There is no reason to enable this option; at best "
    "it will make you easier to track." },
  { "AllowSingleHopCircuits", "Almost no relays actually allow single-hop "
    "exits, making this option pointless." },
  { "AllowSingleHopExits", "Turning this on will make your relay easier "
    "to abuse." },
  { "ClientDNSRejectInternalAddresses", "Turning this on makes your client "
    "easier to fingerprint, and may open you to esoteric attacks." },
  { "ExcludeSingleHopRelays", "Turning it on makes your client easier to "
    "fingerprint." },
  { "FastFirstHopPK", "Changing this option does not make your client more "
    "secure, but does make it easier to fingerprint." },
635
  { "CloseHSClientCircuitsImmediatelyOnTimeout", "This option makes your "
636
    "client easier to fingerprint." },
637
  { "CloseHSServiceRendCircuitsImmediatelyOnTimeout", "This option makes "
638
639
640
641
642
643
644
645
646
647
648
649
650
651
    "your hidden services easier to fingerprint." },
  { "WarnUnsafeSocks", "Changing this option makes it easier for you "
    "to accidentally lose your anonymity by leaking DNS information" },
  { "TLSECGroup", "The default is a nice secure choice; the other option "
    "is less secure." },
  { "ControlListenAddress", "Use ControlPort instead." },
  { "DirListenAddress", "Use DirPort instead, possibly with the "
    "NoAdvertise sub-option" },
  { "DNSListenAddress", "Use DNSPort instead." },
  { "SocksListenAddress", "Use SocksPort instead." },
  { "TransListenAddress", "Use TransPort instead." },
  { "NATDListenAddress", "Use NATDPort instead." },
  { "ORListenAddress", "Use ORPort instead, possibly with the "
    "NoAdvertise sub-option" },
652
  /* End of options deprecated since 0.2.9.2-alpha. */
653
654
655
656

  { NULL, NULL }
};

657
#ifdef _WIN32
658
659
static char *get_windows_conf_root(void);
#endif
660
661
662
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
663
                                      char **msg);
664
665
666
667
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);
668
static int check_nickname_list(char **lst, const char *name, char **msg);
669
670
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
671
static int parse_ports(or_options_t *options, int validate_only,
672
673
                              char **msg_out, int *n_ports_out,
                              int *world_writable_control_socket);
674
static int check_server_ports(const smartlist_t *ports,
675
676
                              const or_options_t *options,
                              int *num_low_ports_out);
677

678
static int validate_data_directory(or_options_t *options);
679
680
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
681
682
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
683

684
static void init_libevent(const or_options_t *options);
685
static int opt_streq(const char *s1, const char *s2);
686
687
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
688
689
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
690
691
692
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
693
694
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
695

696
/** Magic value for or_options_t. */
697
698
#define OR_OPTIONS_MAGIC 9090909

699
/** Configuration format for or_options_t. */
700
STATIC config_format_t options_format = {
701
702
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
703
704
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
705
  option_deprecation_notes_,
706
  option_vars_,
707
  options_validate_cb,
708
  NULL
709
710
};

711
712
713
714
715
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
716
static or_options_t *global_options = NULL;
717
718
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
719
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
720
/** Name of most recently read torrc file. */
721
static char *torrc_fname = NULL;
722
/** Name of the most recently read torrc-defaults file.*/
723
static char *torrc_defaults_fname;
724
/** Configuration options set by command line. */
725
static config_line_t *global_cmdline_options = NULL;
726
727
728
729
/** Non-configuration options set by the command line */
static config_line_t *global_cmdline_only_options = NULL;
/** Boolean: Have we parsed the command line? */
static int have_parsed_cmdline = 0;
Roger Dingledine's avatar
Roger Dingledine committed
730
/** Contents of most recently read DirPortFrontPage file. */
731
static char *global_dirfrontpagecontents = NULL;
732
733
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
734
735

/** Return the contents of our frontpage string, or NULL if not configured. */
736
737
MOCK_IMPL(const char*,
get_dirportfrontpage, (void))
738
739
740