config.c 246 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
  { "_UseFilteringSSLBufferevents", "UseFilteringSSLBufferevents", 0, 1},
134
135
  { NULL, NULL, 0, 0},
};
136
137

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

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

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

172
173
174
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

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

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

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

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

465
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
466
};
467

468
469
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
470
static const config_var_t testing_tor_network_defaults[] = {
471
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
472
473
474
475
476
477
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
478
  V(ClientRejectInternalAddresses, BOOL,   "0"),
479
  V(CountPrivateBandwidth,       BOOL,     "1"),
480
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
481
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
482
483
484
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
485
486
487
488
489
  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"),
490
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
491
  VAR("___UsingTestNetworkDefaults", BOOL, _UsingTestNetworkDefaults, "1"),
492

493
494
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
495
496
#undef VAR

497
498
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
499
      initvalue }
500
501

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

505
506
507
508
509
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
510
511
512
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
513

514
515
516
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
517
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
518
  VAR("EntryGuardPathBias",      LINELIST_S,  EntryGuards,             NULL),
519
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
520

521
522
523
  VAR("TransportProxy",               LINELIST_S, TransportProxies, NULL),
  V(TransportProxies,                 LINELIST_V, NULL),

524
525
526
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
527
  V(BWHistoryReadMaxima,              CSV,      ""),
528
529
530
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
531
  V(BWHistoryWriteMaxima,             CSV,      ""),
532
533
534
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
535
  V(BWHistoryDirReadMaxima,           CSV,      ""),
536
537
538
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
539
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
540

541
  V(TorVersion,                       STRING,   NULL),
542

543
544
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
545

546
  V(TotalBuildTimes,                  UINT,     NULL),
547
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
548
549
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
550
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
551
552
};

553
#undef VAR
554
#undef V
555
556
#undef OBSOLETE

557
558
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
559
560
561
562
563
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

564
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
565
 * well-formed and consistent. See options_trial_assign() for documentation
566
 * of arguments. */
567
typedef int (*validate_fn_t)(void*,void*,int,char**);
568

569
570
571
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
572
typedef struct {
573
574
575
  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
576
  off_t magic_offset; /**< Offset of the magic value within the struct. */
577
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
578
                             * parsing this format. */
579
580
581
  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
582
583
584
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
585
586
} config_format_t;

587
588
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
589
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
590
    tor_assert(fmt && cfg);                                             \
591
    tor_assert((fmt)->magic ==                                          \
592
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
593
  STMT_END
594

595
#ifdef _WIN32
596
597
static char *get_windows_conf_root(void);
#endif
598
static void config_line_append(config_line_t **lst,
599
                               const char *key, const char *val);
600
601
602
603
604
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);
605
static int config_lines_eq(config_line_t *a, config_line_t *b);
606
static int config_count_key(const config_line_t *a, const char *key);
607
608
static int option_is_same(const config_format_t *fmt,
                          const or_options_t *o1, const or_options_t *o2,
609
                          const char *name);
610
611
612
613
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,
614
                            int from_setconf, char **msg);
615
616
617
618
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,
619
                                      char **msg);
620
621
622
623
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);
624
static int check_nickname_list(const char *lst, const char *name, char **msg);
625

626
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
627
static int parse_client_transport_line(const char *line, int validate_only);
628
629

static int parse_server_transport_line(const char *line, int validate_only);
630
static int parse_dir_server_line(const char *line,
631
                                 dirinfo_type_t required_type,
632
                                 int validate_only);
633
static void port_cfg_free(port_cfg_t *port);
634
static int parse_ports(or_options_t *options, int validate_only,
635
                              char **msg_out, int *n_ports_out);
636
637
638
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

639
static int validate_data_directory(or_options_t *options);
640
641
642
643
644
645
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);
646
static int or_state_validate(or_state_t *old_options, or_state_t *options,
647
                             int from_setconf, char **msg);
648
649
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
650

651
static uint64_t config_parse_memunit(const char *s, int *ok);
652
static int config_parse_msec_interval(const char *s, int *ok);
653
static int config_parse_interval(const char *s, int *ok);
654
static void init_libevent(const or_options_t *options);
655
static int opt_streq(const char *s1, const char *s2);
656

657
/** Magic value for or_options_t. */
658
659
#define OR_OPTIONS_MAGIC 9090909

660
/** Configuration format for or_options_t. */
661
static config_format_t options_format = {
662
663
664
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
665
666
667
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
668
  NULL
669
670
};

671
/** Magic value for or_state_t. */
672
673
#define OR_STATE_MAGIC 0x57A73f57

674
675
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
676
677
678
679
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

680
/** Configuration format for or_state_t. */
681
static const config_format_t state_format = {
682
683
684
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
685
  _state_abbrevs,
686
687
  _state_vars,
  (validate_fn_t)or_state_validate,
688
  &state_extra_var,
689
690
};

691
692
693
694
695
/*
 * Functions to read and write the global options pointer.
 */

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

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

720
/** Allocate an empty configuration object of a given format type. */
721
static void *
722
config_new(const config_format_t *fmt)
723
{
724
  void *opts = tor_malloc_zero(fmt->size);