config.c 176 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-2011, 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"
Sebastian Hahn's avatar
Sebastian Hahn committed
36
#include "routerlist.h"
37
38
39
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
40

Nick Mathewson's avatar
Nick Mathewson committed
41
42
/** Enumeration of types which option values can take */
typedef enum config_type_t {
43
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
44
  CONFIG_TYPE_FILENAME,     /**< A filename: some prefixes get expanded. */
45
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
46
47
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
48
49
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
Nick Mathewson's avatar
Nick Mathewson committed
50
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formatted time relative to GMT. */
51
52
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
53
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
54
55
56
57
58
  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.
                             */
59
60
  CONFIG_TYPE_ROUTERSET,    /**< A list of router names, addrs, and fps,
                             * parsed into a routerset_t. */
61
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
62
} config_type_t;
63

64
/** An abbreviation for a configuration option allowed on the command line. */
65
typedef struct config_abbrev_t {
66
67
  const char *abbreviated;
  const char *full;
68
  int commandline_only;
69
  int warn;
70
71
} config_abbrev_t;

72
73
/* Handy macro for declaring "In the config file or on the command line,
 * you can abbreviate <b>tok</b>s as <b>tok</b>". */
74
#define PLURAL(tok) { #tok, #tok "s", 0, 0 }
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
  PLURAL(ExitNode),
80
  PLURAL(EntryNode),
81
82
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
83
  PLURAL(LongLivedPort),
84
85
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
86
  PLURAL(NumCPU),
87
88
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
89
90
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
91
  PLURAL(StrictNode),
92
  { "l", "Log", 1, 0},
93
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
94
95
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
96
97
98
99
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
100
101
102
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
103
104
105
106
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
107
108
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
109
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
110
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
111
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
112
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
113
114
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
115
116
  { NULL, NULL, 0, 0},
};
117
118

/** A list of state-file "abbreviations," for compatibility. */
119
static config_abbrev_t _state_abbrevs[] = {
120
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
121
122
123
124
125
126
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
127
  { NULL, NULL, 0, 0},
128
};
129
#undef PLURAL
130

131
/** A variable allowed in the configuration file or on the command line. */
132
typedef struct config_var_t {
133
  const char *name; /**< The full keyword (case insensitive). */
134
135
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
136
137
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
138
139
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
140
141
142
143
/** 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>"
 */
144
145
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
146
      initvalue }
147
148
149
/** 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
150
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
151
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
152

Nick Mathewson's avatar
Nick Mathewson committed
153
154
155
156
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
157
static config_var_t _option_vars[] = {
158
  OBSOLETE("AccountingMaxKB"),
159
160
161
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
162
  V(AllowDotExit,                BOOL,     "0"),
163
164
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
165
166
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
167
168
169
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
  V(AlternateHSAuthority,        LINELIST, NULL),
170
  V(AssumeReachable,             BOOL,     "0"),
171
  V(AuthDirBadDir,               LINELIST, NULL),
172
173
174
175
  V(AuthDirBadExit,              LINELIST, NULL),
  V(AuthDirInvalid,              LINELIST, NULL),
  V(AuthDirReject,               LINELIST, NULL),
  V(AuthDirRejectUnlisted,       BOOL,     "0"),
176
  V(AuthDirListBadDirs,          BOOL,     "0"),
177
  V(AuthDirListBadExits,         BOOL,     "0"),
178
179
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
180
181
182
183
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
184
185
  V(BandwidthBurst,              MEMUNIT,  "10 MB"),
  V(BandwidthRate,               MEMUNIT,  "5 MB"),
186
187
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
188
  V(BridgePassword,              STRING,   NULL),
189
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
190
  V(BridgeRelay,                 BOOL,     "0"),
191
  V(CellStatistics,              BOOL,     "0"),
192
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
193
  V(CircuitBuildTimeout,         INTERVAL, "0"),
194
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
195
  V(CircuitStreamTimeout,        INTERVAL, "0"),
196
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
197
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
198
  V(ClientRejectInternalAddresses, BOOL,   "1"),
199
  V(ClientOnly,                  BOOL,     "0"),
200
  V(ConsensusParams,             STRING,   NULL),
201
202
203
204
205
206
207
208
209
210
  V(ConnLimit,                   UINT,     "1000"),
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
  V(ControlPort,                 UINT,     "0"),
  V(ControlSocket,               LINELIST, NULL),
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
211
  V(DataDirectory,               FILENAME, NULL),
212
  OBSOLETE("DebugLogFile"),
213
  V(DirAllowPrivateAddresses,    BOOL,     NULL),
214
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
215
  V(DirListenAddress,            LINELIST, NULL),
216
  OBSOLETE("DirFetchPeriod"),
217
218
  V(DirPolicy,                   LINELIST, NULL),
  V(DirPort,                     UINT,     "0"),
219
  V(DirPortFrontPage,            FILENAME, NULL),
220
  OBSOLETE("DirPostPeriod"),
221
222
223
224
  OBSOLETE("DirRecordUsageByCountry"),
  OBSOLETE("DirRecordUsageGranularity"),
  OBSOLETE("DirRecordUsageRetainIPs"),
  OBSOLETE("DirRecordUsageSaveInterval"),
Karsten Loesing's avatar
Karsten Loesing committed
225
  V(DirReqStatistics,            BOOL,     "0"),
226
  VAR("DirServer",               LINELIST, DirServers, NULL),
227
  V(DisableAllSwap,              BOOL,     "0"),
228
229
230
231
  V(DNSPort,                     UINT,     "0"),
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
232
  V(EntryNodes,                  ROUTERSET,   NULL),
233
  V(EntryStatistics,             BOOL,     "0"),
234
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
235
236
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
237
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
238
  V(ExitNodes,                   ROUTERSET, NULL),
239
240
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
241
  V(ExitPortStatistics,          BOOL,     "0"),
242
  V(ExtraInfoStatistics,         BOOL,     "0"),
243

valerino's avatar
valerino committed
244
245
246
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
247
  V(FallbackNetworkstatusFile,   FILENAME,
248
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
249
#endif
250
251
252
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
253
  V(FetchDirInfoEarly,           BOOL,     "0"),
254
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
255
256
257
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
258
  V(FetchV2Networkstatus,        BOOL,     "0"),
259
#ifdef WIN32
260
  V(GeoIPFile,                   FILENAME, "<default>"),
261
#else
262
263
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
264
#endif
265
  OBSOLETE("Group"),
266
  V(HardwareAccel,               BOOL,     "0"),
267
268
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
269
  V(HashedControlPassword,       LINELIST, NULL),
270
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
271
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
272
273
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
274
275
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
276
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
277
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
278
  V(HidServAuth,                 LINELIST, NULL),
279
  V(HSAuthoritativeDir,          BOOL,     "0"),
280
  OBSOLETE("HSAuthorityRecordStats"),
281
282
283
284
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
285
286
287
288
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
289
  OBSOLETE("IgnoreVersion"),
290
291
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
292
  V(LogMessageDomains,           BOOL,     "0"),
293
  OBSOLETE("LinkPadding"),
294
295
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
296
  V(LongLivedPorts,              CSV,
297
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
298
299
300
301
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
  V(MaxOnionsPending,            UINT,     "100"),
302
  OBSOLETE("MonthlyAccountingStart"),
303
304
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
305
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
306
307
  V(NATDListenAddress,           LINELIST, NULL),
  V(NATDPort,                    UINT,     "0"),
308
  V(Nickname,                    STRING,   NULL),
309
  V(WarnUnsafeSocks,              BOOL,     "1"),
Sebastian Hahn's avatar
Sebastian Hahn committed
310
  OBSOLETE("NoPublish"),
311
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
312
  V(NumCPUs,                     UINT,     "1"),
313
314
315
316
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
  V(ORPort,                      UINT,     "0"),
  V(OutboundBindAddress,         STRING,   NULL),
317
  OBSOLETE("PathlenCoinWeight"),
318
319
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
320
  V(PidFile,                     STRING,   NULL),
321
  V(TestingTorNetwork,           BOOL,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
322
  V(PreferTunneledDirConns,      BOOL,     "1"),
323
  V(ProtocolWarnings,            BOOL,     "0"),
324
  V(PublishServerDescriptor,     CSV,      "1"),
325
326
327
328
329
330
331
  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),
332
  OBSOLETE("RedirectExit"),
333
  V(RefuseUnknownExits,          STRING,   "auto"),
334
  V(RejectPlaintextPorts,        CSV,      ""),
335
336
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
337
338
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
339
340
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
341
  OBSOLETE("RouterFile"),
342
  V(RunAsDaemon,                 BOOL,     "0"),
343
344
//  V(RunTesting,                  BOOL,     "0"),
  OBSOLETE("RunTesting"), // currently unused
345
  V(SafeLogging,                 STRING,   "1"),
346
  V(SafeSocks,                   BOOL,     "0"),
347
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
348
349
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
350
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
351
352
353
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
354
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
355
356
357
358
359
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
  V(SocksPort,                   UINT,     "9050"),
  V(SocksTimeout,                INTERVAL, "2 minutes"),
360
  OBSOLETE("StatusFetchPeriod"),
361
  V(StrictNodes,                 BOOL,     "0"),
362
  OBSOLETE("SysLog"),
363
  V(TestSocks,                   BOOL,     "0"),
364
  OBSOLETE("TestVia"),
365
366
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
367
  OBSOLETE("TrafficShaping"),
368
369
  V(TransListenAddress,          LINELIST, NULL),
  V(TransPort,                   UINT,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
370
  V(TunnelDirConns,              BOOL,     "1"),
371
372
373
374
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
  V(UseBridges,                  BOOL,     "0"),
  V(UseEntryGuards,              BOOL,     "1"),
  V(User,                        STRING,   NULL),
375
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
376
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
377
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
378
379
380
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
381
382
383
384
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
385
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
386
  V(V3BandwidthsFile,            FILENAME, NULL),
387
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
388
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
389
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
390
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
391
392
393
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
394
395
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
396
  V(MinUptimeHidServDirectoryV2, INTERVAL, "24 hours"),
397
  V(_UsingTestNetworkDefaults,   BOOL,     "0"),
398

399
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
400
};
401

402
403
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
404
static config_var_t testing_tor_network_defaults[] = {
405
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
406
407
408
409
410
411
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
412
  V(ClientRejectInternalAddresses, BOOL,   "0"),
413
414
415
416
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
417
418
419
420
421
  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"),
422
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
423
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
424
425
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
426
427
#undef VAR

428
429
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
430
      initvalue }
431
432

/** Array of "state" variables saved to the ~/.tor/state file. */
433
static config_var_t _state_vars[] = {
434
435
436
437
438
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
439
440
441
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
442

443
444
445
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
446
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
447
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
448

449
450
451
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
452
  V(BWHistoryReadMaxima,              CSV,      ""),
453
454
455
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
456
  V(BWHistoryWriteMaxima,             CSV,      ""),
457
458
459
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
460
  V(BWHistoryDirReadMaxima,           CSV,      ""),
461
462
463
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
464
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
465

466
  V(TorVersion,                       STRING,   NULL),
467

468
469
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
470

471
  V(TotalBuildTimes,                  UINT,     NULL),
472
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
473
474
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
475

476
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
477
478
};

479
#undef VAR
480
#undef V
481
482
#undef OBSOLETE

483
484
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
485
486
487
488
489
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

490
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
491
 * well-formed and consistent. See options_trial_assign() for documentation
492
 * of arguments. */
493
typedef int (*validate_fn_t)(void*,void*,int,char**);
494

495
496
497
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
498
typedef struct {
499
500
501
  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
502
  off_t magic_offset; /**< Offset of the magic value within the struct. */
503
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
504
                             * parsing this format. */
505
506
507
  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
508
509
510
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
511
512
} config_format_t;

513
514
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
515
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
516
    tor_assert(fmt && cfg);                                             \
517
    tor_assert((fmt)->magic ==                                          \
518
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
519
  STMT_END
520

521
522
523
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
524
static void config_line_append(config_line_t **lst,
525
                               const char *key, const char *val);
526
527
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
528
static void option_reset(config_format_t *fmt, or_options_t *options,
529
                         config_var_t *var, int use_defaults);
530
static void config_free(config_format_t *fmt, void *options);
531
static int config_lines_eq(config_line_t *a, config_line_t *b);
532
static int option_is_same(config_format_t *fmt,
533
534
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
535
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
536
537
538
static int options_validate(or_options_t *old_options, or_options_t *options,
                            int from_setconf, char **msg);
static int options_act_reversible(or_options_t *old_options, char **msg);
539
static int options_act(or_options_t *old_options);
540
541
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
542
543
544
545
static int options_transition_affects_workers(or_options_t *old_options,
                                              or_options_t *new_options);
static int options_transition_affects_descriptor(or_options_t *old_options,
                                                 or_options_t *new_options);
546
static int check_nickname_list(const char *lst, const char *name, char **msg);
547
static void config_register_addressmaps(or_options_t *options);
548

549
static int parse_bridge_line(const char *line, int validate_only);
550
551
552
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
553
static int validate_data_directory(or_options_t *options);
554
static int write_configuration_file(const char *fname, or_options_t *options);
555
static config_line_t *get_assigned_option(config_format_t *fmt,
556
557
                                          void *options, const char *key,
                                          int escape_val);
558
static void config_init(config_format_t *fmt, void *options);
559
static int or_state_validate(or_state_t *old_options, or_state_t *options,
560
                             int from_setconf, char **msg);
561
562
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
563

564
565
566
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

567
568
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
569
static void init_libevent(void);
570
static int opt_streq(const char *s1, const char *s2);
571

572
/** Magic value for or_options_t. */
573
574
#define OR_OPTIONS_MAGIC 9090909

575
/** Configuration format for or_options_t. */
576
static config_format_t options_format = {
577
578
579
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
580
581
582
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
583
  NULL
584
585
};

586
/** Magic value for or_state_t. */
587
588
#define OR_STATE_MAGIC 0x57A73f57

589
590
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
591
592
593
594
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

595
/** Configuration format for or_state_t. */
596
597
598
599
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
600
  _state_abbrevs,
601
602
  _state_vars,
  (validate_fn_t)or_state_validate,
603
  &state_extra_var,
604
605
};

606
607
608
609
610
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
611
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
612
/** Name of most recently read torrc file. */
613
static char *torrc_fname = NULL;
614
/** Persistent serialized state. */
615
static or_state_t *global_state = NULL;
616
617
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
618
/** Contents of most recently read DirPortFrontPage file. */
619
620
621
622
623
624
625
626
static char *global_dirfrontpagecontents = NULL;

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

628
/** Allocate an empty configuration object of a given format type. */
629
630
631
static void *
config_alloc(config_format_t *fmt)
{
632
  void *opts = tor_malloc_zero(fmt->size);
633
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
634
635
636
637
  CHECK(fmt, opts);
  return opts;
}

638
639
/** Return the currently configured options. */
or_options_t *
640
641
get_options(void)
{
642
643
644
  tor_assert(global_options);
  return global_options;
}
645

646
647
/** Change the current global options to contain <b>new_val</b> instead of
 * their current value; take action based on the new value; free the old value
648
 * as necessary.  Returns 0 on success, -1 on failure.
649
 */
650
int
651
set_options(or_options_t *new_val, char **msg)
652
{
653
  or_options_t *old_options = global_options;
654
  global_options = new_val;
655
656
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
657
658
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
659
660
661
    global_options = old_options;
    return -1;
  }
662
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
663
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
664
            "Acting on config options left us in a broken state. Dying.");
665
666
    exit(1);
  }
667
668

  config_free(&options_format, old_options);
669
670

  return 0;
671
672
}

673
extern const char tor_git_revision[]; /* from tor_main.c */
674

675
/** The version of this Tor process, as parsed. */
676
677
static char *_version = NULL;

678
/** Return the current Tor version. */
679
680
681
const char *
get_version(void)
{
682
  if (_version == NULL) {
683
684
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
685
      _version = tor_malloc(len);
686
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
687
    } else {
688
      _version = tor_strdup(VERSION);
689
690
    }
  }
691
  return _version;
692
693
}

694
695
696
697
698
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
699
700
701
  if (!options)
    return;

702
  routerset_free(options->_ExcludeExitNodesUnion);
703
704
705
  config_free(&options_format, options);
}

706
707
/** Release all memory and resources held by global configuration structures.
 */
708
709
710
void
config_free_all(void)
{
711
712
713
714
715
716
717
718
719
  or_options_free(global_options);
  global_options = NULL;

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

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

720
  tor_free(torrc_fname);
721
  tor_free(_version);
722
  tor_free(global_dirfrontpagecontents);
723
724
}

725
726
727
728
729
/** Make <b>address</b> -- a piece of information related to our operation as
 * a client -- safe to log according to the settings in options->SafeLogging,
 * and return it.
 *
 * (We return "[scrubbed]" if SafeLogging is "1", and address otherwise.)
730
731
 */
const char *
732
safe_str_client(const char *address)
733
{
734
  tor_assert(address);
735
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
736
737
738
739
740
    return "[scrubbed]";
  else
    return address;
}

741
742
743
744
745
746
/** Make <b>address</b> -- a piece of information of unspecified sensitivity
 * -- safe to log according to the settings in options->SafeLogging, and
 * return it.
 *
 * (We return "[scrubbed]" if SafeLogging is anything besides "0", and address
 * otherwise.)
747
748
 */
const char *
749
750
safe_str(const char *address)
{
751
  tor_assert(address);
752
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
753
754
755
756
757
    return "[scrubbed]";
  else
    return address;
}

758
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
759
760
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
761
const char *
762
escaped_safe_str_client(const char *address)
763
{
764
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
765
766
767
768
769
    return "[scrubbed]";
  else
    return escaped(address);
}

770
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
771
772
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
773
774
775
const char *
escaped_safe_str(const char *address)
{
776
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
777
778
779
780
781
    return "[scrubbed]";
  else
    return escaped(address);
}

782
783
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
784
static void
785
add_default_trusted_dir_authorities(authority_type_t type)
786
{
787
  int i;
788
  const char *dirservers[] = {