config.c 169 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 "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
19
#include "router.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
20
#include "routerlist.h"
21
22
23
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
24

Nick Mathewson's avatar
Nick Mathewson committed
25
26
/** Enumeration of types which option values can take */
typedef enum config_type_t {
27
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
28
  CONFIG_TYPE_FILENAME,     /**< A filename: some prefixes get expanded. */
29
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
30
31
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
32
33
  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
34
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formatted time relative to GMT. */
35
36
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
37
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
38
39
40
41
42
  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.
                             */
43
44
  CONFIG_TYPE_ROUTERSET,    /**< A list of router names, addrs, and fps,
                             * parsed into a routerset_t. */
45
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
46
} config_type_t;
47

48
/** An abbreviation for a configuration option allowed on the command line. */
49
typedef struct config_abbrev_t {
50
51
  const char *abbreviated;
  const char *full;
52
  int commandline_only;
53
  int warn;
54
55
} config_abbrev_t;

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

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

/** A list of state-file "abbreviations," for compatibility. */
103
static config_abbrev_t _state_abbrevs[] = {
104
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
105
106
107
108
109
110
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
111
  { NULL, NULL, 0, 0},
112
};
113
#undef PLURAL
114

115
/** A variable allowed in the configuration file or on the command line. */
116
typedef struct config_var_t {
117
  const char *name; /**< The full keyword (case insensitive). */
118
119
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
120
121
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
122
123
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
124
125
126
127
/** 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>"
 */
128
129
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
130
      initvalue }
131
132
133
/** 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
134
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
135
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
136

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

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

378
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
379
};
380

381
382
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
383
static config_var_t testing_tor_network_defaults[] = {
384
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
385
386
387
388
389
390
391
392
393
394
  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"),
395
396
397
398
399
  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"),
400
401
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
402
403
#undef VAR

404
405
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
406
      initvalue }
407
408

/** Array of "state" variables saved to the ~/.tor/state file. */
409
static config_var_t _state_vars[] = {
410
411
412
413
414
  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
415

416
417
418
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
419
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
420
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
421

422
423
424
425
426
427
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
428

429
  V(TorVersion,                       STRING,   NULL),
430

431
432
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
433

434
  V(TotalBuildTimes,                  UINT,     NULL),
435
  V(CircuitBuildAbandonedCount,         UINT,     "0"),
436
437
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
438

439
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
440
441
};

442
#undef VAR
443
#undef V
444
445
#undef OBSOLETE

446
447
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
448
449
450
451
452
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

453
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
454
 * well-formed and consistent. See options_trial_assign() for documentation
455
 * of arguments. */
456
typedef int (*validate_fn_t)(void*,void*,int,char**);
457

458
459
460
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
461
typedef struct {
462
463
464
  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
465
  off_t magic_offset; /**< Offset of the magic value within the struct. */
466
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
467
                             * parsing this format. */
468
469
470
  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
471
472
473
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
474
475
} config_format_t;

476
477
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
478
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
479
    tor_assert(fmt && cfg);                                             \
480
    tor_assert((fmt)->magic ==                                          \
481
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
482
  STMT_END
483

484
485
486
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
487
static void config_line_append(config_line_t **lst,
488
                               const char *key, const char *val);
489
490
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
491
static void option_reset(config_format_t *fmt, or_options_t *options,
492
                         config_var_t *var, int use_defaults);
493
static void config_free(config_format_t *fmt, void *options);
494
static int config_lines_eq(config_line_t *a, config_line_t *b);
495
static int option_is_same(config_format_t *fmt,
496
497
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
498
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
499
500
501
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);
502
static int options_act(or_options_t *old_options);
503
504
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
505
506
507
508
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);
509
static int check_nickname_list(const char *lst, const char *name, char **msg);
510
static void config_register_addressmaps(or_options_t *options);
511

512
static int parse_bridge_line(const char *line, int validate_only);
513
514
515
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
516
static int validate_data_directory(or_options_t *options);
517
static int write_configuration_file(const char *fname, or_options_t *options);
518
static config_line_t *get_assigned_option(config_format_t *fmt,
519
520
                                          void *options, const char *key,
                                          int escape_val);
521
static void config_init(config_format_t *fmt, void *options);
522
static int or_state_validate(or_state_t *old_options, or_state_t *options,
523
                             int from_setconf, char **msg);
524
525
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
526

527
528
529
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

530
531
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
532
static void init_libevent(void);
533
static int opt_streq(const char *s1, const char *s2);
534

535
/** Magic value for or_options_t. */
536
537
#define OR_OPTIONS_MAGIC 9090909

538
/** Configuration format for or_options_t. */
539
static config_format_t options_format = {
540
541
542
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
543
544
545
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
546
  NULL
547
548
};

549
/** Magic value for or_state_t. */
550
551
#define OR_STATE_MAGIC 0x57A73f57

552
553
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
554
555
556
557
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

558
/** Configuration format for or_state_t. */
559
560
561
562
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
563
  _state_abbrevs,
564
565
  _state_vars,
  (validate_fn_t)or_state_validate,
566
  &state_extra_var,
567
568
};

569
570
571
572
573
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
574
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
575
/** Name of most recently read torrc file. */
576
static char *torrc_fname = NULL;
577
/** Persistent serialized state. */
578
static or_state_t *global_state = NULL;
579
580
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
581
/** Contents of most recently read DirPortFrontPage file. */
582
583
584
585
586
587
588
589
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;
}
590

591
/** Allocate an empty configuration object of a given format type. */
592
593
594
static void *
config_alloc(config_format_t *fmt)
{
595
  void *opts = tor_malloc_zero(fmt->size);
596
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
597
598
599
600
  CHECK(fmt, opts);
  return opts;
}

601
602
/** Return the currently configured options. */
or_options_t *
603
604
get_options(void)
{
605
606
607
  tor_assert(global_options);
  return global_options;
}
608

609
610
/** 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
611
 * as necessary.  Returns 0 on success, -1 on failure.
612
 */
613
int
614
set_options(or_options_t *new_val, char **msg)
615
{
616
  or_options_t *old_options = global_options;
617
  global_options = new_val;
618
619
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
620
621
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
622
623
624
    global_options = old_options;
    return -1;
  }
625
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
626
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
627
            "Acting on config options left us in a broken state. Dying.");
628
629
    exit(1);
  }
630
631

  config_free(&options_format, old_options);
632
633

  return 0;
634
635
}

636
extern const char tor_git_revision[]; /* from tor_main.c */
637

638
/** The version of this Tor process, as parsed. */
639
640
static char *_version = NULL;

641
/** Return the current Tor version. */
642
643
644
const char *
get_version(void)
{
645
  if (_version == NULL) {
646
647
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
648
      _version = tor_malloc(len);
649
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
650
    } else {
651
      _version = tor_strdup(VERSION);
652
653
    }
  }
654
  return _version;
655
656
}

657
658
659
660
661
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
662
663
664
  if (!options)
    return;

665
  routerset_free(options->_ExcludeExitNodesUnion);
666
667
668
  config_free(&options_format, options);
}

669
670
/** Release all memory and resources held by global configuration structures.
 */
671
672
673
void
config_free_all(void)
{
674
675
676
677
678
679
680
681
682
  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;

683
  tor_free(torrc_fname);
684
  tor_free(_version);
685
  tor_free(global_dirfrontpagecontents);
686
687
}

688
689
690
691
692
/** 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.)
693
694
 */
const char *
695
safe_str_client(const char *address)
696
{
697
  tor_assert(address);
698
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
699
700
701
702
703
    return "[scrubbed]";
  else
    return address;
}

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

721
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
722
723
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
724
const char *
725
escaped_safe_str_client(const char *address)
726
{
727
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
728
729
730
731
732
    return "[scrubbed]";
  else
    return escaped(address);
}

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

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

/** 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->DirServers &&
      (options->AlternateDirAuthority || options->AlternateBridgeAuthority ||
       options->AlternateHSAuthority)) {
    log_warn(LD_CONFIG,
             "You cannot set both DirServers and Alternate*Authority.");
    return -1;
  }

  /* do we want to complain to the user about being partitionable? */
  if ((options->DirServers &&
       (!old_options ||
        !config_lines_eq(options->DirServers, old_options->DirServers))) ||
      (options->AlternateDirAuthority &&
       (!old_options ||
        !config_lines_eq(options->AlternateDirAuthority,
                         old_options->AlternateDirAuthority)))) {
    log_warn(LD_CONFIG,
             "You have used DirServer or AlternateDirAuthority to "
             "specify alternate directory authorities in "
             "your configuration. This is potentially dangerous: it can "
             "make you look different from all other Tor users, and hurt "
             "your anonymity. Even if you've specified the same "
             "authorities as Tor uses by default, the defaults could "
             "change in the future. Be sure you know what you're doing.");
  }

  /* Now go through the four ways you can configure an alternate
   * set of directory authorities, and make sure none are broken. */
  for (cl = options->DirServers; cl; cl = cl->next)
822
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
823
824
      return -1;
  for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
825
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
826
827
      return -1;
  for (cl = options->AlternateDirAuthority; cl; cl = cl->next)
828
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
829
830
      return -1;
  for (cl = options->AlternateHSAuthority; cl; cl = cl->next)
831
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
832
833
834
835
836
837
838
839
840
841
842
843
844
      return -1;
  return 0;
}

/** Look at all the config options and assign new dir authorities
 * as appropriate.
 */
static int
consider_adding_dir_authorities(or_options_t *options,