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 "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "router.h"
17
18
19
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
20

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

44
/** An abbreviation for a configuration option allowed on the command line. */
45
typedef struct config_abbrev_t {
46
47
  const char *abbreviated;
  const char *full;
48
  int commandline_only;
49
  int warn;
50
51
} config_abbrev_t;

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

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

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

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

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

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

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

374
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
375
};
376

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

400
401
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
402
      initvalue }
403
404

/** Array of "state" variables saved to the ~/.tor/state file. */
405
static config_var_t _state_vars[] = {
406
407
408
409
410
  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
411

412
413
414
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
415
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
416
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
417

418
419
420
421
422
423
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
424

425
  V(TorVersion,                       STRING,   NULL),
426

427
428
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
429

430
  V(TotalBuildTimes,                  UINT,     NULL),
431
  V(CircuitBuildAbandonedCount,         UINT,     "0"),
432
433
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
434

435
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
436
437
};

438
#undef VAR
439
#undef V
440
441
#undef OBSOLETE

442
443
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
444
445
446
447
448
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

449
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
450
 * well-formed and consistent. See options_trial_assign() for documentation
451
 * of arguments. */
452
typedef int (*validate_fn_t)(void*,void*,int,char**);
453

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

472
473
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
474
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
475
    tor_assert(fmt && cfg);                                             \
476
    tor_assert((fmt)->magic ==                                          \
477
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
478
  STMT_END
479

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

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

523
524
525
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

526
527
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
528
static void init_libevent(void);
529
static int opt_streq(const char *s1, const char *s2);
530

531
/** Magic value for or_options_t. */
532
533
#define OR_OPTIONS_MAGIC 9090909

534
/** Configuration format for or_options_t. */
535
static config_format_t options_format = {
536
537
538
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
539
540
541
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
542
  NULL
543
544
};

545
/** Magic value for or_state_t. */
546
547
#define OR_STATE_MAGIC 0x57A73f57

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

554
/** Configuration format for or_state_t. */
555
556
557
558
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
559
  _state_abbrevs,
560
561
  _state_vars,
  (validate_fn_t)or_state_validate,
562
  &state_extra_var,
563
564
};

565
566
567
568
569
/*
 * Functions to read and write the global options pointer.
 */

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

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

597
598
/** Return the currently configured options. */
or_options_t *
599
600
get_options(void)
{
601
602
603
  tor_assert(global_options);
  return global_options;
}
604

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

  config_free(&options_format, old_options);
628
629

  return 0;
630
631
}

632
extern const char tor_git_revision[]; /* from tor_main.c */
633

634
/** The version of this Tor process, as parsed. */
635
636
static char *_version = NULL;

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

653
654
655
656
657
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
658
659
660
  if (!options)
    return;

661
  routerset_free(options->_ExcludeExitNodesUnion);
662
663
664
  config_free(&options_format, options);
}

665
666
/** Release all memory and resources held by global configuration structures.
 */
667
668
669
void
config_free_all(void)
{
670
671
672
673
674
675
676
677
678
  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;

679
  tor_free(torrc_fname);
680
  tor_free(_version);
681
  tor_free(global_dirfrontpagecontents);
682
683
}

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

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

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

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

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

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

/** Look at all the config options and assign new dir authorities
 * as appropriate.
 */
static int
consider_adding_dir_authorities(or_options_t *options,
                                or_options_t *old_options)
{
  config_line_t *cl;
  int need_to_update =
841
    !smartlist_len(router_get_trusted_dir_servers()) || !old_options ||
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859