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

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

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

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

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

436
437
438
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
439
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
440
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
441

442
443
444
445
446
447
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
448
449
450
451
452
453
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
454

455
  V(TorVersion,                       STRING,   NULL),
456

457
458
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
459

460
  V(TotalBuildTimes,                  UINT,     NULL),
461
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
462
463
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
464

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

468
#undef VAR
469
#undef V
470
471
#undef OBSOLETE

472
473
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
474
475
476
477
478
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

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

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

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

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

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

553
554
555
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

556
557
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
558
static void init_libevent(const or_options_t *options);
559
static int opt_streq(const char *s1, const char *s2);
560

561
/** Magic value for or_options_t. */
562
563
#define OR_OPTIONS_MAGIC 9090909

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

575
/** Magic value for or_state_t. */
576
577
#define OR_STATE_MAGIC 0x57A73f57

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

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

595
596
597
598
599
/*
 * Functions to read and write the global options pointer.
 */

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

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

627
628
/** Return the currently configured options. */
or_options_t *
629
630
get_options(void)
{
631
632
633
  tor_assert(global_options);
  return global_options;
}
634

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

  config_free(&options_format, old_options);
658
659

  return 0;
660
661
}

662
extern const char tor_git_revision[]; /* from tor_main.c */
663

664
/** The version of this Tor process, as parsed. */
665
666
static char *_version = NULL;

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

683
684
685
686
687
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
688
689
690
  if (!options)
    return;

691
  routerset_free(options->_ExcludeExitNodesUnion);
692
693
694
  config_free(&options_format, options);
}

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

709
  tor_free(torrc_fname);
710
  tor_free(_version);
711
  tor_free(global_dirfrontpagecontents);
712
713
}

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

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

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

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

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