config.c 34 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"
13
14
15
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
16

Nick Mathewson's avatar
Nick Mathewson committed
17
18
19
20
21
22
/** 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. */
23
24
  CONFIG_TYPE_CSV, /**< A list of strings, separated by commas and optional
                    * whitespace. */
Nick Mathewson's avatar
Nick Mathewson committed
25
26
  CONFIG_TYPE_LINELIST, /**< Uninterpreted config lines */
} config_type_t;
27

Nick Mathewson's avatar
Nick Mathewson committed
28
/** Largest allowed config line */
29
#define CONFIG_LINE_T_MAXLEN 4096
30
31
32

static FILE *config_open(const unsigned char *filename);
static int config_close(FILE *f);
33
34
35
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);
36
static int config_compare(struct config_line_t *c, const char *key, config_type_t type, void *arg);
37
static int config_assign(or_options_t *options, struct config_line_t *list);
38

Nick Mathewson's avatar
Nick Mathewson committed
39
/** Open a configuration file for reading */
40
static FILE *config_open(const unsigned char *filename) {
Roger Dingledine's avatar
Roger Dingledine committed
41
  tor_assert(filename);
42
43
44
45
46
47
48
  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
49
/** Close the configuration file */
50
static int config_close(FILE *f) {
Roger Dingledine's avatar
Roger Dingledine committed
51
  tor_assert(f);
52
53
54
  return fclose(f);
}

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

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

69
    new = tor_malloc(sizeof(struct config_line_t));
70
71
72
    s = argv[i];
    while(*s == '-')
      s++;
73
74
    new->key = tor_strdup(s);
    new->value = tor_strdup(argv[i+1]);
75
76
77
78
79
80
81
82
83
84

    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
85
86
/** Helper: allocate a new configuration option mapping 'key' to 'val',
 * prepend it to 'front', and return the newly allocated config_line_t */
87
88
89
90
91
92
93
94
95
96
97
98
99
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;
}

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

  struct config_line_t *front = NULL;
  char line[CONFIG_LINE_T_MAXLEN];
107
108
  int result;
  char *key, *value;
109

110
  while( (result=parse_line_from_file(line,sizeof(line),f,&key,&value)) > 0) {
111
    front = config_line_prepend(front, key, value);
Roger Dingledine's avatar
Roger Dingledine committed
112
  }
113
114
  if(result < 0)
    return NULL;
115
  return front;
Roger Dingledine's avatar
Roger Dingledine committed
116
117
}

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
134
135
136
137
138
/** 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.
 */
139
static int config_compare(struct config_line_t *c, const char *key, config_type_t type, void *arg) {
140
  int i;
141
142
143
144

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

145
146
147
148
149
  if(strcasecmp(c->key,key)) {
    tor_free(c->key);
    c->key = tor_strdup(key);
  }

150
  /* it's a match. cast and assign. */
151
  log_fn(LOG_DEBUG,"Recognized keyword '%s' as %s, using value '%s'.",c->key,key,c->value);
152
153

  switch(type) {
Roger Dingledine's avatar
Roger Dingledine committed
154
    case CONFIG_TYPE_INT:
155
      *(int *)arg = atoi(c->value);
156
      break;
157
158
159
    case CONFIG_TYPE_BOOL:
      i = atoi(c->value);
      if (i != 0 && i != 1) {
Roger Dingledine's avatar
Roger Dingledine committed
160
        log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1", c->key);
161
        return 0;
162
163
164
      }
      *(int *)arg = i;
      break;
165
    case CONFIG_TYPE_STRING:
166
      tor_free(*(char **)arg);
167
      *(char **)arg = tor_strdup(c->value);
168
      break;
169
170
    case CONFIG_TYPE_DOUBLE:
      *(double *)arg = atof(c->value);
171
      break;
172
    case CONFIG_TYPE_CSV:
173
174
      if(*(smartlist_t**)arg == NULL)
        *(smartlist_t**)arg = smartlist_create();
175
      smartlist_split_string(*(smartlist_t**)arg, c->value, ",", 1);
176
      break;
177
178
179
180
181
182
183
    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;
184
185
186
187
  }
  return 1;
}

Nick Mathewson's avatar
Nick Mathewson committed
188
189
/** Iterate through the linked list of options <b>list</b>.
 * For each item, convert as appropriate and assign to <b>options</b>.
190
191
 * If an item is unrecognized, return -1 immediately,
 * else return 0 for success. */
192
static int config_assign(or_options_t *options, struct config_line_t *list) {
193
194
195
196
197
198
199

  while(list) {
    if(

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

    /* string options */
200
    config_compare(list, "Address",        CONFIG_TYPE_STRING, &options->Address) ||
201
    config_compare(list, "AllowUnverifiedNodes", CONFIG_TYPE_CSV, &options->AllowUnverifiedNodes) ||
202
    config_compare(list, "AuthoritativeDirectory",CONFIG_TYPE_BOOL, &options->AuthoritativeDir) ||
203

204
205
206
    config_compare(list, "BandwidthRate",  CONFIG_TYPE_INT, &options->BandwidthRate) ||
    config_compare(list, "BandwidthBurst", CONFIG_TYPE_INT, &options->BandwidthBurst) ||

207
    config_compare(list, "ClientOnly",     CONFIG_TYPE_BOOL, &options->ClientOnly) ||
208
    config_compare(list, "ContactInfo",    CONFIG_TYPE_STRING, &options->ContactInfo) ||
209

210
    config_compare(list, "DebugLogFile",   CONFIG_TYPE_STRING, &options->DebugLogFile) ||
211
    config_compare(list, "DataDirectory",  CONFIG_TYPE_STRING, &options->DataDirectory) ||
212
    config_compare(list, "DirPort",        CONFIG_TYPE_INT, &options->DirPort) ||
213
    config_compare(list, "DirBindAddress", CONFIG_TYPE_LINELIST, &options->DirBindAddress) ||
214
215
    config_compare(list, "DirFetchPostPeriod",CONFIG_TYPE_INT, &options->DirFetchPostPeriod) ||

216
217
    config_compare(list, "ExitNodes",      CONFIG_TYPE_STRING, &options->ExitNodes) ||
    config_compare(list, "EntryNodes",     CONFIG_TYPE_STRING, &options->EntryNodes) ||
218
219
    config_compare(list, "StrictExitNodes", CONFIG_TYPE_BOOL, &options->StrictExitNodes) ||
    config_compare(list, "StrictEntryNodes", CONFIG_TYPE_BOOL, &options->StrictEntryNodes) ||
220
    config_compare(list, "ExitPolicy",     CONFIG_TYPE_LINELIST, &options->ExitPolicy) ||
221
    config_compare(list, "ExcludeNodes",   CONFIG_TYPE_STRING, &options->ExcludeNodes) ||
222

223
    config_compare(list, "FascistFirewall",CONFIG_TYPE_BOOL, &options->FascistFirewall) ||
224
    config_compare(list, "FirewallPorts",CONFIG_TYPE_CSV, &options->FirewallPorts) ||
225

226
    config_compare(list, "Group",          CONFIG_TYPE_STRING, &options->Group) ||
227

228
229
230
231
232
    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)||

233
234
235
236
    config_compare(list, "IgnoreVersion",  CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||

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

237
238
    config_compare(list, "LogLevel",       CONFIG_TYPE_LINELIST, &options->LogOptions) ||
    config_compare(list, "LogFile",        CONFIG_TYPE_LINELIST, &options->LogOptions) ||
239
240
241
    config_compare(list, "LinkPadding",    CONFIG_TYPE_BOOL, &options->LinkPadding) ||

    config_compare(list, "MaxConn",        CONFIG_TYPE_INT, &options->MaxConn) ||
242
    config_compare(list, "MaxOnionsPending",CONFIG_TYPE_INT, &options->MaxOnionsPending) ||
243
244

    config_compare(list, "Nickname",       CONFIG_TYPE_STRING, &options->Nickname) ||
245
    config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_INT, &options->NewCircuitPeriod) ||
246
    config_compare(list, "NumCpus",        CONFIG_TYPE_INT, &options->NumCpus) ||
247

248
    config_compare(list, "ORPort",         CONFIG_TYPE_INT, &options->ORPort) ||
249
    config_compare(list, "ORBindAddress",  CONFIG_TYPE_LINELIST, &options->ORBindAddress) ||
250
    config_compare(list, "OutboundBindAddress",CONFIG_TYPE_STRING, &options->OutboundBindAddress) ||
251

252
    config_compare(list, "PidFile",        CONFIG_TYPE_STRING, &options->PidFile) ||
253
    config_compare(list, "PathlenCoinWeight",CONFIG_TYPE_DOUBLE, &options->PathlenCoinWeight) ||
254
255
256

    config_compare(list, "RouterFile",     CONFIG_TYPE_STRING, &options->RouterFile) ||
    config_compare(list, "RunAsDaemon",    CONFIG_TYPE_BOOL, &options->RunAsDaemon) ||
257
    config_compare(list, "RunTesting",     CONFIG_TYPE_BOOL, &options->RunTesting) ||
258
    config_compare(list, "RecommendedVersions",CONFIG_TYPE_STRING, &options->RecommendedVersions) ||
259
260
    config_compare(list, "RendNodes",      CONFIG_TYPE_STRING, &options->RendNodes) ||
    config_compare(list, "RendExcludeNodes",CONFIG_TYPE_STRING, &options->RendExcludeNodes) ||
261

262
    config_compare(list, "SocksPort",      CONFIG_TYPE_INT, &options->SocksPort) ||
263
264
    config_compare(list, "SocksBindAddress",CONFIG_TYPE_LINELIST,&options->SocksBindAddress) ||
    config_compare(list, "SocksPolicy",     CONFIG_TYPE_LINELIST,&options->SocksPolicy) ||
265
266
267

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

268
269
270
    config_compare(list, "User",           CONFIG_TYPE_STRING, &options->User)


271
272
273
    ) {
      /* then we're ok. it matched something. */
    } else {
274
275
      log_fn(LOG_WARN,"Unknown keyword '%s'. Failing.",list->key);
      return -1;
276
277
278
    }

    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
279
  }
280
  return 0;
281
282
}

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

392
int config_assign_default_dirservers(void) {
393
  if(router_load_routerlist_from_string(default_dirservers_string, 1) < 0) {
394
395
396
397
398
399
    log_fn(LOG_WARN,"Bug: the default dirservers internal string is corrupt.");
    return -1;
  }
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
400
401
/** Set <b>options</b> to a reasonable default.
 *
Roger Dingledine's avatar
Roger Dingledine committed
402
 * Call this function when we can't find any torrc config file.
403
 */
Roger Dingledine's avatar
Roger Dingledine committed
404
static int config_assign_defaults(or_options_t *options) {
405
406
407
408

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

409
410
411
412
  options->AllowUnverifiedNodes = smartlist_create();
  smartlist_add(options->AllowUnverifiedNodes, "middle");
  smartlist_add(options->AllowUnverifiedNodes, "rendezvous");

Roger Dingledine's avatar
Roger Dingledine committed
413
414
415
  config_free_lines(options->ExitPolicy);
  options->ExitPolicy = config_line_prepend(NULL, "ExitPolicy", "reject *:*");

416
  /* plus give them a dirservers file */
417
  if(config_assign_default_dirservers() < 0)
418
419
420
421
    return -1;
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
422
/** Print a usage message for tor. */
423
static void print_usage(void) {
424
  printf("tor -f <torrc> [args]\n"
425
         "See man page for more options. This -h is probably obsolete.\n\n"
426
         "-b <bandwidth>\t\tbytes/second rate limiting\n"
427
         "-d <file>\t\tDebug file\n"
428
//         "-m <max>\t\tMax number of connections\n"
429
430
431
432
         "-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"
433
         "-s <IP>\t\t\tPort to bind to for Socks\n"
434
         );
435
436
  printf("\nServer options:\n"
         "-n <nick>\t\tNickname of router\n"
437
438
439
         "-o <port>\t\tOR port to bind to\n"
         "-p <file>\t\tPID file\n"
         );
440
441
}

Nick Mathewson's avatar
Nick Mathewson committed
442
443
444
/**
 * Adjust <b>options</b> to contain a reasonable value for Address.
 */
445
int resolve_my_address(const char *address, uint32_t *addr) {
446
447
  struct in_addr in;
  struct hostent *rent;
448
  char hostname[256];
449
  int explicit_ip=1;
450

451
452
453
454
455
  tor_assert(addr);

  if(address) {
    strlcpy(hostname,address,sizeof(hostname));
  } else { /* then we need to guess our address */
456
    explicit_ip = 0; /* it's implicit */
457

458
    if(gethostname(hostname,sizeof(hostname)) < 0) {
459
460
461
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
462
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",hostname);
463
464
  }

465
  /* now we know hostname. resolve it and keep only the IP */
466

467
  if(tor_inet_aton(hostname, &in) == 0) {
468
469
    /* then we have to resolve it */
    explicit_ip = 0;
470
    rent = (struct hostent *)gethostbyname(hostname);
471
    if (!rent) {
472
      log_fn(LOG_WARN,"Could not resolve local Address %s. Failing.", hostname);
473
474
      return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
475
    tor_assert(rent->h_length == 4);
476
    memcpy(&in.s_addr, rent->h_addr,rent->h_length);
477
  }
478
  if(!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
479
    log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
480
           "Please set the Address config option to be the IP you want to use.",
481
           hostname, inet_ntoa(in));
482
483
    return -1;
  }
484
485
  log_fn(LOG_DEBUG,"Resolved Address to %s.", inet_ntoa(in));
  *addr = ntohl(in.s_addr);
486
487
488
  return 0;
}

489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
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
523
/** Release storage held by <b>options</b> */
524
static void free_options(or_options_t *options) {
525
  config_free_lines(options->LogOptions);
526
  tor_free(options->ContactInfo);
527
528
529
530
531
532
  tor_free(options->DebugLogFile);
  tor_free(options->DataDirectory);
  tor_free(options->RouterFile);
  tor_free(options->Nickname);
  tor_free(options->Address);
  tor_free(options->PidFile);
533
534
  tor_free(options->ExitNodes);
  tor_free(options->EntryNodes);
535
  tor_free(options->ExcludeNodes);
536
537
  tor_free(options->RendNodes);
  tor_free(options->RendExcludeNodes);
538
  tor_free(options->OutboundBindAddress);
539
  tor_free(options->RecommendedVersions);
540
541
  tor_free(options->User);
  tor_free(options->Group);
542
  config_free_lines(options->RendConfigLines);
543
544
545
546
547
  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);
548
549
  SMARTLIST_FOREACH(options->FirewallPorts, char *, cp, tor_free(cp));
  smartlist_free(options->FirewallPorts);
550
}
551

Nick Mathewson's avatar
Nick Mathewson committed
552
/** Set <b>options</b> to hold reasonable defaults for most options. */
553
static void init_options(or_options_t *options) {
554
/* give reasonable values for each option. Defaults to zero. */
555
  memset(options,0,sizeof(or_options_t));
556
  options->LogOptions = NULL;
557
558
  options->ExitNodes = tor_strdup("");
  options->EntryNodes = tor_strdup("");
559
  options->StrictEntryNodes = options->StrictExitNodes = 0;
560
  options->ExcludeNodes = tor_strdup("");
561
562
  options->RendNodes = tor_strdup("");
  options->RendExcludeNodes = tor_strdup("");
563
564
565
566
567
  options->ExitPolicy = NULL;
  options->SocksPolicy = NULL;
  options->SocksBindAddress = NULL;
  options->ORBindAddress = NULL;
  options->DirBindAddress = NULL;
568
  options->OutboundBindAddress = NULL;
569
  options->RecommendedVersions = NULL;
570
  options->PidFile = NULL; // tor_strdup("tor.pid");
571
  options->DataDirectory = NULL;
572
  options->PathlenCoinWeight = 0.3;
573
  options->MaxConn = 900;
574
  options->DirFetchPostPeriod = 600;
575
  options->KeepalivePeriod = 300;
576
  options->MaxOnionsPending = 100;
577
  options->NewCircuitPeriod = 30; /* twice a minute */
578
579
  options->BandwidthRate = 800000; /* at most 800kB/s total sustained incoming */
  options->BandwidthBurst = 10000000; /* max burst on the token bucket */
580
  options->NumCpus = 1;
581
  options->RendConfigLines = NULL;
582
  options->FirewallPorts = NULL;
583
584
}

585
586
587
588
589
590
static char *get_default_conf_file(void)
{
#ifdef MS_WINDOWS
  char *path = tor_malloc(MAX_PATH);
  if (!SUCCEEDED(SHGetSpecialFolderPath(NULL, path, CSIDL_APPDATA, 1))) {
    tor_free(path);
Nick Mathewson's avatar
Nick Mathewson committed
591
    return NULL;
592
593
594
595
  }
  strlcat(path,"\\tor\\torrc",MAX_PATH);
  return path;
#else
596
  return tor_strdup(CONFDIR "/torrc");
597
598
599
#endif
}

Nick Mathewson's avatar
Nick Mathewson committed
600
601
602
/** 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. */
603
int getconfig(int argc, char **argv, or_options_t *options) {
604
  struct config_line_t *cl;
605
606
607
608
  FILE *cf;
  char *fname;
  int i;
  int result = 0;
609
610
611
612
613
  static int first_load = 1;
  static char **backup_argv;
  static int backup_argc;
  char *previous_pidfile = NULL;
  int previous_runasdaemon = 0;
614
  int previous_orport = -1;
615
  int using_default_torrc;
616
617
618
619
620
621
622
623
624
625

  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 */
626
627
    if(options->PidFile)
      previous_pidfile = tor_strdup(options->PidFile);
628
    previous_runasdaemon = options->RunAsDaemon;
629
    previous_orport = options->ORPort;
630
631
    free_options(options);
  }
Roger Dingledine's avatar
Roger Dingledine committed
632
  init_options(options);
633

634
635
636
637
638
  if(argc > 1 && (!strcmp(argv[1], "-h") || !strcmp(argv[1],"--help"))) {
    print_usage();
    exit(0);
  }

639
640
641
642
643
  if(argc > 1 && (!strcmp(argv[1],"--version"))) {
    printf("Tor version %s.\n",VERSION);
    exit(0);
  }

644
645
646
647
648
649
/* 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 */
650
    fname = tor_strdup(argv[i+1]);
651
    using_default_torrc = 0;
652
  } else {
653
    /* didn't find one, try CONFDIR */
Nick Mathewson's avatar
Nick Mathewson committed
654
655
656
    char *fn;
    using_default_torrc = 1;
    fn = get_default_conf_file();
657
    if (fn && file_status(fn)==FN_FILE) {
Nick Mathewson's avatar
Nick Mathewson committed
658
659
660
661
662
663
664
665
666
667
668
      fname = fn;
    } else {
      tor_free(fn);
      fn = expand_filename("~/.torrc");
      if (fn && file_status(fn)==FN_FILE) {
        fname = fn;
      } else {
        tor_free(fn);
        fname = get_default_conf_file();
      }
    }
669
670
671
672
  }
  log(LOG_DEBUG,"Opening config file '%s'",fname);

  cf = config_open(fname);
673
  if(!cf) {
674
    if(using_default_torrc == 1) {
675
      log(LOG_NOTICE, "Configuration file '%s' not present, using reasonable defaults.",fname);
676
677
      tor_free(fname);
      if(config_assign_defaults(options) < 0) {
678
        return -1;
679
      }
680
681
    } else {
      log(LOG_WARN, "Unable to open configuration file '%s'.",fname);
682
      tor_free(fname);
683
684
685
      return -1;
    }
  } else { /* it opened successfully. use it. */
686
    tor_free(fname);
687
688
    cl = config_get_lines(cf);
    if(!cl) return -1;
689
690
    if(config_assign(options,cl) < 0)
      return -1;
691
692
    config_free_lines(cl);
    config_close(cf);
693
  }
694

695
696
/* go through command-line variables too */
  cl = config_get_commandlines(argc,argv);
697
698
  if(config_assign(options,cl) < 0)
    return -1;
699
700
701
702
  config_free_lines(cl);

/* Validate options */

703
  /* first check if any of the previous options have changed but aren't allowed to */
704
705
706
707
708
709
710
711
712
713
714
715
  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;
  }

716
  if(previous_orport == 0 && options->ORPort > 0) {
Roger Dingledine's avatar
Roger Dingledine committed
717
    log_fn(LOG_WARN,"During reload, change from ORPort=0 to >0 not allowed. Failing.");
718
719
720
    return -1;
  }

721
  if(options->ORPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
722
    log(LOG_WARN,"ORPort option can't be negative.");
723
724
725
    result = -1;
  }

726
  if (options->Nickname == NULL) {
727
728
729
730
731
    if(server_mode()) {
      if (!(options->Nickname = get_default_nickname()))
        return -1;
      log_fn(LOG_NOTICE, "Choosing default nickname %s", options->Nickname);
    }
732
733
734
735
736
737
  } else {
    if (strspn(options->Nickname, LEGAL_NICKNAME_CHARACTERS) !=
        strlen(options->Nickname)) {
      log_fn(LOG_WARN, "Nickname '%s' contains illegal characters.", options->Nickname);
      result = -1;
    }
738
739
740
741
    if (strlen(options->Nickname) == 0) {
      log_fn(LOG_WARN, "Nickname must have at least one character");
      result = -1;
    }
742
743
744
745
    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;
746
    }
747
748
  }

749
750
751
752
  if(server_mode()) {
    /* confirm that our address isn't broken, so we can complain now */
    uint32_t tmp;
    if(resolve_my_address(options->Address, &tmp) < 0)
753
      result = -1;
754
755
  }

756
757
  if(options->SocksPort < 0) {
    log(LOG_WARN,"SocksPort option can't be negative.");
758
759
760
    result = -1;
  }

761
762
763
  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
764
  }
765

766
  if(options->DirPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
767
    log(LOG_WARN,"DirPort option can't be negative.");
768
769
770
    result = -1;
  }

771
772
773
774
775
776
777
778
  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
779
  if(options->AuthoritativeDir && options->RecommendedVersions == NULL) {
780
781
782
783
    log(LOG_WARN,"Directory servers must configure RecommendedVersions.");
    result = -1;
  }

784
785
786
787
788
  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
789
790
791
792
  if(options->AuthoritativeDir && !options->ORPort) {
    log(LOG_WARN,"Running as authoritative directory, but no ORPort set.");
    result = -1;
  }
793

Roger Dingledine's avatar
Roger Dingledine committed
794
795
796
797
  if(options->AuthoritativeDir && options->ClientOnly) {
    log(LOG_WARN,"Running as authoritative directory, but ClientOnly also set.");
    result = -1;
  }
798

799
800
801
802
803
804
805
  if(options->FascistFirewall && !options->FirewallPorts) {
    options->FirewallPorts = smartlist_create();
    smartlist_add(options->FirewallPorts, "80");
    smartlist_add(options->FirewallPorts, "443");
  }
  if(options->FirewallPorts) {
    SMARTLIST_FOREACH(options->FirewallPorts, const char *, cp,
806
    { i = atoi(cp);
807
      if (i < 1 || i > 65535) {
808
809
810
811
812
813
814
815
816
817
818
819
820
821
        log(LOG_WARN, "Port '%s' out of range in FirewallPorts", cp);
        result=-1;
      }
    });
  }
  options->_AllowUnverified = 0;
  if(options->AllowUnverifiedNodes) {
    SMARTLIST_FOREACH(options->AllowUnverifiedNodes, const char *, cp,
    { if (!strcasecmp(cp, "entry"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_ENTRY;
      else if (!strcasecmp(cp, "exit"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_EXIT;
      else if (!strcasecmp(cp, "middle"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_MIDDLE;
822
823
824
825
      else if (!strcasecmp(cp, "introduction"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_INTRODUCTION;
      else if (!strcasecmp(cp, "rendezvous"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_RENDEZVOUS;
826
827
828
      else {
        log(LOG_WARN, "Unrecognized value '%s' in AllowUnverifiedNodes",
            cp);
829
830
831
832
833
        result=-1;
      }
    });
  }

834
  if(options->SocksPort >= 1 &&
835
836
     (options->PathlenCoinWeight < 0.0 || options->PathlenCoinWeight >= 1.0)) {
    log(LOG_WARN,"PathlenCoinWeight option must be >=0.0 and <1.0.");
837
838
839
    result = -1;
  }

840
  if(options->MaxConn < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
841
    log(LOG_WARN,"MaxConn option must be a non-zero positive integer.");
842
843
844
845
    result = -1;
  }

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

850
  if(options->DirFetchPostPeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
851
    log(LOG_WARN,"DirFetchPostPeriod option must be positive.");
852
853
    result = -1;
  }
854
855
856
857
  if(options->DirFetchPostPeriod > MIN_ONION_KEY_LIFETIME/2) {
    log(LOG_WARN,"DirFetchPostPeriod is too large; clipping.");
    options->DirFetchPostPeriod = MIN_ONION_KEY_LIFETIME/2;
  }
858
859

  if(options->KeepalivePeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
860
    log(LOG_WARN,"KeepalivePeriod option must be positive.");
861
862
863
    result = -1;
  }

864
865
866
867
  /* XXX look at the various nicknamelists and make sure they're
   * valid and don't have hostnames that are too long.
   */

868
869
870
871
  if (rend_config_services(options) < 0) {
    result = -1;
  }

872
  return result;
873
874
}

875
static int add_single_log(struct config_line_t *level_opt,
876
877
878
879
880
881
882
883
884
885
886
887
                           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) {
888
889
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", tmp_sev);
        return -1;
890
891
892
893
      }
      tor_free(tmp_sev);
      levelMax = parse_log_level(cp+1);
      if (levelMax<0) {
894
895
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", cp+1);
        return -1;
896
897
898
899
      }
    } else {
      levelMin = parse_log_level(level_opt->value);
      if (levelMin<0) {
900
901
902
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", level_opt->value);
        return -1;

903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
      }
    }
  }
  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));
918
      return -1;
919
920
921
922
    }
    log_fn(LOG_NOTICE, "Successfully opened LogFile '%s', redirecting output.",
           file_opt->value);
  } else if (!isDaemon) {
923
    add_stream_log(levelMin, levelMax, "<stdout>", stdout);
924
    close_temp_logs();
925
  }
926
  return 0;
927
928
929
930
931
}

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

938
939
940
941
  /* 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
942
943
    /* don't return yet, in case we want to do a debuglogfile below */
  }
944

945
946
947
  /* Special case for if first option is LogLevel. */
  if (opt && !strcasecmp(opt->key, "LogLevel")) {
    if (opt->next && !strcasecmp(opt->next->key, "LogFile")) {
948
949
      if (add_single_log(opt, opt->next, options->RunAsDaemon)<0)
        return -1;
950
951
      opt = opt->next->next;
    } else if (!opt->next) {
952
953
      if (add_single_log(opt, NULL, options->RunAsDaemon)<0)
        return -1;
954
      opt = opt->next;
955
956
    } else {
      ; /* give warning below */
957
958
959
960
961
962
963
964
    }
  }

  while (opt) {
    if (!strcasecmp(opt->key, "LogLevel")) {
      log_fn(LOG_WARN, "Two LogLevel options in a row without intervening LogFile");
      opt = opt->next;
    } else {
965
      tor_assert(!strcasecmp(opt->key, "LogFile"));
966
967
      if (opt->next && !strcasecmp(opt->next->key, "LogLevel")) {
        /* LogFile followed by LogLevel */
968
969
        if (add_single_log(opt->next, opt, options->RunAsDaemon)<0)
          return -1;
970
971
972
        opt = opt->next->next;
      } else {
        /* LogFile followed by LogFile or end of list. */
973
974
        if (add_single_log(NULL, opt, options->RunAsDaemon)<0)
          return -1;
975
976
977
978
979
980
981
        opt = opt->next;
      }
    }
  }

  if (options->DebugLogFile) {
    log_fn(LOG_WARN, "DebugLogFile is deprecated; use LogFile and LogLevel instead");
982
983
    if (add_file_log(LOG_DEBUG, LOG_ERR, options->DebugLogFile)<0)
      return -1;
984
  }
985
  return 0;
986
987
}

988
/** XXX008 DOCDOC */
989
990
991
992
993
994
995
996
997
998
999
1000
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;