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

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

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

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

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

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

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

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

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

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

382
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
383
};
384

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

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

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

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

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

433
  V(TorVersion,                       STRING,   NULL),
434

435
436
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
437

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

443
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
444
445
};

446
#undef VAR
447
#undef V
448
449
#undef OBSOLETE

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

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

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

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

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

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

531
532
533
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

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

539
/** Magic value for or_options_t. */
540
541
#define OR_OPTIONS_MAGIC 9090909

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

553
/** Magic value for or_state_t. */
554
555
#define OR_STATE_MAGIC 0x57A73f57

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

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

573
574
575
576
577
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

  config_free(&options_format, old_options);
636
637

  return 0;
638
639
}

640
extern const char tor_git_revision[]; /* from tor_main.c */
641

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

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

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

669
  routerset_free(options->_ExcludeExitNodesUnion);
670
671
672
  config_free(&options_format, options);
}

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

687
  tor_free(torrc_fname);
688
  tor_free(_version);
689
  tor_free(global_dirfrontpagecontents);
690
691
}

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

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

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

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

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

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