config.c 170 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2010, The Tor Project, Inc. */
5
/* See LICENSE for licensing information */
6

Nick Mathewson's avatar
Nick Mathewson committed
7
/**
8
9
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
10
11
 **/

12
13
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
15
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
19
#include "connection_edge.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
20
#include "control.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "router.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "routerlist.h"
27
28
29
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
30

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

54
/** An abbreviation for a configuration option allowed on the command line. */
55
typedef struct config_abbrev_t {
56
57
  const char *abbreviated;
  const char *full;
58
  int commandline_only;
59
  int warn;
60
61
} config_abbrev_t;

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

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

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

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

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

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

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

384
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
385
};
386

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

410
411
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
412
      initvalue }
413
414

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

422
423
424
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
425
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
426
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
427

428
429
430
431
432
433
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
434

435
  V(TorVersion,                       STRING,   NULL),
436

437
438
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
439

440
  V(TotalBuildTimes,                  UINT,     NULL),
441
  V(CircuitBuildAbandonedCount,         UINT,     "0"),
442
443
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
444

445
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
446
447
};

448
#undef VAR
449
#undef V
450
451
#undef OBSOLETE

452
453
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
454
455
456
457
458
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

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

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

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

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

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

533
534
535
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

536
537
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
538
static void init_libevent(void);
539
static int opt_streq(const char *s1, const char *s2);
540

541
/** Magic value for or_options_t. */
542
543
#define OR_OPTIONS_MAGIC 9090909

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

555
/** Magic value for or_state_t. */
556
557
#define OR_STATE_MAGIC 0x57A73f57

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

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

575
576
577
578
579
/*
 * Functions to read and write the global options pointer.
 */

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

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

607
608
/** Return the currently configured options. */
or_options_t *
609
610
get_options(void)
{
611
612
613
  tor_assert(global_options);
  return global_options;
}
614

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

  config_free(&options_format, old_options);
638
639

  return 0;
640
641
}

642
extern const char tor_git_revision[]; /* from tor_main.c */
643

644
/** The version of this Tor process, as parsed. */
645
646
static char *_version = NULL;

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

663
664
665
666
667
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
668
669
670
  if (!options)
    return;

671
  routerset_free(options->_ExcludeExitNodesUnion);
672
673
674
  config_free(&options_format, options);
}

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

689
  tor_free(torrc_fname);
690
  tor_free(_version);
691
  tor_free(global_dirfrontpagecontents);
692
693
}

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

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

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

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

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

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