config.c 27.1 KB
Newer Older
1
/* Copyright 2001,2002,2003 Roger Dingledine, Matej Pfajfar. */
2
3
4
/* See LICENSE for licensing information */
/* $Id$ */

Nick Mathewson's avatar
Nick Mathewson committed
5
6
7
8
9
10
11
/**
 * /file config.c
 *
 * /brief Code to parse and interpret configuration files.
 *
 **/

Roger Dingledine's avatar
Roger Dingledine committed
12
#include "or.h"
Roger Dingledine's avatar
Roger Dingledine committed
13

Nick Mathewson's avatar
Nick Mathewson committed
14
15
16
17
18
19
20
21
/** Enumeration of types which option values can take */
typedef enum config_type_t {
  CONFIG_TYPE_STRING = 0, /**< An arbitrary string. */
  CONFIG_TYPE_INT, /**< An integer */
  CONFIG_TYPE_DOUBLE, /**< A floating-point value */
  CONFIG_TYPE_BOOL, /**< A boolean value, expressed as 0 or 1. */
  CONFIG_TYPE_LINELIST, /**< Uninterpreted config lines */
} config_type_t;
22

Nick Mathewson's avatar
Nick Mathewson committed
23
/** Largest allowed config line */
24
#define CONFIG_LINE_T_MAXLEN 4096
25
26
27

static FILE *config_open(const unsigned char *filename);
static int config_close(FILE *f);
28
29
30
static struct config_line_t *config_get_commandlines(int argc, char **argv);
static struct config_line_t *config_get_lines(FILE *f);
static void config_free_lines(struct config_line_t *front);
31
static int config_compare(struct config_line_t *c, const char *key, config_type_t type, void *arg);
32
static int config_assign(or_options_t *options, struct config_line_t *list);
33

Nick Mathewson's avatar
Nick Mathewson committed
34
/** Open a configuration file for reading */
35
static FILE *config_open(const unsigned char *filename) {
Roger Dingledine's avatar
Roger Dingledine committed
36
  tor_assert(filename);
37
38
39
40
41
42
43
  if (strspn(filename,CONFIG_LEGAL_FILENAME_CHARACTERS) != strlen(filename)) {
    /* filename has illegal letters */
    return NULL;
  }
  return fopen(filename, "r");
}

Nick Mathewson's avatar
Nick Mathewson committed
44
/** Close the configuration file */
45
static int config_close(FILE *f) {
Roger Dingledine's avatar
Roger Dingledine committed
46
  tor_assert(f);
47
48
49
  return fclose(f);
}

Nick Mathewson's avatar
Nick Mathewson committed
50
/** Helper: Read a list of configuration options from the command line. */
51
52
53
static struct config_line_t *config_get_commandlines(int argc, char **argv) {
  struct config_line_t *new;
  struct config_line_t *front = NULL;
54
55
56
  char *s;
  int i = 1;

Roger Dingledine's avatar
Roger Dingledine committed
57
  while(i < argc-1) {
58
59
60
61
62
63
    if(!strcmp(argv[i],"-f")) {
//      log(LOG_DEBUG,"Commandline: skipping over -f.");
      i+=2; /* this is the config file option. ignore it. */
      continue;
    }

64
    new = tor_malloc(sizeof(struct config_line_t));
65
66
67
    s = argv[i];
    while(*s == '-')
      s++;
68
69
    new->key = tor_strdup(s);
    new->value = tor_strdup(argv[i+1]);
70
71
72
73
74
75
76
77
78
79

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
      new->key, new->value);
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
80
81
/** Helper: allocate a new configuration option mapping 'key' to 'val',
 * prepend it to 'front', and return the newly allocated config_line_t */
82
83
84
85
86
87
88
89
90
91
92
93
94
static struct config_line_t *
config_line_prepend(struct config_line_t *front,
                    const char *key,
                    const char *val)
{
  struct config_line_t *newline;
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
  newline->next = front;
  return newline;
}

95
/** Helper: parse the config file and strdup into key/value
Nick Mathewson's avatar
Nick Mathewson committed
96
97
 * strings. Return list, or NULL if parsing the file failed.  Warn and
 * ignore any misformatted lines. */
98
99
100
101
static struct config_line_t *config_get_lines(FILE *f) {

  struct config_line_t *front = NULL;
  char line[CONFIG_LINE_T_MAXLEN];
102
103
  int result;
  char *key, *value;
104

105
  while( (result=parse_line_from_file(line,sizeof(line),f,&key,&value)) > 0) {
106
    front = config_line_prepend(front, key, value);
Roger Dingledine's avatar
Roger Dingledine committed
107
  }
108
109
  if(result < 0)
    return NULL;
110
  return front;
Roger Dingledine's avatar
Roger Dingledine committed
111
112
}

Nick Mathewson's avatar
Nick Mathewson committed
113
114
115
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
116
117
static void config_free_lines(struct config_line_t *front) {
  struct config_line_t *tmp;
118
119
120
121
122
123
124
125
126
127
128

  while(front) {
    tmp = front;
    front = tmp->next;

    free(tmp->key);
    free(tmp->value);
    free(tmp);
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
129
130
131
132
133
/** Search the linked list <b>c</b> for any option whose key is <b>key</b>.
 * If such an option is found, interpret it as of type <b>type</b>, and store
 * the result in <b>arg</b>.  If the option is misformatted, log a warning and
 * skip it.
 */
134
static int config_compare(struct config_line_t *c, const char *key, config_type_t type, void *arg) {
135
  int i;
136
137
138
139

  if(strncasecmp(c->key,key,strlen(c->key)))
    return 0;

140
141
142
143
144
  if(strcasecmp(c->key,key)) {
    tor_free(c->key);
    c->key = tor_strdup(key);
  }

145
  /* it's a match. cast and assign. */
146
  log_fn(LOG_DEBUG,"Recognized keyword '%s' as %s, using value '%s'.",c->key,key,c->value);
147
148

  switch(type) {
Roger Dingledine's avatar
Roger Dingledine committed
149
    case CONFIG_TYPE_INT:
150
      *(int *)arg = atoi(c->value);
151
      break;
152
153
154
    case CONFIG_TYPE_BOOL:
      i = atoi(c->value);
      if (i != 0 && i != 1) {
Roger Dingledine's avatar
Roger Dingledine committed
155
        log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1", c->key);
156
        return 0;
157
158
159
      }
      *(int *)arg = i;
      break;
160
    case CONFIG_TYPE_STRING:
161
      tor_free(*(char **)arg);
162
      *(char **)arg = tor_strdup(c->value);
163
      break;
164
165
    case CONFIG_TYPE_DOUBLE:
      *(double *)arg = atof(c->value);
166
      break;
167
168
169
170
171
172
173
    case CONFIG_TYPE_LINELIST:
      /* 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**)arg =
        config_line_prepend(*(struct config_line_t**)arg, c->key, c->value);
      break;
174
175
176
177
  }
  return 1;
}

Nick Mathewson's avatar
Nick Mathewson committed
178
179
/** Iterate through the linked list of options <b>list</b>.
 * For each item, convert as appropriate and assign to <b>options</b>.
180
181
 * If an item is unrecognized, return -1 immediately,
 * else return 0 for success. */
182
static int config_assign(or_options_t *options, struct config_line_t *list) {
183
184
185
186
187
188
189

  while(list) {
    if(

    /* order matters here! abbreviated arguments use the first match. */

    /* string options */
190
191
    config_compare(list, "Address",        CONFIG_TYPE_STRING, &options->Address) ||

192
193
194
    config_compare(list, "BandwidthRate",  CONFIG_TYPE_INT, &options->BandwidthRate) ||
    config_compare(list, "BandwidthBurst", CONFIG_TYPE_INT, &options->BandwidthBurst) ||

195
    config_compare(list, "DebugLogFile",   CONFIG_TYPE_STRING, &options->DebugLogFile) ||
196
    config_compare(list, "DataDirectory",  CONFIG_TYPE_STRING, &options->DataDirectory) ||
197
198
199
200
    config_compare(list, "DirPort",        CONFIG_TYPE_INT, &options->DirPort) ||
    config_compare(list, "DirBindAddress", CONFIG_TYPE_STRING, &options->DirBindAddress) ||
    config_compare(list, "DirFetchPostPeriod",CONFIG_TYPE_INT, &options->DirFetchPostPeriod) ||

201
202
    config_compare(list, "ExitNodes",      CONFIG_TYPE_STRING, &options->ExitNodes) ||
    config_compare(list, "EntryNodes",     CONFIG_TYPE_STRING, &options->EntryNodes) ||
203
    config_compare(list, "ExitPolicy",     CONFIG_TYPE_STRING, &options->ExitPolicy) ||
204
    config_compare(list, "ExcludeNodes",   CONFIG_TYPE_STRING, &options->ExcludeNodes) ||
205

206
    config_compare(list, "Group",          CONFIG_TYPE_STRING, &options->Group) ||
207

208
209
210
211
    config_compare(list, "IgnoreVersion",  CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||

    config_compare(list, "KeepalivePeriod",CONFIG_TYPE_INT, &options->KeepalivePeriod) ||

212
213
    config_compare(list, "LogLevel",       CONFIG_TYPE_LINELIST, &options->LogOptions) ||
    config_compare(list, "LogFile",        CONFIG_TYPE_LINELIST, &options->LogOptions) ||
214
215
216
    config_compare(list, "LinkPadding",    CONFIG_TYPE_BOOL, &options->LinkPadding) ||

    config_compare(list, "MaxConn",        CONFIG_TYPE_INT, &options->MaxConn) ||
217
    config_compare(list, "MaxOnionsPending",CONFIG_TYPE_INT, &options->MaxOnionsPending) ||
218
219

    config_compare(list, "Nickname",       CONFIG_TYPE_STRING, &options->Nickname) ||
220
    config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_INT, &options->NewCircuitPeriod) ||
221
    config_compare(list, "NumCpus",        CONFIG_TYPE_INT, &options->NumCpus) ||
222

223
224
    config_compare(list, "ORPort",         CONFIG_TYPE_INT, &options->ORPort) ||
    config_compare(list, "ORBindAddress",  CONFIG_TYPE_STRING, &options->ORBindAddress) ||
225

226
    config_compare(list, "PidFile",        CONFIG_TYPE_STRING, &options->PidFile) ||
227
    config_compare(list, "PathlenCoinWeight",CONFIG_TYPE_DOUBLE, &options->PathlenCoinWeight) ||
228
229
230

    config_compare(list, "RouterFile",     CONFIG_TYPE_STRING, &options->RouterFile) ||
    config_compare(list, "RunAsDaemon",    CONFIG_TYPE_BOOL, &options->RunAsDaemon) ||
231
    config_compare(list, "RecommendedVersions",CONFIG_TYPE_STRING, &options->RecommendedVersions) ||
232
233
    config_compare(list, "RendNodes",      CONFIG_TYPE_STRING, &options->RendNodes) ||
    config_compare(list, "RendExcludeNodes",CONFIG_TYPE_STRING, &options->RendExcludeNodes) ||
234

235
236
237
238
239
    config_compare(list, "SocksPort",      CONFIG_TYPE_INT, &options->SocksPort) ||
    config_compare(list, "SocksBindAddress",CONFIG_TYPE_STRING,&options->SocksBindAddress) ||

    config_compare(list, "TrafficShaping", CONFIG_TYPE_BOOL, &options->TrafficShaping) ||

240
    config_compare(list, "User",           CONFIG_TYPE_STRING, &options->User) ||
241
    config_compare(list, "RunTesting",     CONFIG_TYPE_BOOL, &options->RunTesting) ||
242
243
244
245
    config_compare(list, "HiddenServiceDir", CONFIG_TYPE_LINELIST, &options->RendConfigLines)||
    config_compare(list, "HiddenServicePort", CONFIG_TYPE_LINELIST, &options->RendConfigLines)||
    config_compare(list, "HiddenServiceNodes", CONFIG_TYPE_LINELIST, &options->RendConfigLines)||
    config_compare(list, "HiddenServiceExcludeNodes", CONFIG_TYPE_LINELIST, &options->RendConfigLines)
246
247
248
    ) {
      /* then we're ok. it matched something. */
    } else {
249
250
      log_fn(LOG_WARN,"Unknown keyword '%s'. Failing.",list->key);
      return -1;
251
252
253
    }

    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
254
  }
255
  return 0;
256
257
}

258
259
260
/* XXX are there any other specifiers we want to give so making
 * a several-thousand-byte string is less painful? */
const char default_dirservers_string[] =
261
262
263
264
"router moria1 18.244.0.188 9001 9021 9031\n"
"platform Tor 0.0.6rc1 on Linux moria.mit.edu i686\n"
"published 2004-04-25 21:54:28\n"
"bandwidth 800000 10000000\n"
265
266
267
268
269
270
271
272
273
274
275
276
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBANoIvHieyHUTzIacbnWOnyTyzGrLOdXqbcjz2GGMxyHEd5K1bO1ZBNHP\n"
"9i5qLQpN5viFk2K2rEGuG8tFgDEzSWZEtBqv3NVfUdiumdERWMBwlaQ0MVK4C+jf\n"
"y5gZ8KI3o9ZictgPS1AQF+Kk932/vIHTuRIUKb4ILTnQilNvID0NAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBAMHa0ZC/jo2Q2DrwKYF/6ZbmZ27PFYG91u4gUzzmZ/VXLpZ8wNzEV3oW\n"
"nt+I61048fBiC1frT1/DZ351n2bLSk9zJbB6jyGZJn0380FPRX3+cXyXS0Gq8Ril\n"
"xkhMQf5XuNFUb8UmYPSOH4WErjvYjKvU+gfjbK/82Jo9SuHpYz+BAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
"reject 0.0.0.0/255.0.0.0:*\n"
"reject 169.254.0.0/255.255.0.0:*\n"
"reject 127.0.0.0/255.0.0.0:*\n"
"reject 192.168.0.0/255.255.0.0:*\n"
"reject 10.0.0.0/255.0.0.0:*\n"
"reject 172.16.0.0/255.240.0.0:*\n"
"accept *:20-22\n"
"accept *:53\n"
"accept *:79-80\n"
"accept *:110\n"
"accept *:143\n"
"accept *:443\n"
"accept *:873\n"
"accept *:993\n"
"accept *:995\n"
"accept *:1024-65535\n"
"reject *:*\n"
294
295
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
296
297
298
"o1eAoRHDAEAXsnh5wN++vIwrupd+DbAJ2p3wxHDrmqxTpygzxxCnyQyhMfX03ua2\n"
"4iplyNlwyFwzWcw0sk31otlO2HBYXT1V9G0YxGtKMOeOBMHjfGbUjGvEALHzWi4z\n"
"8DXGJp13zgnUyP4ZA6xaGROwcT6oB5e7UlztvvpGxTg=\n"
299
300
"-----END SIGNATURE-----\n"
"\n"
301
302
303
304
"router moria2 18.244.0.188 9002 9022 9032\n"
"platform Tor 0.0.6rc1 on Linux moria.mit.edu i686\n"
"published 2004-04-25 21:54:30\n"
"bandwidth 800000 10000000\n"
305
306
307
308
309
310
311
312
313
314
315
316
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBAM4Cc/npgYC54XrYLC+grVxJp7PDmNO2DRRJOxKttBBtvLpnR1UaueTi\n"
"kyknT5kmlx+ihgZF/jmye//2dDUp2+kK/kSkpRV4xnDLXZmed+sNSQxqmm9TtZQ9\n"
"/hjpxhp5J9HmUTYhntBs+4E4CUKokmrI6oRLoln4SA39AX9QLPcnAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBAOcrht/y5rkaahfX7sMe2qnpqoPibsjTSJaDvsUtaNP/Bq0MgNDGOR48\n"
"rtwfqTRff275Edkp/UYw3G3vSgKCJr76/bqOHCmkiZrnPV1zxNfrK18gNw2Cxre0\n"
"nTA+fD8JQqpPtb8b0SnG9kwy75eS//sRu7TErie2PzGMxrf9LH0LAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
"reject 0.0.0.0/255.0.0.0:*\n"
"reject 169.254.0.0/255.255.0.0:*\n"
"reject 127.0.0.0/255.0.0.0:*\n"
"reject 192.168.0.0/255.255.0.0:*\n"
"reject 10.0.0.0/255.0.0.0:*\n"
"reject 172.16.0.0/255.240.0.0:*\n"
"accept *:20-22\n"
"accept *:53\n"
"accept *:79-80\n"
"accept *:110\n"
"accept *:143\n"
"accept *:443\n"
"accept *:873\n"
"accept *:993\n"
"accept *:995\n"
"accept *:1024-65535\n"
"reject *:*\n"
334
335
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
336
337
338
"RKROLwP1ExjTZeg6wuN0pzYqed9IJUd5lAe9hp4ritbnmJAgS6qfww6jgx61CfUR\n"
"6SElhOLE7Q77jAdoL45Ji5pn/Y+Q+E+5lJm1E/ed9ha+YsOPaOc7z6GQ7E4mihCL\n"
"gI1vsw92+P1Ty4RHj6fyD9DhbV19nh2Qs+pvGJOS2FY=\n"
339
340
"-----END SIGNATURE-----\n"
"\n"
341
342
343
344
"router tor26 62.116.124.106 9001 9050 9030\n"
"platform Tor 0.0.6 on Linux seppia i686\n"
"published 2004-05-06 21:33:23\n"
"bandwidth 500000 10000000\n"
345
346
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
347
348
349
"MIGJAoGBAMEHdDnpj3ik1AF1xe/VqjoguH2DbANifYqXXfempu0fS+tU9FGo6dU/\n"
"fnVHAZwL9Ek9k2rMzumShi1RduK9p035R/Gk+PBBcLfvwYJ/Nat+ZO/L8jn/3bZe\n"
"ieQd9CKj2LjNGKpRNry37vkwMGIOIlegwK+2us8aXJ7sIvlNts0TAgMBAAE=\n"
350
351
352
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
353
354
355
"MIGJAoGBAMQgV2gXLbXgesWgeAsj8P1Uvm/zibrFXqwDq27lLKNgWGYGX2ax3LyT\n"
"3nzI1Y5oLs4kPKTsMM5ft9aokwf417lKoCRlZc9ptfRbgxDx90c9GtWVmkrmDvCK\n"
"ae59TMoXIiGfZiwWT6KKq5Zm9/Fu2Il3B2vHGkKJYKixmiBJRKp/AgMBAAE=\n"
356
"-----END RSA PUBLIC KEY-----\n"
357
358
359
"accept 62.245.184.24:25\n"
"accept 62.116.124.106:6666-6670\n"
"accept *:48099\n"
360
"reject *:*\n"
361
362
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
363
364
365
"qh/xRoqfLNFzPaB8VdpbdMAwRyuk5qjx4LeLVQ2pDwTZ55PqmG99+VKUNte2WTTD\n"
"7dZEA7um2rueohGe4nYmvbhJWr20/I0ZxmWDRDvFy0b5nwzDMGvLvDw95Zu/XJQ2\n"
"md32NE3y9VZCfbCN+GlvETX3fdR3Svzcm8Kzesg2/s4=\n"
366
367
368
"-----END SIGNATURE-----\n"
;

369
int config_assign_default_dirservers(void) {
370
  if(router_load_routerlist_from_string(default_dirservers_string, 1) < 0) {
371
372
373
374
375
376
    log_fn(LOG_WARN,"Bug: the default dirservers internal string is corrupt.");
    return -1;
  }
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
377
378
379
380
/** Set <b>options</b> to a reasonable default.
 *
 * Call this function when they're using the default torrc but
 * we can't find it. For now, we just hard-code what comes in the
381
382
383
384
385
386
387
388
 * default torrc.
 */
static int config_assign_default(or_options_t *options) {

  /* set them up as a client only */
  options->SocksPort = 9050;

  /* plus give them a dirservers file */
389
  if(config_assign_default_dirservers() < 0)
390
391
392
393
    return -1;
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
394
/** Print a usage message for tor. */
395
static void print_usage(void) {
396
  printf("tor -f <torrc> [args]\n"
397
         "See man page for more options. This -h is probably obsolete.\n\n"
398
         "-b <bandwidth>\t\tbytes/second rate limiting\n"
399
         "-d <file>\t\tDebug file\n"
400
//         "-m <max>\t\tMax number of connections\n"
401
402
403
404
         "-l <level>\t\tLog level\n"
         "-r <file>\t\tList of known routers\n");
  printf("\nClient options:\n"
         "-e \"nick1 nick2 ...\"\t\tExit nodes\n"
405
         "-s <IP>\t\t\tPort to bind to for Socks\n"
406
         );
407
408
  printf("\nServer options:\n"
         "-n <nick>\t\tNickname of router\n"
409
410
411
         "-o <port>\t\tOR port to bind to\n"
         "-p <file>\t\tPID file\n"
         );
412
413
}

Nick Mathewson's avatar
Nick Mathewson committed
414
415
416
/**
 * Adjust <b>options</b> to contain a reasonable value for Address.
 */
417
static int resolve_my_address(or_options_t *options) {
418
419
420
  struct in_addr in;
  struct hostent *rent;
  char localhostname[256];
421
  int explicit_ip=1;
422
423

  if(!options->Address) { /* then we need to guess our address */
424
    explicit_ip = 0; /* it's implicit */
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442

    if(gethostname(localhostname,sizeof(localhostname)) < 0) {
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
#if 0 /* don't worry about complaining, as long as it resolves */
    if(!strchr(localhostname,'.')) {
      log_fn(LOG_WARN,"fqdn '%s' has only one element. Misconfigured machine?",address);
      log_fn(LOG_WARN,"Try setting the Address line in your config file.");
      return -1;
    }
#endif
    options->Address = tor_strdup(localhostname);
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",options->Address);
  }

  /* now we know options->Address is set. resolve it and keep only the IP */

443
444
445
446
447
448
449
450
  if(tor_inet_aton(options->Address, &in) == 0) {
    /* then we have to resolve it */
    explicit_ip = 0;
    rent = (struct hostent *)gethostbyname(options->Address);
    if (!rent) {
      log_fn(LOG_WARN,"Could not resolve Address %s. Failing.", options->Address);
      return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
451
    tor_assert(rent->h_length == 4);
452
    memcpy(&in.s_addr, rent->h_addr,rent->h_length);
453
  }
454
  if(!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
455
    log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
456
           "Please set the Address config option to be the IP you want to use.",
457
458
459
460
461
462
463
464
465
           options->Address, inet_ntoa(in));
    return -1;
  }
  tor_free(options->Address);
  options->Address = tor_strdup(inet_ntoa(in));
  log_fn(LOG_DEBUG,"Resolved Address to %s.", options->Address);
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
466
/** Release storage held by <b>options</b> */
467
static void free_options(or_options_t *options) {
468
  config_free_lines(options->LogOptions);
469
470
471
472
473
474
  tor_free(options->DebugLogFile);
  tor_free(options->DataDirectory);
  tor_free(options->RouterFile);
  tor_free(options->Nickname);
  tor_free(options->Address);
  tor_free(options->PidFile);
475
476
  tor_free(options->ExitNodes);
  tor_free(options->EntryNodes);
477
  tor_free(options->ExcludeNodes);
478
479
  tor_free(options->RendNodes);
  tor_free(options->RendExcludeNodes);
480
  tor_free(options->ExitPolicy);
481
482
  tor_free(options->SocksBindAddress);
  tor_free(options->ORBindAddress);
483
  tor_free(options->DirBindAddress);
484
  tor_free(options->RecommendedVersions);
485
486
  tor_free(options->User);
  tor_free(options->Group);
487
  config_free_lines(options->RendConfigLines);
488
}
489

Nick Mathewson's avatar
Nick Mathewson committed
490
/** Set <b>options</b> to hold reasonable defaults for most options. */
491
static void init_options(or_options_t *options) {
492
/* give reasonable values for each option. Defaults to zero. */
493
  memset(options,0,sizeof(or_options_t));
494
  options->LogOptions = NULL;
495
496
  options->ExitNodes = tor_strdup("");
  options->EntryNodes = tor_strdup("");
497
  options->ExcludeNodes = tor_strdup("");
498
499
  options->RendNodes = tor_strdup("");
  options->RendExcludeNodes = tor_strdup("");
500
  options->ExitPolicy = tor_strdup("");
501
502
  options->SocksBindAddress = tor_strdup("127.0.0.1");
  options->ORBindAddress = tor_strdup("0.0.0.0");
503
  options->DirBindAddress = tor_strdup("0.0.0.0");
504
  options->RecommendedVersions = NULL;
505
  options->PidFile = NULL; // tor_strdup("tor.pid");
506
  options->DataDirectory = NULL;
507
  options->PathlenCoinWeight = 0.3;
508
  options->MaxConn = 900;
509
  options->DirFetchPostPeriod = 600;
510
  options->KeepalivePeriod = 300;
511
  options->MaxOnionsPending = 100;
512
  options->NewCircuitPeriod = 30; /* twice a minute */
513
514
  options->BandwidthRate = 800000; /* at most 800kB/s total sustained incoming */
  options->BandwidthBurst = 10000000; /* max burst on the token bucket */
515
  options->NumCpus = 1;
516
  options->RendConfigLines = NULL;
517
518
}

Nick Mathewson's avatar
Nick Mathewson committed
519
520
521
/** Read a configuration file into <b>options</b>, finding the configuration
 * file location based on the command line.  After loading the options,
 * validate them for consistency. Return 0 if success, <0 if failure. */
522
int getconfig(int argc, char **argv, or_options_t *options) {
523
  struct config_line_t *cl;
524
525
526
527
  FILE *cf;
  char *fname;
  int i;
  int result = 0;
528
529
530
531
532
  static int first_load = 1;
  static char **backup_argv;
  static int backup_argc;
  char *previous_pidfile = NULL;
  int previous_runasdaemon = 0;
533
  int previous_orport = -1;
534
  int using_default_torrc;
535
536
537
538
539
540
541
542
543
544

  if(first_load) { /* first time we're called. save commandline args */
    backup_argv = argv;
    backup_argc = argc;
    first_load = 0;
  } else { /* we're reloading. need to clean up old ones first. */
    argv = backup_argv;
    argc = backup_argc;

    /* record some previous values, so we can fail if they change */
545
546
    if(options->PidFile)
      previous_pidfile = tor_strdup(options->PidFile);
547
    previous_runasdaemon = options->RunAsDaemon;
548
    previous_orport = options->ORPort;
549
550
    free_options(options);
  }
Roger Dingledine's avatar
Roger Dingledine committed
551
  init_options(options);
552

553
554
555
556
557
  if(argc > 1 && (!strcmp(argv[1], "-h") || !strcmp(argv[1],"--help"))) {
    print_usage();
    exit(0);
  }

558
559
560
561
562
  if(argc > 1 && (!strcmp(argv[1],"--version"))) {
    printf("Tor version %s.\n",VERSION);
    exit(0);
  }

563
564
565
566
567
568
/* learn config file name, get config lines, assign them */
  i = 1;
  while(i < argc-1 && strcmp(argv[i],"-f")) {
    i++;
  }
  if(i < argc-1) { /* we found one */
569
    fname = argv[i+1];
570
    using_default_torrc = 0;
571
572
  } else { /* didn't find one, try CONFDIR */
    fname = CONFDIR "/torrc";
573
    using_default_torrc = 1;
574
575
576
577
  }
  log(LOG_DEBUG,"Opening config file '%s'",fname);

  cf = config_open(fname);
578
  if(!cf) {
579
    if(using_default_torrc == 1) {
580
      log(LOG_NOTICE, "Configuration file '%s' not present, using reasonable defaults.",fname);
581
582
583
584
585
586
587
588
589
      if(config_assign_default(options) < 0)
        return -1;
    } else {
      log(LOG_WARN, "Unable to open configuration file '%s'.",fname);
      return -1;
    }
  } else { /* it opened successfully. use it. */
    cl = config_get_lines(cf);
    if(!cl) return -1;
590
591
    if(config_assign(options,cl) < 0)
      return -1;
592
593
    config_free_lines(cl);
    config_close(cf);
594
  }
595

596
597
/* go through command-line variables too */
  cl = config_get_commandlines(argc,argv);
598
599
  if(config_assign(options,cl) < 0)
    return -1;
600
601
602
603
  config_free_lines(cl);

/* Validate options */

604
  /* first check if any of the previous options have changed but aren't allowed to */
605
606
607
608
609
610
611
612
613
614
615
616
  if(previous_pidfile && strcmp(previous_pidfile,options->PidFile)) {
    log_fn(LOG_WARN,"During reload, PidFile changed from %s to %s. Failing.",
           previous_pidfile, options->PidFile);
    return -1;
  }
  tor_free(previous_pidfile);

  if(previous_runasdaemon && !options->RunAsDaemon) {
    log_fn(LOG_WARN,"During reload, change from RunAsDaemon=1 to =0 not allowed. Failing.");
    return -1;
  }

617
  if(previous_orport == 0 && options->ORPort > 0) {
Roger Dingledine's avatar
Roger Dingledine committed
618
    log_fn(LOG_WARN,"During reload, change from ORPort=0 to >0 not allowed. Failing.");
619
620
621
    return -1;
  }

622
  if(options->ORPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
623
    log(LOG_WARN,"ORPort option can't be negative.");
624
625
626
    result = -1;
  }

627
628
  if(options->ORPort && options->DataDirectory == NULL) {
    log(LOG_WARN,"DataDirectory option required if ORPort is set, but not found.");
629
630
631
    result = -1;
  }

632
633
634
635
  if (options->ORPort) {
    if (options->Nickname == NULL) {
      log_fn(LOG_WARN,"Nickname required if ORPort is set, but not found.");
      result = -1;
636
637
638
639
640
641
642
643
644
645
646
    } else {
      if (strspn(options->Nickname, LEGAL_NICKNAME_CHARACTERS) !=
                 strlen(options->Nickname)) {
        log_fn(LOG_WARN, "Nickname '%s' contains illegal characters.", options->Nickname);
        result = -1;
      }
      if (strlen(options->Nickname) > MAX_NICKNAME_LEN) {
        log_fn(LOG_WARN, "Nickname '%s' has more than %d characters.",
               options->Nickname, MAX_NICKNAME_LEN);
        result = -1;
      }
647
    }
648
649
  }

650
  if(options->ORPort) { /* get an IP for ourselves */
651
652
    if(resolve_my_address(options) < 0)
      result = -1;
653
654
  }

655
656
  if(options->SocksPort < 0) {
    log(LOG_WARN,"SocksPort option can't be negative.");
657
658
659
    result = -1;
  }

660
661
662
  if(options->SocksPort == 0 && options->ORPort == 0) {
    log(LOG_WARN,"SocksPort and ORPort are both undefined? Quitting.");
    result = -1;
Roger Dingledine's avatar
Roger Dingledine committed
663
  }
664

665
  if(options->DirPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
666
    log(LOG_WARN,"DirPort option can't be negative.");
667
668
669
    result = -1;
  }

670
671
672
673
674
  if(options->DirPort && options->RecommendedVersions == NULL) {
    log(LOG_WARN,"Directory servers must configure RecommendedVersions.");
    result = -1;
  }

675
  if(options->SocksPort > 1 &&
676
677
     (options->PathlenCoinWeight < 0.0 || options->PathlenCoinWeight >= 1.0)) {
    log(LOG_WARN,"PathlenCoinWeight option must be >=0.0 and <1.0.");
678
679
680
    result = -1;
  }

681
  if(options->MaxConn < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
682
    log(LOG_WARN,"MaxConn option must be a non-zero positive integer.");
683
684
685
686
    result = -1;
  }

  if(options->MaxConn >= MAXCONNECTIONS) {
Roger Dingledine's avatar
Roger Dingledine committed
687
    log(LOG_WARN,"MaxConn option must be less than %d.", MAXCONNECTIONS);
688
689
690
    result = -1;
  }

691
  if(options->DirFetchPostPeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
692
    log(LOG_WARN,"DirFetchPostPeriod option must be positive.");
693
694
    result = -1;
  }
695
696
697
698
  if(options->DirFetchPostPeriod > MIN_ONION_KEY_LIFETIME/2) {
    log(LOG_WARN,"DirFetchPostPeriod is too large; clipping.");
    options->DirFetchPostPeriod = MIN_ONION_KEY_LIFETIME/2;
  }
699
700

  if(options->KeepalivePeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
701
    log(LOG_WARN,"KeepalivePeriod option must be positive.");
702
703
704
    result = -1;
  }

705
706
707
708
  /* XXX look at the various nicknamelists and make sure they're
   * valid and don't have hostnames that are too long.
   */

709
710
711
712
  if (rend_config_services(options) < 0) {
    result = -1;
  }

713
  return result;
714
715
}

716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
static void add_single_log(struct config_line_t *level_opt,
                           struct config_line_t *file_opt,
                           int isDaemon)
{
  int levelMin=-1, levelMax=-1;
  char *cp, *tmp_sev;

  if (level_opt) {
    cp = strchr(level_opt->value, '-');
    if (cp) {
      tmp_sev = tor_strndup(level_opt->value, cp - level_opt->value);
      levelMin = parse_log_level(tmp_sev);
      if (levelMin<0) {
        log_fn(LOG_WARN, "Unrecognized log severity %s: must be one of err|warn|notice|info|debug", tmp_sev);
      }
      tor_free(tmp_sev);
      levelMax = parse_log_level(cp+1);
      if (levelMax<0) {
        log_fn(LOG_WARN, "Unrecognized log severity %s: must be one of err|warn|notice|info|debug", cp+1);
      }
    } else {
      levelMin = parse_log_level(level_opt->value);
      if (levelMin<0) {
        log_fn(LOG_WARN, "Unrecognized log severity %s: must be one of err|warn|notice|info|debug", level_opt->value);
      }
    }
  }
  if (levelMin < 0 && levelMax < 0) {
    levelMin = LOG_NOTICE;
    levelMax = LOG_ERR;
  } else if (levelMin < 0) {
    levelMin = levelMax;
  } else {
    levelMax = LOG_ERR;
  }
  if (file_opt) {
    if (add_file_log(levelMin, levelMax, file_opt->value) < 0) {
      /* opening the log file failed!  Use stderr and log a warning */
      add_stream_log(levelMin, levelMax, "<stderr>", stderr);
      log_fn(LOG_WARN, "Cannot write to LogFile '%s': %s.", file_opt->value,
             strerror(errno));
    }
    log_fn(LOG_NOTICE, "Successfully opened LogFile '%s', redirecting output.",
           file_opt->value);
  } else if (!isDaemon) {
    add_stream_log(levelMin, levelMax, "<stderr>", stderr);
  }
}

/**
 * Initialize the logs based on the configuration file.
 */
void config_init_logs(or_options_t *options)
{
  /* The order of options is:  Level? (File Level?)+
   */
  struct config_line_t *opt = options->LogOptions;

  /* Special case for if first option is LogLevel. */
  if (opt && !strcasecmp(opt->key, "LogLevel")) {
    if (opt->next && !strcasecmp(opt->next->key, "LogFile")) {
      add_single_log(opt, opt->next, options->RunAsDaemon);
      opt = opt->next->next;
    } else if (!opt->next) {
      add_single_log(opt, NULL, options->RunAsDaemon);
      return;
    } else {
      opt = opt->next;
    }
  }

  while (opt) {
    if (!strcasecmp(opt->key, "LogLevel")) {
      log_fn(LOG_WARN, "Two LogLevel options in a row without intervening LogFile");
      opt = opt->next;
    } else {
      assert(!strcasecmp(opt->key, "LogFile"));
      if (opt->next && !strcasecmp(opt->next->key, "LogLevel")) {
        /* LogFile followed by LogLevel */
        add_single_log(opt->next, opt, options->RunAsDaemon);
        opt = opt->next->next;
      } else {
        /* LogFile followed by LogFile or end of list. */
        add_single_log(NULL, opt, options->RunAsDaemon);
        opt = opt->next;
      }
    }
  }

  if (options->DebugLogFile) {
    log_fn(LOG_WARN, "DebugLogFile is deprecated; use LogFile and LogLevel instead");
    add_file_log(LOG_DEBUG, LOG_ERR, options->DebugLogFile);
  }
}

811
812
813
814
815
816
817
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/