1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
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
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
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
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
|
/* Copyright 2001,2002,2003 Roger Dingledine, Matej Pfajfar. */
/* See LICENSE for licensing information */
/* $Id$ */
/**
* /file config.c
*
* /brief Code to parse and interpret configuration files.
*
**/
#include "or.h"
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
/** Enumeration of types which option values can take */
typedef enum config_type_t {
CONFIG_TYPE_STRING = 0, /**< An arbitrary string. */
CONFIG_TYPE_UINT, /**< A non-negative integer less than MAX_INT */
CONFIG_TYPE_DOUBLE, /**< A floating-point value */
CONFIG_TYPE_BOOL, /**< A boolean value, expressed as 0 or 1. */
CONFIG_TYPE_CSV, /**< A list of strings, separated by commas and optional
* whitespace. */
CONFIG_TYPE_LINELIST, /**< Uninterpreted config lines */
CONFIG_TYPE_OBSOLETE, /**< Obsolete (ignored) option. */
} config_type_t;
/** Largest allowed config line */
#define CONFIG_LINE_T_MAXLEN 4096
static struct config_line_t *config_get_commandlines(int argc, char **argv);
static int config_get_lines(FILE *f, struct config_line_t **result);
static void config_free_lines(struct config_line_t *front);
static int config_compare(struct config_line_t *c, const char *key, config_type_t type, void *arg);
static int config_assign(or_options_t *options, struct config_line_t *list);
static int parse_dir_server_line(const char *line);
static int parse_redirect_line(or_options_t *options,
struct config_line_t *line);
/** Helper: Read a list of configuration options from the command line. */
static struct config_line_t *
config_get_commandlines(int argc, char **argv)
{
struct config_line_t *new;
struct config_line_t *front = NULL;
char *s;
int i = 1;
while (i < argc-1) {
if (!strcmp(argv[i],"-f")) {
// log(LOG_DEBUG,"Commandline: skipping over -f.");
i += 2; /* this is the config file option. ignore it. */
continue;
}
new = tor_malloc(sizeof(struct config_line_t));
s = argv[i];
while(*s == '-')
s++;
new->key = tor_strdup(s);
new->value = tor_strdup(argv[i+1]);
log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
new->key, new->value);
new->next = front;
front = new;
i += 2;
}
return front;
}
/** Helper: allocate a new configuration option mapping 'key' to 'val',
* prepend it to 'front', and return the newly allocated config_line_t */
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;
}
/** Helper: parse the config file and strdup into key/value
* strings. Set *result to the list, or NULL if parsing the file
* failed. Return 0 on success, -1 on failure. Warn and ignore any
* misformatted lines. */
static int
config_get_lines(FILE *f, struct config_line_t **result)
{
struct config_line_t *front = NULL;
char line[CONFIG_LINE_T_MAXLEN];
int r;
char *key, *value;
while ((r = parse_line_from_file(line, sizeof(line), f, &key, &value)) > 0) {
front = config_line_prepend(front, key, value);
}
if (r < 0) {
*result = NULL;
return -1;
} else {
*result = front;
return 0;
}
}
/**
* Free all the configuration lines on the linked list <b>front</b>.
*/
static void
config_free_lines(struct config_line_t *front)
{
struct config_line_t *tmp;
while (front) {
tmp = front;
front = tmp->next;
tor_free(tmp->key);
tor_free(tmp->value);
tor_free(tmp);
}
}
/** 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.
*/
static int
config_compare(struct config_line_t *c, const char *key,
config_type_t type, void *arg)
{
int i, ok;
if (strncasecmp(c->key, key, strlen(c->key)))
return 0;
if (strcasecmp(c->key, key)) {
tor_free(c->key);
c->key = tor_strdup(key);
}
/* it's a match. cast and assign. */
log_fn(LOG_DEBUG, "Recognized keyword '%s' as %s, using value '%s'.",
c->key, key, c->value);
switch(type) {
case CONFIG_TYPE_UINT:
i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
if (!ok) {
log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds. Skipping.",
c->key,c->value);
return 0;
}
*(int *)arg = i;
break;
case CONFIG_TYPE_BOOL:
i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
if (!ok) {
log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1. Skipping.", c->key);
return 0;
}
*(int *)arg = i;
break;
case CONFIG_TYPE_STRING:
tor_free(*(char **)arg);
*(char **)arg = tor_strdup(c->value);
break;
case CONFIG_TYPE_DOUBLE:
*(double *)arg = atof(c->value);
break;
case CONFIG_TYPE_CSV:
if (*(smartlist_t**)arg == NULL)
*(smartlist_t**)arg = smartlist_create();
smartlist_split_string(*(smartlist_t**)arg, c->value, ",",
SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
break;
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;
case CONFIG_TYPE_OBSOLETE:
log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
break;
}
return 1;
}
/** Iterate through the linked list of options <b>list</b>.
* For each item, convert as appropriate and assign to <b>options</b>.
* If an item is unrecognized, return -1 immediately,
* else return 0 for success. */
static int
config_assign(or_options_t *options, struct config_line_t *list)
{
while (list) {
if (
/* order matters here! abbreviated arguments use the first match. */
/* string options */
config_compare(list, "Address", CONFIG_TYPE_STRING, &options->Address) ||
config_compare(list, "AllowUnverifiedNodes", CONFIG_TYPE_CSV, &options->AllowUnverifiedNodes) ||
config_compare(list, "AuthoritativeDirectory",CONFIG_TYPE_BOOL, &options->AuthoritativeDir) ||
config_compare(list, "BandwidthRate", CONFIG_TYPE_UINT, &options->BandwidthRate) ||
config_compare(list, "BandwidthBurst", CONFIG_TYPE_UINT, &options->BandwidthBurst) ||
config_compare(list, "ClientOnly", CONFIG_TYPE_BOOL, &options->ClientOnly) ||
config_compare(list, "ContactInfo", CONFIG_TYPE_STRING, &options->ContactInfo) ||
config_compare(list, "DebugLogFile", CONFIG_TYPE_STRING, &options->DebugLogFile) ||
config_compare(list, "DataDirectory", CONFIG_TYPE_STRING, &options->DataDirectory) ||
config_compare(list, "DirPort", CONFIG_TYPE_UINT, &options->DirPort) ||
config_compare(list, "DirBindAddress", CONFIG_TYPE_LINELIST, &options->DirBindAddress) ||
config_compare(list, "DirFetchPostPeriod",CONFIG_TYPE_UINT, &options->DirFetchPostPeriod) ||
config_compare(list, "DirServer", CONFIG_TYPE_LINELIST, &options->DirServers) ||
config_compare(list, "ExitNodes", CONFIG_TYPE_STRING, &options->ExitNodes) ||
config_compare(list, "EntryNodes", CONFIG_TYPE_STRING, &options->EntryNodes) ||
config_compare(list, "StrictExitNodes", CONFIG_TYPE_BOOL, &options->StrictExitNodes) ||
config_compare(list, "StrictEntryNodes", CONFIG_TYPE_BOOL, &options->StrictEntryNodes) ||
config_compare(list, "ExitPolicy", CONFIG_TYPE_LINELIST, &options->ExitPolicy) ||
config_compare(list, "ExcludeNodes", CONFIG_TYPE_STRING, &options->ExcludeNodes) ||
config_compare(list, "FascistFirewall",CONFIG_TYPE_BOOL, &options->FascistFirewall) ||
config_compare(list, "FirewallPorts",CONFIG_TYPE_CSV, &options->FirewallPorts) ||
config_compare(list, "MyFamily", CONFIG_TYPE_STRING, &options->MyFamily) ||
config_compare(list, "NodeFamily", CONFIG_TYPE_LINELIST, &options->NodeFamilies) ||
config_compare(list, "Group", CONFIG_TYPE_STRING, &options->Group) ||
config_compare(list, "HttpProxy", CONFIG_TYPE_STRING, &options->HttpProxy) ||
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)||
config_compare(list, "IgnoreVersion", CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||
config_compare(list, "KeepalivePeriod",CONFIG_TYPE_UINT, &options->KeepalivePeriod) ||
config_compare(list, "LogLevel", CONFIG_TYPE_LINELIST, &options->LogOptions) ||
config_compare(list, "LogFile", CONFIG_TYPE_LINELIST, &options->LogOptions) ||
config_compare(list, "LinkPadding", CONFIG_TYPE_OBSOLETE, NULL) ||
config_compare(list, "MaxConn", CONFIG_TYPE_UINT, &options->MaxConn) ||
config_compare(list, "MaxOnionsPending",CONFIG_TYPE_UINT, &options->MaxOnionsPending) ||
config_compare(list, "Nickname", CONFIG_TYPE_STRING, &options->Nickname) ||
config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_UINT, &options->NewCircuitPeriod) ||
config_compare(list, "NumCpus", CONFIG_TYPE_UINT, &options->NumCpus) ||
config_compare(list, "ORPort", CONFIG_TYPE_UINT, &options->ORPort) ||
config_compare(list, "ORBindAddress", CONFIG_TYPE_LINELIST, &options->ORBindAddress) ||
config_compare(list, "OutboundBindAddress",CONFIG_TYPE_STRING, &options->OutboundBindAddress) ||
config_compare(list, "PidFile", CONFIG_TYPE_STRING, &options->PidFile) ||
config_compare(list, "PathlenCoinWeight",CONFIG_TYPE_DOUBLE, &options->PathlenCoinWeight) ||
config_compare(list, "RedirectExit", CONFIG_TYPE_LINELIST, &options->RedirectExit) ||
config_compare(list, "RouterFile", CONFIG_TYPE_OBSOLETE, NULL) ||
config_compare(list, "RunAsDaemon", CONFIG_TYPE_BOOL, &options->RunAsDaemon) ||
config_compare(list, "RunTesting", CONFIG_TYPE_BOOL, &options->RunTesting) ||
config_compare(list, "RecommendedVersions",CONFIG_TYPE_LINELIST, &options->RecommendedVersions) ||
config_compare(list, "RendNodes", CONFIG_TYPE_STRING, &options->RendNodes) ||
config_compare(list, "RendExcludeNodes",CONFIG_TYPE_STRING, &options->RendExcludeNodes) ||
config_compare(list, "SocksPort", CONFIG_TYPE_UINT, &options->SocksPort) ||
config_compare(list, "SocksBindAddress",CONFIG_TYPE_LINELIST,&options->SocksBindAddress) ||
config_compare(list, "SocksPolicy", CONFIG_TYPE_LINELIST,&options->SocksPolicy) ||
config_compare(list, "TrafficShaping", CONFIG_TYPE_OBSOLETE, NULL) ||
config_compare(list, "User", CONFIG_TYPE_STRING, &options->User)
) {
/* then we're ok. it matched something. */
} else {
log_fn(LOG_WARN,"Unknown keyword '%s'. Failing.",list->key);
return -1;
}
list = list->next;
}
return 0;
}
static void
add_default_trusted_dirservers(void)
{
/* moria1 */
parse_dir_server_line("18.244.0.188:9031 "
"FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441");
/* moria2 */
parse_dir_server_line("18.244.0.114:80 "
"719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF");
/* tor26 */
parse_dir_server_line("62.116.124.106:9030 "
"847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
}
/** Set <b>options</b> to a reasonable default.
*
* Call this function before we parse the torrc file.
*/
static int
config_assign_defaults(or_options_t *options)
{
/* set them up as a client only */
options->SocksPort = 9050;
options->AllowUnverifiedNodes = smartlist_create();
smartlist_add(options->AllowUnverifiedNodes, "middle");
smartlist_add(options->AllowUnverifiedNodes, "rendezvous");
config_free_lines(options->ExitPolicy);
options->ExitPolicy = NULL;
return 0;
}
/** Print a usage message for tor. */
static void
print_usage(void)
{
printf("tor -f <torrc> [args]\n"
"See man page for more options. This -h is probably obsolete.\n\n"
"-b <bandwidth>\t\tbytes/second rate limiting\n"
"-d <file>\t\tDebug file\n"
// "-m <max>\t\tMax number of connections\n"
"-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"
"-s <IP>\t\t\tPort to bind to for Socks\n");
printf("\nServer options:\n"
"-n <nick>\t\tNickname of router\n"
"-o <port>\t\tOR port to bind to\n"
"-p <file>\t\tPID file\n");
}
/**
* Based on <b>address</b>, guess our public IP address and put it
* in <b>addr</b>.
*/
int
resolve_my_address(const char *address, uint32_t *addr)
{
struct in_addr in;
struct hostent *rent;
char hostname[256];
int explicit_ip=1;
tor_assert(addr);
if (address) {
strlcpy(hostname, address, sizeof(hostname));
} else { /* then we need to guess our address */
explicit_ip = 0; /* it's implicit */
if (gethostname(hostname, sizeof(hostname)) < 0) {
log_fn(LOG_WARN,"Error obtaining local hostname");
return -1;
}
log_fn(LOG_DEBUG,"Guessed local host name as '%s'",hostname);
}
/* now we know hostname. resolve it and keep only the IP */
if (tor_inet_aton(hostname, &in) == 0) {
/* then we have to resolve it */
explicit_ip = 0;
rent = (struct hostent *)gethostbyname(hostname);
if (!rent) {
log_fn(LOG_WARN,"Could not resolve local Address %s. Failing.", hostname);
return -1;
}
tor_assert(rent->h_length == 4);
memcpy(&in.s_addr, rent->h_addr, rent->h_length);
}
if (!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
"Please set the Address config option to be the IP you want to use.",
hostname, inet_ntoa(in));
return -1;
}
log_fn(LOG_DEBUG, "Resolved Address to %s.", inet_ntoa(in));
*addr = ntohl(in.s_addr);
return 0;
}
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;
}
/** Release storage held by <b>options</b> */
static void
free_options(or_options_t *options)
{
config_free_lines(options->LogOptions);
tor_free(options->ContactInfo);
tor_free(options->DebugLogFile);
tor_free(options->DataDirectory);
tor_free(options->Nickname);
tor_free(options->Address);
tor_free(options->PidFile);
tor_free(options->ExitNodes);
tor_free(options->EntryNodes);
tor_free(options->ExcludeNodes);
tor_free(options->RendNodes);
tor_free(options->RendExcludeNodes);
tor_free(options->OutboundBindAddress);
tor_free(options->User);
tor_free(options->Group);
tor_free(options->HttpProxy);
config_free_lines(options->RendConfigLines);
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);
config_free_lines(options->DirServers);
config_free_lines(options->RecommendedVersions);
config_free_lines(options->NodeFamilies);
config_free_lines(options->RedirectExit);
if (options->RedirectExitList) {
SMARTLIST_FOREACH(options->RedirectExitList,
exit_redirect_t *, p, tor_free(p));
smartlist_free(options->RedirectExitList);
options->RedirectExitList = NULL;
}
if (options->FirewallPorts) {
SMARTLIST_FOREACH(options->FirewallPorts, char *, cp, tor_free(cp));
smartlist_free(options->FirewallPorts);
options->FirewallPorts = NULL;
}
}
/** Set <b>options</b> to hold reasonable defaults for most options.
* Each option defaults to zero. */
static void
init_options(or_options_t *options)
{
memset(options,0,sizeof(or_options_t));
options->ExitNodes = tor_strdup("");
options->EntryNodes = tor_strdup("");
options->StrictEntryNodes = options->StrictExitNodes = 0;
options->ExcludeNodes = tor_strdup("");
options->RendNodes = tor_strdup("");
options->RendExcludeNodes = tor_strdup("");
/* options->PidFile = tor_strdup("tor.pid"); */
options->PathlenCoinWeight = 0.3;
options->MaxConn = 900;
options->DirFetchPostPeriod = 600;
options->KeepalivePeriod = 300;
options->MaxOnionsPending = 100;
options->NewCircuitPeriod = 30; /* twice a minute */
options->BandwidthRate = 800000; /* at most 800kB/s total sustained incoming */
options->BandwidthBurst = 10000000; /* max burst on the token bucket */
options->NumCpus = 1;
}
static char *
get_default_conf_file(void)
{
#ifdef MS_WINDOWS
LPITEMIDLIST idl;
IMalloc *m;
HRESULT result;
char *path = tor_malloc(MAX_PATH);
/* Find X:\documents and settings\username\applicatation data\ .
* We would use SHGetSpecialFolder path, but that wasn't added until IE4.
*/
if (!SUCCEEDED(SHGetSpecialFolderLocation(NULL, CSIDL_APPDATA,
&idl))) {
tor_free(path);
return NULL;
}
/* Convert the path from an "ID List" (whatever that is!) to a path. */
result = SHGetPathFromIDList(idl, path);
/* Now we need to free the */
SHGetMalloc(&m);
if (m) {
m->lpVtbl->Free(m, idl);
m->lpVtbl->Release(m);
}
if (!SUCCEEDED(result)) {
tor_free(path);
return NULL;
}
strlcat(path,"\\tor\\torrc",MAX_PATH);
return path;
#else
return tor_strdup(CONFDIR "/torrc");
#endif
}
/** Verify whether lst is a string containing valid-looking space-separated
* nicknames, or NULL. Return 0 on success. Warn and return -1 on failure.
*/
static int check_nickname_list(const char *lst, const char *name)
{
int r = 0;
smartlist_t *sl;
if (!lst)
return 0;
sl = smartlist_create();
smartlist_split_string(sl, lst, ",", SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
SMARTLIST_FOREACH(sl, const char *, s,
{
if (!is_legal_nickname_or_hexdigest(s)) {
log_fn(LOG_WARN, "Invalid nickname '%s' in %s line", s, name);
r = -1;
}
});
SMARTLIST_FOREACH(sl, char *, s, tor_free(s));
smartlist_free(sl);
return r;
}
/** 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. */
int
getconfig(int argc, char **argv, or_options_t *options)
{
struct config_line_t *cl;
FILE *cf;
char *fname;
int i;
int result = 0;
static int first_load = 1;
static char **backup_argv;
static int backup_argc;
char *previous_pidfile = NULL;
int previous_runasdaemon = 0;
int previous_orport = -1;
int using_default_torrc;
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 */
if (options->PidFile)
previous_pidfile = tor_strdup(options->PidFile);
previous_runasdaemon = options->RunAsDaemon;
previous_orport = options->ORPort;
free_options(options);
}
init_options(options);
if (argc > 1 && (!strcmp(argv[1], "-h") || !strcmp(argv[1],"--help"))) {
print_usage();
exit(0);
}
if (argc > 1 && (!strcmp(argv[1],"--version"))) {
printf("Tor version %s.\n",VERSION);
exit(0);
}
/* 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 */
fname = tor_strdup(argv[i+1]);
using_default_torrc = 0;
} else {
/* didn't find one, try CONFDIR */
char *fn;
using_default_torrc = 1;
fn = get_default_conf_file();
if (fn && file_status(fn) == FN_FILE) {
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();
}
}
}
tor_assert(fname);
log(LOG_DEBUG, "Opening config file '%s'", fname);
if (config_assign_defaults(options) < 0) {
return -1;
}
cf = fopen(fname, "r");
if (!cf) {
if (using_default_torrc == 1) {
log(LOG_NOTICE, "Configuration file '%s' not present, "
"using reasonable defaults.", fname);
tor_free(fname);
} else {
log(LOG_WARN, "Unable to open configuration file '%s'.", fname);
tor_free(fname);
return -1;
}
} else { /* it opened successfully. use it. */
tor_free(fname);
if (config_get_lines(cf, &cl)<0)
return -1;
if (config_assign(options,cl) < 0)
return -1;
config_free_lines(cl);
fclose(cf);
}
/* go through command-line variables too */
cl = config_get_commandlines(argc,argv);
if (config_assign(options,cl) < 0)
return -1;
config_free_lines(cl);
/* Validate options */
/* first check if any of the previous options have changed but aren't allowed to */
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;
}
if (previous_orport == 0 && options->ORPort > 0) {
log_fn(LOG_WARN,"During reload, change from ORPort=0 to >0 not allowed. Failing.");
return -1;
}
if (options->ORPort < 0 || options->ORPort > 65535) {
log(LOG_WARN, "ORPort option out of bounds.");
result = -1;
}
if (options->Nickname == NULL) {
if (server_mode()) {
if (!(options->Nickname = get_default_nickname()))
return -1;
log_fn(LOG_NOTICE, "Choosing default nickname %s", options->Nickname);
}
} 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) == 0) {
log_fn(LOG_WARN, "Nickname must have at least one character");
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;
}
}
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)
result = -1;
}
if (options->SocksPort < 0 || options->SocksPort > 65535) {
log(LOG_WARN, "SocksPort option out of bounds.");
result = -1;
}
if (options->SocksPort == 0 && options->ORPort == 0) {
log(LOG_WARN, "SocksPort and ORPort are both undefined? Quitting.");
result = -1;
}
if (options->DirPort < 0 || options->DirPort > 65535) {
log(LOG_WARN, "DirPort option out of bounds.");
result = -1;
}
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.");
}
if (options->AuthoritativeDir && options->RecommendedVersions == NULL) {
log(LOG_WARN, "Directory servers must configure RecommendedVersions.");
result = -1;
}
if (options->AuthoritativeDir && !options->DirPort) {
log(LOG_WARN, "Running as authoritative directory, but no DirPort set.");
result = -1;
}
if (options->AuthoritativeDir && !options->ORPort) {
log(LOG_WARN, "Running as authoritative directory, but no ORPort set.");
result = -1;
}
if (options->AuthoritativeDir && options->ClientOnly) {
log(LOG_WARN, "Running as authoritative directory, but ClientOnly also set.");
result = -1;
}
if (options->FascistFirewall && !options->FirewallPorts) {
options->FirewallPorts = smartlist_create();
smartlist_add(options->FirewallPorts, tor_strdup("80"));
smartlist_add(options->FirewallPorts, tor_strdup("443"));
}
if (options->FirewallPorts) {
SMARTLIST_FOREACH(options->FirewallPorts, const char *, cp,
{
i = atoi(cp);
if (i < 1 || i > 65535) {
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;
else if (!strcasecmp(cp, "introduction"))
options->_AllowUnverified |= ALLOW_UNVERIFIED_INTRODUCTION;
else if (!strcasecmp(cp, "rendezvous"))
options->_AllowUnverified |= ALLOW_UNVERIFIED_RENDEZVOUS;
else {
log(LOG_WARN, "Unrecognized value '%s' in AllowUnverifiedNodes",
cp);
result=-1;
}
});
}
if (options->SocksPort >= 1 &&
(options->PathlenCoinWeight < 0.0 || options->PathlenCoinWeight >= 1.0)) {
log(LOG_WARN, "PathlenCoinWeight option must be >=0.0 and <1.0.");
result = -1;
}
if (options->MaxConn < 1) {
log(LOG_WARN, "MaxConn option must be a non-zero positive integer.");
result = -1;
}
if (options->MaxConn >= MAXCONNECTIONS) {
log(LOG_WARN, "MaxConn option must be less than %d.", MAXCONNECTIONS);
result = -1;
}
#define MIN_DIRFETCHPOSTPERIOD 60
if (options->DirFetchPostPeriod < MIN_DIRFETCHPOSTPERIOD) {
log(LOG_WARN, "DirFetchPostPeriod option must be at least %d.", MIN_DIRFETCHPOSTPERIOD);
result = -1;
}
if (options->DirFetchPostPeriod > MIN_ONION_KEY_LIFETIME / 2) {
log(LOG_WARN, "DirFetchPostPeriod is too large; clipping.");
options->DirFetchPostPeriod = MIN_ONION_KEY_LIFETIME / 2;
}
if (options->KeepalivePeriod < 1) {
log(LOG_WARN,"KeepalivePeriod option must be positive.");
result = -1;
}
if (options->HttpProxy) { /* parse it now */
if (parse_addr_port(options->HttpProxy, NULL,
&options->HttpProxyAddr, &options->HttpProxyPort) < 0) {
log(LOG_WARN,"HttpProxy failed to parse or resolve. Please fix.");
result = -1;
}
if (options->HttpProxyPort == 0) { /* give it a default */
options->HttpProxyPort = 80;
}
}
if (check_nickname_list(options->ExitNodes, "ExitNodes"))
return -1;
if (check_nickname_list(options->EntryNodes, "EntryNodes"))
return -1;
if (check_nickname_list(options->ExcludeNodes, "ExcludeNodes"))
return -1;
if (check_nickname_list(options->RendNodes, "RendNodes"))
return -1;
if (check_nickname_list(options->RendNodes, "RendExcludeNodes"))
return -1;
if (check_nickname_list(options->MyFamily, "MyFamily"))
return -1;
for (cl = options->NodeFamilies; cl; cl = cl->next) {
if (check_nickname_list(cl->value, "NodeFamily"))
return -1;
}
if (!options->RedirectExitList)
options->RedirectExitList = smartlist_create();
for (cl = options->RedirectExit; cl; cl = cl->next) {
if (parse_redirect_line(options, cl)<0)
return -1;
}
clear_trusted_dir_servers();
if (!options->DirServers) {
add_default_trusted_dirservers();
} else {
for (cl = options->DirServers; cl; cl = cl->next) {
if (parse_dir_server_line(cl->value)<0)
return -1;
}
}
if (rend_config_services(options) < 0) {
result = -1;
}
return result;
}
static int
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);
return -1;
}
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);
return -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);
return -1;
}
}
}
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));
return -1;
}
log_fn(LOG_NOTICE, "Successfully opened LogFile '%s', redirecting output.",
file_opt->value);
} else if (!isDaemon) {
add_stream_log(levelMin, levelMax, "<stdout>", stdout);
close_temp_logs();
}
return 0;
}
/**
* Initialize the logs based on the configuration file.
*/
int
config_init_logs(or_options_t *options)
{
/* The order of options is: Level? (File Level?)+
*/
struct config_line_t *opt = options->LogOptions;
/* Special case if no options are given. */
if (!opt) {
add_stream_log(LOG_NOTICE, LOG_ERR, "<stdout>", stdout);
close_temp_logs();
/* don't return yet, in case we want to do a debuglogfile below */
}
/* Special case for if first option is LogLevel. */
if (opt && !strcasecmp(opt->key, "LogLevel")) {
if (opt->next && !strcasecmp(opt->next->key, "LogFile")) {
if (add_single_log(opt, opt->next, options->RunAsDaemon) < 0)
return -1;
opt = opt->next->next;
} else if (!opt->next) {
if (add_single_log(opt, NULL, options->RunAsDaemon) < 0)
return -1;
opt = opt->next;
} else {
; /* give warning below */
}
}
while (opt) {
if (!strcasecmp(opt->key, "LogLevel")) {
log_fn(LOG_WARN, "Two LogLevel options in a row without intervening LogFile");
opt = opt->next;
} else {
tor_assert(!strcasecmp(opt->key, "LogFile"));
if (opt->next && !strcasecmp(opt->next->key, "LogLevel")) {
/* LogFile followed by LogLevel */
if (add_single_log(opt->next, opt, options->RunAsDaemon) < 0)
return -1;
opt = opt->next->next;
} else {
/* LogFile followed by LogFile or end of list. */
if (add_single_log(NULL, opt, options->RunAsDaemon) < 0)
return -1;
opt = opt->next;
}
}
}
if (options->DebugLogFile) {
log_fn(LOG_WARN, "DebugLogFile is deprecated; use LogFile and LogLevel instead");
if (add_file_log(LOG_DEBUG, LOG_ERR, options->DebugLogFile) < 0)
return -1;
}
return 0;
}
/**
* Given a linked list of config lines containing "allow" and "deny" tokens,
* parse them and place the result in <b>dest</b>. Skip malformed lines.
*/
void
config_parse_exit_policy(struct config_line_t *cfg,
struct exit_policy_t **dest)
{
struct exit_policy_t **nextp;
smartlist_t *entries;
if (!cfg)
return;
nextp = dest;
while (*nextp)
nextp = &((*nextp)->next);
entries = smartlist_create();
for (; cfg; cfg = cfg->next) {
smartlist_split_string(entries, cfg->value, ",", SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
SMARTLIST_FOREACH(entries, const char *, ent,
{
log_fn(LOG_DEBUG,"Adding new entry '%s'",ent);
*nextp = router_parse_exit_policy_from_string(ent);
if (*nextp) {
nextp = &((*nextp)->next);
} else {
log_fn(LOG_WARN,"Malformed exit policy %s; skipping.", ent);
}
});
SMARTLIST_FOREACH(entries, char *, ent, tor_free(ent));
smartlist_clear(entries);
}
smartlist_free(entries);
}
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);
}
}
static int parse_redirect_line(or_options_t *options,
struct config_line_t *line)
{
smartlist_t *elements = NULL;
exit_redirect_t *r;
tor_assert(options);
tor_assert(options->RedirectExitList);
tor_assert(line);
r = tor_malloc_zero(sizeof(exit_redirect_t));
smartlist_split_string(elements, line->value, " ",
SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
if (smartlist_len(elements) != 2) {
log_fn(LOG_WARN, "Wrong number of elements in RedirectExit line");
goto err;
}
if (parse_addr_and_port_range(smartlist_get(elements,0),&r->addr,&r->mask,
&r->port_min,&r->port_max)) {
log_fn(LOG_WARN, "Error parsing source address in RedirectExit line");
goto err;
}
if (parse_addr_port(smartlist_get(elements,1),NULL,&r->addr_dest,
&r->port_dest)) {
log_fn(LOG_WARN, "Error parseing dest address in RedirectExit line");
goto err;
}
goto done;
err:
tor_free(r);
done:
SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
smartlist_free(elements);
if (r) {
smartlist_add(options->RedirectExitList, r);
return 0;
} else {
return -1;
}
}
static int parse_dir_server_line(const char *line)
{
smartlist_t *items = NULL;
int r;
char *addrport, *address=NULL;
uint16_t port;
char digest[DIGEST_LEN];
items = smartlist_create();
smartlist_split_string(items, line, " ",
SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 2);
if (smartlist_len(items) < 2) {
log_fn(LOG_WARN, "Too few arguments to DirServer line.");
goto err;
}
addrport = smartlist_get(items, 0);
if (parse_addr_port(addrport, &address, NULL, &port)<0) {
log_fn(LOG_WARN, "Error parsing DirServer address '%s'", addrport);
goto err;
}
if (!port) {
log_fn(LOG_WARN, "Missing port in DirServe address '%s'",addrport);
goto err;
}
tor_strstrip(smartlist_get(items, 1), " ");
if (strlen(smartlist_get(items, 1)) != HEX_DIGEST_LEN) {
log_fn(LOG_WARN, "Key digest for DirServer is wrong length.");
goto err;
}
if (base16_decode(digest, DIGEST_LEN,
smartlist_get(items,1), HEX_DIGEST_LEN)<0) {
log_fn(LOG_WARN, "Unable to decode DirServer key digest.");
goto err;
}
log_fn(LOG_DEBUG, "Trusted dirserver at %s:%d (%s)", address, (int)port,
(char*)smartlist_get(items,1));
add_trusted_dir_server(address, port, digest);
r = 0;
goto done;
err:
r = -1;
done:
SMARTLIST_FOREACH(items, char*, s, tor_free(s));
smartlist_free(items);
if (address)
tor_free(address);
return r;
}
const char *
get_data_directory(or_options_t *options)
{
const char *d;
if (options->DataDirectory) {
d = options->DataDirectory;
} else {
#ifdef MS_WINDOWS
char *p;
p = tor_malloc(MAX_PATH);
if (!SUCCEEDED(SHGetSpecialFolderPath(NULL, p, CSIDL_APPDATA, 1))) {
strlcpy(p,CONFDIR, MAX_PATH);
}
strlcat(p,"\\tor",MAX_PATH);
options->DataDirectory = p;
return p;
#else
d = "~/.tor";
#endif
}
if (d && strncmp(d,"~/",2) == 0) {
char *fn = expand_filename(d);
if (!fn) {
log_fn(LOG_ERR,"Failed to expand filename '%s'. Exiting.", d);
exit(1);
}
tor_free(options->DataDirectory);
options->DataDirectory = fn;
}
return options->DataDirectory;
}
/*
Local Variables:
mode:c
indent-tabs-mode:nil
c-basic-offset:2
End:
*/
|