config.c 79.8 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright 2001 Matej Pfajfar.
 * Copyright 2001-2004 Roger Dingledine.
Nick Mathewson's avatar
Nick Mathewson committed
3
 * Copyright 2004-2005 Roger Dingledine, Nick Mathewson. */
4
5
/* See LICENSE for licensing information */
/* $Id$ */
6
const char config_c_id[] = "$Id$";
7

Nick Mathewson's avatar
Nick Mathewson committed
8
/**
9
 * \file config.c
Nick Mathewson's avatar
Nick Mathewson committed
10
 *
11
 * \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
28
29
30
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and optional
                              * whitespace. */
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
31
32
33
34
35
  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.
                             */
36
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
37
} config_type_t;
38

Nick Mathewson's avatar
Nick Mathewson committed
39
/* An abbreviation for a configuration option allowed on the command line */
40
typedef struct config_abbrev_t {
41
42
  const char *abbreviated;
  const char *full;
43
  int commandline_only;
44
45
} config_abbrev_t;

46
47
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>". */
#define PLURAL(tok) { #tok, #tok "s", 0 }

Nick Mathewson's avatar
Nick Mathewson committed
50
/* A list of command-line abbreviations. */
51
static config_abbrev_t config_abbrevs[] = {
52
  PLURAL(ExitNode),
53
  PLURAL(EntryNode),
54
55
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
56
  PLURAL(LongLivedPort),
57
58
59
60
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
61
62
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
63
  { "l", "Log", 1},
64
65
  { "BandwidthRateBytes", "BandwidthRate", 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0},
66
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0},
67
  { "MaxConn", "ConnLimit", 0},
68
  { NULL, NULL , 0},
69
};
70
#undef PLURAL
71

72
/** A variable allowed in the configuration file or on the command line. */
73
typedef struct config_var_t {
74
75
76
77
  const char *name; /**< The full keyword (case insensitive). */
  config_type_t type; /**< How to interpret the type and turn it into a value. */
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
78
79
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
80
/** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
Nick Mathewson's avatar
Nick Mathewson committed
81
#define STRUCT_OFFSET(tp, member) ((off_t) (((char*)&((tp*)0)->member)-(char*)0))
Nick Mathewson's avatar
Nick Mathewson committed
82
83
84
85
/** 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>"
 */
86
87
#define VAR(name,conftype,member,initvalue) \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), initvalue }
Nick Mathewson's avatar
Nick Mathewson committed
88
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
89
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
90

Nick Mathewson's avatar
Nick Mathewson committed
91
92
93
94
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
95
static config_var_t config_vars[] = {
96
  VAR("Address",             STRING,   Address,              NULL),
97
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
98
  VAR("AllowUnverifiedNodes",CSV,      AllowUnverifiedNodes, "middle,rendezvous"),
99
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
100
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "1 MB"),
101
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "5 MB"),
102
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"128 TB"),
103
104
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
105
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
106
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
107
108
  VAR("DebugLogFile",        STRING,   DebugLogFile,         NULL),
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
109
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
110
111
  VAR("DirPort",             UINT,     DirPort,              "0"),
  VAR("DirBindAddress",      LINELIST, DirBindAddress,       NULL),
112
113
  /** DOCDOC **/
  VAR("DirFetchPeriod",      INTERVAL, DirFetchPeriod,       "0 seconds"),
114
115
  VAR("DirPostPeriod",       INTERVAL, DirPostPeriod,        "20 minutes"),
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "20 minutes"),
116
117
118
119
120
121
122
123
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
  VAR("DirServer",           LINELIST, DirServers,           NULL),
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
124
125
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
126
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
127
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
128
  VAR("FirewallPorts",       CSV,      FirewallPorts,        "80,443"),
129
130
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
Roger Dingledine's avatar
Roger Dingledine committed
131
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
132
  VAR("Group",               STRING,   Group,                NULL),
133
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
134
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
135
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
136
137
138
139
140
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceNodes",  LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceExcludeNodes", LINELIST_S, RendConfigLines, NULL),
141
  VAR("IgnoreVersion",       BOOL,     IgnoreVersion,        "0"),
142
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
143
144
145
  VAR("Log",                 LINELIST, Logs,                 NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
146
  OBSOLETE("LinkPadding"),
147
  VAR("ConnLimit",           UINT,     ConnLimit,            "1024"),
148
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
149
  VAR("MonthlyAccountingStart",UINT,   _MonthlyAccountingStart,"0"),
150
151
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
  VAR("AccountingMax",       MEMUNIT,   AccountingMax,        "0 bytes"),
152
  VAR("Nickname",            STRING,   Nickname,             NULL),
153
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
154
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
155
156
157
158
159
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
  VAR("ORPort",              UINT,     ORPort,               "0"),
  VAR("ORBindAddress",       LINELIST, ORBindAddress,        NULL),
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
  VAR("PidFile",             STRING,   PidFile,              NULL),
160
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,       "21,22,706,1863,5050,5190,5222,5223,6667,8300,8888"),
161
162
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
163
  OBSOLETE("RouterFile"),
164
165
166
167
168
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
169
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
170
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
171
172
  VAR("SocksBindAddress",    LINELIST, SocksBindAddress,     NULL),
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
173
174
  /** DOCDOC */
  VAR("StatusFetchPeriod",   INTERVAL, StatusFetchPeriod,    "0 seconds"),
175
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
176
  OBSOLETE("TrafficShaping"),
177
  VAR("User",                STRING,   User,                 NULL),
178
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
179
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
180
181
182
183
};
#undef VAR
#undef OBSOLETE

Nick Mathewson's avatar
Nick Mathewson committed
184
/** Largest allowed config line */
185
#define CONFIG_LINE_T_MAXLEN 4096
186

187
188
static void config_line_append(struct config_line_t **lst,
                               const char *key, const char *val);
189
190
static void option_reset(or_options_t *options, config_var_t *var);
static void options_free(or_options_t *options);
191
static int option_is_same(or_options_t *o1, or_options_t *o2,const char *name);
192
193
194
195
static or_options_t *options_dup(or_options_t *old);
static int options_validate(or_options_t *options);
static int options_transition_allowed(or_options_t *old, or_options_t *new);
static int check_nickname_list(const char *lst, const char *name);
196
static void config_register_addressmaps(or_options_t *options);
197

198
static int parse_dir_server_line(const char *line, int validate_only);
199
static int parse_redirect_line(smartlist_t *result,
Roger Dingledine's avatar
Roger Dingledine committed
200
                               struct config_line_t *line);
201
202
203
204
205
206
207
208
209
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
static int convert_log_option(or_options_t *options,
                              struct config_line_t *level_opt,
                              struct config_line_t *file_opt, int isDaemon);
static int add_single_log_option(or_options_t *options, int minSeverity,
                                 int maxSeverity,
                                 const char *type, const char *fname);
static int normalize_log_options(or_options_t *options);
210
static int validate_data_directory(or_options_t *options);
211
static int write_configuration_file(const char *fname, or_options_t *options);
212

213
214
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
215
static void print_cvs_version(void);
216

217
218
219
220
221
222
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
static or_options_t *global_options=NULL;
Roger Dingledine's avatar
Roger Dingledine committed
223
/** Name of most recently read torrc file. */
224
static char *config_fname = NULL;
225

226
227
228
/** Return the currently configured options. */
or_options_t *
get_options(void) {
229
230
231
  tor_assert(global_options);
  return global_options;
}
232

Roger Dingledine's avatar
Roger Dingledine committed
233
/** Change the current global options to contain <b>new_val</b> instead
234
 * of their current value; free the old value as necessary.
235
236
237
238
239
240
 */
void
set_options(or_options_t *new_val) {
  if (global_options)
    options_free(global_options);
  global_options = new_val;
241
242
}

243
244
245
246
247
248
249
void
config_free_all(void)
{
  options_free(global_options);
  tor_free(config_fname);
}

250
251
252
/** Fetch the active option list, and take actions based on it. All
 * of the things we do should survive being done repeatedly.
 * Return 0 if all goes well, return -1 if it's time to die.
253
254
255
256
257
258
 *
 * Note 1: <b>new_val</b> must have previously been validated with
 * options_validate(), or Tor may freak out and exit.
 *
 * Note 2: We haven't moved all the "act on new configuration" logic
 * here yet.  Some is still in do_hup() and other places.
259
260
261
262
263
 */
int
options_act(void) {
  struct config_line_t *cl;
  or_options_t *options = get_options();
264
265
266
267
268
269
  static int libevent_initialized = 0;

  /* XXXX009 We once had a reason to separate start_daemon and finish_daemon:
   *    It let us have the parent process stick around until we were sure Tor
   *    was started.  Should we make start_daemon get called earlier? -NM */
  if (options->RunAsDaemon) {
270
    start_daemon();
271
272
  }
  if (!libevent_initialized) {
273
    configure_libevent_logging();
274
    suppress_libevent_log_msg("function not implemented");
275
    event_init();
276
    suppress_libevent_log_msg(NULL);
277
278
279
280
281
282
283
284
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
    /* Making this a NOTICE for now so we can link bugs to a libevent versions
     * or methods better. */
    log_fn(LOG_NOTICE, "Initialized libevent version %s using method %s",
           event_get_version(), event_get_method());
#else
    log_fn(LOG_NOTICE, "Initialized old libevent (version 1.0b or earlier)");
#endif
285
286
    libevent_initialized = 1;
  }
287
288

  clear_trusted_dir_servers();
289
  for (cl = options->DirServers; cl; cl = cl->next) {
290
291
    if (parse_dir_server_line(cl->value, 0)<0) {
      log_fn(LOG_ERR,
292
             "Bug: Previously validated DirServer line could not be added!");
293
      return -1;
294
295
296
    }
  }

297
  if (rend_config_services(options, 0)<0) {
298
    log_fn(LOG_ERR,
299
           "Bug: Previously validated hidden services line could not be added!");
300
    return -1;
301
  }
302
303

  /* Setuid/setgid as appropriate */
304
305
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
306
307
308
309
310
      return -1;
    }
  }

  /* Ensure data directory is private; create if possible. */
311
  if (check_private_dir(options->DataDirectory, CPD_CREATE) != 0) {
312
    log_fn(LOG_ERR, "Couldn't access/create private data directory %s",
313
           options->DataDirectory);
314
315
316
317
318
319
320
321
    return -1;
  }

  /* Bail out at this point if we're not going to be a server: we want
   * to not fork, and to log stuff to stderr. */
  if (options->command != CMD_RUN_TOR)
    return 0;

322
  mark_logs_temp(); /* Close current logs once new logs are open. */
323
  if (config_init_logs(options, 0)<0) /* Configure the log(s) */
324
325
326
327
    return -1;
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
328
329
  add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
  adjust_event_log_severity();
330

331
  options->_ConnLimit =
332
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
333
  if (options->_ConnLimit < 0)
334
335
    return -1;

336
337
338
339
340
341
342
343
344
  {
    smartlist_t *sl = smartlist_create();
    for (cl = options->RedirectExit; cl; cl = cl->next) {
      if (parse_redirect_line(sl, cl)<0)
        return -1;
    }
    set_exit_redirects(sl);
  }

345
  /* Start backgrounding the process, if requested. */
346

347
  /* Finish backgrounding the process */
348
  if (options->RunAsDaemon) {
349
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
350
    finish_daemon(options->DataDirectory);
351
352
353
354
  }

  /* Write our pid to the pid file. If we do not have write permissions we
   * will log a warning */
355
  if (options->PidFile)
356
357
    write_pidfile(options->PidFile);

358
359
360
  /* Register addressmap directives */
  config_register_addressmaps(options);

361
362
363
364
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();

365
366
  init_cookie_authentication(options->CookieAuthentication);

367
368
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
369
    log_fn(LOG_ERR,"Error loading rendezvous service keys");
370
371
372
    return -1;
  }

373
  /* Set up accounting */
374
  if (accounting_parse_options(options, 0)<0) {
375
    log_fn(LOG_ERR,"Error in accounting options");
376
377
    return -1;
  }
378
  if (accounting_is_enabled(options))
379
380
    configure_accounting(time(NULL));

381
  if (!we_are_hibernating() && retry_all_listeners(1) < 0) {
382
383
384
385
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }

386
387
388
389
390
391
#if 0
  {
    char *smin, *smax;
    smin = config_dump_options(options, 1);
    smax = config_dump_options(options, 0);
    log_fn(LOG_DEBUG, "These are our options:\n%s",smax);
Roger Dingledine's avatar
Roger Dingledine committed
392
    log_fn(LOG_DEBUG, "We changed these options:\n%s",smin);
393
394
395
396
397
    tor_free(smin);
    tor_free(smax);
  }
#endif

398
399
400
401
402
403
  /* Since our options changed, we might need to regenerate and upload our
   * server descriptor.  (We could probably be more clever about only calling
   * this when something significant changed.)
   */
  mark_my_descriptor_dirty();

404
  return 0;
405
406
407
408
409
410
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
411
/** If <b>option</b> is an official abbreviation for a longer option,
412
413
414
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
 * apply abbreviations that work for the config file and the command line. */
415
static const char *
416
expand_abbrev(const char *option, int command_line)
417
418
419
420
{
  int i;
  for (i=0; config_abbrevs[i].abbreviated; ++i) {
    /* Abbreviations aren't casei. */
421
    if (!strcasecmp(option,config_abbrevs[i].abbreviated) &&
422
        (command_line || !config_abbrevs[i].commandline_only)) {
423
      return config_abbrevs[i].full;
424
    }
425
426
427
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
428

Nick Mathewson's avatar
Nick Mathewson committed
429
/** Helper: Read a list of configuration options from the command line. */
430
431
432
static struct config_line_t *
config_get_commandlines(int argc, char **argv)
{
433
434
  struct config_line_t *new;
  struct config_line_t *front = NULL;
435
436
437
  char *s;
  int i = 1;

438
  while (i < argc-1) {
439
440
441
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
442
      continue;
443
444
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
445
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
446
447
448
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
449
450
    }

451
    new = tor_malloc(sizeof(struct config_line_t));
452
    s = argv[i];
453

454
    while (*s == '-')
455
      s++;
456

457
    new->key = tor_strdup(expand_abbrev(s, 1));
458
    new->value = tor_strdup(argv[i+1]);
459
460

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
461
        new->key, new->value);
462
463
464
465
466
467
468
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
469
/** Helper: allocate a new configuration option mapping 'key' to 'val',
470
471
472
473
474
 * append it to *<b>lst</b>. */
static void
config_line_append(struct config_line_t **lst,
                   const char *key,
                   const char *val)
475
476
{
  struct config_line_t *newline;
477

478
479
480
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
481
482
483
484
485
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
486
487
}

488
489
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
490
491
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
492
493
int
config_get_lines(char *string, struct config_line_t **result)
494
{
495
  struct config_line_t *list = NULL, **next;
496
  char *k, *v;
497

498
  next = &list;
499
500
501
502
503
504
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
505
506
507
508
509
510
511
512
513
514
    if (k && v) {
      /* This list can get long, so we keep a pointer to the end of it
       * rather than using config_line_append over and over and getting n^2
       * performance.  This is the only really long list. */
      *next = tor_malloc(sizeof(struct config_line_t));
      (*next)->key = tor_strdup(k);
      (*next)->value = tor_strdup(v);
      (*next)->next = NULL;
      next = &((*next)->next);
    }
515
  } while (*string);
516

517
  *result = list;
518
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
519
520
}

Nick Mathewson's avatar
Nick Mathewson committed
521
522
523
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
524
void
525
526
config_free_lines(struct config_line_t *front)
{
527
  struct config_line_t *tmp;
528

529
  while (front) {
530
531
532
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
533
534
535
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
536
537
538
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
539
540
541
542
/** If <b>key</b> is a configuration option, return the corresponding
 * config_var_t.  Otherwise, if <b>key</b> is a non-standard abbreviation,
 * warn, and return the corresponding config_var_t.  Otherwise return NULL.
 */
543
544
545
static config_var_t *config_find_option(const char *key)
{
  int i;
546
  size_t keylen = strlen(key);
547
  if (!keylen)
548
    return NULL; /* if they say "--" on the commandline, it's not an option */
Nick Mathewson's avatar
Nick Mathewson committed
549
  /* First, check for an exact (case-insensitive) match */
550
  for (i=0; config_vars[i].name; ++i) {
Nick Mathewson's avatar
Nick Mathewson committed
551
    if (!strcasecmp(key, config_vars[i].name))
552
      return &config_vars[i];
Nick Mathewson's avatar
Nick Mathewson committed
553
554
555
  }
  /* If none, check for an abbreviated match */
  for (i=0; config_vars[i].name; ++i) {
556
    if (!strncasecmp(key, config_vars[i].name, keylen)) {
557
558
559
560
561
562
      log_fn(LOG_WARN, "The abbreviation '%s' is deprecated. "
          "Tell Nick and Roger to make it official, or just use '%s' instead",
             key, config_vars[i].name);
      return &config_vars[i];
    }
  }
563
  /* Okay, unrecognized options */
564
565
566
  return NULL;
}

Nick Mathewson's avatar
Nick Mathewson committed
567
/** If <b>c</b> is a syntactically valid configuration line, update
568
569
 * <b>options</b> with its value and return 0.  Otherwise return -1 for bad key,
 * -2 for bad value.
570
571
572
573
 *
 * If 'reset' is set, and we get a line containing no value, restore the
 * option to its default value.
 */
574
static int
575
config_assign_line(or_options_t *options, struct config_line_t *c, int reset)
576
{
577
  int i, ok;
578
579
  config_var_t *var;
  void *lvalue;
580

581
582
583
584
585
586
587
  var = config_find_option(c->key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", c->key);
    return -1;
  }
  /* Put keyword into canonical case. */
  if (strcmp(var->name, c->key)) {
588
    tor_free(c->key);
589
    c->key = tor_strdup(var->name);
590
591
  }

592
  if (reset && !strlen(c->value)) {
593
    option_reset(options, var);
594
595
596
    return 0;
  }

Nick Mathewson's avatar
Nick Mathewson committed
597
  lvalue = ((char*)options) + var->var_offset;
598
  switch (var->type) {
599

600
601
602
  case CONFIG_TYPE_UINT:
    i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
    if (!ok) {
603
      log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds.",
604
          c->key,c->value);
605
      return -2;
606
    }
607
    *(int *)lvalue = i;
608
609
    break;

610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
  case CONFIG_TYPE_INTERVAL: {
    i = config_parse_interval(c->value, &ok);
    if (!ok) {
      return -2;
    }
    *(int *)lvalue = i;
    break;
  }

  case CONFIG_TYPE_MEMUNIT: {
    uint64_t u64 = config_parse_memunit(c->value, &ok);
    if (!ok) {
      return -2;
    }
    *(uint64_t *)lvalue = u64;
    break;
  }

628
629
630
  case CONFIG_TYPE_BOOL:
    i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
    if (!ok) {
631
      log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1.", c->key);
632
      return -2;
633
    }
634
    *(int *)lvalue = i;
635
636
637
    break;

  case CONFIG_TYPE_STRING:
638
639
    tor_free(*(char **)lvalue);
    *(char **)lvalue = tor_strdup(c->value);
640
641
642
    break;

  case CONFIG_TYPE_DOUBLE:
643
    *(double *)lvalue = atof(c->value);
644
645
646
    break;

  case CONFIG_TYPE_CSV:
647
648
649
650
    if (*(smartlist_t**)lvalue) {
      SMARTLIST_FOREACH(*(smartlist_t**)lvalue, char *, cp, tor_free(cp));
      smartlist_clear(*(smartlist_t**)lvalue);
    } else {
651
      *(smartlist_t**)lvalue = smartlist_create();
652
    }
653

654
    smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
655
656
657
                           SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
    break;

658
659
  case CONFIG_TYPE_LINELIST:
  case CONFIG_TYPE_LINELIST_S:
660
    config_line_append((struct config_line_t**)lvalue, c->key, c->value);
661
    break;
662
663
664
665

  case CONFIG_TYPE_OBSOLETE:
    log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
    break;
666
667
  case CONFIG_TYPE_LINELIST_V:
    log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
668
    return -2;
669
670
671
  default:
    tor_assert(0);
    break;
672
  }
673
  return 0;
674
675
}

676
677
678
679
680
681
682
683
684
685
/** restore the option named <b>key</b> in options to its default value. */
static void
config_reset_line(or_options_t *options, const char *key)
{
  config_var_t *var;

  var = config_find_option(key);
  if (!var)
    return; /* give error on next pass. */

686
  option_reset(options, var);
687
688
}

689
690
691
692
693
694
695
696
/** Return true iff key is a valid configuration option. */
int
config_option_is_recognized(const char *key)
{
  config_var_t *var = config_find_option(key);
  return (var != NULL);
}

697
698
699
700
701
702
703
704
705
/** Return a canonicalized list of the options assigned for key.
 */
struct config_line_t *
config_get_assigned_option(or_options_t *options, const char *key)
{
  config_var_t *var;
  const void *value;
  char buf[32];
  struct config_line_t *result;
706
  tor_assert(options && key);
707
708
709
710
711

  var = config_find_option(key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", key);
    return NULL;
712
713
714
  } else if (var->type == CONFIG_TYPE_LINELIST_S) {
    log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
    return NULL;
715
716
717
  }
  value = ((char*)options) + var->var_offset;

718
719
  if (var->type == CONFIG_TYPE_LINELIST ||
      var->type == CONFIG_TYPE_LINELIST_V) {
720
    /* Linelist requires special handling: we just copy and return it. */
Roger Dingledine's avatar
Roger Dingledine committed
721
    const struct config_line_t *next_in = *(const struct config_line_t**)value;
722
723
724
725
726
727
728
729
730
731
732
733
734
735
    struct config_line_t **next_out = &result;
    while (next_in) {
      *next_out = tor_malloc(sizeof(struct config_line_t));
      (*next_out)->key = tor_strdup(next_in->key);
      (*next_out)->value = tor_strdup(next_in->value);
      next_in = next_in->next;
      next_out = &((*next_out)->next);
    }
    (*next_out) = NULL;
    return result;
  }

  result = tor_malloc_zero(sizeof(struct config_line_t));
  result->key = tor_strdup(var->name);
736
  switch (var->type)
737
738
    {
    case CONFIG_TYPE_STRING:
739
740
741
742
743
744
745
      if (*(char**)value) {
        result->value = tor_strdup(*(char**)value);
      } else {
        tor_free(result->key);
        tor_free(result);
        return NULL;
      }
746
      break;
747
    case CONFIG_TYPE_INTERVAL:
748
    case CONFIG_TYPE_UINT:
749
      /* This means every or_options_t uint or bool element
750
       * needs to be an int. Not, say, a uint16_t or char. */
751
752
753
      tor_snprintf(buf, sizeof(buf), "%d", *(int*)value);
      result->value = tor_strdup(buf);
      break;
754
755
756
757
758
    case CONFIG_TYPE_MEMUNIT:
      tor_snprintf(buf, sizeof(buf), U64_FORMAT,
                   U64_PRINTF_ARG(*(uint64_t*)value));
      result->value = tor_strdup(buf);
      break;
759
760
761
762
763
764
765
766
    case CONFIG_TYPE_DOUBLE:
      tor_snprintf(buf, sizeof(buf), "%f", *(double*)value);
      result->value = tor_strdup(buf);
      break;
    case CONFIG_TYPE_BOOL:
      result->value = tor_strdup(*(int*)value ? "1" : "0");
      break;
    case CONFIG_TYPE_CSV:
Roger Dingledine's avatar
Roger Dingledine committed
767
768
      if (*(smartlist_t**)value)
        result->value = smartlist_join_strings(*(smartlist_t**)value,",",0,NULL);
769
770
771
      else
        result->value = tor_strdup("");
      break;
772
773
774
775
776
    case CONFIG_TYPE_OBSOLETE:
      log_fn(LOG_WARN,"You asked me for the value of an obsolete config option %s.", key);
      tor_free(result->key);
      tor_free(result);
      return NULL;
777
778
779
    default:
      tor_free(result->key);
      tor_free(result);
780
      log_fn(LOG_WARN,"Bug: unknown type %d for known key %s", var->type, key);
781
782
783
784
785
786
      return NULL;
    }

  return result;
}

787
/** Iterate through the linked list of requested options <b>list</b>.
Nick Mathewson's avatar
Nick Mathewson committed
788
 * For each item, convert as appropriate and assign to <b>options</b>.
789
 * If an item is unrecognized, return -1 immediately,
790
791
792
793
 * else return 0 for success.
 *
 * If <b>reset</b>, then interpret empty lines as meaning "restore to
 * default value", and interpret LINELIST* options as replacing (not
794
795
 * extending) their previous values.  Return 0 on success, -1 on bad key,
 * -2 on bad value.
796
 */
797
static int
798
config_assign(or_options_t *options, struct config_line_t *list, int reset)
799
{
800
  struct config_line_t *p;
801
  tor_assert(options);
802
803
804
805
806
807
808

  /* pass 1: normalize keys */
  for (p = list; p; p = p->next) {
    const char *full = expand_abbrev(p->key, 0);
    if (strcmp(full,p->key)) {
      tor_free(p->key);
      p->key = tor_strdup(full);
809
    }
810
811
  }

812
  /* pass 2: if we're reading from a resetting source, clear all mentioned
813
814
815
816
817
   * linelists. */
  if (reset) {
    for (p = list; p; p = p->next)
      config_reset_line(options, p->key);
  }
818

819
820
  /* pass 3: assign. */
  while (list) {
821
822
823
    int r;
    if ((r=config_assign_line(options, list, reset)))
      return r;
824
    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
825
  }
826
  return 0;
827
828
}

829
/** Try assigning <b>list</b> to the global options. You do this by duping
830
 * options, assigning list to the new one, then validating it. If it's
831
 * ok, then throw out the old one and stick with the new one. Else,
832
833
 * revert to old and return failure.  Return 0 on success, -1 on bad
 * keys, -2 on bad values, -3 on bad transition.
834
835
 */
int
836
config_trial_assign(struct config_line_t *list, int reset)
837
{
838
  int r;
839
  or_options_t *trial_options = options_dup(get_options());
840

841
  if ((r=config_assign(trial_options, list, reset)) < 0) {
842
    options_free(trial_options);
843
    return r;
844
845
846
847
  }

  if (options_validate(trial_options) < 0) {
    options_free(trial_options);
848
    return -2;
849
850
  }

851
  if (options_transition_allowed(get_options(), trial_options) < 0) {
852
    options_free(trial_options);
853
    return -3;
854
855
  }

856
  set_options(trial_options); /* we liked it. put it in place. */
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
  return 0;
}

/** Replace the option indexed by <b>var</b> in <b>options</b> with its
 * default value. */
static void
option_reset(or_options_t *options, config_var_t *var)
{
  struct config_line_t *c;
  void *lvalue;

  lvalue = ((char*)options) + var->var_offset;
  switch (var->type) {
    case CONFIG_TYPE_STRING:
      tor_free(*(char**)lvalue);
      break;
    case CONFIG_TYPE_DOUBLE:
      *(double*)lvalue = 0.0;
      break;
876
    case CONFIG_TYPE_INTERVAL:
877
878
879
880
    case CONFIG_TYPE_UINT:
    case CONFIG_TYPE_BOOL:
      *(int*)lvalue = 0;
      break;
881
882
883
    case CONFIG_TYPE_MEMUNIT:
      *(uint64_t*)lvalue = 0;
      break;
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
    case CONFIG_TYPE_CSV:
      if (*(smartlist_t**)lvalue) {
        SMARTLIST_FOREACH(*(smartlist_t **)lvalue, char *, cp, tor_free(cp));
        smartlist_free(*(smartlist_t **)lvalue);
        *(smartlist_t **)lvalue = NULL;
      }
      break;
    case CONFIG_TYPE_LINELIST:
    case CONFIG_TYPE_LINELIST_S:
      config_free_lines(*(struct config_line_t **)lvalue);
      *(struct config_line_t **)lvalue = NULL;
      break;
    case CONFIG_TYPE_LINELIST_V:
      /* handled by linelist_s. */
      break;
    case CONFIG_TYPE_OBSOLETE:
      break;
  }
  if (var->initvalue) {
903
    c = tor_malloc_zero(sizeof(struct config_line_t));
904
905
906
907
908
909
910
    c->key = tor_strdup(var->name);
    c->value = tor_strdup(var->initvalue);
    config_assign_line(options,c,0);
    config_free_lines(c);
  }
}

911
/** Set <b>options</b>-&gt;DirServers to contain the default directory
912
 * servers. */
913
static void
914
add_default_trusted_dirservers(or_options_t *options)
915
{
Nick Mathewson's avatar
Nick Mathewson committed
916
  /* moria1 */
917
  config_line_append(&options->DirServers, "DirServer",
918
       "18.244.0.188:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441");
Nick Mathewson's avatar
Nick Mathewson committed
919
  /* moria2 */
920
  config_line_append(&options->DirServers, "DirServer",
921
         "18.244.0.114:80 719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF");
Nick Mathewson's avatar
Nick Mathewson committed
922
  /* tor26 */
923
  config_line_append(&options->DirServers, "DirServer",
924
     "62.116.124.106:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
925
//  "tor.noreply.org:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
926
927
}

Nick Mathewson's avatar
Nick Mathewson committed
928
/** Print a usage message for tor. */
929
930
931
static void
print_usage(void)
{
932
933
934
  printf(
"Copyright 2001-2004 Roger Dingledine, Nick Mathewson, Matej Pfajfar.\n\n"
"tor -f <torrc> [args]\n"
935
"See man page for options, or http://tor.eff.org/ for documentation.\n");