config.c 153 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
20
#include "../common/aes.h"
Roger Dingledine's avatar
Roger Dingledine committed
21

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

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

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

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

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

279
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
280
};
281
282
#undef VAR

283
284
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
285
      initvalue }
286
static config_var_t _state_vars[] = {
287
  VAR("AccountingBytesReadInInterval", MEMUNIT,
288
      AccountingBytesReadInInterval, NULL),
289
290
291
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
292
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
293
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
294
295
296
297
  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
298

299
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
300
301
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  "900"),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    ""),
302
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
303
304
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, "900"),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   ""),
305

306
307
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

308
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
309
310
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

311
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
312
313
};

314
315
316
#undef VAR
#undef OBSOLETE

317
318
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
319
320
321
322
323
324
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
325
  /* ==== general options */
326
327
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
328
329
330
331
332
333
334
335
336
337
338
339
  { "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." },
  /*  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 "
340
    "can read a file that Tor creates in its data directory." },
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
  { "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 "
365
    "provided IP address (only useful for multiple network interfaces)." },
366
367
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
368
369
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
    "don't support tunneled conncetions." },
370
  /* PreferTunneledDirConns */
371
372
373
374
375
376
  /* 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]." },
377
378
379
  { "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." },
380
381
382
383
384
  { "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\"?" },
385
386
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
387
388
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
389
    "server, even if ORPort is enabled." },
390
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
391
    "in circuits, when possible." },
392
393
394
395
396
  /* { "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 "
397
398
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
399
400
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
401
    "high-uptime connections." },
402
403
404
  { "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 "
405
    "every NUM seconds." },
406
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
407
    "been used more than this many seconds ago." },
408
409
410
411
412
413
414
415
416
  /* 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, "
417
    "when possible." },
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
  { "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 "
433
    "accessed from the same exit node each time we connect to them." },
434
435
436
437
  { "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 "
438
439
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
440
441

  /* === server options */
442
  { "Address", "The advertised (external) address we should use." },
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
  /* 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." },
459
  { "NoPublish", "{DEPRECATED}" },
460
461
462
463
464
  { "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." },
465
  { "PublishServerDescriptors", "Set to \"\" to keep the server from "
466
    "uploading info to the directory authorities." },
467
468
469
470
471
472
473
474
  /*{ "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", } */

475
  /* === directory cache options */
476
477
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
478
  { "DirListenAddress", "Bind to this address to listen for connections from "
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
    "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 */
494
495
496
497
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
498
  { "AccountingBytesReadInInterval",
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
    "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." },

514
515
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
516
    "The last entry guard has been unreachable since this time." },
517
  { "EntryGuardUnlistedSince",
518
    "The last entry guard has been unusable since this time." },
519
520
521
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
522
523
524
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
525
526
527
  { NULL, NULL },
};

528
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
529
 * well-formed and consistent. See options_trial_assign() for documentation
530
 * of arguments. */
531
typedef int (*validate_fn_t)(void*,void*,int,char**);
532

533
534
535
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
536
typedef struct {
537
538
539
  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
540
  off_t magic_offset; /**< Offset of the magic value within the struct. */
541
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
542
                             * parsing this format. */
543
544
545
546
  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. */
547
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
548
549
550
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
551
552
} config_format_t;

553
554
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
555
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
556
    tor_assert(fmt && cfg);                                             \
557
    tor_assert((fmt)->magic ==                                          \
558
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
559
  STMT_END
560

561
static void config_line_append(config_line_t **lst,
562
                               const char *key, const char *val);
563
564
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
565
static void option_reset(config_format_t *fmt, or_options_t *options,
566
                         config_var_t *var, int use_defaults);
567
static void config_free(config_format_t *fmt, void *options);
568
static int option_is_same(config_format_t *fmt,
569
570
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
571
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
572
573
574
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);
575
static int options_act(or_options_t *old_options);
576
577
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
578
579
580
581
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);
582
static int check_nickname_list(const char *lst, const char *name, char **msg);
583
static void config_register_addressmaps(or_options_t *options);
584

585
static int parse_bridge_line(const char *line, int validate_only);
586
static int parse_dir_server_line(const char *line, int validate_only);
587
static int parse_redirect_line(smartlist_t *result,
588
                               config_line_t *line, char **msg);
589
590
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
591
static int validate_data_directory(or_options_t *options);
592
static int write_configuration_file(const char *fname, or_options_t *options);
593
static config_line_t *get_assigned_option(config_format_t *fmt,
594
                                     or_options_t *options, const char *key);
595
static void config_init(config_format_t *fmt, void *options);
596
static int or_state_validate(or_state_t *old_options, or_state_t *options,
597
                             int from_setconf, char **msg);
598

599
600
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
601
static void print_svn_version(void);
602
static void init_libevent(void);
603
static int opt_streq(const char *s1, const char *s2);
604
/** Versions of libevent. */
605
typedef enum {
606
607
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
608
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
609
  LE_13, LE_13A, LE_13B,
610
  LE_OTHER
611
612
} le_version_t;
static le_version_t decode_libevent_version(void);
613
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
614
static void check_libevent_version(const char *m, int server);
615
#endif
616

617
/** Magic value for or_options_t. */
618
619
#define OR_OPTIONS_MAGIC 9090909

620
/** Configuration format for or_options_t. */
621
static config_format_t options_format = {
622
623
624
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
625
626
627
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
628
629
  options_description,
  NULL
630
631
};

632
/** Magic value for or_state_t. */
633
634
#define OR_STATE_MAGIC 0x57A73f57

635
636
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
637
638
639
640
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

641
/** Configuration format for or_state_t. */
642
643
644
645
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
646
  _state_abbrevs,
647
648
  _state_vars,
  (validate_fn_t)or_state_validate,
649
650
  state_description,
  &state_extra_var,
651
652
};

653
654
655
656
657
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
658
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
659
/** Name of most recently read torrc file. */
660
static char *torrc_fname = NULL;
661
/** Persistent serialized state. */
662
static or_state_t *global_state = NULL;
663

664
/** Allocate an empty configuration object of a given format type. */
665
666
667
static void *
config_alloc(config_format_t *fmt)
{
668
  void *opts = tor_malloc_zero(fmt->size);
669
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
670
671
672
673
  CHECK(fmt, opts);
  return opts;
}

674
675
/** Return the currently configured options. */
or_options_t *
676
677
get_options(void)
{
678
679
680
  tor_assert(global_options);
  return global_options;
}
681

682
683
684
/** 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.
685
 */
686
int
687
set_options(or_options_t *new_val, char **msg)
688
{
689
  or_options_t *old_options = global_options;
690
  global_options = new_val;
691
692
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
693
694
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
695
696
697
    global_options = old_options;
    return -1;
  }
698
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
699
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
700
            "Acting on config options left us in a broken state. Dying.");
701
702
703
    exit(1);
  }
  if (old_options)
704
    config_free(&options_format, old_options);
705
706

  return 0;
707
708
}

Roger Dingledine's avatar
Roger Dingledine committed
709
extern const char tor_svn_revision[]; /* from tor_main.c */
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727

/** Return the current Tor version, possibly */
const char *
get_version(void)
{
  static char *version = NULL;
  if (version == NULL) {
    if (strlen(tor_svn_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_svn_revision)+8;
      version = tor_malloc(len);
      tor_snprintf(version, len, "%s (r%s)", VERSION, tor_svn_revision);
    } else {
      version = tor_strdup(VERSION);
    }
  }
  return version;
}

728
729
/** Release all memory and resources held by global configuration structures.
 */
730
731
732
void
config_free_all(void)
{
733
734
735
736
737
738
739
740
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
741
  tor_free(torrc_fname);
742
743
}

744
745
746
747
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
748
749
safe_str(const char *address)
{
750
751
752
753
754
755
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

756
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
757
758
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
759
760
761
762
763
764
765
766
767
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

768
769
770
771
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
772
  int i;
773
  const char *dirservers[] = {
774
    /* eventually we should mark moria1 as "v1only" */
775
    "moria1 v1 orport=9001 128.31.0.34:9031 "
776
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
777
    "moria2 v1 orport=9002 128.31.0.34:9032 "
778
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
779
    "tor26 v1 orport=443 86.59.21.38:80 "
780
      "847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
781
    "lefkada orport=443 140.247.60.64:80 "
782
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
783
784
    "dizum 194.109.206.212:80 "
      "7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
785
    NULL
786
  };
787
788
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
789
790
}

791
792
793
794
795
796
797
/** 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
798
options_act_reversible(or_options_t *old_options, char **msg)
799
800
801
802
803
804
805
806
{
  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;
807
  int logs_marked = 0;
808

809
810
  /* Daemonize _first_, since we only want to open most of this stuff in
   * the subprocess. */
811
812
813
814
815
  if (running_tor && options->RunAsDaemon) {
    /* No need to roll back, since you can't change the value. */
    start_daemon();
  }

816
817
818
819
820
821
822
823
#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

824
825
826
827
828
829
830
831
832
  if (running_tor) {
    /* We need to set the connection limit before we can open the listeners. */
    options->_ConnLimit =
      set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
    if (options->_ConnLimit < 0) {
      *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
      goto rollback;
    }
    set_conn_limit = 1;
833

834
835
836
837
838
839
    /* Set up libevent.  (We need to do this before we can register the
     * listeners as listeners.) */
    if (running_tor && !libevent_initialized) {
      init_libevent();
      libevent_initialized = 1;
    }
840

841
842
    /* Launch the listeners.  (We do this before we setuid, so we can bind to
     * ports under 1024.) */
843
    if (retry_all_listeners(replaced_listeners, new_listeners) < 0) {
844
845
846
      *msg = tor_strdup("Failed to bind one of the listener ports.");
      goto rollback;
    }
847
848
  }

849
850
851
852
  /* Setuid/setgid as appropriate */
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
      /* No need to roll back, since you can't change the value. */
853
854
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
855
856
857
858
859
860
      goto done;
    }
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
861
862
863
864
865
    char buf[1024];
    int tmp = tor_snprintf(buf, sizeof(buf),
              "Couldn't access/create private data directory \"%s\"",
              options->DataDirectory);
    *msg = tor_strdup(tmp >= 0 ? buf : "internal error");
866
    goto done;
867
    /* No need to roll back, since you can't change the value. */
868
869
870
  }

  /* Bail out at this point if we're not going to be a client or server:
871
   * we don't run Tor itself. */
872
  if (!running_tor)
873
874
    goto commit;

875