config.c 155 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("ConstrainedSockets",  BOOL,     ConstrainedSockets,   "0"),
150
  VAR("ConstrainedSockSize", MEMUNIT,  ConstrainedSockSize,  "8192"),
151
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
152
  VAR("ControlListenAddress",LINELIST, ControlListenAddress, NULL),
153
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
154
  VAR("ControlSocket",       LINELIST, ControlSocket,        NULL),
155
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
156
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
157
  OBSOLETE("DebugLogFile"),
158
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
159
  VAR("DirListenAddress",    LINELIST, DirListenAddress,     NULL),
160
  OBSOLETE("DirFetchPeriod"),
161
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
Nick Mathewson's avatar
Nick Mathewson committed
162
  VAR("DirPort",             UINT,     DirPort,              "0"),
163
  OBSOLETE("DirPostPeriod"),
164
  VAR("DirServer",           LINELIST, DirServers,           NULL),
165
166
  VAR("DNSPort",             UINT,     DNSPort,              "0"),
  VAR("DNSListenAddress",    LINELIST, DNSListenAddress,     NULL),
167
  VAR("DownloadExtraInfo",   BOOL,     DownloadExtraInfo,    "0"),
168
  VAR("EnforceDistinctSubnets", BOOL,  EnforceDistinctSubnets,"1"),
169
170
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
171
172
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
173
  VAR("ExitPolicyRejectPrivate", BOOL, ExitPolicyRejectPrivate, "1"),
174
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
175
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
176
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
177
178
  VAR("FetchServerDescriptors",BOOL,   FetchServerDescriptors,"1"),
  VAR("FetchHidServDescriptors",BOOL,  FetchHidServDescriptors, "1"),
179
  VAR("FetchUselessDescriptors",BOOL,  FetchUselessDescriptors, "0"),
180
  VAR("Group",               STRING,   Group,                NULL),
181
  VAR("HardwareAccel",       BOOL,     HardwareAccel,        "0"),
182
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
183
184
185
186
187
  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),
188
  VAR("HSAuthoritativeDir",  BOOL,     HSAuthoritativeDir,   "0"),
189
  VAR("HSAuthorityRecordStats",BOOL,   HSAuthorityRecordStats,"0"),
190
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
191
  VAR("HttpProxyAuthenticator",STRING, HttpProxyAuthenticator,NULL),
192
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
193
  VAR("HttpsProxyAuthenticator",STRING,HttpsProxyAuthenticator,NULL),
194
  OBSOLETE("IgnoreVersion"),
195
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
196
  VAR("Log",                 LINELIST, Logs,                 NULL),
197
  OBSOLETE("LinkPadding"),
198
199
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
200
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,
201
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
Nick Mathewson's avatar
Nick Mathewson committed
202
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
203
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"1 GB"),
Nick Mathewson's avatar
Nick Mathewson committed
204
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
205
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
206
  OBSOLETE("MonthlyAccountingStart"),
Nick Mathewson's avatar
Nick Mathewson committed
207
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
208
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
209
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
210
211
  VAR("NatdListenAddress",   LINELIST, NatdListenAddress,    NULL),
  VAR("NatdPort",            UINT,     NatdPort,             "0"),
Nick Mathewson's avatar
Nick Mathewson committed
212
213
214
  VAR("Nickname",            STRING,   Nickname,             NULL),
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
215
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
216
  VAR("NumEntryGuards",      UINT,     NumEntryGuards,       "3"),
217
  VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
218
  VAR("ORPort",              UINT,     ORPort,               "0"),
219
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
220
  OBSOLETE("PathlenCoinWeight"),
Nick Mathewson's avatar
Nick Mathewson committed
221
  VAR("PidFile",             STRING,   PidFile,              NULL),
222
  VAR("PreferTunneledDirConns", BOOL,  PreferTunneledDirConns, "0"),
223
  VAR("ProtocolWarnings",    BOOL,     ProtocolWarnings,     "0"),
224
  VAR("PublishServerDescriptor", CSV,  PublishServerDescriptor,"v1,v2"),
225
  VAR("PublishHidServDescriptors",BOOL,PublishHidServDescriptors, "1"),
226
  VAR("ReachableAddresses",  LINELIST, ReachableAddresses,   NULL),
227
228
  VAR("ReachableDirAddresses",LINELIST,ReachableDirAddresses,NULL),
  VAR("ReachableORAddresses",LINELIST, ReachableORAddresses, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
229
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
230
231
  VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
  VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
232
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
233
234
  VAR("RelayBandwidthBurst", MEMUNIT,  RelayBandwidthBurst,  "0"),
  VAR("RelayBandwidthRate",  MEMUNIT,  RelayBandwidthRate,   "0"),
Nick Mathewson's avatar
Nick Mathewson committed
235
236
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
237
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "1 hour"),
238
  VAR("RephistTrackTime",    INTERVAL, RephistTrackTime,     "24 hours"),
239
  OBSOLETE("RouterFile"),
240
241
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
242
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
243
  VAR("SafeSocks",           BOOL,     SafeSocks,            "0"),
244
245
  VAR("ServerDNSAllowNonRFC953Hostnames",
                             BOOL,     ServerDNSAllowNonRFC953Hostnames, "0"),
246
  VAR("ServerDNSDetectHijacking",BOOL,   ServerDNSDetectHijacking,"1"),
247
248
  VAR("ServerDNSResolvConfFile", STRING, ServerDNSResolvConfFile, NULL),
  VAR("ServerDNSSearchDomains",  BOOL,   ServerDNSSearchDomains,  "0"),
249
250
  VAR("ServerDNSTestAddresses",  CSV,    ServerDNSTestAddresses,
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
251
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
252
  VAR("SocksListenAddress",  LINELIST, SocksListenAddress,   NULL),
253
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
254
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
255
  VAR("SocksTimeout",        INTERVAL, SocksTimeout,         "2 minutes"),
256
  OBSOLETE("StatusFetchPeriod"),
Nick Mathewson's avatar
Nick Mathewson committed
257
258
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
259
  OBSOLETE("SysLog"),
260
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
261
  VAR("TestVia",             STRING,   TestVia,              NULL),
Nick Mathewson's avatar
Nick Mathewson committed
262
263
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
264
  OBSOLETE("TrafficShaping"),
265
266
  VAR("TransListenAddress",  LINELIST, TransListenAddress,   NULL),
  VAR("TransPort",           UINT,     TransPort,            "0"),
267
  VAR("TunnelDirConns",      BOOL,     TunnelDirConns,       "0"),
268
  VAR("UpdateBridgesFromAuthority",BOOL,UpdateBridgesFromAuthority,"0"),
269
  VAR("UseBridges",          BOOL,     UseBridges,           "0"),
270
  VAR("UseEntryGuards",      BOOL,     UseEntryGuards,       "1"),
Nick Mathewson's avatar
Nick Mathewson committed
271
  VAR("User",                STRING,   User,                 NULL),
272
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
273
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
274
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
275
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
276
  VAR("VirtualAddrNetwork",  STRING,   VirtualAddrNetwork,   "127.192.0.0/10"),
277
278
  VAR("__AllDirActionsPrivate",BOOL,   AllDirActionsPrivate, "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits,"0"),
279
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
280

281
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
282
};
283
284
#undef VAR

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

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

308
309
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

310
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
311
312
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

313
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
314
315
};

316
317
318
#undef VAR
#undef OBSOLETE

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

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

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

482
  /* === directory cache options */
483
484
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
485
  { "DirListenAddress", "Bind to this address to listen for connections from "
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
    "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 */
501
502
503
504
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
505
  { "AccountingBytesReadInInterval",
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
    "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." },

521
522
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
523
    "The last entry guard has been unreachable since this time." },
524
  { "EntryGuardUnlistedSince",
525
    "The last entry guard has been unusable since this time." },
526
527
528
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
529
530
531
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
532
533
534
  { NULL, NULL },
};

535
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
536
 * well-formed and consistent. See options_trial_assign() for documentation
537
 * of arguments. */
538
typedef int (*validate_fn_t)(void*,void*,int,char**);
539

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

560
561
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
562
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
563
    tor_assert(fmt && cfg);                                             \
564
    tor_assert((fmt)->magic ==                                          \
565
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
566
  STMT_END
567

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

592
static int parse_bridge_line(const char *line, int validate_only);
593
static int parse_dir_server_line(const char *line, int validate_only);
594
static int parse_redirect_line(smartlist_t *result,
595
                               config_line_t *line, char **msg);
596
597
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
598
static int validate_data_directory(or_options_t *options);
599
static int write_configuration_file(const char *fname, or_options_t *options);
600
static config_line_t *get_assigned_option(config_format_t *fmt,
601
                                     or_options_t *options, const char *key);
602
static void config_init(config_format_t *fmt, void *options);
603
static int or_state_validate(or_state_t *old_options, or_state_t *options,
604
                             int from_setconf, char **msg);
605

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

624
/** Magic value for or_options_t. */
625
626
#define OR_OPTIONS_MAGIC 9090909

627
/** Configuration format for or_options_t. */
628
static config_format_t options_format = {
629
630
631
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
632
633
634
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
635
636
  options_description,
  NULL
637
638
};

639
/** Magic value for or_state_t. */
640
641
#define OR_STATE_MAGIC 0x57A73f57

642
643
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
644
645
646
647
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

648
/** Configuration format for or_state_t. */
649
650
651
652
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
653
  _state_abbrevs,
654
655
  _state_vars,
  (validate_fn_t)or_state_validate,
656
657
  state_description,
  &state_extra_var,
658
659
};

660
661
662
663
664
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
665
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
666
/** Name of most recently read torrc file. */
667
static char *torrc_fname = NULL;
668
/** Persistent serialized state. */
669
static or_state_t *global_state = NULL;
670

671
/** Allocate an empty configuration object of a given format type. */
672
673
674
static void *
config_alloc(config_format_t *fmt)
{
675
  void *opts = tor_malloc_zero(fmt->size);
676
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
677
678
679
680
  CHECK(fmt, opts);
  return opts;
}

681
682
/** Return the currently configured options. */
or_options_t *
683
684
get_options(void)
{
685
686
687
  tor_assert(global_options);
  return global_options;
}
688

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

  return 0;
714
715
}

Roger Dingledine's avatar
Roger Dingledine committed
716
extern const char tor_svn_revision[]; /* from tor_main.c */
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734

/** 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;
}

735
736
/** Release all memory and resources held by global configuration structures.
 */
737
738
739
void
config_free_all(void)
{
740
741
742
743
744
745
746
747
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
748
  tor_free(torrc_fname);
749
750
}

751
752
753
754
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
755
756
safe_str(const char *address)
{
757
758
759
760
761
762
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

763
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
764
765
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
766
767
768
769
770
771
772
773
774
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

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

798
799
800
801
802
803
804
/** 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
805
options_act_reversible(or_options_t *old_options, char **msg)
806
807
808
809
810
811
812
813
{
  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;
814
  int logs_marked = 0;
815

816
817
  /* Daemonize _first_, since we only want to open most of this stuff in
   * the subprocess. */
818
819
820
821
822
  if (running_tor && options->RunAsDaemon) {
    /* No need to roll back, since you can't change the value. */
    start_daemon();
  }

823
824
825
826
827
828
829
830
#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

831
832
833
834
835
836
837
838
839
  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;
840

841
842
843
844
845
846
    /* 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;
    }
847

848
849
    /* Launch the listeners.  (We do this before we setuid, so we can bind to
     * ports under 1024.) */
850
    if (retry_all_listeners(replaced_listeners, new_listeners) < 0) {
851
852
853
      *msg = tor_strdup("Failed to bind one of the listener ports.");
      goto rollback;
    }
854
855
  }

856
857
858
859
  /* 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. */
860
861
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
862
863
864
865
866
867
      goto done;
    }
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
868
869
870
871
872
    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");
873
    goto done;
874
    /* No need to roll back, since you can't change the value. */