config.c 181 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
  { "l", "Log", 1, 0},
70
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
71
72
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
73
74
75
76
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
77
78
79
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
80
81
82
83
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
84
85
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
Nick Mathewson's avatar
Nick Mathewson committed
86
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0 },
87
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
88
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
89
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
90
91
  { NULL, NULL, 0, 0},
};
92
93

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
128
129
130
131
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
132
static config_var_t _option_vars[] = {
133
  OBSOLETE("AccountingMaxKB"),
134
135
136
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
137
  V(AllowDotExit,                BOOL,     "0"),
138
139
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
140
141
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
142
143
144
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
  V(AlternateHSAuthority,        LINELIST, NULL),
145
  V(AssumeReachable,             BOOL,     "0"),
146
  V(AuthDirBadDir,               LINELIST, NULL),
147
148
149
150
  V(AuthDirBadExit,              LINELIST, NULL),
  V(AuthDirInvalid,              LINELIST, NULL),
  V(AuthDirReject,               LINELIST, NULL),
  V(AuthDirRejectUnlisted,       BOOL,     "0"),
151
  V(AuthDirListBadDirs,          BOOL,     "0"),
152
  V(AuthDirListBadExits,         BOOL,     "0"),
153
154
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
155
156
157
158
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
159
160
  V(BandwidthBurst,              MEMUNIT,  "10 MB"),
  V(BandwidthRate,               MEMUNIT,  "5 MB"),
161
162
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
163
  V(BridgePassword,              STRING,   NULL),
164
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
165
  V(BridgeRelay,                 BOOL,     "0"),
166
  V(CellStatistics,              BOOL,     "0"),
167
168
169
170
  V(CircuitBuildTimeout,         INTERVAL, "1 minute"),
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
171
  V(ConsensusParams,             STRING,   NULL),
172
173
174
175
176
177
178
179
180
181
  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),
182
  V(DataDirectory,               FILENAME, NULL),
183
  OBSOLETE("DebugLogFile"),
184
  V(DirAllowPrivateAddresses,    BOOL,     NULL),
185
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
186
  V(DirListenAddress,            LINELIST, NULL),
187
  OBSOLETE("DirFetchPeriod"),
188
189
  V(DirPolicy,                   LINELIST, NULL),
  V(DirPort,                     UINT,     "0"),
190
  V(DirPortFrontPage,            FILENAME, NULL),
191
  OBSOLETE("DirPostPeriod"),
192
193
194
195
  OBSOLETE("DirRecordUsageByCountry"),
  OBSOLETE("DirRecordUsageGranularity"),
  OBSOLETE("DirRecordUsageRetainIPs"),
  OBSOLETE("DirRecordUsageSaveInterval"),
Karsten Loesing's avatar
Karsten Loesing committed
196
  V(DirReqStatistics,            BOOL,     "0"),
197
198
199
200
201
  VAR("DirServer",               LINELIST, DirServers, NULL),
  V(DNSPort,                     UINT,     "0"),
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
202
  V(EntryNodes,                  ROUTERSET,   NULL),
203
  V(EntryStatistics,             BOOL,     "0"),
204
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
205
206
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
207
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
208
  V(ExitNodes,                   ROUTERSET, NULL),
209
210
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
211
  V(ExitPortStatistics,          BOOL,     "0"),
212
  V(ExtraInfoStatistics,         BOOL,     "0"),
213
  V(FallbackNetworkstatusFile,   FILENAME,
214
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
215
216
217
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
218
  V(FetchDirInfoEarly,           BOOL,     "0"),
219
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
220
221
222
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
223
#ifdef WIN32
224
  V(GeoIPFile,                   FILENAME, "<default>"),
225
#else
226
227
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
228
#endif
229
  OBSOLETE("Group"),
230
  V(HardwareAccel,               BOOL,     "0"),
231
232
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
233
  V(HashedControlPassword,       LINELIST, NULL),
234
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
235
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
236
237
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
238
239
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
240
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
241
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
242
  V(HidServAuth,                 LINELIST, NULL),
243
244
245
246
247
248
  V(HSAuthoritativeDir,          BOOL,     "0"),
  V(HSAuthorityRecordStats,      BOOL,     "0"),
  V(HttpProxy,                   STRING,   NULL),
  V(HttpProxyAuthenticator,      STRING,   NULL),
  V(HttpsProxy,                  STRING,   NULL),
  V(HttpsProxyAuthenticator,     STRING,   NULL),
249
250
251
252
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
253
  OBSOLETE("IgnoreVersion"),
254
255
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
256
  OBSOLETE("LinkPadding"),
257
258
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
259
  V(LongLivedPorts,              CSV,
260
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
261
262
263
264
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
  V(MaxOnionsPending,            UINT,     "100"),
265
  OBSOLETE("MonthlyAccountingStart"),
266
267
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
268
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
269
270
271
272
273
274
275
276
277
278
  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),
279
  OBSOLETE("PathlenCoinWeight"),
280
  V(PidFile,                     STRING,   NULL),
281
  V(TestingTorNetwork,           BOOL,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
282
  V(PreferTunneledDirConns,      BOOL,     "1"),
283
  V(ProtocolWarnings,            BOOL,     "0"),
284
  V(PublishServerDescriptor,     CSV,      "1"),
285
286
287
288
289
290
291
  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),
292
  OBSOLETE("RedirectExit"),
293
  V(RejectPlaintextPorts,        CSV,      ""),
294
295
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
296
297
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
298
299
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
300
  OBSOLETE("RouterFile"),
301
302
303
304
  V(RunAsDaemon,                 BOOL,     "0"),
  V(RunTesting,                  BOOL,     "0"),
  V(SafeLogging,                 BOOL,     "1"),
  V(SafeSocks,                   BOOL,     "0"),
305
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
306
307
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
308
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
309
310
311
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
312
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
313
314
315
316
317
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
  V(SocksPort,                   UINT,     "9050"),
  V(SocksTimeout,                INTERVAL, "2 minutes"),
318
  OBSOLETE("StatusFetchPeriod"),
319
320
  V(StrictEntryNodes,            BOOL,     "0"),
  V(StrictExitNodes,             BOOL,     "0"),
321
  OBSOLETE("SysLog"),
322
  V(TestSocks,                   BOOL,     "0"),
323
  OBSOLETE("TestVia"),
324
325
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
326
  OBSOLETE("TrafficShaping"),
327
328
  V(TransListenAddress,          LINELIST, NULL),
  V(TransPort,                   UINT,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
329
  V(TunnelDirConns,              BOOL,     "1"),
330
331
332
333
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
  V(UseBridges,                  BOOL,     "0"),
  V(UseEntryGuards,              BOOL,     "1"),
  V(User,                        STRING,   NULL),
334
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
335
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
336
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
337
338
339
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
340
341
342
343
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
344
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
345
  V(V3BandwidthsFile,            FILENAME, NULL),
346
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
347
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
348
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
349
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
350
351
352
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
353
354
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
355
  V(MinUptimeHidServDirectoryV2, INTERVAL, "24 hours"),
356
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
357
};
358

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

382
383
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
384
      initvalue }
385
386

/** Array of "state" variables saved to the ~/.tor/state file. */
387
static config_var_t _state_vars[] = {
388
389
390
391
392
  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
393

394
395
396
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
397
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
398
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
399

400
401
402
403
404
405
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
406

407
  V(TorVersion,                       STRING,   NULL),
408

409
410
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
411

412
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
413
414
};

415
#undef VAR
416
#undef V
417
418
#undef OBSOLETE

419
420
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
421
422
423
424
425
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

426
427
428
/** Descriptions of the configuration options, to be displayed by online
 * option browsers */
/* XXXX022 did anybody want this? at all? If not, kill it.*/
429
static config_var_description_t options_description[] = {
430
  /* ==== general options */
431
432
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
433
434
435
436
  { "BandwidthRate", "A token bucket limits the average incoming bandwidth on "
    "this node to the specified number of bytes per second." },
  { "BandwidthBurst", "Limit the maximum token buffer size (also known as "
    "burst) to the given number of bytes." },
437
  { "ConnLimit", "Minimum number of simultaneous sockets we must have." },
438
439
440
441
442
  { "ConstrainedSockets", "Shrink tx and rx buffers for sockets to avoid "
    "system limits on vservers and related environments.  See man page for "
    "more information regarding this option." },
  { "ConstrainedSockSize", "Limit socket buffers to this size when "
    "ConstrainedSockets is enabled." },
443
444
445
  /*  ControlListenAddress */
  { "ControlPort", "If set, Tor will accept connections from the same machine "
    "(localhost only) on this port, and allow those connections to control "
Karsten Loesing's avatar
Karsten Loesing committed
446
    "the Tor process using the Tor Control Protocol (described in "
447
448
449
    "control-spec.txt).", },
  { "CookieAuthentication", "If this option is set to 1, don't allow any "
    "connections to the control port except when the connecting process "
450
    "can read a file that Tor creates in its data directory." },
451
452
453
454
455
456
457
458
459
  { "DataDirectory", "Store working data, state, keys, and caches here." },
  { "DirServer", "Tor only trusts directories signed with one of these "
    "servers' keys.  Used to override the standard list of directory "
    "authorities." },
  /* { "FastFirstHopPK", "" }, */
  /* FetchServerDescriptors, FetchHidServDescriptors,
   * FetchUselessDescriptors */
  { "HardwareAccel", "If set, Tor tries to use hardware crypto accelerators "
    "when it can." },
460
461
462
463
  { "AccelName", "If set, try to use hardware crypto accelerator with this "
    "specific ID." },
  { "AccelDir", "If set, look in this directory for the dynamic hardware "
    "engine in addition to OpenSSL default path." },
464
465
466
467
468
  /* HashedControlPassword */
  { "HTTPProxy", "Force Tor to make all HTTP directory requests through this "
    "host:port (or host:80 if port is not set)." },
  { "HTTPProxyAuthenticator", "A username:password pair to be used with "
    "HTTPProxy." },
Nick Mathewson's avatar
Nick Mathewson committed
469
  { "HTTPSProxy", "Force Tor to make all TLS (SSL) connections through this "
470
471
472
473
474
475
476
477
    "host:port (or host:80 if port is not set)." },
  { "HTTPSProxyAuthenticator", "A username:password pair to be used with "
    "HTTPSProxy." },
  { "KeepalivePeriod", "Send a padding cell every N seconds to keep firewalls "
    "from closing our connections while Tor is not in use." },
  { "Log", "Where to send logging messages.  Format is "
    "minSeverity[-maxSeverity] (stderr|stdout|syslog|file FILENAME)." },
  { "OutboundBindAddress", "Make all outbound connections originate from the "
478
    "provided IP address (only useful for multiple network interfaces)." },
479
480
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
481
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
482
    "don't support tunneled connections." },
483
  /* PreferTunneledDirConns */
484
485
486
487
488
489
  /* ProtocolWarnings */
  /* RephistTrackTime */
  { "RunAsDaemon", "If set, Tor forks and daemonizes to the background when "
    "started.  Unix only." },
  { "SafeLogging", "If set to 0, Tor logs potentially sensitive strings "
    "rather than replacing them with the string [scrubbed]." },
490
491
492
  { "TunnelDirConns", "If non-zero, when a directory server we contact "
    "supports it, we will build a one-hop circuit and make an encrypted "
    "connection via its ORPort." },
Karsten Loesing's avatar
Karsten Loesing committed
493
  { "User", "On startup, setuid to this user." },
494
495
496
497

  /* ==== client options */
  { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
    "that the directory authorities haven't called \"valid\"?" },
498
499
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
500
501
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
502
    "server, even if ORPort is enabled." },
503
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
504
    "in circuits, when possible." },
505
506
507
508
509
  /* { "EnforceDistinctSubnets" , "" }, */
  { "ExitNodes", "A list of preferred nodes to use for the last hop in "
    "circuits, when possible." },
  { "ExcludeNodes", "A list of nodes never to use when building a circuit." },
  { "FascistFirewall", "If set, Tor will only create outgoing connections to "
510
511
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
512
513
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
514
    "high-uptime connections." },
515
516
517
  { "MapAddress", "Force Tor to treat all requests for one address as if "
    "they were for another." },
  { "NewCircuitPeriod", "Force Tor to consider whether to build a new circuit "
518
    "every NUM seconds." },
519
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
520
    "been used more than this many seconds ago." },
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
  /* NatdPort, NatdListenAddress */
  { "NodeFamily", "A list of servers that constitute a 'family' and should "
    "never be used in the same circuit." },
  { "NumEntryGuards", "How many entry guards should we keep at a time?" },
  /* PathlenCoinWeight */
  { "ReachableAddresses", "Addresses we can connect to, as IP/bits:port-port. "
    "By default, we assume all addresses are reachable." },
  /* reachablediraddresses, reachableoraddresses. */
  /* SafeSOCKS */
  { "SOCKSPort", "The port where we listen for SOCKS connections from "
    "applications." },
  { "SOCKSListenAddress", "Bind to this address to listen to connections from "
    "SOCKS-speaking applications." },
  { "SOCKSPolicy", "Set an entry policy to limit which addresses can connect "
    "to the SOCKSPort." },
  /* SocksTimeout */
  { "StrictExitNodes", "If set, Tor will fail to operate when none of the "
    "configured ExitNodes can be used." },
  { "StrictEntryNodes", "If set, Tor will fail to operate when none of the "
    "configured EntryNodes can be used." },
  /* TestSocks */
  { "TrackHostsExit", "Hosts and domains which should, if possible, be "
543
    "accessed from the same exit node each time we connect to them." },
544
545
546
547
  { "TrackHostsExitExpire", "Time after which we forget which exit we were "
    "using to connect to hosts in TrackHostsExit." },
  /* "TransPort", "TransListenAddress */
  { "UseEntryGuards", "Set to 0 if we want to pick from the whole set of "
548
549
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
550
551

  /* === server options */
552
  { "Address", "The advertised (external) address we should use." },
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
  /* Accounting* options. */
  /* AssumeReachable */
  { "ContactInfo", "Administrative contact information to advertise for this "
    "server." },
  { "ExitPolicy", "Address/port ranges for which to accept or reject outgoing "
    "connections on behalf of Tor users." },
  /*  { "ExitPolicyRejectPrivate, "" }, */
  { "MaxAdvertisedBandwidth", "If set, we will not advertise more than this "
    "amount of bandwidth for our bandwidth rate, regardless of how much "
    "bandwidth we actually detect." },
  { "MaxOnionsPending", "Reject new attempts to extend circuits when we "
    "already have this many pending." },
  { "MyFamily", "Declare a list of other servers as belonging to the same "
    "family as this one, so that clients will not use two from the same "
    "family in the same circuit." },
  { "Nickname", "Set the server nickname." },
569
  { "NoPublish", "{DEPRECATED}" },
570
571
572
573
574
  { "NumCPUs", "How many processes to use at once for public-key crypto." },
  { "ORPort", "Advertise this port to listen for connections from Tor clients "
    "and servers." },
  { "ORListenAddress", "Bind to this address to listen for connections from "
    "clients and servers, instead of the default 0.0.0.0:ORPort." },
575
  { "PublishServerDescriptor", "Set to 0 to keep the server from "
576
    "uploading info to the directory authorities." },
577
578
579
580
  /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
  { "ShutdownWaitLength", "Wait this long for clients to finish when "
    "shutting down because of a SIGINT." },

581
  /* === directory cache options */
582
583
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
584
  { "DirPortFrontPage", "Serve a static html disclaimer on DirPort." },
585
  { "DirListenAddress", "Bind to this address to listen for connections from "
586
587
    "clients and servers, instead of the default 0.0.0.0:DirPort." },
  { "DirPolicy", "Set a policy to limit who can connect to the directory "
Karsten Loesing's avatar
Karsten Loesing committed
588
    "port." },
589
590
591
592
593
594
595
596
597
598
599
600

  /*  Authority options: AuthDirBadExit, AuthDirInvalid, AuthDirReject,
   * AuthDirRejectUnlisted, AuthDirListBadExits, AuthoritativeDirectory,
   * DirAllowPrivateAddresses, HSAuthoritativeDir,
   * NamingAuthoritativeDirectory, RecommendedVersions,
   * RecommendedClientVersions, RecommendedServerVersions, RendPostPeriod,
   * RunTesting, V1AuthoritativeDirectory, VersioningAuthoritativeDirectory, */

  /* Hidden service options: HiddenService: dir,excludenodes, nodes,
   * options, port.  PublishHidServDescriptor */

  /* Nonpersistent options: __LeaveStreamsUnattached, __AllDirActionsPrivate */
601
602
603
  { NULL, NULL },
};

604
/** Online description of state variables. */
605
static config_var_description_t state_description[] = {
606
  { "AccountingBytesReadInInterval",
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
    "How many bytes have we read in this accounting period?" },
  { "AccountingBytesWrittenInInterval",
    "How many bytes have we written in this accounting period?" },
  { "AccountingExpectedUsage",
    "How many bytes did we expect to use per minute? (0 for no estimate.)" },
  { "AccountingIntervalStart", "When did this accounting period begin?" },
  { "AccountingSecondsActive", "How long have we been awake in this period?" },

  { "BWHistoryReadEnds", "When does the last-recorded read-interval end?" },
  { "BWHistoryReadInterval", "How long is each read-interval (in seconds)?" },
  { "BWHistoryReadValues", "Number of bytes read in each interval." },
  { "BWHistoryWriteEnds", "When does the last-recorded write-interval end?" },
  { "BWHistoryWriteInterval", "How long is each write-interval (in seconds)?"},
  { "BWHistoryWriteValues", "Number of bytes written in each interval." },

622
623
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
624
    "The last entry guard has been unreachable since this time." },
625
  { "EntryGuardUnlistedSince",
626
    "The last entry guard has been unusable since this time." },
Roger Dingledine's avatar
Roger Dingledine committed
627

628
629
630
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
631
632
633
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
634
635
636
  { NULL, NULL },
};

637
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
638
 * well-formed and consistent. See options_trial_assign() for documentation
639
 * of arguments. */
640
typedef int (*validate_fn_t)(void*,void*,int,char**);
641

642
643
644
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
645
typedef struct {
646
647
648
  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
649
  off_t magic_offset; /**< Offset of the magic value within the struct. */
650
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
651
                             * parsing this format. */
652
653
654
655
  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. */
  /** Documentation for configuration variables. */
656
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
657
658
659
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
660
661
} config_format_t;

662
663
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
664
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
665
    tor_assert(fmt && cfg);                                             \
666
    tor_assert((fmt)->magic ==                                          \
667
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
668
  STMT_END
669

670
671
672
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
673
static void config_line_append(config_line_t **lst,
674
                               const char *key, const char *val);
675
676
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
677
static void option_reset(config_format_t *fmt, or_options_t *options,
678
                         config_var_t *var, int use_defaults);
679
static void config_free(config_format_t *fmt, void *options);
680
static int config_lines_eq(config_line_t *a, config_line_t *b);
681
static int option_is_same(config_format_t *fmt,
682
683
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
684
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
685
686
687
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);
688
static int options_act(or_options_t *old_options);
689
690
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
691
692
693
694
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);
695
static int check_nickname_list(const char *lst, const char *name, char **msg);
696
static void config_register_addressmaps(or_options_t *options);
697

698
static int parse_bridge_line(const char *line, int validate_only);
699
700
701
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
702
static int validate_data_directory(or_options_t *options);
703
static int write_configuration_file(const char *fname, or_options_t *options);
704
static config_line_t *get_assigned_option(config_format_t *fmt,
705
706
                                          void *options, const char *key,
                                          int escape_val);
707
static void config_init(config_format_t *fmt, void *options);
708
static int or_state_validate(or_state_t *old_options, or_state_t *options,
709
                             int from_setconf, char **msg);
710
711
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
712

713
714
715
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

716
717
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
718
static void init_libevent(void);
719
static int opt_streq(const char *s1, const char *s2);
720

721
/** Magic value for or_options_t. */
722
723
#define OR_OPTIONS_MAGIC 9090909

724
/** Configuration format for or_options_t. */
725
static config_format_t options_format = {
726
727
728
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
729
730
731
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
732
733
  options_description,
  NULL
734
735
};

736
/** Magic value for or_state_t. */
737
738
#define OR_STATE_MAGIC 0x57A73f57

739
740
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
741
742
743
744
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

745
/** Configuration format for or_state_t. */
746
747
748
749
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
750
  _state_abbrevs,
751
752
  _state_vars,
  (validate_fn_t)or_state_validate,
753
754
  state_description,
  &state_extra_var,
755
756
};

757
758
759
760
761
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
762
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
763
/** Name of most recently read torrc file. */
764
static char *torrc_fname = NULL;
765
/** Persistent serialized state. */
766
static or_state_t *global_state = NULL;
767
768
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
769
/** Contents of most recently read DirPortFrontPage file. */
770
771
772
773
774
775
776
777
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;
}
778

779
/** Allocate an empty configuration object of a given format type. */
780
781
782
static void *
config_alloc(config_format_t *fmt)
{
783
  void *opts = tor_malloc_zero(fmt->size);
784
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
785
786
787
788
  CHECK(fmt, opts);
  return opts;
}

789
790
/** Return the currently configured options. */
or_options_t *
791
792
get_options(void)
{
793
794
795
  tor_assert(global_options);
  return global_options;
}
796

797
798
/** 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
799
 * as necessary.  Returns 0 on success, -1 on failure.
800
 */
801
int
802
set_options(or_options_t *new_val, char **msg)
803
{
804
  or_options_t *old_options = global_options;
805
  global_options = new_val;
806
807
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
808
809
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
810
811
812
    global_options = old_options;
    return -1;
  }
813
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
814
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
815
            "Acting on config options left us in a broken state. Dying.");
816
817
818
    exit(1);
  }
  if (old_options)
819
    config_free(&options_format, old_options);
820
821

  return 0;
822
823
}

824
extern const char tor_git_revision[]; /* from tor_main.c */
825

826
/** The version of this Tor process, as parsed. */
827
828
static char *_version = NULL;

829
/** Return the current Tor version. */
830
831
832
const char *
get_version(void)
{
833
  if (_version == NULL) {
834
835
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
836
      _version = tor_malloc(len);
837
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
838
    } else {
839
      _version = tor_strdup(VERSION);
840
841
    }
  }
842
  return _version;
843
844
}

845
846
847
848
849
850
851
852
853
854
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
  if (options->_ExcludeExitNodesUnion)
    routerset_free(options->_ExcludeExitNodesUnion);
  config_free(&options_format, options);
}

855
856
/** Release all memory and resources held by global configuration structures.
 */
857
858
859
void
config_free_all(void)
{
860
  if (global_options) {
861
    or_options_free(global_options);
862
863
864
865
866
867
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
868
869
870
871
  if (global_cmdline_options) {
    config_free_lines(global_cmdline_options);
    global_cmdline_options = NULL;
  }
872
  tor_free(torrc_fname);
873
  tor_free(_version);
874
  tor_free(global_dirfrontpagecontents);
875
876
}

877
878
879
880
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
881
882
safe_str(const char *address)
{
883
  tor_assert(address);
884
885
886
887
888
889
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

890
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on