config.c 159 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-2007, Roger Dingledine, Nick Mathewson. */
4
5
/* See LICENSE for licensing information */
/* $Id$ */
6
7
const char config_c_id[] = \
  "$Id$";
8

Nick Mathewson's avatar
Nick Mathewson committed
9
/**
10
11
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
12
13
 **/

14
15
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
16
#include "or.h"
17
18
19
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
20

Nick Mathewson's avatar
Nick Mathewson committed
21
22
/** Enumeration of types which option values can take */
typedef enum config_type_t {
23
24
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
25
26
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
27
28
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
29
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formated time relative to GMT. */
30
31
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
32
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
33
34
35
36
37
  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.
                             */
38
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
39
} config_type_t;
40

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

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

Nick Mathewson's avatar
Nick Mathewson committed
53
/* A list of command-line abbreviations. */
54
static config_abbrev_t _option_abbrevs[] = {
55
  PLURAL(ExitNode),
56
  PLURAL(EntryNode),
57
58
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
59
  PLURAL(LongLivedPort),
60
61
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
62
  PLURAL(NumCpu),
63
64
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
65
66
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
67
  { "l", "Log", 1, 0},
68
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
69
70
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
71
72
73
74
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
75
76
77
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
78
79
80
81
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
82
83
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
84
85
86
87
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
88
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
89
90
91
92
93
94
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
95
  { NULL, NULL, 0, 0},
96
};
97
#undef PLURAL
98

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

Nick Mathewson's avatar
Nick Mathewson committed
108
109
110
111
/** 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>"
 */
112
113
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
114
      initvalue }
Nick Mathewson's avatar
Nick Mathewson committed
115
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
116
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
117

Nick Mathewson's avatar
Nick Mathewson committed
118
119
120
121
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
122
static config_var_t _option_vars[] = {
123
  OBSOLETE("AccountingMaxKB"),
Roger Dingledine's avatar
Roger Dingledine committed
124
  VAR("AccountingMax",       MEMUNIT,  AccountingMax,        "0 bytes"),
125
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
126
  VAR("Address",             STRING,   Address,              NULL),
127
  VAR("AllowInvalidNodes",   CSV,      AllowInvalidNodes,
128
                                                        "middle,rendezvous"),
129
  VAR("AllowNonRFC953Hostnames", BOOL, AllowNonRFC953Hostnames, "0"),
130
  VAR("AssumeReachable",     BOOL,     AssumeReachable,      "0"),
131
  VAR("AuthDirBadExit",      LINELIST, AuthDirBadExit,       NULL),
132
133
  VAR("AuthDirInvalid",      LINELIST, AuthDirInvalid,       NULL),
  VAR("AuthDirReject",       LINELIST, AuthDirReject,        NULL),
134
  VAR("AuthDirRejectUnlisted",BOOL,    AuthDirRejectUnlisted,"0"),
135
  VAR("AuthDirListBadExits", BOOL,     AuthDirListBadExits,  "0"),
136
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
137
138
  VAR("AutomapHostsOnResolve",BOOL,    AutomapHostsOnResolve,"0"),
  VAR("AutomapHostsSuffixes",CSV,      AutomapHostsSuffixes, ".onion,.exit"),
139
  VAR("AvoidDiskWrites",     BOOL,     AvoidDiskWrites,      "0"),
140
141
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "6 MB"),
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "3 MB"),
142
  VAR("BridgeAuthoritativeDir", BOOL,  BridgeAuthoritativeDir, "0"),
143
  VAR("Bridge",              LINELIST, Bridges,              NULL),
144
145
  VAR("CircuitBuildTimeout", INTERVAL, CircuitBuildTimeout,  "1 minute"),
  VAR("CircuitIdleTimeout",  INTERVAL, CircuitIdleTimeout,   "1 hour"),
146
147
  VAR("ClientDNSRejectInternalAddresses", BOOL,
      ClientDNSRejectInternalAddresses, "1"),
148
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
149
  VAR("ConnLimit",           UINT,     ConnLimit,            "1000"),
150
  VAR("ConstrainedSockets",  BOOL,     ConstrainedSockets,   "0"),
151
  VAR("ConstrainedSockSize", MEMUNIT,  ConstrainedSockSize,  "8192"),
152
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
153
  VAR("ControlListenAddress",LINELIST, ControlListenAddress, NULL),
154
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
155
  VAR("ControlSocket",       LINELIST, ControlSocket,        NULL),
156
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
157
  VAR("CookieAuthFileGroupReadable",BOOL,CookieAuthFileGroupReadable, "0"),
158
  VAR("CookieAuthFile",      STRING,   CookieAuthFile,       NULL),
159
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
160
  OBSOLETE("DebugLogFile"),
161
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
162
  VAR("DirListenAddress",    LINELIST, DirListenAddress,     NULL),
163
  OBSOLETE("DirFetchPeriod"),
164
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
Nick Mathewson's avatar
Nick Mathewson committed
165
  VAR("DirPort",             UINT,     DirPort,              "0"),
166
  OBSOLETE("DirPostPeriod"),
167
  VAR("DirServer",           LINELIST, DirServers,           NULL),
168
169
  VAR("DNSPort",             UINT,     DNSPort,              "0"),
  VAR("DNSListenAddress",    LINELIST, DNSListenAddress,     NULL),
170
  VAR("DownloadExtraInfo",   BOOL,     DownloadExtraInfo,    "0"),
171
  VAR("EnforceDistinctSubnets", BOOL,  EnforceDistinctSubnets,"1"),
172
173
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
174
175
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
176
  VAR("ExitPolicyRejectPrivate", BOOL, ExitPolicyRejectPrivate, "1"),
177
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
178
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
179
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
180
181
  VAR("FetchServerDescriptors",BOOL,   FetchServerDescriptors,"1"),
  VAR("FetchHidServDescriptors",BOOL,  FetchHidServDescriptors, "1"),
182
  VAR("FetchUselessDescriptors",BOOL,  FetchUselessDescriptors, "0"),
183
  VAR("Group",               STRING,   Group,                NULL),
184
  VAR("HardwareAccel",       BOOL,     HardwareAccel,        "0"),
185
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
186
187
188
189
190
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceExcludeNodes", LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceNodes",  LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
191
  VAR("HSAuthoritativeDir",  BOOL,     HSAuthoritativeDir,   "0"),
192
  VAR("HSAuthorityRecordStats",BOOL,   HSAuthorityRecordStats,"0"),
193
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
194
  VAR("HttpProxyAuthenticator",STRING, HttpProxyAuthenticator,NULL),
195
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
196
  VAR("HttpsProxyAuthenticator",STRING,HttpsProxyAuthenticator,NULL),
197
  OBSOLETE("IgnoreVersion"),
198
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
199
  VAR("Log",                 LINELIST, Logs,                 NULL),
200
  OBSOLETE("LinkPadding"),
201
202
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
203
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,
204
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
Nick Mathewson's avatar
Nick Mathewson committed
205
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
206
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"1 GB"),
Nick Mathewson's avatar
Nick Mathewson committed
207
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
208
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
209
  OBSOLETE("MonthlyAccountingStart"),
Nick Mathewson's avatar
Nick Mathewson committed
210
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
211
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
212
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
213
214
  VAR("NatdListenAddress",   LINELIST, NatdListenAddress,    NULL),
  VAR("NatdPort",            UINT,     NatdPort,             "0"),
Nick Mathewson's avatar
Nick Mathewson committed
215
216
217
  VAR("Nickname",            STRING,   Nickname,             NULL),
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
218
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
219
  VAR("NumEntryGuards",      UINT,     NumEntryGuards,       "3"),
220
  VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
221
  VAR("ORPort",              UINT,     ORPort,               "0"),
222
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
223
  OBSOLETE("PathlenCoinWeight"),
Nick Mathewson's avatar
Nick Mathewson committed
224
  VAR("PidFile",             STRING,   PidFile,              NULL),
225
  VAR("PreferTunneledDirConns", BOOL,  PreferTunneledDirConns, "0"),
226
  VAR("ProtocolWarnings",    BOOL,     ProtocolWarnings,     "0"),
227
  VAR("PublishServerDescriptor", CSV,  PublishServerDescriptor,"v1,v2"),
228
  VAR("PublishHidServDescriptors",BOOL,PublishHidServDescriptors, "1"),
229
  VAR("ReachableAddresses",  LINELIST, ReachableAddresses,   NULL),
230
231
  VAR("ReachableDirAddresses",LINELIST,ReachableDirAddresses,NULL),
  VAR("ReachableORAddresses",LINELIST, ReachableORAddresses, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
232
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
233
234
  VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
  VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
235
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
236
237
  VAR("RelayBandwidthBurst", MEMUNIT,  RelayBandwidthBurst,  "0"),
  VAR("RelayBandwidthRate",  MEMUNIT,  RelayBandwidthRate,   "0"),
Nick Mathewson's avatar
Nick Mathewson committed
238
239
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
240
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "1 hour"),
241
  VAR("RephistTrackTime",    INTERVAL, RephistTrackTime,     "24 hours"),
242
  OBSOLETE("RouterFile"),
243
244
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
245
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
246
  VAR("SafeSocks",           BOOL,     SafeSocks,            "0"),
247
248
  VAR("ServerDNSAllowNonRFC953Hostnames",
                             BOOL,     ServerDNSAllowNonRFC953Hostnames, "0"),
249
  VAR("ServerDNSDetectHijacking",BOOL,   ServerDNSDetectHijacking,"1"),
250
251
  VAR("ServerDNSResolvConfFile", STRING, ServerDNSResolvConfFile, NULL),
  VAR("ServerDNSSearchDomains",  BOOL,   ServerDNSSearchDomains,  "0"),
252
253
  VAR("ServerDNSTestAddresses",  CSV,    ServerDNSTestAddresses,
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
254
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
255
  VAR("SocksListenAddress",  LINELIST, SocksListenAddress,   NULL),
256
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
257
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
258
  VAR("SocksTimeout",        INTERVAL, SocksTimeout,         "2 minutes"),
259
  OBSOLETE("StatusFetchPeriod"),
Nick Mathewson's avatar
Nick Mathewson committed
260
261
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
262
  OBSOLETE("SysLog"),
263
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
264
  VAR("TestVia",             STRING,   TestVia,              NULL),
Nick Mathewson's avatar
Nick Mathewson committed
265
266
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
267
  OBSOLETE("TrafficShaping"),
268
269
  VAR("TransListenAddress",  LINELIST, TransListenAddress,   NULL),
  VAR("TransPort",           UINT,     TransPort,            "0"),
270
  VAR("TunnelDirConns",      BOOL,     TunnelDirConns,       "0"),
271
  VAR("UpdateBridgesFromAuthority",BOOL,UpdateBridgesFromAuthority,"0"),
272
  VAR("UseBridges",          BOOL,     UseBridges,           "0"),
273
  VAR("UseEntryGuards",      BOOL,     UseEntryGuards,       "1"),
Nick Mathewson's avatar
Nick Mathewson committed
274
  VAR("User",                STRING,   User,                 NULL),
275
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
276
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
277
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
278
  VAR("V3AuthVotingInterval",INTERVAL, V3AuthVotingInterval, "1 hour"),
279
280
281
282
  VAR("V3AuthVoteDelay",     INTERVAL, V3AuthVoteDelay, "5 minutes"),
  VAR("V3AuthDistDelay",     INTERVAL, V3AuthDistDelay, "5 minutes"),
  VAR("V3AuthNIntervalsValid", UINT,   V3AuthNIntervalsValid, "3"),

283
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
284
  VAR("VirtualAddrNetwork",  STRING,   VirtualAddrNetwork,   "127.192.0.0/10"),
285
286
  VAR("__AllDirActionsPrivate",BOOL,   AllDirActionsPrivate, "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits,"0"),
287
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
288

289
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
290
};
291
292
#undef VAR

293
294
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
295
      initvalue }
296
static config_var_t _state_vars[] = {
297
  VAR("AccountingBytesReadInInterval", MEMUNIT,
298
      AccountingBytesReadInInterval, NULL),
299
300
301
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
302
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
303
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
Roger Dingledine's avatar
Roger Dingledine committed
304

305
306
307
308
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuards",             LINELIST_V,  EntryGuards,             NULL),
Nick Mathewson's avatar
Nick Mathewson committed
309

310
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
311
312
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  "900"),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    ""),
313
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
314
315
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, "900"),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   ""),
316

317
318
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

319
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
320
321
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

322
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
323
324
};

325
326
327
#undef VAR
#undef OBSOLETE

328
329
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
330
331
332
333
334
335
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
336
  /* ==== general options */
337
338
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
339
340
341
342
343
  { "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." },
  { "ConnLimit", "Maximum number of simultaneous sockets allowed." },
344
345
346
347
348
  { "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." },
349
350
351
352
353
354
355
  /*  ControlListenAddress */
  { "ControlPort", "If set, Tor will accept connections from the same machine "
    "(localhost only) on this port, and allow those connections to control "
    "the Tor process using the Tor Control Protocol (described in"
    "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 "
356
    "can read a file that Tor creates in its data directory." },
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
  { "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 */
  { "Group", "On startup, setgid to this group." },
  { "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." },
  { "HTTPSProxy", "Force Tor to make all TLS (SSL) connectinos through this "
    "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 "
381
    "provided IP address (only useful for multiple network interfaces)." },
382
383
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
384
385
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
    "don't support tunneled conncetions." },
386
  /* PreferTunneledDirConns */
387
388
389
390
391
392
  /* 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]." },
393
394
395
  { "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." },
396
397
398
399
400
  { "User", "On startup, setuid to this user" },

  /* ==== client options */
  { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
    "that the directory authorities haven't called \"valid\"?" },
401
402
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
403
404
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
405
    "server, even if ORPort is enabled." },
406
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
407
    "in circuits, when possible." },
408
409
410
411
412
  /* { "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 "
413
414
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
415
416
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
417
    "high-uptime connections." },
418
419
420
  { "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 "
421
    "every NUM seconds." },
422
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
423
    "been used more than this many seconds ago." },
424
425
426
427
428
429
430
431
432
  /* 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. */
  { "RendNodes", "A list of preferred nodes to use for a rendezvous point, "
433
    "when possible." },
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
  { "RendExcludenodes", "A list of nodes never to use as rendezvous points." },
  /* 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 "
449
    "accessed from the same exit node each time we connect to them." },
450
451
452
453
  { "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 "
454
455
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
456
457

  /* === server options */
458
  { "Address", "The advertised (external) address we should use." },
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
  /* 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." },
475
  { "NoPublish", "{DEPRECATED}" },
476
477
478
479
480
  { "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." },
481
  { "PublishServerDescriptors", "Set to \"\" to keep the server from "
482
    "uploading info to the directory authorities." },
483
484
485
486
487
488
489
490
  /*{ "RedirectExit", "When an outgoing connection tries to connect to a "
   *"given address, redirect it to another address instead." },
   */
  /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
  { "ShutdownWaitLength", "Wait this long for clients to finish when "
    "shutting down because of a SIGINT." },
  /* { "TestVia", } */

491
  /* === directory cache options */
492
493
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
494
  { "DirListenAddress", "Bind to this address to listen for connections from "
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
    "clients and servers, instead of the default 0.0.0.0:DirPort." },
  { "DirPolicy", "Set a policy to limit who can connect to the directory "
    "port" },

  /*  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 */
510
511
512
513
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
514
  { "AccountingBytesReadInInterval",
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
    "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." },

530
531
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
532
    "The last entry guard has been unreachable since this time." },
533
  { "EntryGuardUnlistedSince",
534
    "The last entry guard has been unusable since this time." },
Roger Dingledine's avatar
Roger Dingledine committed
535

536
537
538
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
539
540
541
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
542
543
544
  { NULL, NULL },
};

545
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
546
 * well-formed and consistent. See options_trial_assign() for documentation
547
 * of arguments. */
548
typedef int (*validate_fn_t)(void*,void*,int,char**);
549

550
551
552
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
553
typedef struct {
554
555
556
  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
557
  off_t magic_offset; /**< Offset of the magic value within the struct. */
558
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
559
                             * parsing this format. */
560
561
562
563
  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. */
564
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
565
566
567
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
568
569
} config_format_t;

570
571
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
572
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
573
    tor_assert(fmt && cfg);                                             \
574
    tor_assert((fmt)->magic ==                                          \
575
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
576
  STMT_END
577

578
static void config_line_append(config_line_t **lst,
579
                               const char *key, const char *val);
580
581
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
582
static void option_reset(config_format_t *fmt, or_options_t *options,
583
                         config_var_t *var, int use_defaults);
584
static void config_free(config_format_t *fmt, void *options);
585
static int option_is_same(config_format_t *fmt,
586
587
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
588
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
589
590
591
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);
592
static int options_act(or_options_t *old_options);
593
594
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
595
596
597
598
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);
599
static int check_nickname_list(const char *lst, const char *name, char **msg);
600
static void config_register_addressmaps(or_options_t *options);
601

602
static int parse_bridge_line(const char *line, int validate_only);
603
static int parse_dir_server_line(const char *line, int validate_only);
604
static int parse_redirect_line(smartlist_t *result,
605
                               config_line_t *line, char **msg);
606
607
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
608
static int validate_data_directory(or_options_t *options);
609
static int write_configuration_file(const char *fname, or_options_t *options);
610
static config_line_t *get_assigned_option(config_format_t *fmt,
611
                                     or_options_t *options, const char *key);
612
static void config_init(config_format_t *fmt, void *options);
613
static int or_state_validate(or_state_t *old_options, or_state_t *options,
614
                             int from_setconf, char **msg);
615

616
617
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
618
static void print_svn_version(void);
619
static void init_libevent(void);
620
static int opt_streq(const char *s1, const char *s2);
621
/** Versions of libevent. */
622
typedef enum {
623
624
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
625
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
626
  LE_13, LE_13A, LE_13B,
627
  LE_OTHER
628
629
} le_version_t;
static le_version_t decode_libevent_version(void);
630
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
631
static void check_libevent_version(const char *m, int server);
632
#endif
633

634
/** Magic value for or_options_t. */
635
636
#define OR_OPTIONS_MAGIC 9090909

637
/** Configuration format for or_options_t. */
638
static config_format_t options_format = {
639
640
641
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
642
643
644
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
645
646
  options_description,
  NULL
647
648
};

649
/** Magic value for or_state_t. */
650
651
#define OR_STATE_MAGIC 0x57A73f57

652
653
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
654
655
656
657
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

658
/** Configuration format for or_state_t. */
659
660
661
662
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
663
  _state_abbrevs,
664
665
  _state_vars,
  (validate_fn_t)or_state_validate,
666
667
  state_description,
  &state_extra_var,
668
669
};

670
671
672
673
674
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
675
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
676
/** Name of most recently read torrc file. */
677
static char *torrc_fname = NULL;
678
/** Persistent serialized state. */
679
static or_state_t *global_state = NULL;
680

681
/** Allocate an empty configuration object of a given format type. */
682
683
684
static void *
config_alloc(config_format_t *fmt)
{
685
  void *opts = tor_malloc_zero(fmt->size);
686
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
687
688
689
690
  CHECK(fmt, opts);
  return opts;
}

691
692
/** Return the currently configured options. */
or_options_t *
693
694
get_options(void)
{
695
696
697
  tor_assert(global_options);
  return global_options;
}
698

699
700
701
/** 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
 * as necessary.
702
 */
703
int
704
set_options(or_options_t *new_val, char **msg)
705
{
706
  or_options_t *old_options = global_options;
707
  global_options = new_val;
708
709
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
710
711
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
712
713
714
    global_options = old_options;
    return -1;
  }
715
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
716
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
717
            "Acting on config options left us in a broken state. Dying.");
718
719
720
    exit(1);
  }
  if (old_options)
721
    config_free(&options_format, old_options);
722
723

  return 0;
724
725
}

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

728
729
static char *_version = NULL;

730
731
732
733
/** Return the current Tor version, possibly */
const char *
get_version(void)
{
734
  if (_version == NULL) {
735
736
    if (strlen(tor_svn_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_svn_revision)+8;
737
738
      _version = tor_malloc(len);
      tor_snprintf(_version, len, "%s (r%s)", VERSION, tor_svn_revision);
739
    } else {
740
      _version = tor_strdup(VERSION);
741
742
    }
  }
743
  return _version;
744
745
}

746
747
/** Release all memory and resources held by global configuration structures.
 */
748
749
750
void
config_free_all(void)
{
751
752
753
754
755
756
757
758
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
759
  tor_free(torrc_fname);
760
  tor_free(_version);
761
762
}

763
764
765
766
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
767
768
safe_str(const char *address)
{
769
  tor_assert(address);
770
771
772
773
774
775
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

776
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
777
778
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
779
780
781
782
783
784
785
786
787
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

788
789
790
791
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
792
  int i;
793
  const char *dirservers[] = {
794
    /* eventually we should mark moria1 as "v1only" */
795
    "moria1 v1 orport=9001 128.31.0.34:9031 "
796
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
797
    "moria2 v1 orport=9002 128.31.0.34:9032 "
798
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
799
    "tor26 v1 orport=443 86.59.21.38:80 "
800
      "847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
801
    "lefkada orport=443 140.247.60.64:80 "
802
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
803
804
    "dizum 194.109.206.212:80 "
      "7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
805
806
    "Tonga orport=443 bridge no-v2 82.94.251.206:80 "
      "4A0C CD2D DC79 9508 3D73 F5D6 6710 0C8A 5831 F16D",
807
    NULL
808
  };
809
810
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
811
812
}

813
814
815
816
817
818
819
/** Fetch the active option list, and take actions based on it. All of the
 * things we do should survive being done repeatedly.  If present,
 * <b>old_options</b> contains the previous value of the options.
 *
 * Return 0 if all goes well, return -1 if things went badly.
 */
static int
820
options_act_reversible(or_options_t *old_options, char **msg)
821
822
823
824
825
826
827
828
{
  smartlist_t *new_listeners = smartlist_create();
  smartlist_t *replaced_listeners = smartlist_create();
  static int libevent_initialized = 0;
  or_options_t *options = get_options();
  int running_tor = options->command == CMD_RUN_TOR;
  int set_conn_limit = 0;
  int r = -1;
829
  int logs_marked = 0;
830

831
  /* Daemonize _first_, since we only want to open most of this stuff in
832
833
   * the subprocess.  Libevent bases can't be reliably inherited across
   * processes. */
834
835
836
837
838
  if (running_tor && options->RunAsDaemon) {
    /* No need to roll back, since you can't change the value. */
    start_daemon();
  }

839
840
841
842
843
844
845
846
#ifndef HAVE_SYS_UN_H
  if (options->ControlSocket) {
    *msg = tor_strdup("Unix domain sockets (ControlSocket) not supported"
                      " on this OS/with this build.");
    goto rollback;
  }
#endif

847
848
849
850
851