config.c 31 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
    config_compare(list, "Address",        CONFIG_TYPE_STRING, &options->Address) ||
191
    config_compare(list, "AuthoritativeDirectory",CONFIG_TYPE_BOOL, &options->AuthoritativeDir) ||
192

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

196
    config_compare(list, "ClientOnly",     CONFIG_TYPE_BOOL, &options->ClientOnly) ||
197
    config_compare(list, "ContactInfo",    CONFIG_TYPE_STRING, &options->ContactInfo) ||
198

199
    config_compare(list, "DebugLogFile",   CONFIG_TYPE_STRING, &options->DebugLogFile) ||
200
    config_compare(list, "DataDirectory",  CONFIG_TYPE_STRING, &options->DataDirectory) ||
201
    config_compare(list, "DirPort",        CONFIG_TYPE_INT, &options->DirPort) ||
202
    config_compare(list, "DirBindAddress", CONFIG_TYPE_LINELIST, &options->DirBindAddress) ||
203
204
    config_compare(list, "DirFetchPostPeriod",CONFIG_TYPE_INT, &options->DirFetchPostPeriod) ||

205
206
    config_compare(list, "ExitNodes",      CONFIG_TYPE_STRING, &options->ExitNodes) ||
    config_compare(list, "EntryNodes",     CONFIG_TYPE_STRING, &options->EntryNodes) ||
207
208
    config_compare(list, "StrictExitNodes", CONFIG_TYPE_BOOL, &options->StrictExitNodes) ||
    config_compare(list, "StrictEntryNodes", CONFIG_TYPE_BOOL, &options->StrictEntryNodes) ||
209
    config_compare(list, "ExitPolicy",     CONFIG_TYPE_LINELIST, &options->ExitPolicy) ||
210
    config_compare(list, "ExcludeNodes",   CONFIG_TYPE_STRING, &options->ExcludeNodes) ||
211

212
213
    config_compare(list, "FascistFirewall",CONFIG_TYPE_BOOL, &options->FascistFirewall) ||

214
    config_compare(list, "Group",          CONFIG_TYPE_STRING, &options->Group) ||
215

216
217
218
219
    config_compare(list, "IgnoreVersion",  CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||

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

220
221
    config_compare(list, "LogLevel",       CONFIG_TYPE_LINELIST, &options->LogOptions) ||
    config_compare(list, "LogFile",        CONFIG_TYPE_LINELIST, &options->LogOptions) ||
222
223
224
    config_compare(list, "LinkPadding",    CONFIG_TYPE_BOOL, &options->LinkPadding) ||

    config_compare(list, "MaxConn",        CONFIG_TYPE_INT, &options->MaxConn) ||
225
    config_compare(list, "MaxOnionsPending",CONFIG_TYPE_INT, &options->MaxOnionsPending) ||
226
227

    config_compare(list, "Nickname",       CONFIG_TYPE_STRING, &options->Nickname) ||
228
    config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_INT, &options->NewCircuitPeriod) ||
229
    config_compare(list, "NumCpus",        CONFIG_TYPE_INT, &options->NumCpus) ||
230

231
    config_compare(list, "ORPort",         CONFIG_TYPE_INT, &options->ORPort) ||
232
    config_compare(list, "ORBindAddress",  CONFIG_TYPE_LINELIST, &options->ORBindAddress) ||
233

234
    config_compare(list, "PidFile",        CONFIG_TYPE_STRING, &options->PidFile) ||
235
    config_compare(list, "PathlenCoinWeight",CONFIG_TYPE_DOUBLE, &options->PathlenCoinWeight) ||
236
237
238

    config_compare(list, "RouterFile",     CONFIG_TYPE_STRING, &options->RouterFile) ||
    config_compare(list, "RunAsDaemon",    CONFIG_TYPE_BOOL, &options->RunAsDaemon) ||
239
    config_compare(list, "RecommendedVersions",CONFIG_TYPE_STRING, &options->RecommendedVersions) ||
240
241
    config_compare(list, "RendNodes",      CONFIG_TYPE_STRING, &options->RendNodes) ||
    config_compare(list, "RendExcludeNodes",CONFIG_TYPE_STRING, &options->RendExcludeNodes) ||
242

243
    config_compare(list, "SocksPort",      CONFIG_TYPE_INT, &options->SocksPort) ||
244
245
    config_compare(list, "SocksBindAddress",CONFIG_TYPE_LINELIST,&options->SocksBindAddress) ||
    config_compare(list, "SocksPolicy",     CONFIG_TYPE_LINELIST,&options->SocksPolicy) ||
246
247
248

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

249
    config_compare(list, "User",           CONFIG_TYPE_STRING, &options->User) ||
250
    config_compare(list, "RunTesting",     CONFIG_TYPE_BOOL, &options->RunTesting) ||
251
252
253
254
    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)
255
256
257
    ) {
      /* then we're ok. it matched something. */
    } else {
258
259
      log_fn(LOG_WARN,"Unknown keyword '%s'. Failing.",list->key);
      return -1;
260
261
262
    }

    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
263
  }
264
  return 0;
265
266
}

267
const char default_dirservers_string[] =
268
269
270
271
"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"
272
273
274
275
276
277
278
279
280
281
282
283
"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"
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
"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"
301
302
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
303
304
305
"o1eAoRHDAEAXsnh5wN++vIwrupd+DbAJ2p3wxHDrmqxTpygzxxCnyQyhMfX03ua2\n"
"4iplyNlwyFwzWcw0sk31otlO2HBYXT1V9G0YxGtKMOeOBMHjfGbUjGvEALHzWi4z\n"
"8DXGJp13zgnUyP4ZA6xaGROwcT6oB5e7UlztvvpGxTg=\n"
306
307
"-----END SIGNATURE-----\n"
"\n"
308
309
310
311
"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"
312
313
314
315
316
317
318
319
320
321
322
323
"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"
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
"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"
341
342
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
343
344
345
"RKROLwP1ExjTZeg6wuN0pzYqed9IJUd5lAe9hp4ritbnmJAgS6qfww6jgx61CfUR\n"
"6SElhOLE7Q77jAdoL45Ji5pn/Y+Q+E+5lJm1E/ed9ha+YsOPaOc7z6GQ7E4mihCL\n"
"gI1vsw92+P1Ty4RHj6fyD9DhbV19nh2Qs+pvGJOS2FY=\n"
346
347
"-----END SIGNATURE-----\n"
"\n"
348
349
350
351
"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"
352
353
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
354
355
356
"MIGJAoGBAMEHdDnpj3ik1AF1xe/VqjoguH2DbANifYqXXfempu0fS+tU9FGo6dU/\n"
"fnVHAZwL9Ek9k2rMzumShi1RduK9p035R/Gk+PBBcLfvwYJ/Nat+ZO/L8jn/3bZe\n"
"ieQd9CKj2LjNGKpRNry37vkwMGIOIlegwK+2us8aXJ7sIvlNts0TAgMBAAE=\n"
357
358
359
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
360
361
362
"MIGJAoGBAMQgV2gXLbXgesWgeAsj8P1Uvm/zibrFXqwDq27lLKNgWGYGX2ax3LyT\n"
"3nzI1Y5oLs4kPKTsMM5ft9aokwf417lKoCRlZc9ptfRbgxDx90c9GtWVmkrmDvCK\n"
"ae59TMoXIiGfZiwWT6KKq5Zm9/Fu2Il3B2vHGkKJYKixmiBJRKp/AgMBAAE=\n"
363
"-----END RSA PUBLIC KEY-----\n"
364
365
366
"accept 62.245.184.24:25\n"
"accept 62.116.124.106:6666-6670\n"
"accept *:48099\n"
367
"reject *:*\n"
368
369
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
370
371
372
"qh/xRoqfLNFzPaB8VdpbdMAwRyuk5qjx4LeLVQ2pDwTZ55PqmG99+VKUNte2WTTD\n"
"7dZEA7um2rueohGe4nYmvbhJWr20/I0ZxmWDRDvFy0b5nwzDMGvLvDw95Zu/XJQ2\n"
"md32NE3y9VZCfbCN+GlvETX3fdR3Svzcm8Kzesg2/s4=\n"
373
374
375
"-----END SIGNATURE-----\n"
;

376
int config_assign_default_dirservers(void) {
377
  if(router_load_routerlist_from_string(default_dirservers_string, 1) < 0) {
378
379
380
381
382
383
    log_fn(LOG_WARN,"Bug: the default dirservers internal string is corrupt.");
    return -1;
  }
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
384
385
/** Set <b>options</b> to a reasonable default.
 *
Roger Dingledine's avatar
Roger Dingledine committed
386
 * Call this function when we can't find any torrc config file.
387
 */
Roger Dingledine's avatar
Roger Dingledine committed
388
static int config_assign_defaults(or_options_t *options) {
389
390
391
392

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

Roger Dingledine's avatar
Roger Dingledine committed
393
394
395
  config_free_lines(options->ExitPolicy);
  options->ExitPolicy = config_line_prepend(NULL, "ExitPolicy", "reject *:*");

396
  /* plus give them a dirservers file */
397
  if(config_assign_default_dirservers() < 0)
398
399
400
401
    return -1;
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
402
/** Print a usage message for tor. */
403
static void print_usage(void) {
404
  printf("tor -f <torrc> [args]\n"
405
         "See man page for more options. This -h is probably obsolete.\n\n"
406
         "-b <bandwidth>\t\tbytes/second rate limiting\n"
407
         "-d <file>\t\tDebug file\n"
408
//         "-m <max>\t\tMax number of connections\n"
409
410
411
412
         "-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"
413
         "-s <IP>\t\t\tPort to bind to for Socks\n"
414
         );
415
416
  printf("\nServer options:\n"
         "-n <nick>\t\tNickname of router\n"
417
418
419
         "-o <port>\t\tOR port to bind to\n"
         "-p <file>\t\tPID file\n"
         );
420
421
}

Nick Mathewson's avatar
Nick Mathewson committed
422
423
424
/**
 * Adjust <b>options</b> to contain a reasonable value for Address.
 */
425
static int resolve_my_address(or_options_t *options) {
426
427
428
  struct in_addr in;
  struct hostent *rent;
  char localhostname[256];
429
  int explicit_ip=1;
430
431

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

    if(gethostname(localhostname,sizeof(localhostname)) < 0) {
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
    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 */

444
445
446
447
448
449
450
451
  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
452
    tor_assert(rent->h_length == 4);
453
    memcpy(&in.s_addr, rent->h_addr,rent->h_length);
454
  }
455
  if(!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
456
    log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
457
           "Please set the Address config option to be the IP you want to use.",
458
459
460
461
462
463
464
465
466
           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;
}

467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
static char *get_default_nickname(void)
{
  char localhostname[256];
  char *cp, *out, *outp;

  if(gethostname(localhostname,sizeof(localhostname)) < 0) {
    log_fn(LOG_WARN,"Error obtaining local hostname");
    return NULL;
  }
  /* Put it in lowercase; stop at the first dot. */
  for(cp = localhostname; *cp; ++cp) {
    if (*cp == '.') {
      *cp = '\0';
      break;
    }
    *cp = tolower(*cp);
  }
  /* Strip invalid characters. */
  cp = localhostname;
  out = outp = tor_malloc(strlen(localhostname)+1);
  while (*cp) {
    if (strchr(LEGAL_NICKNAME_CHARACTERS, *cp))
      *outp++ = *cp++;
    else
      cp++;
  }
  *outp = '\0';
  /* Enforce length. */
  if (strlen(out) > MAX_NICKNAME_LEN)
    out[MAX_NICKNAME_LEN]='\0';

  return out;
}

Nick Mathewson's avatar
Nick Mathewson committed
501
/** Release storage held by <b>options</b> */
502
static void free_options(or_options_t *options) {
503
  config_free_lines(options->LogOptions);
504
  tor_free(options->ContactInfo);
505
506
507
508
509
510
  tor_free(options->DebugLogFile);
  tor_free(options->DataDirectory);
  tor_free(options->RouterFile);
  tor_free(options->Nickname);
  tor_free(options->Address);
  tor_free(options->PidFile);
511
512
  tor_free(options->ExitNodes);
  tor_free(options->EntryNodes);
513
  tor_free(options->ExcludeNodes);
514
515
  tor_free(options->RendNodes);
  tor_free(options->RendExcludeNodes);
516
  tor_free(options->RecommendedVersions);
517
518
  tor_free(options->User);
  tor_free(options->Group);
519
  config_free_lines(options->RendConfigLines);
520
521
522
523
524
  config_free_lines(options->SocksBindAddress);
  config_free_lines(options->ORBindAddress);
  config_free_lines(options->DirBindAddress);
  config_free_lines(options->ExitPolicy);
  config_free_lines(options->SocksPolicy);
525
}
526

Nick Mathewson's avatar
Nick Mathewson committed
527
/** Set <b>options</b> to hold reasonable defaults for most options. */
528
static void init_options(or_options_t *options) {
529
/* give reasonable values for each option. Defaults to zero. */
530
  memset(options,0,sizeof(or_options_t));
531
  options->LogOptions = NULL;
532
533
  options->ExitNodes = tor_strdup("");
  options->EntryNodes = tor_strdup("");
534
  options->StrictEntryNodes = options->StrictExitNodes = 0;
535
  options->ExcludeNodes = tor_strdup("");
536
537
  options->RendNodes = tor_strdup("");
  options->RendExcludeNodes = tor_strdup("");
538
539
540
541
542
  options->ExitPolicy = NULL;
  options->SocksPolicy = NULL;
  options->SocksBindAddress = NULL;
  options->ORBindAddress = NULL;
  options->DirBindAddress = NULL;
543
  options->RecommendedVersions = NULL;
544
  options->PidFile = NULL; // tor_strdup("tor.pid");
545
  options->DataDirectory = NULL;
546
  options->PathlenCoinWeight = 0.3;
547
  options->MaxConn = 900;
548
  options->DirFetchPostPeriod = 600;
549
  options->KeepalivePeriod = 300;
550
  options->MaxOnionsPending = 100;
551
  options->NewCircuitPeriod = 30; /* twice a minute */
552
553
  options->BandwidthRate = 800000; /* at most 800kB/s total sustained incoming */
  options->BandwidthBurst = 10000000; /* max burst on the token bucket */
554
  options->NumCpus = 1;
555
  options->RendConfigLines = NULL;
556
557
}

Nick Mathewson's avatar
Nick Mathewson committed
558
559
560
/** 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. */
561
int getconfig(int argc, char **argv, or_options_t *options) {
562
  struct config_line_t *cl;
563
564
565
566
  FILE *cf;
  char *fname;
  int i;
  int result = 0;
567
568
569
570
571
  static int first_load = 1;
  static char **backup_argv;
  static int backup_argc;
  char *previous_pidfile = NULL;
  int previous_runasdaemon = 0;
572
  int previous_orport = -1;
573
  int using_default_torrc;
574
575
576
577
578
579
580
581
582
583

  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 */
584
585
    if(options->PidFile)
      previous_pidfile = tor_strdup(options->PidFile);
586
    previous_runasdaemon = options->RunAsDaemon;
587
    previous_orport = options->ORPort;
588
589
    free_options(options);
  }
Roger Dingledine's avatar
Roger Dingledine committed
590
  init_options(options);
591

592
593
594
595
596
  if(argc > 1 && (!strcmp(argv[1], "-h") || !strcmp(argv[1],"--help"))) {
    print_usage();
    exit(0);
  }

597
598
599
600
601
  if(argc > 1 && (!strcmp(argv[1],"--version"))) {
    printf("Tor version %s.\n",VERSION);
    exit(0);
  }

602
603
604
605
606
607
/* 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 */
608
    fname = tor_strdup(argv[i+1]);
609
    using_default_torrc = 0;
610
611
612
613
614
615
616
617
618
619
620
621
  } else if (file_status(CONFDIR "/torrc")==FN_FILE) {
    /* didn't find one, try CONFDIR */
    fname = tor_strdup(CONFDIR "/torrc");
    using_default_torrc = 1;
  } else {
    char *fn = expand_filename("~/.torrc");
    if (file_status(fn)==FN_FILE) {
      fname = fn;
    } else {
      tor_free(fn);
      fname = tor_strdup(CONFDIR "/torrc");
    }
622
    using_default_torrc = 1;
623
624
625
626
  }
  log(LOG_DEBUG,"Opening config file '%s'",fname);

  cf = config_open(fname);
627
  if(!cf) {
628
    if(using_default_torrc == 1) {
629
      log(LOG_NOTICE, "Configuration file '%s' not present, using reasonable defaults.",fname);
630
631
      tor_free(fname);
      if(config_assign_defaults(options) < 0) {
632
        return -1;
633
      }
634
635
    } else {
      log(LOG_WARN, "Unable to open configuration file '%s'.",fname);
636
      tor_free(fname);
637
638
639
      return -1;
    }
  } else { /* it opened successfully. use it. */
640
    tor_free(fname);
641
642
    cl = config_get_lines(cf);
    if(!cl) return -1;
643
644
    if(config_assign(options,cl) < 0)
      return -1;
645
646
    config_free_lines(cl);
    config_close(cf);
647
  }
648

649
650
/* go through command-line variables too */
  cl = config_get_commandlines(argc,argv);
651
652
  if(config_assign(options,cl) < 0)
    return -1;
653
654
655
656
  config_free_lines(cl);

/* Validate options */

657
  /* first check if any of the previous options have changed but aren't allowed to */
658
659
660
661
662
663
664
665
666
667
668
669
  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;
  }

670
  if(previous_orport == 0 && options->ORPort > 0) {
Roger Dingledine's avatar
Roger Dingledine committed
671
    log_fn(LOG_WARN,"During reload, change from ORPort=0 to >0 not allowed. Failing.");
672
673
674
    return -1;
  }

675
  if(options->ORPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
676
    log(LOG_WARN,"ORPort option can't be negative.");
677
678
679
    result = -1;
  }

680
  if (options->Nickname == NULL) {
681
682
683
684
685
    if(server_mode()) {
      if (!(options->Nickname = get_default_nickname()))
        return -1;
      log_fn(LOG_NOTICE, "Choosing default nickname %s", options->Nickname);
    }
686
687
688
689
690
691
692
693
694
695
  } 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;
696
    }
697
698
  }

699
  if(server_mode()) { /* get an IP for ourselves */
700
701
    if(resolve_my_address(options) < 0)
      result = -1;
702
703
  }

704
705
  if(options->SocksPort < 0) {
    log(LOG_WARN,"SocksPort option can't be negative.");
706
707
708
    result = -1;
  }

709
710
711
  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
712
  }
713

714
  if(options->DirPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
715
    log(LOG_WARN,"DirPort option can't be negative.");
716
717
718
    result = -1;
  }

719
720
721
722
723
724
725
726
  if(options->StrictExitNodes && !strlen(options->ExitNodes)) {
    log(LOG_WARN,"StrictExitNodes set, but no ExitNodes listed.");
  }

  if(options->StrictEntryNodes && !strlen(options->EntryNodes)) {
    log(LOG_WARN,"StrictEntryNodes set, but no EntryNodes listed.");
  }

Roger Dingledine's avatar
Roger Dingledine committed
727
  if(options->AuthoritativeDir && options->RecommendedVersions == NULL) {
728
729
730
731
    log(LOG_WARN,"Directory servers must configure RecommendedVersions.");
    result = -1;
  }

732
733
734
735
736
  if(options->AuthoritativeDir && !options->DirPort) {
    log(LOG_WARN,"Running as authoritative directory, but no DirPort set.");
    result = -1;
  }

Roger Dingledine's avatar
Roger Dingledine committed
737
738
739
740
  if(options->AuthoritativeDir && !options->ORPort) {
    log(LOG_WARN,"Running as authoritative directory, but no ORPort set.");
    result = -1;
  }
741

Roger Dingledine's avatar
Roger Dingledine committed
742
743
744
745
  if(options->AuthoritativeDir && options->ClientOnly) {
    log(LOG_WARN,"Running as authoritative directory, but ClientOnly also set.");
    result = -1;
  }
746

747
  if(options->SocksPort >= 1 &&
748
749
     (options->PathlenCoinWeight < 0.0 || options->PathlenCoinWeight >= 1.0)) {
    log(LOG_WARN,"PathlenCoinWeight option must be >=0.0 and <1.0.");
750
751
752
    result = -1;
  }

753
  if(options->MaxConn < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
754
    log(LOG_WARN,"MaxConn option must be a non-zero positive integer.");
755
756
757
758
    result = -1;
  }

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

763
  if(options->DirFetchPostPeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
764
    log(LOG_WARN,"DirFetchPostPeriod option must be positive.");
765
766
    result = -1;
  }
767
768
769
770
  if(options->DirFetchPostPeriod > MIN_ONION_KEY_LIFETIME/2) {
    log(LOG_WARN,"DirFetchPostPeriod is too large; clipping.");
    options->DirFetchPostPeriod = MIN_ONION_KEY_LIFETIME/2;
  }
771
772

  if(options->KeepalivePeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
773
    log(LOG_WARN,"KeepalivePeriod option must be positive.");
774
775
776
    result = -1;
  }

777
778
779
780
  /* XXX look at the various nicknamelists and make sure they're
   * valid and don't have hostnames that are too long.
   */

781
782
783
784
  if (rend_config_services(options) < 0) {
    result = -1;
  }

785
  return result;
786
787
}

788
static int add_single_log(struct config_line_t *level_opt,
789
790
791
792
793
794
795
796
797
798
799
800
                           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) {
801
802
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", tmp_sev);
        return -1;
803
804
805
806
      }
      tor_free(tmp_sev);
      levelMax = parse_log_level(cp+1);
      if (levelMax<0) {
807
808
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", cp+1);
        return -1;
809
810
811
812
      }
    } else {
      levelMin = parse_log_level(level_opt->value);
      if (levelMin<0) {
813
814
815
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", level_opt->value);
        return -1;

816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
      }
    }
  }
  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) {
      log_fn(LOG_WARN, "Cannot write to LogFile '%s': %s.", file_opt->value,
             strerror(errno));
831
      return -1;
832
833
834
835
    }
    log_fn(LOG_NOTICE, "Successfully opened LogFile '%s', redirecting output.",
           file_opt->value);
  } else if (!isDaemon) {
836
    add_stream_log(levelMin, levelMax, "<stdout>", stdout);
837
    close_temp_logs();
838
  }
839
  return 0;
840
841
842
843
844
}

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

851
852
853
854
  /* Special case if no options are given. */
  if (!opt) {
    add_stream_log(LOG_NOTICE, LOG_ERR, "<stdout>", stdout);
    close_temp_logs();
Roger Dingledine's avatar
Roger Dingledine committed
855
856
    /* don't return yet, in case we want to do a debuglogfile below */
  }
857

858
859
860
  /* Special case for if first option is LogLevel. */
  if (opt && !strcasecmp(opt->key, "LogLevel")) {
    if (opt->next && !strcasecmp(opt->next->key, "LogFile")) {
861
862
      if (add_single_log(opt, opt->next, options->RunAsDaemon)<0)
        return -1;
863
864
      opt = opt->next->next;
    } else if (!opt->next) {
865
866
      if (add_single_log(opt, NULL, options->RunAsDaemon)<0)
        return -1;
867
      opt = opt->next;
868
869
    } else {
      ; /* give warning below */
870
871
872
873
874
875
876
877
    }
  }

  while (opt) {
    if (!strcasecmp(opt->key, "LogLevel")) {
      log_fn(LOG_WARN, "Two LogLevel options in a row without intervening LogFile");
      opt = opt->next;
    } else {
878
      tor_assert(!strcasecmp(opt->key, "LogFile"));
879
880
      if (opt->next && !strcasecmp(opt->next->key, "LogLevel")) {
        /* LogFile followed by LogLevel */
881
882
        if (add_single_log(opt->next, opt, options->RunAsDaemon)<0)
          return -1;
883
884
885
        opt = opt->next->next;
      } else {
        /* LogFile followed by LogFile or end of list. */
886
887
        if (add_single_log(NULL, opt, options->RunAsDaemon)<0)
          return -1;
888
889
890
891
892
893
894
        opt = opt->next;
      }
    }
  }

  if (options->DebugLogFile) {
    log_fn(LOG_WARN, "DebugLogFile is deprecated; use LogFile and LogLevel instead");
895
896
    if (add_file_log(LOG_DEBUG, LOG_ERR, options->DebugLogFile)<0)
      return -1;
897
  }
898
  return 0;
899
900
}

901
/** XXX008 DOCDOC */
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
void
config_parse_exit_policy(struct config_line_t *cfg,
                         struct exit_policy_t **dest)
{
  struct exit_policy_t **nextp;
  char *e, *s;
  int last=0;
  char line[1024];

  if (!cfg)
    return;
  nextp = dest;
  while (*nextp)
    nextp = &((*nextp)->next);

  for (; cfg; cfg = cfg->next) {
    s = cfg->value;
    for (;;) {
      e = strchr(s,',');
      if(!e) {
        last = 1;
        strncpy(line,s,1023);
      } else {
        memcpy(line,s, ((e-s)<1023)?(e-s):1023);
      line[e-s] = 0;
      }
      line[1023]=0;
      log_fn(LOG_DEBUG,"Adding new entry '%s'",line);
      *nextp = router_parse_exit_policy_from_string(line);
      if(*nextp) {
        nextp = &((*nextp)->next);
      } else {
        log_fn(LOG_WARN,"Malformed exit policy %s; skipping.", line);
      }
      if (last)
        break;
      s = e+1;
    }
  }
}

void exit_policy_free(struct exit_policy_t *p) {
  struct exit_policy_t *e;
  while (p) {
    e = p;
    p = p->next;
    tor_free(e->string);
    tor_free(e);
  }
}

953
954
955
956
const char *get_data_directory(or_options_t *options) {
  const char *d;
  if (options->DataDirectory)
    d = options->DataDirectory;
957
  else if (server_mode())
958
    d = "~/.tor";
959
960
961
  else
    d = NULL; /* XXX008 don't create datadir until we have something
                 we'll be putting in it */
962

963
  if (d && strncmp(d,"~/",2)==0) {
964
    char *fn = expand_filename(d);
965
    tor_free(options->DataDirectory);
966
    options->DataDirectory = fn;
967
968
969
970
  }
  return options->DataDirectory;
}

971
972
973
974
975
976
977
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/