config.c 75.3 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
3
/* Copyright 2001 Matej Pfajfar.
 * Copyright 2001-2004 Roger Dingledine.
 * Copyright 2004 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
56
57
58
59
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
60
61
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
62
  { "l", "Log", 1},
63
64
  { "BandwidthRateBytes", "BandwidthRate", 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0},
65
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0},
66
  { NULL, NULL , 0},
67
};
68
#undef PLURAL
69

70
/** A variable allowed in the configuration file or on the command line. */
71
typedef struct config_var_t {
72
73
74
75
  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. */
76
77
} config_var_t;

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

Nick Mathewson's avatar
Nick Mathewson committed
89
90
91
92
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
93
static config_var_t config_vars[] = {
94
  VAR("Address",             STRING,   Address,              NULL),
95
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
96
  VAR("AllowUnverifiedNodes",CSV,      AllowUnverifiedNodes, "middle,rendezvous"),
97
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
98
99
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "780 KB"),
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "48 MB"),
100
101
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
102
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
103
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
104
105
  VAR("DebugLogFile",        STRING,   DebugLogFile,         NULL),
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
106
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
107
108
  VAR("DirPort",             UINT,     DirPort,              "0"),
  VAR("DirBindAddress",      LINELIST, DirBindAddress,       NULL),
109
110
111
/* XXX we'd like dirfetchperiod to be higher for people with dirport not
 * set, but low for people with dirport set. how to have two defaults? */
  VAR("DirFetchPeriod",      INTERVAL, DirFetchPeriod,       "1 hour"),
112
113
  VAR("DirPostPeriod",       INTERVAL, DirPostPeriod,        "20 minutes"),
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "20 minutes"),
114
115
116
117
118
119
120
121
122
  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),
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
123
  VAR("FirewallPorts",       CSV,      FirewallPorts,        "80,443"),
124
125
126
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
  VAR("Group",               STRING,   Group,                NULL),
127
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
128
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
129
130
131
132
133
  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),
134
  VAR("IgnoreVersion",       BOOL,     IgnoreVersion,        "0"),
135
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
136
137
138
  VAR("Log",                 LINELIST, Logs,                 NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
139
  OBSOLETE("LinkPadding"),
140
141
  VAR("MaxConn",             UINT,     MaxConn,              "1024"),
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
142
  VAR("MonthlyAccountingStart",UINT,   _MonthlyAccountingStart,"0"),
143
144
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
  VAR("AccountingMax",       MEMUNIT,   AccountingMax,        "0 bytes"),
145
  VAR("Nickname",            STRING,   Nickname,             NULL),
146
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
147
148
149
150
151
152
153
  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),
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
154
  OBSOLETE("RouterFile"),
155
156
157
158
159
  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),
160
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
161
162
  VAR("SocksBindAddress",    LINELIST, SocksBindAddress,     NULL),
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
163
164
165
/* XXX as with dirfetchperiod, we want this to be 15 minutes for people
 * with a dirport open, but higher for people without a dirport open. */
  VAR("StatusFetchPeriod",   INTERVAL, StatusFetchPeriod,    "15 minutes"),
166
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
167
  OBSOLETE("TrafficShaping"),
168
169
  VAR("User",                STRING,   User,                 NULL),
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
170
171
172
173
};
#undef VAR
#undef OBSOLETE

Nick Mathewson's avatar
Nick Mathewson committed
174
/** Largest allowed config line */
175
#define CONFIG_LINE_T_MAXLEN 4096
176

177
178
static void config_line_append(struct config_line_t **lst,
                               const char *key, const char *val);
179
180
static void option_reset(or_options_t *options, config_var_t *var);
static void options_free(or_options_t *options);
181
static int option_is_same(or_options_t *o1, or_options_t *o2,const char *name);
182
183
184
185
186
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);

187
static int parse_dir_server_line(const char *line, int validate_only);
188
static int parse_redirect_line(smartlist_t *result,
Roger Dingledine's avatar
Roger Dingledine committed
189
                               struct config_line_t *line);
190
191
192
193
194
195
196
197
198
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);
199
static int validate_data_directory(or_options_t *options);
200
static int write_configuration_file(const char *fname, or_options_t *options);
201

202
203
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
204
static void print_cvs_version(void);
205

206
207
208
209
210
211
/*
 * 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
212
/** Name of most recently read torrc file. */
213
static char *config_fname = NULL;
214

215
216
217
/** Return the currently configured options. */
or_options_t *
get_options(void) {
218
219
220
  tor_assert(global_options);
  return global_options;
}
221

Roger Dingledine's avatar
Roger Dingledine committed
222
/** Change the current global options to contain <b>new_val</b> instead
223
 * of their current value; free the old value as necessary.
224
225
226
227
228
229
 */
void
set_options(or_options_t *new_val) {
  if (global_options)
    options_free(global_options);
  global_options = new_val;
230
231
232
233
234
}

/** 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.
235
236
237
238
239
240
 *
 * 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.
241
242
243
244
245
 */
int
options_act(void) {
  struct config_line_t *cl;
  or_options_t *options = get_options();
246
247

  clear_trusted_dir_servers();
248
  for (cl = options->DirServers; cl; cl = cl->next) {
249
250
    if (parse_dir_server_line(cl->value, 0)<0) {
      log_fn(LOG_ERR,
251
             "Bug: Previously validated DirServer line could not be added!");
252
      return -1;
253
254
255
    }
  }

256
  if (rend_config_services(options, 0)<0) {
257
    log_fn(LOG_ERR,
258
           "Bug: Previously validated hidden services line could not be added!");
259
    return -1;
260
  }
261
262

  /* Setuid/setgid as appropriate */
263
264
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
265
266
267
268
269
      return -1;
    }
  }

  /* Ensure data directory is private; create if possible. */
270
  if (check_private_dir(options->DataDirectory, CPD_CREATE) != 0) {
271
    log_fn(LOG_ERR, "Couldn't access/create private data directory %s",
272
           options->DataDirectory);
273
274
275
276
277
278
279
280
    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;

281
  mark_logs_temp(); /* Close current logs once new logs are open. */
282
  if (config_init_logs(options, 0)<0) /* Configure the log(s) */
283
284
285
286
    return -1;
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
287
  add_callback_log(LOG_NOTICE, LOG_ERR, control_event_logmsg);
288

289
290
291
  if (set_max_file_descriptors(options->MaxConn) < 0)
    return -1;

292
293
294
295
296
297
298
299
300
  {
    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);
  }

301
  /* Start backgrounding the process, if requested. */
302

303
304
305
  /* 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 */
306
  if (options->RunAsDaemon) {
307
    start_daemon(options->DataDirectory);
308
309
310
  }

  /* Finish backgrounding the process */
311
  if (options->RunAsDaemon) {
312
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
313
314
315
316
317
    finish_daemon();
  }

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

321
322
323
324
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();

325
326
  init_cookie_authentication(options->CookieAuthentication);

327
328
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
329
    log_fn(LOG_ERR,"Error loading rendezvous service keys");
330
331
332
    return -1;
  }

333
  /* Set up accounting */
334
  if (accounting_parse_options(options, 0)<0) {
335
    log_fn(LOG_ERR,"Error in accounting options");
336
337
    return -1;
  }
338
  if (accounting_is_enabled(options))
339
340
    configure_accounting(time(NULL));

341
  if (!we_are_hibernating() && retry_all_listeners(1) < 0) {
342
343
344
345
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }

346
347
348
349
350
351
#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
352
    log_fn(LOG_DEBUG, "We changed these options:\n%s",smin);
353
354
355
356
357
    tor_free(smin);
    tor_free(smax);
  }
#endif

358
359
360
361
362
363
  /* 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();

364
  return 0;
365
366
367
368
369
370
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
371
/** If <b>option</b> is an official abbreviation for a longer option,
372
373
374
 * 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. */
375
static const char *
376
expand_abbrev(const char *option, int command_line)
377
378
379
380
{
  int i;
  for (i=0; config_abbrevs[i].abbreviated; ++i) {
    /* Abbreviations aren't casei. */
381
    if (!strcasecmp(option,config_abbrevs[i].abbreviated) &&
382
        (command_line || !config_abbrevs[i].commandline_only)) {
383
      return config_abbrevs[i].full;
384
    }
385
386
387
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
388

Nick Mathewson's avatar
Nick Mathewson committed
389
/** Helper: Read a list of configuration options from the command line. */
390
391
392
static struct config_line_t *
config_get_commandlines(int argc, char **argv)
{
393
394
  struct config_line_t *new;
  struct config_line_t *front = NULL;
395
396
397
  char *s;
  int i = 1;

398
  while (i < argc-1) {
399
400
401
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
402
      continue;
403
404
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
405
      continue;
406
407
    }

408
    new = tor_malloc(sizeof(struct config_line_t));
409
    s = argv[i];
410

411
    while (*s == '-')
412
      s++;
413

414
    new->key = tor_strdup(expand_abbrev(s, 1));
415
    new->value = tor_strdup(argv[i+1]);
416
417

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
418
        new->key, new->value);
419
420
421
422
423
424
425
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
426
/** Helper: allocate a new configuration option mapping 'key' to 'val',
427
428
429
430
431
 * append it to *<b>lst</b>. */
static void
config_line_append(struct config_line_t **lst,
                   const char *key,
                   const char *val)
432
433
{
  struct config_line_t *newline;
434

435
436
437
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
438
439
440
441
442
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
443
444
}

445
446
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
447
448
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
449
450
int
config_get_lines(char *string, struct config_line_t **result)
451
{
452
  struct config_line_t *list = NULL, **next;
453
  char *k, *v;
454

455
  next = &list;
456
457
458
459
460
461
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
462
463
464
465
466
467
468
469
470
471
    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);
    }
472
  } while (*string);
473

474
  *result = list;
475
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
476
477
}

Nick Mathewson's avatar
Nick Mathewson committed
478
479
480
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
481
void
482
483
config_free_lines(struct config_line_t *front)
{
484
  struct config_line_t *tmp;
485

486
  while (front) {
487
488
489
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
490
491
492
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
493
494
495
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
496
497
498
499
/** 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.
 */
500
501
502
static config_var_t *config_find_option(const char *key)
{
  int i;
Nick Mathewson's avatar
Nick Mathewson committed
503
  /* First, check for an exact (case-insensitive) match */
504
  for (i=0; config_vars[i].name; ++i) {
Nick Mathewson's avatar
Nick Mathewson committed
505
    if (!strcasecmp(key, config_vars[i].name))
506
      return &config_vars[i];
Nick Mathewson's avatar
Nick Mathewson committed
507
508
509
510
  }
  /* If none, check for an abbreviated match */
  for (i=0; config_vars[i].name; ++i) {
    if (!strncasecmp(key, config_vars[i].name, strlen(key))) {
511
512
513
514
515
516
      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];
    }
  }
517
  /* Okay, unrecognized options */
518
519
520
  return NULL;
}

Nick Mathewson's avatar
Nick Mathewson committed
521
/** If <b>c</b> is a syntactically valid configuration line, update
522
523
 * <b>options</b> with its value and return 0.  Otherwise return -1 for bad key,
 * -2 for bad value.
524
525
526
527
 *
 * If 'reset' is set, and we get a line containing no value, restore the
 * option to its default value.
 */
528
static int
529
config_assign_line(or_options_t *options, struct config_line_t *c, int reset)
530
{
531
  int i, ok;
532
533
  config_var_t *var;
  void *lvalue;
534

535
536
537
538
539
540
541
  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)) {
542
    tor_free(c->key);
543
    c->key = tor_strdup(var->name);
544
545
  }

546
  if (reset && !strlen(c->value)) {
547
    option_reset(options, var);
548
549
550
    return 0;
  }

Nick Mathewson's avatar
Nick Mathewson committed
551
  lvalue = ((char*)options) + var->var_offset;
552
  switch (var->type) {
553

554
555
556
  case CONFIG_TYPE_UINT:
    i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
    if (!ok) {
557
      log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds.",
558
          c->key,c->value);
559
      return -2;
560
    }
561
    *(int *)lvalue = i;
562
563
    break;

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
  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;
  }

582
583
584
  case CONFIG_TYPE_BOOL:
    i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
    if (!ok) {
585
      log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1.", c->key);
586
      return -2;
587
    }
588
    *(int *)lvalue = i;
589
590
591
    break;

  case CONFIG_TYPE_STRING:
592
593
    tor_free(*(char **)lvalue);
    *(char **)lvalue = tor_strdup(c->value);
594
595
596
    break;

  case CONFIG_TYPE_DOUBLE:
597
    *(double *)lvalue = atof(c->value);
598
599
600
    break;

  case CONFIG_TYPE_CSV:
601
602
603
604
    if (*(smartlist_t**)lvalue) {
      SMARTLIST_FOREACH(*(smartlist_t**)lvalue, char *, cp, tor_free(cp));
      smartlist_clear(*(smartlist_t**)lvalue);
    } else {
605
      *(smartlist_t**)lvalue = smartlist_create();
606
    }
607

608
    smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
609
610
611
                           SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
    break;

612
613
  case CONFIG_TYPE_LINELIST:
  case CONFIG_TYPE_LINELIST_S:
614
    config_line_append((struct config_line_t**)lvalue, c->key, c->value);
615
    break;
616
617
618
619

  case CONFIG_TYPE_OBSOLETE:
    log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
    break;
620
621
  case CONFIG_TYPE_LINELIST_V:
    log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
622
    return -2;
623
624
625
  default:
    tor_assert(0);
    break;
626
  }
627
  return 0;
628
629
}

630
631
632
633
634
635
636
637
638
639
/** 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. */

640
  option_reset(options, var);
641
642
}

643
644
645
646
647
648
649
650
/** 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);
}

651
652
653
654
655
656
657
658
659
/** 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;
660
  tor_assert(options && key);
661
662
663
664
665

  var = config_find_option(key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", key);
    return NULL;
666
667
668
  } else if (var->type == CONFIG_TYPE_LINELIST_S) {
    log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
    return NULL;
669
670
671
  }
  value = ((char*)options) + var->var_offset;

672
673
  if (var->type == CONFIG_TYPE_LINELIST ||
      var->type == CONFIG_TYPE_LINELIST_V) {
674
    /* Linelist requires special handling: we just copy and return it. */
Roger Dingledine's avatar
Roger Dingledine committed
675
    const struct config_line_t *next_in = *(const struct config_line_t**)value;
676
677
678
679
680
681
682
683
684
685
686
687
688
689
    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);
690
  switch (var->type)
691
692
    {
    case CONFIG_TYPE_STRING:
693
694
695
696
697
698
699
      if (*(char**)value) {
        result->value = tor_strdup(*(char**)value);
      } else {
        tor_free(result->key);
        tor_free(result);
        return NULL;
      }
700
      break;
701
    case CONFIG_TYPE_INTERVAL:
702
    case CONFIG_TYPE_UINT:
703
      /* This means every or_options_t uint or bool element
704
       * needs to be an int. Not, say, a uint16_t or char. */
705
706
707
      tor_snprintf(buf, sizeof(buf), "%d", *(int*)value);
      result->value = tor_strdup(buf);
      break;
708
709
710
711
712
    case CONFIG_TYPE_MEMUNIT:
      tor_snprintf(buf, sizeof(buf), U64_FORMAT,
                   U64_PRINTF_ARG(*(uint64_t*)value));
      result->value = tor_strdup(buf);
      break;
713
714
715
716
717
718
719
720
    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
721
722
      if (*(smartlist_t**)value)
        result->value = smartlist_join_strings(*(smartlist_t**)value,",",0,NULL);
723
724
725
      else
        result->value = tor_strdup("");
      break;
726
727
728
729
730
    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;
731
732
733
    default:
      tor_free(result->key);
      tor_free(result);
734
      log_fn(LOG_WARN,"Bug: unknown type %d for known key %s", var->type, key);
735
736
737
738
739
740
      return NULL;
    }

  return result;
}

741
/** Iterate through the linked list of requested options <b>list</b>.
Nick Mathewson's avatar
Nick Mathewson committed
742
 * For each item, convert as appropriate and assign to <b>options</b>.
743
 * If an item is unrecognized, return -1 immediately,
744
745
746
747
 * 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
748
749
 * extending) their previous values.  Return 0 on success, -1 on bad key,
 * -2 on bad value.
750
 */
751
static int
752
config_assign(or_options_t *options, struct config_line_t *list, int reset)
753
{
754
  struct config_line_t *p;
755
  tor_assert(options);
756
757
758
759
760
761
762

  /* 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);
763
    }
764
765
  }

766
  /* pass 2: if we're reading from a resetting source, clear all mentioned
767
768
769
770
771
   * linelists. */
  if (reset) {
    for (p = list; p; p = p->next)
      config_reset_line(options, p->key);
  }
772

773
774
  /* pass 3: assign. */
  while (list) {
775
776
777
    int r;
    if ((r=config_assign_line(options, list, reset)))
      return r;
778
    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
779
  }
780
  return 0;
781
782
}

783
/** Try assigning <b>list</b> to the global options. You do this by duping
784
 * options, assigning list to the new one, then validating it. If it's
785
 * ok, then throw out the old one and stick with the new one. Else,
786
787
 * revert to old and return failure.  Return 0 on success, -1 on bad
 * keys, -2 on bad values, -3 on bad transition.
788
789
 */
int
790
config_trial_assign(struct config_line_t *list, int reset)
791
{
792
  int r;
793
  or_options_t *trial_options = options_dup(get_options());
794

795
  if ((r=config_assign(trial_options, list, reset)) < 0) {
796
    options_free(trial_options);
797
    return r;
798
799
800
801
  }

  if (options_validate(trial_options) < 0) {
    options_free(trial_options);
802
    return -2;
803
804
  }

805
  if (options_transition_allowed(get_options(), trial_options) < 0) {
806
    options_free(trial_options);
807
    return -3;
808
809
  }

810
  set_options(trial_options); /* we liked it. put it in place. */
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
  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;
830
    case CONFIG_TYPE_INTERVAL:
831
832
833
834
    case CONFIG_TYPE_UINT:
    case CONFIG_TYPE_BOOL:
      *(int*)lvalue = 0;
      break;
835
836
837
    case CONFIG_TYPE_MEMUNIT:
      *(uint64_t*)lvalue = 0;
      break;
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
    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) {
857
    c = tor_malloc_zero(sizeof(struct config_line_t));
858
859
860
861
862
863
864
    c->key = tor_strdup(var->name);
    c->value = tor_strdup(var->initvalue);
    config_assign_line(options,c,0);
    config_free_lines(c);
  }
}

865
/** Set <b>options</b>-&gt;DirServers to contain the default directory
866
 * servers. */
867
static void
868
add_default_trusted_dirservers(or_options_t *options)
869
{
Nick Mathewson's avatar
Nick Mathewson committed
870
  /* moria1 */
871
  config_line_append(&options->DirServers, "DirServer",
872
       "18.244.0.188:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441");
Nick Mathewson's avatar
Nick Mathewson committed
873
  /* moria2 */
874
  config_line_append(&options->DirServers, "DirServer",
875
         "18.244.0.114:80 719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF");
Nick Mathewson's avatar
Nick Mathewson committed
876
  /* tor26 */
877
  config_line_append(&options->DirServers, "DirServer",
878
     "62.116.124.106:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
879
//  "tor.noreply.org:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
880
881
}

Nick Mathewson's avatar
Nick Mathewson committed
882
/** Print a usage message for tor. */
883
884
885
static void
print_usage(void)
{
886
887
888
  printf(
"Copyright 2001-2004 Roger Dingledine, Nick Mathewson, Matej Pfajfar.\n\n"
"tor -f <torrc> [args]\n"
889
"See man page for options, or http://tor.eff.org/ for documentation.\n");
890
891
}

Nick Mathewson's avatar
Nick Mathewson committed
892
/**
893
894
 * Based on <b>address</b>, guess our public IP address and put it
 * in <b>addr</b>.
Nick Mathewson's avatar
Nick Mathewson committed
895
 */
896
897
898
int
resolve_my_address(const char *address, uint32_t *addr)
{
899
900
  struct in_addr in;
  struct hostent *rent;
901
  char hostname[256];
902
  int explicit_ip=1;
903

904
905
  tor_assert(addr);

906
907
  if (address) {
    strlcpy(hostname, address, sizeof(hostname));
908
  } else { /* then we need to guess our address */
909
    explicit_ip = 0; /* it's implicit */
910

911
    if (gethostname(hostname, sizeof(hostname)) < 0) {
912
913
914
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
915
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",hostname);
916
917
  }

918
  /* now we know hostname. resolve it and keep only the IP */
919

920
  if (tor_inet_aton(hostname, &in) == 0) {
921
922
    /* then we have to resolve it */
    explicit_ip = 0;
923
    rent = (struct hostent *)gethostbyname(hostname);
924
    if (!rent) {
925
      log_fn(LOG_WARN,"Could not resolve local Address %s. Failing.", hostname);
926
927
      return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
928
    tor_assert(rent->h_length == 4);
929
    memcpy(&in.s_addr, rent->h_addr, rent->h_length);
930
  }
931
932

  if (!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
933
    log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
934
           "Please set the Address config option to be the IP you want to use.",
935
           hostname, inet_ntoa(in));
936
937
    return -1;
  }
938
939

  log_fn(LOG_DEBUG, "Resolved Address to %s.", inet_ntoa(in));
940
  *addr = ntohl(in.s_addr);
941
942
943
  return 0;
}

944
/** Called when we don't have a nickname set.  Try to guess a good
945
 * nickname based on the hostname, and return it in a newly allocated string. */
946
947
static char *
get_default_nickname(void)