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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

431
  V(TorVersion,                       STRING,   NULL),
432

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
634
635

  return 0;
636
637
}

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

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

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

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

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

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

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

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

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

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

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

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

/** 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)
824
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
825
826
      return -1;
  for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
827
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
828
829
      return -1;
  for (cl = options->AlternateDirAuthority; cl; cl = cl->next)
830
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
831
832
      return -1;
  for (cl = options->AlternateHSAuthority; cl; cl = cl->next)
833
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)