config.c 171 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.
Karsten Loesing's avatar
Karsten Loesing committed
4
 * Copyright (c) 2007-2009, 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"
15
16
17
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
18

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

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

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

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

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

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

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

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

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

363
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
364
};
365

366
367
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
368
static config_var_t testing_tor_network_defaults[] = {
369
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
370
371
372
373
374
375
376
377
378
379
  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"),
380
381
382
383
384
  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"),
385
386
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
387
388
#undef VAR

389
390
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
391
      initvalue }
392
393

/** Array of "state" variables saved to the ~/.tor/state file. */
394
static config_var_t _state_vars[] = {
395
396
397
398
399
  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
400

401
402
403
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
404
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
405
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
406

407
408
409
410
411
412
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
413

414
  V(TorVersion,                       STRING,   NULL),
415

416
417
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
418

419
  V(TotalBuildTimes,                  UINT,     NULL),
420
421
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
422

423
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
424
425
};

426
#undef VAR
427
#undef V
428
429
#undef OBSOLETE

430
431
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
432
433
434
435
436
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

437
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
438
 * well-formed and consistent. See options_trial_assign() for documentation
439
 * of arguments. */
440
typedef int (*validate_fn_t)(void*,void*,int,char**);
441

442
443
444
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
445
typedef struct {
446
447
448
  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
449
  off_t magic_offset; /**< Offset of the magic value within the struct. */
450
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
451
                             * parsing this format. */
452
453
454
  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
455
456
457
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
458
459
} config_format_t;

460
461
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
462
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
463
    tor_assert(fmt && cfg);                                             \
464
    tor_assert((fmt)->magic ==                                          \
465
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
466
  STMT_END
467

468
469
470
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
471
static void config_line_append(config_line_t **lst,
472
                               const char *key, const char *val);
473
474
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
475
static void option_reset(config_format_t *fmt, or_options_t *options,
476
                         config_var_t *var, int use_defaults);
477
static void config_free(config_format_t *fmt, void *options);
478
static int config_lines_eq(config_line_t *a, config_line_t *b);
479
static int option_is_same(config_format_t *fmt,
480
481
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
482
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
483
484
485
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);
486
static int options_act(or_options_t *old_options);
487
488
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
489
490
491
492
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);
493
static int check_nickname_list(const char *lst, const char *name, char **msg);
494
static void config_register_addressmaps(or_options_t *options);
495

496
static int parse_bridge_line(const char *line, int validate_only);
497
498
499
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
500
static int validate_data_directory(or_options_t *options);
501
static int write_configuration_file(const char *fname, or_options_t *options);
502
static config_line_t *get_assigned_option(config_format_t *fmt,
503
504
                                          void *options, const char *key,
                                          int escape_val);
505
static void config_init(config_format_t *fmt, void *options);
506
static int or_state_validate(or_state_t *old_options, or_state_t *options,
507
                             int from_setconf, char **msg);
508
509
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
510

511
512
513
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

514
515
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
516
static void init_libevent(void);
517
static int opt_streq(const char *s1, const char *s2);
518

519
/** Magic value for or_options_t. */
520
521
#define OR_OPTIONS_MAGIC 9090909

522
/** Configuration format for or_options_t. */
523
static config_format_t options_format = {
524
525
526
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
527
528
529
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
530
  NULL
531
532
};

533
/** Magic value for or_state_t. */
534
535
#define OR_STATE_MAGIC 0x57A73f57

536
537
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
538
539
540
541
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

542
/** Configuration format for or_state_t. */
543
544
545
546
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
547
  _state_abbrevs,
548
549
  _state_vars,
  (validate_fn_t)or_state_validate,
550
  &state_extra_var,
551
552
};

553
554
555
556
557
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
558
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
559
/** Name of most recently read torrc file. */
560
static char *torrc_fname = NULL;
561
/** Persistent serialized state. */
562
static or_state_t *global_state = NULL;
563
564
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
565
/** Contents of most recently read DirPortFrontPage file. */
566
567
568
569
570
571
572
573
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;
}
574

575
/** Allocate an empty configuration object of a given format type. */
576
577
578
static void *
config_alloc(config_format_t *fmt)
{
579
  void *opts = tor_malloc_zero(fmt->size);
580
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
581
582
583
584
  CHECK(fmt, opts);
  return opts;
}

585
586
/** Return the currently configured options. */
or_options_t *
587
588
get_options(void)
{
589
590
591
  tor_assert(global_options);
  return global_options;
}
592

593
594
/** 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
595
 * as necessary.  Returns 0 on success, -1 on failure.
596
 */
597
int
598
set_options(or_options_t *new_val, char **msg)
599
{
600
  or_options_t *old_options = global_options;
601
  global_options = new_val;
602
603
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
604
605
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
606
607
608
    global_options = old_options;
    return -1;
  }
609
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
610
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
611
            "Acting on config options left us in a broken state. Dying.");
612
613
    exit(1);
  }
614
615

  config_free(&options_format, old_options);
616
617

  return 0;
618
619
}

620
extern const char tor_git_revision[]; /* from tor_main.c */
621

622
/** The version of this Tor process, as parsed. */
623
624
static char *_version = NULL;

625
/** Return the current Tor version. */
626
627
628
const char *
get_version(void)
{
629
  if (_version == NULL) {
630
631
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
632
      _version = tor_malloc(len);
633
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
634
    } else {
635
      _version = tor_strdup(VERSION);
636
637
    }
  }
638
  return _version;
639
640
}

641
642
643
644
645
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
646
647
648
  if (!options)
    return;

649
  routerset_free(options->_ExcludeExitNodesUnion);
650
651
652
  config_free(&options_format, options);
}

653
654
/** Release all memory and resources held by global configuration structures.
 */
655
656
657
void
config_free_all(void)
{
658
659
660
661
662
663
664
665
666
  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;

667
  tor_free(torrc_fname);
668
  tor_free(_version);
669
  tor_free(global_dirfrontpagecontents);
670
671
}

672
673
674
675
676
/** 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.)
677
678
 */
const char *
679
safe_str_client(const char *address)
680
{
681
  tor_assert(address);
682
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
683
684
685
686
687
    return "[scrubbed]";
  else
    return address;
}

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

705
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
706
707
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
708
const char *
709
escaped_safe_str_client(const char *address)
710
{
711
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
712
713
714
715
716
    return "[scrubbed]";
  else
    return escaped(address);
}

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

729
730
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
731
static void
732
add_default_trusted_dir_authorities(authority_type_t type)
733
{
734
  int i;
735
  const char *dirservers[] = {
736
    "moria1 v1 orport=9001 v3ident=E2A2AF570166665D738736D0DD58169CC61D8A8B "
737
      "128.31.0.39:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
738
    "moria2 v1 orport=9002 128.31.0.34:9032 "
739
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
740
    "tor26 v1 orport=443 v3ident=14C131DFC5C6F93646BE72FA1401C02A8DF2E8B4 "
Peter Palfrader's avatar
Peter Palfrader committed
741
      "86.59.21.38:80 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
Roger Dingledine's avatar
Roger Dingledine committed
742
743
    "dizum orport=443 v3ident=E8A9C45EDE6D711294FADF8E7951F4DE6CA56B58 "
      "194.109.206.212:80 7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
744
    "Tonga orport=443 bridge no-v2 82.94.251.203:80 "
745
      "4A0C CD2D DC79 9508 3D73 F5D6 6710 0C8A 5831 F16D",
746
747
    "ides orport=9090 no-v2 v3ident=27B6B5996C426270A5C95488AA5BCEB6BCC86956 "
      "216.224.124.114:9030 F397 038A DC51 3361 35E7 B80B D99C A384 4360 292B",
748
    "gabelmoo orport=443 no-v2 "
749
      "v3ident=81349FC1F2DBA2C2C11B45CB9706637D480AB913 "
750
      "80.190.246.100:80 6833 3D07 61BC F397 A587 A0C0 B963 E4A9 E99E C4D3",
751
752
753
    "dannenberg orport=443 no-v2 "
      "v3ident=585769C78764D58426B8B52B6651A5A71137189A "
      "213.73.91.31:80 7BE6 83E6 5D48 1413 21C5 ED92 F075 C553 64AC 7123",
754
755
    "urras orport=80 no-v2 v3ident=80550987E1D626E3EBA5E5E75A458DE0626D088C "
      "208.83.223.34:443 0AD3 FA88 4D18 F89E EA2D 89C0 1937 9E0E 7FD9 4417",
756
    NULL
757
  };
758
759
760
761
762
763
  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]);
    }
  }
764
765
766
767
768
769
770
771
772
773
774
775
776
777
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
}

/** 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)
804
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
805
806
      return -1;
  for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
807
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
808
809
      return -1;
  for (cl = options->AlternateDirAuthority; cl; cl = cl->next)
810
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
811
812
      return -1;
  for (cl = options->AlternateHSAuthority; cl; cl = cl->next)
813
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
814
815
816
817
818
819
820
821
822
823
824
825
826
      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 =
827
    !smartlist_len(router_get_trusted_dir_servers()) || !old_options ||
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
    !config_lines_eq(options->DirServers, old_options->DirServers) ||
    !config_lines_eq(options->AlternateBridgeAuthority,
                     old_options->AlternateBridgeAuthority) ||
    !config_lines_eq(options->AlternateDirAuthority,
                     old_options->AlternateDirAuthority) ||
    !config_lines_eq(options->AlternateHSAuthority,
                     old_options->AlternateHSAuthority);

  if (!need_to_update)
    return 0; /* all done */

  /* Start from a clean slate. */
  clear_trusted_dir_servers();

  if (!options->DirServers) {
    /* then we may want some of the defaults */
    authority_type_t type = NO_AUTHORITY;
    if (!options->AlternateBridgeAuthority)
      type |= BRIDGE_AUTHORITY;
    if (!options->AlternateDirAuthority)
848
      type |= V1_AUTHORITY | V2_AUTHORITY | V3_AUTHORITY;
849
850
851
852
853
854
    if (!options->AlternateHSAuthority)
      type |= HIDSERV_AUTHORITY;
    add_default_trusted_dir_authorities(type);
  }

  for (cl = options->DirServers; cl; cl = cl->next)
855
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 0)<0)
856
857
      return -1;
  for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
858
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 0)<0)
859
860
      return -1;
  for (cl = options->AlternateDirAuthority; cl; cl = cl->