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

346
347
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
348
static config_var_t testing_tor_network_defaults[] = {
349
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
350
351
352
353
354
355
356
357
358
359
  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"),
360
361
362
363
364
  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"),
365
366
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
367
368
#undef VAR

369
370
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
371
      initvalue }
372
373

/** Array of "state" variables saved to the ~/.tor/state file. */
374
static config_var_t _state_vars[] = {
375
376
377
378
379
  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
380

381
382
383
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
384
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
385
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
386

387
388
389
390
391
392
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
393

394
  V(TorVersion,                       STRING,   NULL),
395

396
397
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
398

399
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
400
401
};

402
#undef VAR
403
#undef V
404
405
#undef OBSOLETE

406
407
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
408
409
410
411
412
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

413
414
415
/** Descriptions of the configuration options, to be displayed by online
 * option browsers */
/* XXXX022 did anybody want this? at all? If not, kill it.*/
416
static config_var_description_t options_description[] = {
417
  /* ==== general options */
418
419
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
420
421
422
423
  { "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." },
424
  { "ConnLimit", "Minimum number of simultaneous sockets we must have." },
425
426
427
428
429
  { "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." },
430
431
432
  /*  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
433
    "the Tor process using the Tor Control Protocol (described in "
434
435
436
    "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 "
437
    "can read a file that Tor creates in its data directory." },
438
439
440
441
442
443
444
445
446
447
448
449
450
451
  { "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." },
  /* 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
452
  { "HTTPSProxy", "Force Tor to make all TLS (SSL) connections through this "
453
454
455
456
457
458
459
460
    "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 "
461
    "provided IP address (only useful for multiple network interfaces)." },
462
463
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
464
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
465
    "don't support tunneled connections." },
466
  /* PreferTunneledDirConns */
467
468
469
470
471
472
  /* 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]." },
473
474
475
  { "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
476
  { "User", "On startup, setuid to this user." },
477
478
479
480

  /* ==== client options */
  { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
    "that the directory authorities haven't called \"valid\"?" },
481
482
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
483
484
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
485
    "server, even if ORPort is enabled." },
486
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
487
    "in circuits, when possible." },
488
489
490
491
492
  /* { "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 "
493
494
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
495
496
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
497
    "high-uptime connections." },
498
499
500
  { "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 "
501
    "every NUM seconds." },
502
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
503
    "been used more than this many seconds ago." },
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
  /* 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 "
526
    "accessed from the same exit node each time we connect to them." },
527
528
529
530
  { "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 "
531
532
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
533
534

  /* === server options */
535
  { "Address", "The advertised (external) address we should use." },
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
  /* 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." },
552
  { "NoPublish", "{DEPRECATED}" },
553
554
555
556
557
  { "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." },
558
  { "PublishServerDescriptor", "Set to 0 to keep the server from "
559
    "uploading info to the directory authorities." },
560
561
562
563
  /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
  { "ShutdownWaitLength", "Wait this long for clients to finish when "
    "shutting down because of a SIGINT." },

564
  /* === directory cache options */
565
566
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
567
  { "DirPortFrontPage", "Serve a static html disclaimer on DirPort." },
568
  { "DirListenAddress", "Bind to this address to listen for connections from "
569
570
    "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
571
    "port." },
572
573
574
575
576
577
578
579
580
581
582
583

  /*  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 */
584
585
586
  { NULL, NULL },
};

587
/** Online description of state variables. */
588
static config_var_description_t state_description[] = {
589
  { "AccountingBytesReadInInterval",
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
    "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." },

605
606
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
607
    "The last entry guard has been unreachable since this time." },
608
  { "EntryGuardUnlistedSince",
609
    "The last entry guard has been unusable since this time." },
Roger Dingledine's avatar
Roger Dingledine committed
610

611
612
613
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
614
615
616
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
617
618
619
  { NULL, NULL },
};

620
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
621
 * well-formed and consistent. See options_trial_assign() for documentation
622
 * of arguments. */
623
typedef int (*validate_fn_t)(void*,void*,int,char**);
624

625
626
627
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
628
typedef struct {
629
630
631
  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
632
  off_t magic_offset; /**< Offset of the magic value within the struct. */
633
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
634
                             * parsing this format. */
635
636
637
638
  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. */
639
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
640
641
642
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
643
644
} config_format_t;

645
646
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
647
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
648
    tor_assert(fmt && cfg);                                             \
649
    tor_assert((fmt)->magic ==                                          \
650
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
651
  STMT_END
652

653
654
655
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
656
static void config_line_append(config_line_t **lst,
657
                               const char *key, const char *val);
658
659
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
660
static void option_reset(config_format_t *fmt, or_options_t *options,
661
                         config_var_t *var, int use_defaults);
662
static void config_free(config_format_t *fmt, void *options);
663
static int config_lines_eq(config_line_t *a, config_line_t *b);
664
static int option_is_same(config_format_t *fmt,
665
666
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
667
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
668
669
670
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);
671
static int options_act(or_options_t *old_options);
672
673
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
674
675
676
677
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);
678
static int check_nickname_list(const char *lst, const char *name, char **msg);
679
static void config_register_addressmaps(or_options_t *options);
680

681
static int parse_bridge_line(const char *line, int validate_only);
682
683
684
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
685
static int validate_data_directory(or_options_t *options);
686
static int write_configuration_file(const char *fname, or_options_t *options);
687
static config_line_t *get_assigned_option(config_format_t *fmt,
688
689
                                          void *options, const char *key,
                                          int escape_val);
690
static void config_init(config_format_t *fmt, void *options);
691
static int or_state_validate(or_state_t *old_options, or_state_t *options,
692
                             int from_setconf, char **msg);
693
694
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
695

696
697
698
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

699
700
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
701
static void init_libevent(void);
702
static int opt_streq(const char *s1, const char *s2);
703
/** Versions of libevent. */
704
typedef enum {
705
706
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
707
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
708
709
710
  LE_13, LE_13A, LE_13B, LE_13C, LE_13D, LE_13E,
  LE_140, LE_141, LE_142, LE_143, LE_144, LE_145, LE_146, LE_147, LE_148,
  LE_1499,
711
  LE_OTHER
712
} le_version_t;
713
static le_version_t decode_libevent_version(const char *v, int *bincompat_out);
714
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
715
static void check_libevent_version(const char *m, int server);
716
#endif
717

718
/** Magic value for or_options_t. */
719
720
#define OR_OPTIONS_MAGIC 9090909

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

733
/** Magic value for or_state_t. */
734
735
#define OR_STATE_MAGIC 0x57A73f57

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

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

754
755
756
757
758
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

  return 0;
819
820
}

Roger Dingledine's avatar
Roger Dingledine committed
821
extern const char tor_svn_revision[]; /* from tor_main.c */
822

823
/** The version of this Tor process, as parsed. */
824
825
static char *_version = NULL;

826
/** Return the current Tor version. */
827
828
829
const char *
get_version(void)
{
830
  if (_version == NULL) {
831
832
    if (strlen(tor_svn_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_svn_revision)+8;
833
834
      _version = tor_malloc(len);
      tor_snprintf(_version, len, "%s (r%s)", VERSION, tor_svn_revision);
835
    } else {
836
      _version = tor_strdup(VERSION);
837
838
    }
  }
839
  return _version;
840
841
}

842
843
844
845
846
847
848
849
850
851
/** 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);
}

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

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

887
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
888
889
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
890
891
892
893
894
895
896
897
898
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

899