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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

434
  V(TorVersion,                       STRING,   NULL),
435

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
637
638

  return 0;
639
640
}

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

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

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

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

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

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

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

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

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

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

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

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

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