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

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

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

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

75
76
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
77
static config_abbrev_t _option_abbrevs[] = {
78
  PLURAL(ExitNode),
79
  PLURAL(EntryNode),
80
81
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
82
  PLURAL(LongLivedPort),
83
84
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
85
  PLURAL(NumCpu),
86
87
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
88
89
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
90
  PLURAL(StrictNode),
91
  { "l", "Log", 1, 0},
92
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
93
94
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
95
96
97
98
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
99
100
101
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
102
103
104
105
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
106
107
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
108
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
109
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
110
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
111
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
112
113
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
114
115
  { NULL, NULL, 0, 0},
};
116
117

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

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

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

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

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

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

396
397
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
398
static config_var_t testing_tor_network_defaults[] = {
399
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
400
401
402
403
404
405
406
407
408
409
  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"),
410
411
412
413
414
  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"),
415
416
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
417
418
#undef VAR

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

/** Array of "state" variables saved to the ~/.tor/state file. */
424
static config_var_t _state_vars[] = {
425
426
427
428
429
  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
430

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

437
438
439
440
441
442
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
443

444
  V(TorVersion,                       STRING,   NULL),
445

446
447
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
448

449
  V(TotalBuildTimes,                  UINT,     NULL),
450
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
451
452
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
453

454
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
455
456
};

457
#undef VAR
458
#undef V
459
460
#undef OBSOLETE

461
462
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
463
464
465
466
467
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

468
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
469
 * well-formed and consistent. See options_trial_assign() for documentation
470
 * of arguments. */
471
typedef int (*validate_fn_t)(void*,void*,int,char**);
472

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

491
492
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
493
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
494
    tor_assert(fmt && cfg);                                             \
495
    tor_assert((fmt)->magic ==                                          \
496
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
497
  STMT_END
498

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

527
static int parse_bridge_line(const char *line, int validate_only);
528
529
530
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
531
static int validate_data_directory(or_options_t *options);
532
static int write_configuration_file(const char *fname, or_options_t *options);
533
static config_line_t *get_assigned_option(config_format_t *fmt,
534
535
                                          void *options, const char *key,
                                          int escape_val);
536
static void config_init(config_format_t *fmt, void *options);
537
static int or_state_validate(or_state_t *old_options, or_state_t *options,
538
                             int from_setconf, char **msg);
539
540
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
541

542
543
544
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

545
546
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
547
static void init_libevent(void);
548
static int opt_streq(const char *s1, const char *s2);
549

550
/** Magic value for or_options_t. */
551
552
#define OR_OPTIONS_MAGIC 9090909

553
/** Configuration format for or_options_t. */
554
static config_format_t options_format = {
555
556
557
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
558
559
560
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
561
  NULL
562
563
};

564
/** Magic value for or_state_t. */
565
566
#define OR_STATE_MAGIC 0x57A73f57

567
568
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
569
570
571
572
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

573
/** Configuration format for or_state_t. */
574
575
576
577
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
578
  _state_abbrevs,
579
580
  _state_vars,
  (validate_fn_t)or_state_validate,
581
  &state_extra_var,
582
583
};

584
585
586
587
588
/*
 * Functions to read and write the global options pointer.
 */

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

606
/** Allocate an empty configuration object of a given format type. */
607
608
609
static void *
config_alloc(config_format_t *fmt)
{
610
  void *opts = tor_malloc_zero(fmt->size);
611
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
612
613
614
615
  CHECK(fmt, opts);
  return opts;
}

616
617
/** Return the currently configured options. */
or_options_t *
618
619
get_options(void)
{
620
621
622
  tor_assert(global_options);
  return global_options;
}
623

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

  config_free(&options_format, old_options);
647
648

  return 0;
649
650
}

651
extern const char tor_git_revision[]; /* from tor_main.c */
652

653
/** The version of this Tor process, as parsed. */
654
655
static char *_version = NULL;

656
/** Return the current Tor version. */
657
658
659
const char *
get_version(void)
{
660
  if (_version == NULL) {
661
662
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
663
      _version = tor_malloc(len);
664
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
665
    } else {
666
      _version = tor_strdup(VERSION);
667
668
    }
  }
669
  return _version;
670
671
}

672
673
674
675
676
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
677
678
679
  if (!options)
    return;

680
  routerset_free(options->_ExcludeExitNodesUnion);
681
682
683
  config_free(&options_format, options);
}

684
685
/** Release all memory and resources held by global configuration structures.
 */
686
687
688
void
config_free_all(void)
{
689
690
691
692
693
694
695
696
697
  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;

698
  tor_free(torrc_fname);
699
  tor_free(_version);
700
  tor_free(global_dirfrontpagecontents);
701
702
}

703
704
705
706
707
/** 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.)
708
709
 */
const char *
710
safe_str_client(const char *address)
711
{
712
  tor_assert(address);
713
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
714
715
716
717
718
    return "[scrubbed]";
  else
    return address;
}

719
720
721
722
723
724
/** 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.)
725
726
 */
const char *
727
728
safe_str(const char *address)
{
729
  tor_assert(address);
730
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
731
732
733
734
735
    return "[scrubbed]";
  else
    return address;
}

736
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
737
738
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
739
const char *
740
escaped_safe_str_client(const char *address)
741
{
742
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
743
744
745
746
747
    return "[scrubbed]";
  else
    return escaped(address);
}

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

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

/** Look at all the config options for using alternate directory
 * authorities, and make sure none of them are broken. Also, warn the
 * user if we changed any dangerous ones.
 */
static int
validate_dir_authorities(or_options_t *options, or_options_t *old_options)
{
  config_line_t *cl;

  if (options->DirS