config.c 141 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
 **/

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
15
16
17
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
18
#include "../common/aes.h"
Roger Dingledine's avatar
Roger Dingledine committed
19

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

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

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

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

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

105
106
107
#define STRUCT_VAR_P(st, off) \
  ((void*) ( ((char*)st) + off ) )

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("__AllDirActionsPrivate",BOOL,   AllDirActionsPrivate, "0"),
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
  VAR("AvoidDiskWrites",     BOOL,     AvoidDiskWrites,      "0"),
139
140
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "6 MB"),
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "3 MB"),
141
142
  VAR("CircuitBuildTimeout", INTERVAL, CircuitBuildTimeout,  "1 minute"),
  VAR("CircuitIdleTimeout",  INTERVAL, CircuitIdleTimeout,   "1 hour"),
143
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
144
  VAR("ConnLimit",           UINT,     ConnLimit,            "1000"),
145
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
146
  VAR("ControlListenAddress",LINELIST, ControlListenAddress, NULL),
147
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
148
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
149
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
150
  OBSOLETE("DebugLogFile"),
151
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
152
  VAR("DirListenAddress",    LINELIST, DirListenAddress,     NULL),
153
  OBSOLETE("DirFetchPeriod"),
154
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
Nick Mathewson's avatar
Nick Mathewson committed
155
  VAR("DirPort",             UINT,     DirPort,              "0"),
156
  OBSOLETE("DirPostPeriod"),
157
  VAR("DirServer",           LINELIST, DirServers,           NULL),
158
  VAR("EnforceDistinctSubnets", BOOL,  EnforceDistinctSubnets,"1"),
159
160
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
161
162
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
163
  VAR("ExitPolicyRejectPrivate", BOOL, ExitPolicyRejectPrivate, "1"),
164
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
165
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
166
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
167
168
  VAR("FetchServerDescriptors",BOOL,   FetchServerDescriptors,"1"),
  VAR("FetchHidServDescriptors",BOOL,  FetchHidServDescriptors, "1"),
169
  VAR("FetchUselessDescriptors",BOOL,  FetchUselessDescriptors, "0"),
170
  VAR("Group",               STRING,   Group,                NULL),
171
  VAR("HardwareAccel",       BOOL,     HardwareAccel,        "0"),
172
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
173
174
175
176
177
  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),
178
  VAR("HSAuthoritativeDir",  BOOL,     HSAuthoritativeDir,   "0"),
179
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
180
  VAR("HttpProxyAuthenticator",STRING, HttpProxyAuthenticator,NULL),
181
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
182
  VAR("HttpsProxyAuthenticator",STRING,HttpsProxyAuthenticator,NULL),
183
  OBSOLETE("IgnoreVersion"),
184
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
185
  VAR("Log",                 LINELIST, Logs,                 NULL),
186
  OBSOLETE("LinkPadding"),
187
188
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
189
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,
190
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
Nick Mathewson's avatar
Nick Mathewson committed
191
192
193
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"128 TB"),
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
194
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
195
  OBSOLETE("MonthlyAccountingStart"),
Nick Mathewson's avatar
Nick Mathewson committed
196
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
197
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
198
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
199
200
  VAR("NatdListenAddress",   LINELIST, NatdListenAddress,    NULL),
  VAR("NatdPort",            UINT,     NatdPort,             "0"),
Nick Mathewson's avatar
Nick Mathewson committed
201
202
203
  VAR("Nickname",            STRING,   Nickname,             NULL),
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
204
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
205
  VAR("NumEntryGuards",      UINT,     NumEntryGuards,       "3"),
206
  VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
207
  VAR("ORPort",              UINT,     ORPort,               "0"),
208
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
209
  /* XXXX012 mark this obsolete?  Warn if it's set? */
210
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
Nick Mathewson's avatar
Nick Mathewson committed
211
  VAR("PidFile",             STRING,   PidFile,              NULL),
212
  VAR("PreferTunneledDirConns", BOOL,  PreferTunneledDirConns, "0"),
213
  VAR("ProtocolWarnings",    BOOL,     ProtocolWarnings,     "0"),
214
215
  VAR("PublishServerDescriptor",BOOL,  PublishServerDescriptor,"1"),
  VAR("PublishHidServDescriptors",BOOL,PublishHidServDescriptors, "1"),
216
  VAR("ReachableAddresses",  LINELIST, ReachableAddresses,   NULL),
217
218
  VAR("ReachableDirAddresses",LINELIST,ReachableDirAddresses,NULL),
  VAR("ReachableORAddresses",LINELIST, ReachableORAddresses, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
219
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
220
221
  VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
  VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
222
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
223
  /* XXXX012 These aren't implemented. Take them out for now? */
224
225
  VAR("RelayBandwidthBurst", MEMUNIT,  RelayBandwidthBurst,  "0"),
  VAR("RelayBandwidthRate",  MEMUNIT,  RelayBandwidthRate,   "0"),
Nick Mathewson's avatar
Nick Mathewson committed
226
227
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
228
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "1 hour"),
229
  VAR("RephistTrackTime",    INTERVAL, RephistTrackTime,     "24 hours"),
230
  OBSOLETE("RouterFile"),
231
232
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
233
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
234
  VAR("SafeSocks",           BOOL,     SafeSocks,            "0"),
235
236
  VAR("ServerDNSAllowNonRFC953Hostnames",
                             BOOL,     ServerDNSAllowNonRFC953Hostnames, "0"),
237
  VAR("ServerDNSDetectHijacking",BOOL,   ServerDNSDetectHijacking,"1"),
238
239
  VAR("ServerDNSResolvConfFile", STRING, ServerDNSResolvConfFile, NULL),
  VAR("ServerDNSSearchDomains",  BOOL,   ServerDNSSearchDomains,  "0"),
240
241
  VAR("ServerDNSTestAddresses",  CSV,    ServerDNSTestAddresses,
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
242
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
243
  VAR("SocksListenAddress",  LINELIST, SocksListenAddress,   NULL),
244
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
245
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
246
  VAR("SocksTimeout",        INTERVAL, SocksTimeout,         "2 minutes"),
247
  OBSOLETE("StatusFetchPeriod"),
Nick Mathewson's avatar
Nick Mathewson committed
248
249
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
250
  OBSOLETE("SysLog"),
251
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
252
  VAR("TestVia",             STRING,   TestVia,              NULL),
Nick Mathewson's avatar
Nick Mathewson committed
253
254
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
255
  OBSOLETE("TrafficShaping"),
256
257
  VAR("TransListenAddress",  LINELIST, TransListenAddress,   NULL),
  VAR("TransPort",           UINT,     TransPort,            "0"),
258
  VAR("TunnelDirConns",      BOOL,     TunnelDirConns,       "0"),
259
  VAR("UseEntryGuards",      BOOL,     UseEntryGuards,       "1"),
Nick Mathewson's avatar
Nick Mathewson committed
260
  VAR("User",                STRING,   User,                 NULL),
261
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
262
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
263
  VAR("VirtualAddrNetwork",  STRING,   VirtualAddrNetwork,   "127.192.0.0/10"),
264
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
265
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
266
};
267
268
#undef VAR

269
270
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
271
      initvalue }
272
static config_var_t _state_vars[] = {
273
  VAR("AccountingBytesReadInInterval", MEMUNIT,
274
      AccountingBytesReadInInterval, NULL),
275
276
277
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
278
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
279
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
280
281
282
283
  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
284

285
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
286
287
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  "900"),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    ""),
288
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
289
290
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, "900"),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   ""),
291

292
293
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

294
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
295
296
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

297
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
298
299
};

300
301
302
#undef VAR
#undef OBSOLETE

303
304
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
305
306
307
308
309
310
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

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

  /* === server options */
428
  { "Address", "The advertised (external) address we should use." },
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
  /* 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." },
445
  { "NoPublish", "{DEPRECATED}" },
446
447
448
449
450
  { "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." },
451
  { "PublishServerDescriptors", "Set to 0 in order to keep the server from "
452
    "uploading info to the directory authorities." },
453
454
455
456
457
458
459
460
  /*{ "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", } */

461
  /* === directory cache options */
462
463
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
464
  { "DirListenAddress", "Bind to this address to listen for connections from "
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
    "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 */
480
481
482
483
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
484
  { "AccountingBytesReadInInterval",
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
    "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." },

500
501
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
502
    "The last entry guard has been unreachable since this time." },
503
  { "EntryGuardUnlistedSince",
504
    "The last entry guard has been unusable since this time." },
505
506
507
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
508
509
510
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
511
512
513
  { NULL, NULL },
};

514
typedef int (*validate_fn_t)(void*,void*,int,char**);
515

516
517
518
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
519
520
521
522
523
524
525
typedef struct {
  size_t size;
  uint32_t magic;
  off_t magic_offset;
  config_abbrev_t *abbrevs;
  config_var_t *vars;
  validate_fn_t validate_fn;
526
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
527
528
529
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
530
531
532
533
} config_format_t;

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
534
    tor_assert((fmt)->magic ==                                          \
535
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
536
537
  } while (0)

538
static void config_line_append(config_line_t **lst,
539
                               const char *key, const char *val);
540
541
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
542
static void option_reset(config_format_t *fmt, or_options_t *options,
543
                         config_var_t *var, int use_defaults);
544
static void config_free(config_format_t *fmt, void *options);
545
static int option_is_same(config_format_t *fmt,
546
547
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
548
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
549
550
551
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);
552
static int options_act(or_options_t *old_options);
553
554
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
555
556
557
558
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);
559
static int check_nickname_list(const char *lst, const char *name, char **msg);
560
static void config_register_addressmaps(or_options_t *options);
561

562
static int parse_dir_server_line(const char *line, int validate_only);
563
static int parse_redirect_line(smartlist_t *result,
564
                               config_line_t *line, char **msg);
565
566
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
567
static int validate_data_directory(or_options_t *options);
568
static int write_configuration_file(const char *fname, or_options_t *options);
569
static config_line_t *get_assigned_option(config_format_t *fmt,
570
                                     or_options_t *options, const char *key);
571
static void config_init(config_format_t *fmt, void *options);
572
static int or_state_validate(or_state_t *old_options, or_state_t *options,
573
                             int from_setconf, char **msg);
574

575
576
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
577
static void print_svn_version(void);
578
static void init_libevent(void);
579
static int opt_streq(const char *s1, const char *s2);
580
/** Versions of libevent. */
581
typedef enum {
582
583
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
584
585
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
  LE_OTHER
586
587
} le_version_t;
static le_version_t decode_libevent_version(void);
588
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
589
static void check_libevent_version(const char *m, int server);
590
#endif
591

592
593
/*static*/ or_options_t *options_new(void);

594
595
#define OR_OPTIONS_MAGIC 9090909

596
static config_format_t options_format = {
597
598
599
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
600
601
602
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
603
604
  options_description,
  NULL
605
606
607
608
};

#define OR_STATE_MAGIC 0x57A73f57

609
610
611
612
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

613
614
615
616
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
617
  _state_abbrevs,
618
619
  _state_vars,
  (validate_fn_t)or_state_validate,
620
621
  state_description,
  &state_extra_var,
622
623
};

624
625
626
627
628
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
629
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
630
/** Name of most recently read torrc file. */
631
static char *torrc_fname = NULL;
632
/** Persistent serialized state. */
633
static or_state_t *global_state = NULL;
634

635
/** Allocate an empty configuration object of a given format type. */
636
637
638
static void *
config_alloc(config_format_t *fmt)
{
639
  void *opts = tor_malloc_zero(fmt->size);
640
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
641
642
643
644
  CHECK(fmt, opts);
  return opts;
}

645
646
/** Return the currently configured options. */
or_options_t *
647
648
get_options(void)
{
649
650
651
  tor_assert(global_options);
  return global_options;
}
652

653
654
655
/** 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.
656
 */
657
int
658
set_options(or_options_t *new_val, char **msg)
659
{
660
  or_options_t *old_options = global_options;
661
  global_options = new_val;
662
663
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
664
665
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
666
667
668
    global_options = old_options;
    return -1;
  }
669
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
670
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
671
            "Acting on config options left us in a broken state. Dying.");
672
673
674
    exit(1);
  }
  if (old_options)
675
    config_free(&options_format, old_options);
676
677

  return 0;
678
679
}

680
681
/** Release all memory and resources held by global configuration structures.
 */
682
683
684
void
config_free_all(void)
{
685
686
687
688
689
690
691
692
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
693
  tor_free(torrc_fname);
694
695
}

696
697
698
699
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
700
701
safe_str(const char *address)
{
702
703
704
705
706
707
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

708
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
709
710
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
711
712
713
714
715
716
717
718
719
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

720
721
722
723
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
724
  int i;
725
  const char *dirservers[] = {
726
    /* eventually we should mark moria1 as "v1only" */
727
    "moria1 v1 orport=9001 18.244.0.188:9031 "
728
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
729
    "moria2 v1 orport=443 18.244.0.114:80 "
730
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
731
    "tor26 v1 orport=443 86.59.21.38:80 "
732
      "847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
733
    "lefkada orport=443 140.247.60.64:80 "
734
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
735
736
    "dizum 194.109.206.212:80 "
      "7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
737
    NULL
738
  };
739
740
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
741
742
}

743
744
745
746
747
748
749
/** 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
750
options_act_reversible(or_options_t *old_options, char **msg)
751
752
753
754
755
756
757
758
{
  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;
759
  int logs_marked = 0;
760
761
762
763
764
765
766
767
768
769

  if (running_tor && options->RunAsDaemon) {
    /* No need to roll back, since you can't change the value. */
    start_daemon();
  }

  /* 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. */
770
771
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
772
773
774
775
776
777
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
778
    init_libevent();
779
780
781
782
783
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
784
785
786
787
788
    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");
789
    goto done;
790
    /* No need to roll back, since you can't change the value. */
791
792
793
  }

  /* Bail out at this point if we're not going to be a client or server:
794
   * we don't run Tor itself. */
795
796
797
798
799
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
800
801
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
802
    goto rollback;
803
  }
804
805
806
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
807
    *msg = tor_strdup("Failed to bind one of the listener ports.");
808
809
810
    goto rollback;
  }

811
812
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
813
814
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
815
    goto rollback;
816
  }
817

818
819
 commit:
  r = 0;
820
821
822
823
824
  if (logs_marked) {
    close_temp_logs();
    add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
    control_adjust_event_log_severity();
  }
825
826
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
Roger Dingledine's avatar
Roger Dingledine committed
827
828
    log_notice(LD_NET, "Closing old %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
829
830
831
832
833
834
835
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;
836
  tor_assert(*msg);
837

838
839
840
841
842
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

843
844
845
846
847
  if (set_conn_limit && old_options)
    set_max_file_descriptors((unsigned)old_options->ConnLimit,MAXCONNECTIONS);

  SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
  {
848
    log_notice(LD_NET, "Closing partially-constructed listener %s on %s:%d",
Roger Dingledine's avatar
Roger Dingledine committed
849
               conn_type_to_string(conn->type), conn->address, conn->port);
850
851
852
853
854
855
856
857
858
859
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

 done:
  smartlist_free(new_listeners);
  smartlist_free(replaced_listeners);
  return r;
}

860
861
862
/** 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.
863
 *
864
 * Return 0 if all goes well, return -1 if it's time to die.
865
 *
866
 * Note: We haven't moved all the "act on new configuration" logic
867
 * here yet.  Some is still in do_hup() and other places.
868
 */
869
870
static int
options_act(or_options_t *old_options)
871
{
872
  config_line_t *cl;
873
874
  char *fn;
  size_t len;
875
  or_options_t *options = get_options();
876
  int running_tor = options->command == CMD_RUN_TOR;
877
  char *msg;
878
879

  clear_trusted_dir_servers();
880
881
882
  if (options->DirServers) {
    for (cl = options->DirServers; cl; cl = cl->next) {
      if (parse_dir_server_line(cl->value, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
883
        log_err(LD_BUG,
884
885
886
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
887
    }
888
889
  } else {
    add_default_trusted_dirservers();
890
891
  }

892
  if (running_tor && rend_config_services(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
893
894
    log_err(LD_BUG,
       "Bug: Previously validated hidden services line could not be added!");
895
    return -1;
896
  }
897