config.c 241 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"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "networkstatus.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "router.h"
36
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "routerlist.h"
38
#include "transports.h"
39
#ifdef _WIN32
40
41
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
42

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

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

Nick Mathewson's avatar
Nick Mathewson committed
48
49
/** Enumeration of types which option values can take */
typedef enum config_type_t {
50
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
51
  CONFIG_TYPE_FILENAME,     /**< A filename: some prefixes get expanded. */
52
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
53
  CONFIG_TYPE_INT,          /**< Any integer. */
54
55
  CONFIG_TYPE_PORT,         /**< A port from 1...65535, 0 for "not set", or
                             * "auto".  */
56
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
57
58
  CONFIG_TYPE_MSEC_INTERVAL,/**< A number of milliseconds, with optional
                              * units */
59
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
60
61
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
62
63
  CONFIG_TYPE_AUTOBOOL,     /**< A boolean+auto value, expressed 0 for false,
                             * 1 for true, and -1 for auto  */
Nick Mathewson's avatar
Nick Mathewson committed
64
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formatted time relative to GMT. */
65
66
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
67
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
68
69
70
71
72
  CONFIG_TYPE_LINELIST_S,   /**< Uninterpreted, context-sensitive config lines,
                             * mixed with other keywords. */
  CONFIG_TYPE_LINELIST_V,   /**< Catch-all "virtual" option to summarize
                             * context-sensitive config lines when fetching.
                             */
73
74
  CONFIG_TYPE_ROUTERSET,    /**< A list of router names, addrs, and fps,
                             * parsed into a routerset_t. */
75
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
76
} config_type_t;
77

78
/** An abbreviation for a configuration option allowed on the command line. */
79
typedef struct config_abbrev_t {
80
81
  const char *abbreviated;
  const char *full;
82
  int commandline_only;
83
  int warn;
84
85
} config_abbrev_t;

86
87
/* Handy macro for declaring "In the config file or on the command line,
 * you can abbreviate <b>tok</b>s as <b>tok</b>". */
88
#define PLURAL(tok) { #tok, #tok "s", 0, 0 }
89

90
91
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
92
static config_abbrev_t _option_abbrevs[] = {
93
94
95
96
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
97
  PLURAL(ExitNode),
98
  PLURAL(EntryNode),
99
100
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
101
  PLURAL(LongLivedPort),
102
103
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
104
  PLURAL(NumCPU),
105
106
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
107
108
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
109
  PLURAL(StrictNode),
110
  { "l", "Log", 1, 0},
111
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
112
113
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
114
115
116
117
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
118
119
120
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
121
122
123
124
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
125
126
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
127
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
128
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
129
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
130
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
131
132
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
133
134
  { NULL, NULL, 0, 0},
};
135
136

/** A list of state-file "abbreviations," for compatibility. */
137
static config_abbrev_t _state_abbrevs[] = {
138
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
139
140
141
142
143
144
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
145
  { NULL, NULL, 0, 0},
146
};
147
#undef PLURAL
148

149
/** A variable allowed in the configuration file or on the command line. */
150
typedef struct config_var_t {
151
  const char *name; /**< The full keyword (case insensitive). */
152
153
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
154
155
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
156
157
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
158
159
160
161
/** 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>"
 */
162
163
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
164
      initvalue }
165
166
167
/** 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
168
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
169
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
170

Nick Mathewson's avatar
Nick Mathewson committed
171
172
173
174
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
175
static config_var_t _option_vars[] = {
176
  OBSOLETE("AccountingMaxKB"),
177
178
179
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
180
  V(AllowDotExit,                BOOL,     "0"),
181
182
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
183
184
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
185
186
187
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
  V(AlternateHSAuthority,        LINELIST, NULL),
188
  V(AssumeReachable,             BOOL,     "0"),
189
  V(AuthDirBadDir,               LINELIST, NULL),
190
  V(AuthDirBadDirCCs,            CSV,      ""),
191
  V(AuthDirBadExit,              LINELIST, NULL),
192
  V(AuthDirBadExitCCs,           CSV,      ""),
193
  V(AuthDirInvalid,              LINELIST, NULL),
194
  V(AuthDirInvalidCCs,           CSV,      ""),
195
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
196
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "250 KB"),
197
  V(AuthDirReject,               LINELIST, NULL),
198
  V(AuthDirRejectCCs,            CSV,      ""),
199
  V(AuthDirRejectUnlisted,       BOOL,     "0"),
200
  V(AuthDirListBadDirs,          BOOL,     "0"),
201
  V(AuthDirListBadExits,         BOOL,     "0"),
202
203
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
204
205
206
207
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
208
209
  V(BandwidthBurst,              MEMUNIT,  "10 MB"),
  V(BandwidthRate,               MEMUNIT,  "5 MB"),
210
211
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
212
  V(BridgePassword,              STRING,   NULL),
213
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
214
  V(BridgeRelay,                 BOOL,     "0"),
215
  V(CellStatistics,              BOOL,     "0"),
216
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
217
  V(CircuitBuildTimeout,         INTERVAL, "0"),
218
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
219
  V(CircuitStreamTimeout,        INTERVAL, "0"),
220
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
221
222
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
223
  V(ClientRejectInternalAddresses, BOOL,   "1"),
224
  V(ClientTransportPlugin,       LINELIST, NULL),
225
  V(ConsensusParams,             STRING,   NULL),
226
  V(ConnLimit,                   UINT,     "1000"),
227
  V(ConnDirectionStatistics,     BOOL,     "0"),
228
229
230
231
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
232
  V(ControlPort,                 LINELIST, NULL),
233
  V(ControlPortFileGroupReadable,BOOL,     "0"),
234
  V(ControlPortWriteToFile,      FILENAME, NULL),
235
  V(ControlSocket,               LINELIST, NULL),
236
  V(ControlSocketsGroupWritable, BOOL,     "0"),
237
238
239
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
240
  V(CountPrivateBandwidth,       BOOL,     "0"),
241
  V(DataDirectory,               FILENAME, NULL),
242
  OBSOLETE("DebugLogFile"),
243
  V(DisableNetwork,              BOOL,     "0"),
244
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
245
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
246
  V(DirListenAddress,            LINELIST, NULL),
247
  OBSOLETE("DirFetchPeriod"),
248
  V(DirPolicy,                   LINELIST, NULL),
249
  V(DirPort,                     LINELIST, NULL),
250
  V(DirPortFrontPage,            FILENAME, NULL),
251
  OBSOLETE("DirPostPeriod"),
252
253
254
255
  OBSOLETE("DirRecordUsageByCountry"),
  OBSOLETE("DirRecordUsageGranularity"),
  OBSOLETE("DirRecordUsageRetainIPs"),
  OBSOLETE("DirRecordUsageSaveInterval"),
256
  V(DirReqStatistics,            BOOL,     "1"),
257
  VAR("DirServer",               LINELIST, DirServers, NULL),
258
  V(DisableAllSwap,              BOOL,     "0"),
259
  V(DisableDebuggerAttachment,   BOOL,     "1"),
260
  V(DisableIOCP,                 BOOL,     "1"),
261
  V(DynamicDHGroups,             BOOL,     "0"),
262
  V(DNSPort,                     LINELIST, NULL),
263
264
265
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
266
  V(EntryNodes,                  ROUTERSET,   NULL),
267
  V(EntryStatistics,             BOOL,     "0"),
268
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
269
270
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
271
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
272
  V(ExitNodes,                   ROUTERSET, NULL),
273
274
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
275
  V(ExitPortStatistics,          BOOL,     "0"),
276
  V(ExtraInfoStatistics,         BOOL,     "1"),
277

valerino's avatar
valerino committed
278
279
280
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
281
  V(FallbackNetworkstatusFile,   FILENAME,
282
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
283
#endif
284
285
286
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
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
  V(FetchV2Networkstatus,        BOOL,     "0"),
293
#ifdef _WIN32
294
  V(GeoIPFile,                   FILENAME, "<default>"),
295
#else
296
297
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
298
#endif
299
  OBSOLETE("GiveGuardFlagTo_CVE_2011_2768_VulnerableRelays"),
300
  OBSOLETE("Group"),
301
  V(HardwareAccel,               BOOL,     "0"),
302
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
303
304
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
305
  V(HashedControlPassword,       LINELIST, NULL),
306
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
307
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
308
309
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
310
311
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
312
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
313
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
314
  V(HidServAuth,                 LINELIST, NULL),
315
  V(HSAuthoritativeDir,          BOOL,     "0"),
316
  OBSOLETE("HSAuthorityRecordStats"),
317
  V(CloseHSClientCircuitsImmediatelyOnTimeout, BOOL, "0"),
318
  V(CloseHSServiceRendCircuitsImmediatelyOnTimeout, BOOL, "0"),
319
320
321
322
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
323
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
324
325
326
327
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
328
  OBSOLETE("IgnoreVersion"),
329
330
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
331
  V(LogMessageDomains,           BOOL,     "0"),
332
  OBSOLETE("LinkPadding"),
333
334
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
335
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
336
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
337
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
338
339
340
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
341
  V(MaxClientCircuitsPending,    UINT,     "32"),
342
  V(MaxOnionsPending,            UINT,     "100"),
343
  OBSOLETE("MonthlyAccountingStart"),
344
345
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
346
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
347
  V(NATDListenAddress,           LINELIST, NULL),
348
  V(NATDPort,                    LINELIST, NULL),
349
  V(Nickname,                    STRING,   NULL),
350
  V(WarnUnsafeSocks,              BOOL,     "1"),
Sebastian Hahn's avatar
Sebastian Hahn committed
351
  OBSOLETE("NoPublish"),
352
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
353
  V(NumCPUs,                     UINT,     "0"),
354
355
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
356
  V(ORPort,                      LINELIST, NULL),
357
  V(OutboundBindAddress,         STRING,   NULL),
358
359
360
361
362
363
364

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

365
  OBSOLETE("PathlenCoinWeight"),
366
367
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
368
  V(PidFile,                     STRING,   NULL),
369
  V(TestingTorNetwork,           BOOL,     "0"),
370
  V(OptimisticData,              AUTOBOOL, "auto"),
371
372
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
Roger Dingledine's avatar
Roger Dingledine committed
373
  V(PreferTunneledDirConns,      BOOL,     "1"),
374
  V(ProtocolWarnings,            BOOL,     "0"),
375
  V(PublishServerDescriptor,     CSV,      "1"),
376
377
378
379
380
381
382
  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),
383
  OBSOLETE("RedirectExit"),
384
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
385
  V(RejectPlaintextPorts,        CSV,      ""),
386
387
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
388
389
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
390
391
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
392
  OBSOLETE("RouterFile"),
393
  V(RunAsDaemon,                 BOOL,     "0"),
394
395
//  V(RunTesting,                  BOOL,     "0"),
  OBSOLETE("RunTesting"), // currently unused
396
  V(SafeLogging,                 STRING,   "1"),
397
  V(SafeSocks,                   BOOL,     "0"),
398
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
399
400
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
401
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
402
403
404
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
405
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
406
407
408
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
409
  V(SocksPort,                   LINELIST, NULL),
410
  V(SocksTimeout,                INTERVAL, "2 minutes"),
411
  OBSOLETE("StatusFetchPeriod"),
412
  V(StrictNodes,                 BOOL,     "0"),
413
  OBSOLETE("SysLog"),
414
  V(TestSocks,                   BOOL,     "0"),
415
  OBSOLETE("TestVia"),
416
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
417
  V(Tor2webMode,                 BOOL,     "0"),
418
419
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
420
  OBSOLETE("TrafficShaping"),
421
  V(TransListenAddress,          LINELIST, NULL),
422
  V(TransPort,                   LINELIST, NULL),
Roger Dingledine's avatar
Roger Dingledine committed
423
  V(TunnelDirConns,              BOOL,     "1"),
424
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
425
  V(UseBridges,                  BOOL,     "0"),
426
  V(UseEntryGuards,              BOOL,     "1"),
427
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
428
  V(User,                        STRING,   NULL),
429
  V(UserspaceIOCPBuffers,        BOOL,     "0"),
430
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
431
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
432
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
433
434
435
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
436
437
438
439
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
440
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
441
  V(V3BandwidthsFile,            FILENAME, NULL),
442
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
443
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
444
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
445
  V(_UseFilteringSSLBufferevents, BOOL,    "0"),
446
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
447
448
449
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
450
451
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
452
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
453
  V(MinUptimeHidServDirectoryV2, INTERVAL, "25 hours"),
454
  V(VoteOnHidServDirectoriesV2,  BOOL,     "1"),
455
  V(_UsingTestNetworkDefaults,   BOOL,     "0"),
456

457
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
458
};
459

460
461
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
462
static const config_var_t testing_tor_network_defaults[] = {
463
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
464
465
466
467
468
469
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
470
  V(ClientRejectInternalAddresses, BOOL,   "0"),
471
  V(CountPrivateBandwidth,       BOOL,     "1"),
472
473
474
475
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
476
477
478
479
480
  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"),
481
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
482
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
483

484
485
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
486
487
#undef VAR

488
489
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
490
      initvalue }
491
492

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

496
497
498
499
500
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
501
502
503
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
504

505
506
507
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
508
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
509
  VAR("EntryGuardPathBias",      LINELIST_S,  EntryGuards,             NULL),
510
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
511

512
513
514
  VAR("TransportProxy",               LINELIST_S, TransportProxies, NULL),
  V(TransportProxies,                 LINELIST_V, NULL),

515
516
517
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
518
  V(BWHistoryReadMaxima,              CSV,      ""),
519
520
521
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
522
  V(BWHistoryWriteMaxima,             CSV,      ""),
523
524
525
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
526
  V(BWHistoryDirReadMaxima,           CSV,      ""),
527
528
529
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
530
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
531

532
  V(TorVersion,                       STRING,   NULL),
533

534
535
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
536

537
  V(TotalBuildTimes,                  UINT,     NULL),
538
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
539
540
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
541
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
542
543
};

544
#undef VAR
545
#undef V
546
547
#undef OBSOLETE

548
549
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
550
551
552
553
554
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

555
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
556
 * well-formed and consistent. See options_trial_assign() for documentation
557
 * of arguments. */
558
typedef int (*validate_fn_t)(void*,void*,int,char**);
559

560
561
562
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
563
typedef struct {
564
565
566
  size_t size; /**< Size of the struct that everything gets parsed into. */
  uint32_t magic; /**< Required 'magic value' to make sure we have a struct
                   * of the right type. */
Roger Dingledine's avatar
Roger Dingledine committed
567
  off_t magic_offset; /**< Offset of the magic value within the struct. */
568
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
569
                             * parsing this format. */
570
571
572
  config_var_t *vars; /**< List of variables we recognize, their default
                       * values, and where we stick them in the structure. */
  validate_fn_t validate_fn; /**< Function to validate config. */
Roger Dingledine's avatar
Roger Dingledine committed
573
574
575
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
576
577
} config_format_t;

578
579
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
580
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
581
    tor_assert(fmt && cfg);                                             \
582
    tor_assert((fmt)->magic ==                                          \
583
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
584
  STMT_END
585

586
#ifdef _WIN32
587
588
static char *get_windows_conf_root(void);
#endif
589
static void config_line_append(config_line_t **lst,
590
                               const char *key, const char *val);
591
592
593
594
595
static void option_clear(const config_format_t *fmt, or_options_t *options,
                         const config_var_t *var);
static void option_reset(const config_format_t *fmt, or_options_t *options,
                         const config_var_t *var, int use_defaults);
static void config_free(const config_format_t *fmt, void *options);
596
static int config_lines_eq(config_line_t *a, config_line_t *b);
597
static int config_count_key(const config_line_t *a, const char *key);
598
599
static int option_is_same(const config_format_t *fmt,
                          const or_options_t *o1, const or_options_t *o2,
600
                          const char *name);
601
602
603
604
static or_options_t *options_dup(const config_format_t *fmt,
                                 const or_options_t *old);
static int options_validate(or_options_t *old_options,
                            or_options_t *options,
605
                            int from_setconf, char **msg);
606
607
608
609
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,
610
                                      char **msg);
611
612
613
614
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);
615
static int check_nickname_list(const char *lst, const char *name, char **msg);
616

617
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
618
static int parse_client_transport_line(const char *line, int validate_only);
619
620

static int parse_server_transport_line(const char *line, int validate_only);
621
static int parse_dir_server_line(const char *line,
622
                                 dirinfo_type_t required_type,
623
                                 int validate_only);
624
static void port_cfg_free(port_cfg_t *port);
625
static int parse_ports(const or_options_t *options, int validate_only,
626
                              char **msg_out, int *n_ports_out);
627
628
629
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

630
static int validate_data_directory(or_options_t *options);
631
632
633
634
635
636
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
static config_line_t *get_assigned_option(const config_format_t *fmt,
                                        const void *options, const char *key,
                                        int escape_val);
static void config_init(const config_format_t *fmt, void *options);
637
static int or_state_validate(or_state_t *old_options, or_state_t *options,
638
                             int from_setconf, char **msg);
639
640
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
641

642
static uint64_t config_parse_memunit(const char *s, int *ok);
643
static int config_parse_msec_interval(const char *s, int *ok);
644
static int config_parse_interval(const char *s, int *ok);
645
static void init_libevent(const or_options_t *options);
646
static int opt_streq(const char *s1, const char *s2);
647

648
/** Magic value for or_options_t. */
649
650
#define OR_OPTIONS_MAGIC 9090909

651
/** Configuration format for or_options_t. */
652
static config_format_t options_format = {
653
654
655
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
656
657
658
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
659
  NULL
660
661
};

662
/** Magic value for or_state_t. */
663
664
#define OR_STATE_MAGIC 0x57A73f57

665
666
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
667
668
669
670
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

671
/** Configuration format for or_state_t. */
672
static const config_format_t state_format = {
673
674
675
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
676
  _state_abbrevs,
677
678
  _state_vars,
  (validate_fn_t)or_state_validate,
679
  &state_extra_var,
680
681
};

682
683
684
685
686
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
687
static or_options_t *global_options = NULL;
688
689
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
690
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
691
/** Name of most recently read torrc file. */
692
static char *torrc_fname = NULL;
693
/** Name of the most recently read torrc-defaults file.*/
694
static char *torrc_defaults_fname;
695
/** Persistent serialized state. */
696
static or_state_t *global_state = NULL;
697
698
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
699
/** Contents of most recently read DirPortFrontPage file. */
700
static char *global_dirfrontpagecontents = NULL;
701
702
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
703
704
705
706
707
708
709

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

711
/** Allocate an empty configuration object of a given format type. */
712
static void *
713
config_alloc(const config_format_t *fmt)
714
{
715
  void *opts = tor_malloc_zero(fmt->size);
716
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
717
718
719
720
  CHECK(fmt, opts);
  return opts;
}

721
722
/** Return the currently configured options. */
or_options_t *
723
get_options_mutable(void)
724
{
725
726
727
  tor_assert(global_options);
  return global_options;
}
728

729
730
731
732
733
734
735
/** Returns the currently configured options */
const or_options_t *