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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

430
  V(TorVersion,                       STRING,   NULL),
431

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
633
634

  return 0;
635
636
}

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

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

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

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

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

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

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

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

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

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

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

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

/** 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)
823
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
824
825
      return -1;
  for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
826
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
827
828
      return -1;
  for (cl = options->AlternateDirAuthority; cl; cl = cl->next)
829
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
830
831
      return -1;
  for (cl = options->AlternateHSAuthority; cl; cl = cl->next)
832
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
833
834
835
836
837
838
839
840
841
842