config.c 74.6 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
106
107
  VAR("DebugLogFile",        STRING,   DebugLogFile,         NULL),
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
  VAR("DirPort",             UINT,     DirPort,              "0"),
  VAR("DirBindAddress",      LINELIST, DirBindAddress,       NULL),
108
109
110
/* 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"),
111
112
  VAR("DirPostPeriod",       INTERVAL, DirPostPeriod,        "20 minutes"),
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "20 minutes"),
113
114
115
116
117
118
119
120
121
  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"),
122
  VAR("FirewallPorts",       CSV,      FirewallPorts,        "80,443"),
123
124
125
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
  VAR("Group",               STRING,   Group,                NULL),
126
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
127
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
128
129
130
131
132
  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),
133
  VAR("IgnoreVersion",       BOOL,     IgnoreVersion,        "0"),
134
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
135
136
137
  VAR("Log",                 LINELIST, Logs,                 NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
138
  OBSOLETE("LinkPadding"),
139
140
  VAR("MaxConn",             UINT,     MaxConn,              "1024"),
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
141
  VAR("MonthlyAccountingStart",UINT,   _MonthlyAccountingStart,"0"),
142
143
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
  VAR("AccountingMax",       MEMUNIT,   AccountingMax,        "0 bytes"),
144
  VAR("Nickname",            STRING,   Nickname,             NULL),
145
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
146
147
148
149
150
151
152
  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),
153
  OBSOLETE("RouterFile"),
154
155
156
157
158
  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),
159
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
160
161
  VAR("SocksBindAddress",    LINELIST, SocksBindAddress,     NULL),
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
162
163
164
/* 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"),
165
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
166
  OBSOLETE("TrafficShaping"),
167
168
  VAR("User",                STRING,   User,                 NULL),
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
169
170
171
172
};
#undef VAR
#undef OBSOLETE

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

176
177
static void option_reset(or_options_t *options, config_var_t *var);
static void options_free(or_options_t *options);
178
static int option_is_same(or_options_t *o1, or_options_t *o2,const char *name);
179
180
181
182
183
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);

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

199
200
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
201
static void print_cvs_version(void);
202

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

212
213
214
/** Return the currently configured options. */
or_options_t *
get_options(void) {
215
216
217
  tor_assert(global_options);
  return global_options;
}
218

Roger Dingledine's avatar
Roger Dingledine committed
219
220
221
/** Change the current global options to contain <b>new_val</b> instead
 * of their current value; free the old value as necessary.  Where
 * <b>new_val</b> is different from the old value, update the process to
222
223
224
225
226
227
228
229
230
231
232
233
234
 * use the new value instead.
 *
 * 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.
 */
void
set_options(or_options_t *new_val) {
  if (global_options)
    options_free(global_options);
  global_options = new_val;
235
236
237
238
239
240
241
242
243
244
}

/** 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.
 */
int
options_act(void) {
  struct config_line_t *cl;
  or_options_t *options = get_options();
245
246

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

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

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

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

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

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

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

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

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

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

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

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

324
325
  init_cookie_authentication(options->CookieAuthentication);

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

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

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

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

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

363
  return 0;
364
365
366
367
368
369
}

/*
 * Functions to parse config options
 */

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

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

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

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

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
425
426
/** Helper: allocate a new configuration option mapping 'key' to 'val',
 * prepend it to 'front', and return the newly allocated config_line_t */
427
struct config_line_t *
428
429
430
431
432
config_line_prepend(struct config_line_t *front,
                    const char *key,
                    const char *val)
{
  struct config_line_t *newline;
433

434
435
436
437
438
439
440
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
  newline->next = front;
  return newline;
}

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

451
452
453
454
455
456
457
458
459
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
    if (k && v)
      list = config_line_prepend(list, k, v);
  } while (*string);
460

461
  *result = list;
462
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
463
464
}

Nick Mathewson's avatar
Nick Mathewson committed
465
466
467
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
468
void
469
470
config_free_lines(struct config_line_t *front)
{
471
  struct config_line_t *tmp;
472

473
  while (front) {
474
475
476
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
477
478
479
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
480
481
482
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
483
484
485
486
/** 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.
 */
487
488
489
static config_var_t *config_find_option(const char *key)
{
  int i;
Nick Mathewson's avatar
Nick Mathewson committed
490
  /* First, check for an exact (case-insensitive) match */
491
  for (i=0; config_vars[i].name; ++i) {
Nick Mathewson's avatar
Nick Mathewson committed
492
    if (!strcasecmp(key, config_vars[i].name))
493
      return &config_vars[i];
Nick Mathewson's avatar
Nick Mathewson committed
494
495
496
497
  }
  /* If none, check for an abbreviated match */
  for (i=0; config_vars[i].name; ++i) {
    if (!strncasecmp(key, config_vars[i].name, strlen(key))) {
498
499
500
501
502
503
      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];
    }
  }
504
  /* Okay, unrecognized options */
505
506
507
  return NULL;
}

Nick Mathewson's avatar
Nick Mathewson committed
508
/** If <b>c</b> is a syntactically valid configuration line, update
509
510
 * <b>options</b> with its value and return 0.  Otherwise return -1 for bad key,
 * -2 for bad value.
511
512
513
514
 *
 * If 'reset' is set, and we get a line containing no value, restore the
 * option to its default value.
 */
515
static int
516
config_assign_line(or_options_t *options, struct config_line_t *c, int reset)
517
{
518
  int i, ok;
519
520
  config_var_t *var;
  void *lvalue;
521

522
523
524
525
526
527
528
  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)) {
529
    tor_free(c->key);
530
    c->key = tor_strdup(var->name);
531
532
  }

533
  if (reset && !strlen(c->value)) {
534
    option_reset(options, var);
535
536
537
    return 0;
  }

Nick Mathewson's avatar
Nick Mathewson committed
538
  lvalue = ((char*)options) + var->var_offset;
539
  switch (var->type) {
540

541
542
543
  case CONFIG_TYPE_UINT:
    i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
    if (!ok) {
544
      log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds.",
545
          c->key,c->value);
546
      return -2;
547
    }
548
    *(int *)lvalue = i;
549
550
    break;

551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
  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;
  }

569
570
571
  case CONFIG_TYPE_BOOL:
    i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
    if (!ok) {
572
      log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1.", c->key);
573
      return -2;
574
    }
575
    *(int *)lvalue = i;
576
577
578
    break;

  case CONFIG_TYPE_STRING:
579
580
    tor_free(*(char **)lvalue);
    *(char **)lvalue = tor_strdup(c->value);
581
582
583
    break;

  case CONFIG_TYPE_DOUBLE:
584
    *(double *)lvalue = atof(c->value);
585
586
587
    break;

  case CONFIG_TYPE_CSV:
588
589
    if (*(smartlist_t**)lvalue == NULL)
      *(smartlist_t**)lvalue = smartlist_create();
590

591
    smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
592
593
594
                           SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
    break;

595
596
597
598
599
600
601
602
  case CONFIG_TYPE_LINELIST:
  case CONFIG_TYPE_LINELIST_S:
    /* Note: this reverses the order that the lines appear in.  That's
     * just fine, since we build up the list of lines reversed in the
     * first place. */
    *(struct config_line_t**)lvalue =
      config_line_prepend(*(struct config_line_t**)lvalue, c->key, c->value);
    break;
603
604
605
606

  case CONFIG_TYPE_OBSOLETE:
    log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
    break;
607
608
  case CONFIG_TYPE_LINELIST_V:
    log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
609
    return -2;
610
611
612
  default:
    tor_assert(0);
    break;
613
  }
614
  return 0;
615
616
}

617
618
619
620
621
622
623
624
625
626
/** 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. */

627
  option_reset(options, var);
628
629
}

630
631
632
633
634
635
636
637
/** 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);
}

638
639
640
641
642
643
644
645
646
/** 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;
647
  tor_assert(options && key);
648
649
650
651
652

  var = config_find_option(key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", key);
    return NULL;
653
654
655
  } else if (var->type == CONFIG_TYPE_LINELIST_S) {
    log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
    return NULL;
656
657
658
  }
  value = ((char*)options) + var->var_offset;

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

  return result;
}

728
/** Iterate through the linked list of requested options <b>list</b>.
Nick Mathewson's avatar
Nick Mathewson committed
729
 * For each item, convert as appropriate and assign to <b>options</b>.
730
 * If an item is unrecognized, return -1 immediately,
731
732
733
734
 * 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
735
736
 * extending) their previous values.  Return 0 on success, -1 on bad key,
 * -2 on bad value.
737
 */
738
static int
739
config_assign(or_options_t *options, struct config_line_t *list, int reset)
740
{
741
  struct config_line_t *p;
742
  tor_assert(options);
743
744
745
746
747
748
749

  /* 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);
750
    }
751
752
  }

753
  /* pass 2: if we're reading from a resetting source, clear all mentioned
754
755
756
757
758
   * linelists. */
  if (reset) {
    for (p = list; p; p = p->next)
      config_reset_line(options, p->key);
  }
759

760
761
  /* pass 3: assign. */
  while (list) {
762
763
764
    int r;
    if ((r=config_assign_line(options, list, reset)))
      return r;
765
    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
766
  }
767
  return 0;
768
769
}

770
/** Try assigning <b>list</b> to the global options. You do this by duping
771
 * options, assigning list to the new one, then validating it. If it's
772
 * ok, then throw out the old one and stick with the new one. Else,
773
774
 * revert to old and return failure.  Return 0 on success, -1 on bad
 * keys, -2 on bad values, -3 on bad transition.
775
776
 */
int
777
config_trial_assign(struct config_line_t *list, int reset)
778
{
779
  int r;
780
  or_options_t *trial_options = options_dup(get_options());
781

782
  if ((r=config_assign(trial_options, list, reset)) < 0) {
783
    options_free(trial_options);
784
    return r;
785
786
787
788
  }

  if (options_validate(trial_options) < 0) {
    options_free(trial_options);
789
    return -2;
790
791
  }

792
  if (options_transition_allowed(get_options(), trial_options) < 0) {
793
    options_free(trial_options);
794
    return -3;
795
796
  }

797
  set_options(trial_options); /* we liked it. put it in place. */
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
  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;
817
    case CONFIG_TYPE_INTERVAL:
818
819
820
821
    case CONFIG_TYPE_UINT:
    case CONFIG_TYPE_BOOL:
      *(int*)lvalue = 0;
      break;
822
823
824
    case CONFIG_TYPE_MEMUNIT:
      *(uint64_t*)lvalue = 0;
      break;
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
    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) {
844
    c = tor_malloc_zero(sizeof(struct config_line_t));
845
846
847
848
849
850
851
    c->key = tor_strdup(var->name);
    c->value = tor_strdup(var->initvalue);
    config_assign_line(options,c,0);
    config_free_lines(c);
  }
}

852
/** Set <b>options</b>-&gt;DirServers to contain the default directory
853
 * servers. */
854
static void
855
add_default_trusted_dirservers(or_options_t *options)
856
{
Nick Mathewson's avatar
Nick Mathewson committed
857
  /* moria1 */
858
859
  options->DirServers = config_line_prepend(options->DirServers, "DirServer",
       "18.244.0.188:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441");
Nick Mathewson's avatar
Nick Mathewson committed
860
  /* moria2 */
861
862
  options->DirServers = config_line_prepend(options->DirServers, "DirServer",
         "18.244.0.114:80 719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF");
Nick Mathewson's avatar
Nick Mathewson committed
863
  /* tor26 */
864
865
  options->DirServers = config_line_prepend(options->DirServers, "DirServer",
     "62.116.124.106:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
866
//  "tor.noreply.org:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
867
868
}

Nick Mathewson's avatar
Nick Mathewson committed
869
/** Print a usage message for tor. */
870
871
872
static void
print_usage(void)
{
873
874
875
876
  printf(
"Copyright 2001-2004 Roger Dingledine, Nick Mathewson, Matej Pfajfar.\n\n"
"tor -f <torrc> [args]\n"
"See man page for options, or http://freehaven.net/tor/ for documentation.\n");
877
878
}

Nick Mathewson's avatar
Nick Mathewson committed
879
/**
880
881
 * Based on <b>address</b>, guess our public IP address and put it
 * in <b>addr</b>.
Nick Mathewson's avatar
Nick Mathewson committed
882
 */
883
884
885
int
resolve_my_address(const char *address, uint32_t *addr)
{
886
887
  struct in_addr in;
  struct hostent *rent;
888
  char hostname[256];
889
  int explicit_ip=1;
890

891
892
  tor_assert(addr);

893
894
  if (address) {
    strlcpy(hostname, address, sizeof(hostname));
895
  } else { /* then we need to guess our address */
896
    explicit_ip = 0; /* it's implicit */
897

898
    if (gethostname(hostname, sizeof(hostname)) < 0) {
899
900
901
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
902
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",hostname);
903
904
  }

905
  /* now we know hostname. resolve it and keep only the IP */
906

907
  if (tor_inet_aton(hostname, &in) == 0) {
908
909
    /* then we have to resolve it */
    explicit_ip = 0;
910
    rent = (struct hostent *)gethostbyname(hostname);
911
    if (!rent) {
912
      log_fn(LOG_WARN,"Could not resolve local Address %s. Failing.", hostname);
913
914
      return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
915
    tor_assert(rent->h_length == 4);
916
    memcpy(&in.s_addr, rent->h_addr, rent->h_length);
917
  }
918
919

  if (!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
920
    log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
921
           "Please set the Address config option to be the IP you want to use.",
922
           hostname, inet_ntoa(in));
923
924
    return -1;
  }
925
926

  log_fn(LOG_DEBUG, "Resolved Address to %s.", inet_ntoa(in));
927
  *addr = ntohl(in.s_addr);
928
929
930
  return 0;
}

931
932
/** Called when we don't have a nickname set.  Try to guess a good
 * nickname based on the hostname, and return it. */
933
934
static char *
get_default_nickname(void)
935
936
937
938
{
  char localhostname[256];
  char *cp, *out, *outp;

939
  if (gethostname(localhostname, sizeof(localhostname)) < 0) {
940
941
942
    log_fn(LOG_WARN,"Error obtaining local hostname");
    return NULL;
  }
943

944
  /* Put it in lowercase; stop at the first dot. */
945
  for (cp = localhostname; *cp; ++cp) {
946
947
948
949
950
951
    if (*cp == '.') {
      *cp = '\0';
      break;
    }
    *cp = tolower(*cp);
  }
952

953
954
  /* Strip invalid characters. */
  cp = localhostname;
955
  out = outp = tor_malloc(strlen(localhostname) + 1);
956
957
958
959
960
961
962
  while (*cp) {
    if (strchr(LEGAL_NICKNAME_CHARACTERS, *cp))
      *outp++ = *cp++;
    else
      cp++;
  }
  *outp = '\0';
963

964
965
966
967
968
969
970
  /* Enforce length. */
  if (strlen(out) > MAX_NICKNAME_LEN)
    out[MAX_NICKNAME_LEN]='\0';

  return out;
}

Nick Mathewson's avatar
Nick Mathewson committed
971
/** Release storage held by <b>options</b> */