config.c 174 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-2010, 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
198
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
199
  V(ConsensusParams,             STRING,   NULL),
200
201
202
203
204
205
206
207
208
209
  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),
210
  V(DataDirectory,               FILENAME, NULL),
211
  OBSOLETE("DebugLogFile"),
212
  V(DirAllowPrivateAddresses,    BOOL,     NULL),
213
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
214
  V(DirListenAddress,            LINELIST, NULL),
215
  OBSOLETE("DirFetchPeriod"),
216
217
  V(DirPolicy,                   LINELIST, NULL),
  V(DirPort,                     UINT,     "0"),
218
  V(DirPortFrontPage,            FILENAME, NULL),
219
  OBSOLETE("DirPostPeriod"),
220
221
222
223
  OBSOLETE("DirRecordUsageByCountry"),
  OBSOLETE("DirRecordUsageGranularity"),
  OBSOLETE("DirRecordUsageRetainIPs"),
  OBSOLETE("DirRecordUsageSaveInterval"),
Karsten Loesing's avatar
Karsten Loesing committed
224
  V(DirReqStatistics,            BOOL,     "0"),
225
  VAR("DirServer",               LINELIST, DirServers, NULL),
226
  V(DisableAllSwap,              BOOL,     "0"),
227
228
229
230
  V(DNSPort,                     UINT,     "0"),
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
231
  V(EntryNodes,                  ROUTERSET,   NULL),
232
  V(EntryStatistics,             BOOL,     "0"),
233
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
234
235
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
236
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
237
  V(ExitNodes,                   ROUTERSET, NULL),
238
239
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
240
  V(ExitPortStatistics,          BOOL,     "0"),
241
  V(ExtraInfoStatistics,         BOOL,     "0"),
242

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

394
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
395
};
396

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

420
421
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
422
      initvalue }
423
424

/** Array of "state" variables saved to the ~/.tor/state file. */
425
static config_var_t _state_vars[] = {
426
427
428
429
430
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
Roger Dingledine's avatar
Roger Dingledine committed
431

432
433
434
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
435
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
436
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
437

438
439
440
441
442
443
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
444
445
446
447
448
449
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
450

451
  V(TorVersion,                       STRING,   NULL),
452

453
454
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
455

456
  V(TotalBuildTimes,                  UINT,     NULL),
457
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
458
459
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
460

461
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
462
463
};

464
#undef VAR
465
#undef V
466
467
#undef OBSOLETE

468
469
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
470
471
472
473
474
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

475
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
476
 * well-formed and consistent. See options_trial_assign() for documentation
477
 * of arguments. */
478
typedef int (*validate_fn_t)(void*,void*,int,char**);
479

480
481
482
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
483
typedef struct {
484
485
486
  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
487
  off_t magic_offset; /**< Offset of the magic value within the struct. */
488
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
489
                             * parsing this format. */
490
491
492
  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
493
494
495
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
496
497
} config_format_t;

498
499
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
500
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
501
    tor_assert(fmt && cfg);                                             \
502
    tor_assert((fmt)->magic ==                                          \
503
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
504
  STMT_END
505

506
507
508
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
509
static void config_line_append(config_line_t **lst,
510
                               const char *key, const char *val);
511
512
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
513
static void option_reset(config_format_t *fmt, or_options_t *options,
514
                         config_var_t *var, int use_defaults);
515
static void config_free(config_format_t *fmt, void *options);
516
static int config_lines_eq(config_line_t *a, config_line_t *b);
517
static int option_is_same(config_format_t *fmt,
518
519
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
520
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
521
522
523
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);
524
static int options_act(or_options_t *old_options);
525
526
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
527
528
529
530
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);
531
static int check_nickname_list(const char *lst, const char *name, char **msg);
532
static void config_register_addressmaps(or_options_t *options);
533

534
static int parse_bridge_line(const char *line, int validate_only);
535
536
537
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
538
static int validate_data_directory(or_options_t *options);
539
static int write_configuration_file(const char *fname, or_options_t *options);
540
static config_line_t *get_assigned_option(config_format_t *fmt,
541
542
                                          void *options, const char *key,
                                          int escape_val);
543
static void config_init(config_format_t *fmt, void *options);
544
static int or_state_validate(or_state_t *old_options, or_state_t *options,
545
                             int from_setconf, char **msg);
546
547
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
548

549
550
551
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

552
553
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
554
static void init_libevent(void);
555
static int opt_streq(const char *s1, const char *s2);
556

557
/** Magic value for or_options_t. */
558
559
#define OR_OPTIONS_MAGIC 9090909

560
/** Configuration format for or_options_t. */
561
static config_format_t options_format = {
562
563
564
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
565
566
567
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
568
  NULL
569
570
};

571
/** Magic value for or_state_t. */
572
573
#define OR_STATE_MAGIC 0x57A73f57

574
575
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
576
577
578
579
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

580
/** Configuration format for or_state_t. */
581
582
583
584
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
585
  _state_abbrevs,
586
587
  _state_vars,
  (validate_fn_t)or_state_validate,
588
  &state_extra_var,
589
590
};

591
592
593
594
595
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
596
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
597
/** Name of most recently read torrc file. */
598
static char *torrc_fname = NULL;
599
/** Persistent serialized state. */
600
static or_state_t *global_state = NULL;
601
602
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
603
/** Contents of most recently read DirPortFrontPage file. */
604
605
606
607
608
609
610
611
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;
}
612

613
/** Allocate an empty configuration object of a given format type. */
614
615
616
static void *
config_alloc(config_format_t *fmt)
{
617
  void *opts = tor_malloc_zero(fmt->size);
618
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
619
620
621
622
  CHECK(fmt, opts);
  return opts;
}

623
624
/** Return the currently configured options. */
or_options_t *
625
626
get_options(void)
{
627
628
629
  tor_assert(global_options);
  return global_options;
}
630

631
632
/** 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
633
 * as necessary.  Returns 0 on success, -1 on failure.
634
 */
635
int
636
set_options(or_options_t *new_val, char **msg)
637
{
638
  or_options_t *old_options = global_options;
639
  global_options = new_val;
640
641
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
642
643
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
644
645
646
    global_options = old_options;
    return -1;
  }
647
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
648
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
649
            "Acting on config options left us in a broken state. Dying.");
650
651
    exit(1);
  }
652
653

  config_free(&options_format, old_options);
654
655

  return 0;
656
657
}

658
extern const char tor_git_revision[]; /* from tor_main.c */
659

660
/** The version of this Tor process, as parsed. */
661
662
static char *_version = NULL;

663
/** Return the current Tor version. */
664
665
666
const char *
get_version(void)
{
667
  if (_version == NULL) {
668
669
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
670
      _version = tor_malloc(len);
671
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
672
    } else {
673
      _version = tor_strdup(VERSION);
674
675
    }
  }
676
  return _version;
677
678
}

679
680
681
682
683
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
684
685
686
  if (!options)
    return;

687
  routerset_free(options->_ExcludeExitNodesUnion);
688
689
690
  config_free(&options_format, options);
}

691
692
/** Release all memory and resources held by global configuration structures.
 */
693
694
695
void
config_free_all(void)
{
696
697
698
699
700
701
702
703
704
  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;

705
  tor_free(torrc_fname);
706
  tor_free(_version);
707
  tor_free(global_dirfrontpagecontents);
708
709
}

710
711
712
713
714
/** 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.)
715
716
 */
const char *
717
safe_str_client(const char *address)
718
{
719
  tor_assert(address);
720
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
721
722
723
724
725
    return "[scrubbed]";
  else
    return address;
}

726
727
728
729
730
731
/** 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.)
732
733
 */
const char *
734
735
safe_str(const char *address)
{
736
  tor_assert(address);
737
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
738
739
740
741
742
    return "[scrubbed]";
  else
    return address;
}

743
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
744
745
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
746
const char *
747
escaped_safe_str_client(const char *address)
748
{
749
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
750
751
752
753
754
    return "[scrubbed]";
  else
    return escaped(address);
}

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

767
768
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
769
static void
770
add_default_trusted_dir_authorities(authority_type_t type)
771
{
772
  int i;
773
  const char *dirservers[] = {
774
775
776
    "moria1 orport=9101 no-v2 "
      "v3ident=D586D18309DED4CD6D57C18FDB97EFA96D330566 "
      "128.31.0.39:9131 9695 DFC3 5FFE B861 329B 9F1A B04C 4639 7020 CE31",
777
    "tor26 v1 orport=443 v3ident=14C131DFC5C6F93646BE72FA1401C02A8DF2E8B4 "
Peter Palfrader's avatar
Peter Palfrader committed
778
      "86.59.21.38:80 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
Roger Dingledine's avatar
Roger Dingledine committed
779
780
    "dizum orport=443 v3ident=E8A9C45EDE6D711294FADF8E7951F4DE6CA56B58 "
      "194.109.206.212:80 7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
781
    "Tonga orport=443 bridge no-v2 82.94.251.203:80 "
782
      "4A0C CD2D DC79 9508 3D73 F5D6 6710 0C8A 5831 F16D",
783
784
    "ides orport=9090 no-v2 v3ident=27B6B5996C426270A5C95488AA5BCEB6BCC86956 "
      "216.224.124.114:9030 F397 038A DC51 3361 35E7 B80B D99C A384 4360 292B",
785
786
787
    "gabelmoo orport=8080 no-v2 "
      "v3ident=ED03BB616EB2F60BEC80151114BB25CEF515B226 "
      "80.190.246.100:8180 F204 4413 DAC2 E02E 3D6B CF47 35A1 9BCA 1DE9 7281",
788
789
    "dannenberg orport=443 no-v2 "
      "v3ident=585769C78764D58426B8B52B6651A5A71137189A "
790
      "193.23.244.244:80 7BE6 83E6 5D48 1413 21C5 ED92 F075 C553 64AC 7123",
791
792
    "urras orport=80 no-v2 v3ident=80550987E1D626E3EBA5E5E75A458DE0626D088C "
      "208.83.223.34:443 0AD3 FA88 4D18 F89E EA2D 89C0 1937 9E0E 7FD9 4417",
793
794
795
    "maatuska orport=80 no-v2 "
      "v3ident=49015F787433103580E3B66A1707A00E60F2D15B "
      "213.115.239.118:443 BD6A 8292 55CB 08E6 6FBE 7D37 4836 3586 E46B 3810",
796
    NULL
797
  };
798
799
800
801
802
803
  for (i=0; dirservers[i]; i++) {
    if (parse_dir_server_line(dirservers[i], type, 0)<0) {
      log_err(LD_BUG, "Couldn't parse internal dirserver line %s",
              dirservers[i]);
    }
  }
804
805
806
807
808
809
810
811
812
813
814