1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705 |
- /* 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_LINELIST_S, /**< Uninterpreted, context-sensitive config lines,
- * mixed with other keywords. */
- CONFIG_TYPE_LINELIST_V, /**< Catch-all "virtual" option to summarize
- * context-sensitive config lines when fetching.
- */
- CONFIG_TYPE_OBSOLETE, /**< Obsolete (ignored) option. */
- } config_type_t;
- /* An abbreviation for a configuration option allowed on the command line */
- typedef struct config_abbrev_t {
- const char *abbreviated;
- const char *full;
- int commandline_only;
- } config_abbrev_t;
- /* Handy macro for declaring "In the config file or on the command line,
- * you can abbreviate <b>tok</b>s as <b>tok</b>". */
- #define PLURAL(tok) { #tok, #tok "s", 0 }
- /* A list of command-line abbreviations. */
- static config_abbrev_t config_abbrevs[] = {
- PLURAL(ExitNode),
- PLURAL(EntryNodes),
- PLURAL(ExcludeNode),
- PLURAL(FirewallPort),
- PLURAL(HiddenServiceNode),
- PLURAL(HiddenServiceExcludeNode),
- PLURAL(RendNode),
- PLURAL(RendExcludeNode),
- { "l", "Log", 1},
- { "BandwidthRate", "BandwidthRateBytes", 1},
- { "BandwidthBurst", "BandwidthBurstBytes", 1},
- { NULL, NULL , 0},
- };
- #undef PLURAL
- /** A variable allowed in the configuration file or on the command line. */
- typedef struct config_var_t {
- const char *name; /**< The full keyword (case insensitive). */
- config_type_t type; /**< How to interpret the type and turn it into a value. */
- off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
- const char *initvalue; /**< String (or null) describing initial value. */
- } config_var_t;
- /** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
- #define STRUCT_OFFSET(tp, member) ((off_t) (((char*)&((tp*)0)->member)-(char*)0))
- /** An entry for config_vars: "The option <b>name</b> has type
- * CONFIG_TYPE_<b>conftype</b>, and corresponds to
- * or_options_t.<b>member</b>"
- */
- #define VAR(name,conftype,member,initvalue) \
- { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), initvalue }
- /** An entry for config_vars: "The option <b>name</b> is obsolete." */
- #define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
- /** Array of configuration options. Until we disallow nonstandard
- * abbreviations, order is significant, since the first matching option will
- * be chosen first.
- */
- static config_var_t config_vars[] = {
- VAR("Address", STRING, Address, NULL),
- VAR("AllowUnverifiedNodes",CSV, AllowUnverifiedNodes, "middle,rendezvous"),
- VAR("AuthoritativeDirectory",BOOL, AuthoritativeDir, "0"),
- VAR("BandwidthRateBytes", UINT, BandwidthRateBytes, "800000"),
- VAR("BandwidthBurstBytes", UINT, BandwidthBurstBytes, "50000000"),
- VAR("ClientOnly", BOOL, ClientOnly, "0"),
- VAR("ContactInfo", STRING, ContactInfo, NULL),
- VAR("ControlPort", UINT, ControlPort, "0"),
- VAR("DebugLogFile", STRING, DebugLogFile, NULL),
- VAR("DataDirectory", STRING, DataDirectory, NULL),
- VAR("DirPort", UINT, DirPort, "0"),
- VAR("DirBindAddress", LINELIST, DirBindAddress, NULL),
- VAR("DirFetchPostPeriod", UINT, DirFetchPostPeriod, "600"),
- VAR("DirPolicy", LINELIST, DirPolicy, NULL),
- VAR("DirServer", LINELIST, DirServers, NULL),
- VAR("ExitNodes", STRING, ExitNodes, NULL),
- VAR("EntryNodes", STRING, EntryNodes, NULL),
- VAR("StrictExitNodes", BOOL, StrictExitNodes, "0"),
- VAR("StrictEntryNodes", BOOL, StrictEntryNodes, "0"),
- VAR("ExitPolicy", LINELIST, ExitPolicy, NULL),
- VAR("ExcludeNodes", STRING, ExcludeNodes, NULL),
- VAR("FascistFirewall", BOOL, FascistFirewall, "0"),
- VAR("FirewallPorts", CSV, FirewallPorts, "80,443"),
- VAR("MyFamily", STRING, MyFamily, NULL),
- VAR("NodeFamily", LINELIST, NodeFamilies, NULL),
- VAR("Group", STRING, Group, NULL),
- VAR("HashedControlPassword",STRING, HashedControlPassword, NULL),
- VAR("HttpProxy", STRING, HttpProxy, NULL),
- VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines, NULL),
- VAR("HiddenServiceDir", LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServicePort", LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceNodes", LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceExcludeNodes", LINELIST_S, RendConfigLines, NULL),
- VAR("IgnoreVersion", BOOL, IgnoreVersion, "0"),
- VAR("KeepalivePeriod", UINT, KeepalivePeriod, "300"),
- VAR("Log", LINELIST, Logs, NULL),
- VAR("LogLevel", LINELIST_S, OldLogOptions, NULL),
- VAR("LogFile", LINELIST_S, OldLogOptions, NULL),
- OBSOLETE("LinkPadding"),
- VAR("MaxConn", UINT, MaxConn, "1024"),
- VAR("MaxOnionsPending", UINT, MaxOnionsPending, "100"),
- VAR("MonthlyAccountingStart",UINT, AccountingStart, "0"),
- VAR("AccountingMaxKB", UINT, AccountingMaxKB, "0"),
- VAR("Nickname", STRING, Nickname, NULL),
- VAR("NewCircuitPeriod", UINT, NewCircuitPeriod, "30"),
- VAR("NumCpus", UINT, NumCpus, "1"),
- VAR("ORPort", UINT, ORPort, "0"),
- VAR("ORBindAddress", LINELIST, ORBindAddress, NULL),
- VAR("OutboundBindAddress", STRING, OutboundBindAddress, NULL),
- VAR("PidFile", STRING, PidFile, NULL),
- VAR("PathlenCoinWeight", DOUBLE, PathlenCoinWeight, "0.3"),
- VAR("RedirectExit", LINELIST, RedirectExit, NULL),
- OBSOLETE("RouterFile"),
- VAR("RunAsDaemon", BOOL, RunAsDaemon, "0"),
- VAR("RunTesting", BOOL, RunTesting, "0"),
- VAR("RecommendedVersions", LINELIST, RecommendedVersions, NULL),
- VAR("RendNodes", STRING, RendNodes, NULL),
- VAR("RendExcludeNodes", STRING, RendExcludeNodes, NULL),
- VAR("SocksPort", UINT, SocksPort, "9050"),
- VAR("SocksBindAddress", LINELIST, SocksBindAddress, NULL),
- VAR("SocksPolicy", LINELIST, SocksPolicy, NULL),
- VAR("SysLog", LINELIST_S, OldLogOptions, NULL),
- OBSOLETE("TrafficShaping"),
- VAR("User", STRING, User, NULL),
- { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
- };
- #undef VAR
- #undef OBSOLETE
- /** Largest allowed config line */
- #define CONFIG_LINE_T_MAXLEN 4096
- static void option_reset(or_options_t *options, config_var_t *var);
- static void options_free(or_options_t *options);
- static or_options_t *options_dup(or_options_t *old);
- static int options_validate(or_options_t *options);
- static int options_transition_allowed(or_options_t *old, or_options_t *new);
- static int check_nickname_list(const char *lst, const char *name);
- static int parse_dir_server_line(const char *line);
- static int parse_redirect_line(or_options_t *options,
- struct config_line_t *line);
- static int parse_log_severity_range(const char *range, int *min_out,
- int *max_out);
- static int convert_log_option(or_options_t *options,
- struct config_line_t *level_opt,
- struct config_line_t *file_opt, int isDaemon);
- static int add_single_log_option(or_options_t *options, int minSeverity,
- int maxSeverity,
- const char *type, const char *fname);
- static int normalize_log_options(or_options_t *options);
- /*
- * Functions to read and write the global options pointer.
- */
- /** Command-line and config-file options. */
- static or_options_t *global_options=NULL;
- or_options_t *get_options(void) {
- tor_assert(global_options);
- return global_options;
- }
- void set_options(or_options_t *new) {
- global_options = new;
- }
- /*
- * Functions to parse config options
- */
- /** If <b>option</b> is an official abbreviation for a longer option,
- * return the longer option. Otherwise return <b>option</b>.
- * If <b>command_line</b> is set, apply all abbreviations. Otherwise, only
- * apply abbreviations that work for the config file and the command line. */
- static const char *
- expand_abbrev(const char *option, int command_line)
- {
- int i;
- for (i=0; config_abbrevs[i].abbreviated; ++i) {
- /* Abbreviations aren't casei. */
- if (!strcmp(option,config_abbrevs[i].abbreviated) &&
- (command_line || !config_abbrevs[i].commandline_only)) {
- return config_abbrevs[i].full;
- }
- }
- return option;
- }
- /** 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") ||
- !strcmp(argv[i],"--hash-password")) {
- i += 2; /* command-line option with argument. ignore them. */
- continue;
- } else if (!strcmp(argv[i],"--list-fingerprint")) {
- i += 1; /* command-line option. ignore it. */
- continue;
- }
- new = tor_malloc(sizeof(struct config_line_t));
- s = argv[i];
- while(*s == '-')
- s++;
- new->key = tor_strdup(expand_abbrev(s, 1));
- 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 */
- 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 string and strdup into key/value
- * strings. Set *result to the list, or NULL if parsing the string
- * failed. Return 0 on success, -1 on failure. Warn and ignore any
- * misformatted lines. */
- int
- config_get_lines(char *string, struct config_line_t **result)
- {
- struct config_line_t *list = NULL;
- char *k, *v;
- do {
- string = parse_line_from_str(string, &k, &v);
- if (!string) {
- config_free_lines(list);
- return -1;
- }
- if (k && v)
- list = config_line_prepend(list, k, v);
- } while (*string);
- *result = list;
- return 0;
- }
- /**
- * Free all the configuration lines on the linked list <b>front</b>.
- */
- 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);
- }
- }
- /** If <b>key</b> is a configuration option, return the corresponding
- * config_var_t. Otherwise, if <b>key</b> is a non-standard abbreviation,
- * warn, and return the corresponding config_var_t. Otherwise return NULL.
- */
- static config_var_t *config_find_option(const char *key)
- {
- int i;
- /* First, check for an exact (case-insensitive) match */
- for (i=0; config_vars[i].name; ++i) {
- if (!strcasecmp(key, config_vars[i].name))
- return &config_vars[i];
- }
- /* If none, check for an abbreviated match */
- for (i=0; config_vars[i].name; ++i) {
- if (!strncasecmp(key, config_vars[i].name, strlen(key))) {
- log_fn(LOG_WARN, "The abbreviation '%s' is deprecated. "
- "Tell Nick and Roger to make it official, or just use '%s' instead",
- key, config_vars[i].name);
- return &config_vars[i];
- }
- }
- /* Okay, unrecogized options */
- return NULL;
- }
- /** If <b>c</b> is a syntactically valid configuration line, update
- * <b>options</b> with its value and return 0. Otherwise return -1.
- *
- * If 'reset' is set, and we get a line containing no value, restore the
- * option to its default value.
- */
- static int
- config_assign_line(or_options_t *options, struct config_line_t *c, int reset)
- {
- int i, ok;
- config_var_t *var;
- void *lvalue;
- var = config_find_option(c->key);
- if (!var) {
- log_fn(LOG_WARN, "Unknown option '%s'. Failing.", c->key);
- return -1;
- }
- /* Put keyword into canonical case. */
- if (strcmp(var->name, c->key)) {
- tor_free(c->key);
- c->key = tor_strdup(var->name);
- }
- if (reset && !strlen(c->value)) {
- option_reset(options, var);
- return 0;
- }
- lvalue = ((char*)options) + var->var_offset;
- switch(var->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.",
- c->key,c->value);
- return -1;
- }
- *(int *)lvalue = 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.", c->key);
- return -1;
- }
- *(int *)lvalue = i;
- break;
- case CONFIG_TYPE_STRING:
- tor_free(*(char **)lvalue);
- *(char **)lvalue = tor_strdup(c->value);
- break;
- case CONFIG_TYPE_DOUBLE:
- *(double *)lvalue = atof(c->value);
- break;
- case CONFIG_TYPE_CSV:
- if (*(smartlist_t**)lvalue == NULL)
- *(smartlist_t**)lvalue = smartlist_create();
- smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
- break;
- case CONFIG_TYPE_LINELIST:
- case CONFIG_TYPE_LINELIST_S:
- /* Note: this reverses the order that the lines appear in. That's
- * just fine, since we build up the list of lines reversed in the
- * first place. */
- *(struct config_line_t**)lvalue =
- config_line_prepend(*(struct config_line_t**)lvalue, c->key, c->value);
- break;
- case CONFIG_TYPE_OBSOLETE:
- log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
- break;
- case CONFIG_TYPE_LINELIST_V:
- log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
- return -1;
- default:
- tor_assert(0);
- break;
- }
- return 0;
- }
- /** restore the option named <b>key</b> in options to its default value. */
- static void
- config_reset_line(or_options_t *options, const char *key)
- {
- config_var_t *var;
- var = config_find_option(key);
- if (!var)
- return; /* give error on next pass. */
- option_reset(options, var);
- }
- /** Return a canonicalized list of the options assigned for key.
- */
- struct config_line_t *
- config_get_assigned_option(or_options_t *options, const char *key)
- {
- config_var_t *var;
- const void *value;
- char buf[32];
- struct config_line_t *result;
- var = config_find_option(key);
- if (!var) {
- log_fn(LOG_WARN, "Unknown option '%s'. Failing.", key);
- return NULL;
- } else if (var->type == CONFIG_TYPE_LINELIST_S) {
- log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
- return NULL;
- }
- value = ((char*)options) + var->var_offset;
- if (var->type == CONFIG_TYPE_LINELIST ||
- var->type == CONFIG_TYPE_LINELIST_V) {
- /* Linelist requires special handling: we just copy and return it. */
- const struct config_line_t *next_in = value;
- struct config_line_t **next_out = &result;
- while (next_in) {
- *next_out = tor_malloc(sizeof(struct config_line_t));
- (*next_out)->key = tor_strdup(next_in->key);
- (*next_out)->value = tor_strdup(next_in->value);
- next_in = next_in->next;
- next_out = &((*next_out)->next);
- }
- (*next_out) = NULL;
- return result;
- }
- result = tor_malloc_zero(sizeof(struct config_line_t));
- result->key = tor_strdup(var->name);
- switch(var->type)
- {
- case CONFIG_TYPE_STRING:
- result->value = tor_strdup(value ? (char*)value : "");
- break;
- case CONFIG_TYPE_UINT:
- /* XXX This means every or_options_t uint or bool element
- * needs to be an int. Not, say, a uint16_t or char. */
- tor_snprintf(buf, sizeof(buf), "%d", *(int*)value);
- result->value = tor_strdup(buf);
- break;
- case CONFIG_TYPE_DOUBLE:
- tor_snprintf(buf, sizeof(buf), "%f", *(double*)value);
- result->value = tor_strdup(buf);
- break;
- case CONFIG_TYPE_BOOL:
- result->value = tor_strdup(*(int*)value ? "1" : "0");
- break;
- case CONFIG_TYPE_CSV:
- if (value)
- result->value = smartlist_join_strings((smartlist_t*)value,",",0,NULL);
- else
- result->value = tor_strdup("");
- break;
- default:
- tor_free(result->key);
- tor_free(result);
- log_fn(LOG_WARN,"Bug: unknown type %d for known key %s", var->type, key);
- return NULL;
- }
- return result;
- }
- /** Iterate through the linked list of requested 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.
- *
- * If <b>reset</b>, then interpret empty lines as meaning "restore to
- * default value", and interpret LINELIST* options as replacing (not
- * extending) their previous values.
- */
- static int
- config_assign(or_options_t *options, struct config_line_t *list, int reset)
- {
- struct config_line_t *p;
- /* pass 1: normalize keys */
- for (p = list; p; p = p->next) {
- const char *full = expand_abbrev(p->key, 0);
- if (strcmp(full,p->key)) {
- tor_free(p->key);
- p->key = tor_strdup(full);
- }
- }
- /* pass 2: if we're reading from a resetting source, clear all mentioned
- * linelists. */
- if (reset) {
- for (p = list; p; p = p->next)
- config_reset_line(options, p->key);
- }
- /* pass 3: assign. */
- while (list) {
- if (config_assign_line(options, list, reset))
- return -1;
- list = list->next;
- }
- return 0;
- }
- /** Try assigning <b>list</b> to <b>options</b>. You do this by duping
- * options, assigning list to the new one, then validating it. If it's
- * ok, then through out the old one and stick with the new one. Else,
- * revert to old and return failure.
- */
- int
- config_trial_assign(or_options_t **options, struct config_line_t *list, int reset)
- {
- or_options_t *trial_options = options_dup(*options);
- if (config_assign(trial_options, list, reset) < 0) {
- options_free(trial_options);
- return -1;
- }
- if (options_validate(trial_options) < 0) {
- options_free(trial_options);
- return -1;
- }
- if (options_transition_allowed(*options, trial_options) < 0) {
- options_free(trial_options);
- return -1;
- }
- /* XXX now act on options */
- options_free(*options);
- *options = trial_options;
- return 0;
- }
- /** Replace the option indexed by <b>var</b> in <b>options</b> with its
- * default value. */
- static void
- option_reset(or_options_t *options, config_var_t *var)
- {
- struct config_line_t *c;
- void *lvalue;
- lvalue = ((char*)options) + var->var_offset;
- switch (var->type) {
- case CONFIG_TYPE_STRING:
- tor_free(*(char**)lvalue);
- break;
- case CONFIG_TYPE_DOUBLE:
- *(double*)lvalue = 0.0;
- break;
- case CONFIG_TYPE_UINT:
- case CONFIG_TYPE_BOOL:
- *(int*)lvalue = 0;
- break;
- case CONFIG_TYPE_CSV:
- if (*(smartlist_t**)lvalue) {
- SMARTLIST_FOREACH(*(smartlist_t **)lvalue, char *, cp, tor_free(cp));
- smartlist_free(*(smartlist_t **)lvalue);
- *(smartlist_t **)lvalue = NULL;
- }
- break;
- case CONFIG_TYPE_LINELIST:
- case CONFIG_TYPE_LINELIST_S:
- config_free_lines(*(struct config_line_t **)lvalue);
- *(struct config_line_t **)lvalue = NULL;
- break;
- case CONFIG_TYPE_LINELIST_V:
- /* handled by linelist_s. */
- break;
- case CONFIG_TYPE_OBSOLETE:
- break;
- }
- if (var->initvalue) {
- c = tor_malloc(sizeof(struct config_line_t));
- c->key = tor_strdup(var->name);
- c->value = tor_strdup(var->initvalue);
- config_assign_line(options,c,0);
- config_free_lines(c);
- }
- }
- 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");
- }
- /** 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 obsolete.\n");
- #if 0
- "-b <bandwidth>\t\tbytes/second rate limiting\n"
- "-d <file>\t\tDebug file\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");
- #endif
- }
- /**
- * 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
- options_free(or_options_t *options)
- {
- int i;
- void *lvalue;
- for (i=0; config_vars[i].name; ++i) {
- lvalue = ((char*)options) + config_vars[i].var_offset;
- switch(config_vars[i].type) {
- case CONFIG_TYPE_UINT:
- case CONFIG_TYPE_BOOL:
- case CONFIG_TYPE_DOUBLE:
- case CONFIG_TYPE_OBSOLETE:
- break; /* nothing to free for these config types */
- case CONFIG_TYPE_STRING:
- tor_free(*(char **)lvalue);
- break;
- case CONFIG_TYPE_LINELIST:
- case CONFIG_TYPE_LINELIST_V:
- config_free_lines(*(struct config_line_t**)lvalue);
- *(struct config_line_t**)lvalue = NULL;
- break;
- case CONFIG_TYPE_CSV:
- if (*(smartlist_t**)lvalue) {
- SMARTLIST_FOREACH(*(smartlist_t**)lvalue, char *, cp, tor_free(cp));
- smartlist_free(*(smartlist_t**)lvalue);
- *(smartlist_t**)lvalue = NULL;
- }
- break;
- case CONFIG_TYPE_LINELIST_S:
- /* will be freed by corresponding LINELIST_V. */
- break;
- }
- }
- /* XXX this last part is an exception. can we make it not needed? */
- if (options->RedirectExitList) {
- SMARTLIST_FOREACH(options->RedirectExitList,
- exit_redirect_t *, p, tor_free(p));
- smartlist_free(options->RedirectExitList);
- options->RedirectExitList = NULL;
- }
- }
- /** Copy storage held by <b>old</b> into a new or_options_t and return it. */
- static or_options_t *
- options_dup(or_options_t *old)
- {
- or_options_t *new;
- int i;
- struct config_line_t *line;
- new = tor_malloc_zero(sizeof(or_options_t));
- for (i=0; config_vars[i].name; ++i) {
- line = config_get_assigned_option(old, config_vars[i].name);
- if (line) {
- if (config_assign(new, line, 0) < 0) {
- log_fn(LOG_WARN,"Bug: config_get_assigned_option() generated "
- "something we couldn't config_assign().");
- tor_assert(0);
- }
- }
- config_free_lines(line);
- }
- return new;
- }
- /** Set <b>options</b> to hold reasonable defaults for most options.
- * Each option defaults to zero. */
- void
- options_init(or_options_t *options)
- {
- int i;
- config_var_t *var;
- for (i=0; config_vars[i].name; ++i) {
- var = &config_vars[i];
- if(!var->initvalue)
- continue; /* defaults to NULL or 0 */
- option_reset(options, var);
- }
- }
- static int
- options_validate(or_options_t *options)
- {
- int i;
- int result = 0;
- struct config_line_t *cl;
- if (options->ORPort < 0 || options->ORPort > 65535) {
- log(LOG_WARN, "ORPort option out of bounds.");
- result = -1;
- }
- if (options->Nickname == NULL) {
- if (server_mode(options)) {
- 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(options)) {
- /* 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->ControlPort < 0 || options->ControlPort > 65535) {
- log(LOG_WARN, "ControlPort option out of bounds.");
- result = -1;
- }
- if (options->DirPort < 0 || options->DirPort > 65535) {
- log(LOG_WARN, "DirPort option out of bounds.");
- result = -1;
- }
- if (options->StrictExitNodes &&
- (!options->ExitNodes || !strlen(options->ExitNodes))) {
- log(LOG_WARN, "StrictExitNodes set, but no ExitNodes listed.");
- }
- if (options->StrictEntryNodes &&
- (!options->EntryNodes || !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->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->AccountingStart < 0 || options->AccountingStart > 31) {
- log(LOG_WARN,"Monthly accounting must start on a day of the month, and no months have %d days.",
- options->AccountingStart);
- result = -1;
- } else if (options->AccountingStart > 28) {
- log(LOG_WARN,"Not every month has %d days.",options->AccountingStart);
- 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"))
- result = -1;
- if (check_nickname_list(options->EntryNodes, "EntryNodes"))
- result = -1;
- if (check_nickname_list(options->ExcludeNodes, "ExcludeNodes"))
- result = -1;
- if (check_nickname_list(options->RendNodes, "RendNodes"))
- result = -1;
- if (check_nickname_list(options->RendNodes, "RendExcludeNodes"))
- result = -1;
- if (check_nickname_list(options->MyFamily, "MyFamily"))
- result = -1;
- for (cl = options->NodeFamilies; cl; cl = cl->next) {
- if (check_nickname_list(cl->value, "NodeFamily"))
- result = -1;
- }
- /* free options->RedirectExitList */
- if (options->RedirectExitList) {
- SMARTLIST_FOREACH(options->RedirectExitList,
- exit_redirect_t *, p, tor_free(p));
- smartlist_free(options->RedirectExitList);
- }
- options->RedirectExitList = smartlist_create();
- for (cl = options->RedirectExit; cl; cl = cl->next) {
- if (parse_redirect_line(options, cl)<0)
- result = -1;
- }
- /* XXX bug: this parsing shouldn't have side effects */
- 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)
- result = -1;
- }
- }
- return result;
- }
- /** Check if any of the previous options have changed but aren't allowed to. */
- static int
- options_transition_allowed(or_options_t *old, or_options_t *new) {
- if(!old)
- return 0;
- if (old->PidFile &&
- (!new->PidFile || strcmp(old->PidFile,new->PidFile))) {
- log_fn(LOG_WARN,"PidFile is not allowed to change. Failing.");
- return -1;
- }
- if (old->RunAsDaemon && !new->RunAsDaemon) {
- log_fn(LOG_WARN,"During reload, change from RunAsDaemon=1 to =0 not allowed. Failing.");
- return -1;
- }
- if (old->ORPort != new->ORPort) {
- log_fn(LOG_WARN,"During reload, changing ORPort is not allowed. Failing.");
- return -1;
- }
- return 0;
- }
- #ifdef MS_WINDOWS
- static char *get_windows_conf_root(void)
- {
- static int is_set = 0;
- static char path[MAX_PATH+1];
- LPITEMIDLIST idl;
- IMalloc *m;
- HRESULT result;
- if (is_set)
- return 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))) {
- GetCurrentDirectory(MAX_PATH, path);
- is_set = 1;
- log_fn(LOG_WARN, "I couldn't find your application data folder: are you running an ancient version of Windows 95? Defaulting to '%s'", path);
- return path;
- }
- /* 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)) {
- return NULL;
- }
- strlcat(path,"\\tor",MAX_PATH);
- is_set = 1;
- return path;
- }
- #endif
- static char *
- get_default_conf_file(void)
- {
- #ifdef MS_WINDOWS
- char *path = tor_malloc(MAX_PATH);
- strlcpy(path, get_windows_conf_root(), MAX_PATH);
- strlcat(path,"\\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 *oldoptions, *newoptions;
- struct config_line_t *cl;
- char *cf=NULL, *fname=NULL;
- int i, retval;
- int using_default_torrc;
- static char **backup_argv;
- static int backup_argc;
- /* we don't use get_options() here, since it's null on the first call */
- oldoptions = global_options;
- if (argv) { /* first time we're called. save commandline args */
- backup_argv = argv;
- backup_argc = argc;
- } else { /* we're reloading. need to clean up old options first. */
- argv = backup_argv;
- argc = backup_argc;
- }
- 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);
- }
- newoptions = tor_malloc_zero(sizeof(or_options_t));
- options_init(newoptions);
- /* learn config file name, get config lines, assign them */
- fname = NULL;
- using_default_torrc = 1;
- newoptions->command = CMD_RUN_TOR;
- for (i = 1; i < argc; ++i) {
- if (i < argc-1 && !strcmp(argv[i],"-f")) {
- if (fname) {
- log(LOG_WARN, "Duplicate -f options on command line.");
- tor_free(fname);
- }
- fname = tor_strdup(argv[i+1]);
- using_default_torrc = 0;
- ++i;
- } else if (!strcmp(argv[i],"--list-fingerprint")) {
- newoptions->command = CMD_LIST_FINGERPRINT;
- } else if (!strcmp(argv[i],"--hash-password")) {
- newoptions->command = CMD_HASH_PASSWORD;
- newoptions->command_arg = tor_strdup( (i < argc-1) ? argv[i+1] : "");
- ++i;
- }
- }
- if (using_default_torrc) {
- /* didn't find one, try CONFDIR */
- char *fn;
- 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);
- cf = read_file_to_str(fname, 0);
- 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);
- goto err;
- }
- } else { /* it opened successfully. use it. */
- tor_free(fname);
- retval = config_get_lines(cf, &cl);
- tor_free(cf);
- if (retval < 0)
- goto err;
- retval = config_assign(newoptions, cl, 0);
- config_free_lines(cl);
- if (retval < 0)
- goto err;
- }
- /* go through command-line variables too */
- cl = config_get_commandlines(argc,argv);
- retval = config_assign(newoptions,cl,0);
- config_free_lines(cl);
- if (retval < 0)
- goto err;
- /* Validate newoptions */
- if (options_validate(newoptions) < 0)
- goto err;
- if (options_transition_allowed(oldoptions, newoptions) < 0)
- goto err;
- /* XXX now act on options */
- if (rend_config_services(newoptions) < 0)
- goto err;
- if(oldoptions)
- options_free(oldoptions);
- set_options(newoptions);
- return 0;
- err:
- options_free(newoptions);
- return -1;
- }
- static int
- parse_log_severity_range(const char *range, int *min_out, int *max_out)
- {
- int levelMin, levelMax;
- const char *cp;
- cp = strchr(range, '-');
- if (cp) {
- if (cp == range) {
- levelMin = LOG_DEBUG;
- } else {
- char *tmp_sev = tor_strndup(range, cp - range);
- levelMin = parse_log_level(tmp_sev);
- if (levelMin < 0) {
- log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of "
- "err|warn|notice|info|debug", tmp_sev);
- tor_free(tmp_sev);
- return -1;
- }
- tor_free(tmp_sev);
- }
- if (!*(cp+1)) {
- levelMax = LOG_ERR;
- } else {
- 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(range);
- if (levelMin < 0) {
- log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of "
- "err|warn|notice|info|debug", range);
- return -1;
- }
- levelMax = LOG_ERR;
- }
- *min_out = levelMin;
- *max_out = levelMax;
- return 0;
- }
- static int
- convert_log_option(or_options_t *options, struct config_line_t *level_opt,
- struct config_line_t *file_opt, int isDaemon)
- {
- int levelMin = -1, levelMax = -1;
- if (level_opt) {
- if (parse_log_severity_range(level_opt->value, &levelMin, &levelMax))
- 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 && !strcasecmp(file_opt->key, "LogFile")) {
- if (add_single_log_option(options, levelMin, levelMax, "file", file_opt->value) < 0) {
- log_fn(LOG_WARN, "Cannot write to LogFile '%s': %s.", file_opt->value,
- strerror(errno));
- return -1;
- }
- } else if (file_opt && !strcasecmp(file_opt->key, "SysLog")) {
- if (add_single_log_option(options, levelMin, levelMax, "syslog", NULL) < 0)
- return -1;
- } else if (!isDaemon) {
- add_single_log_option(options, levelMin, levelMax, "stdout", NULL);
- }
- return 0;
- }
- /**
- * Initialize the logs based on the configuration file.
- */
- int
- config_init_logs(or_options_t *options)
- {
- struct config_line_t *opt;
- int ok;
- smartlist_t *elts;
- if (normalize_log_options(options))
- return -1;
- /* Special case if no options are given. */
- if (!options->Logs) {
- options->Logs = config_line_prepend(NULL, "Log", "notice-err stdout");
- }
- ok = 1;
- elts = smartlist_create();
- for (opt = options->Logs; opt; opt = opt->next) {
- int levelMin=LOG_DEBUG, levelMax=LOG_ERR;
- smartlist_split_string(elts, opt->value, " ",
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 3);
- if (smartlist_len(elts) == 0) {
- log_fn(LOG_WARN, "Bad syntax on Log option 'Log %s'", opt->value);
- ok = 0; goto cleanup;
- }
- if (parse_log_severity_range(smartlist_get(elts,0), &levelMin, &levelMax)) {
- ok = 0; goto cleanup;
- }
- if (smartlist_len(elts) < 2) { /* only loglevels were provided */
- add_stream_log(levelMin, levelMax, "<stdout>", stdout);
- goto cleanup;
- }
- if (!strcasecmp(smartlist_get(elts,1), "file")) {
- if (smartlist_len(elts) != 3) {
- log_fn(LOG_WARN, "Bad syntax on Log option 'Log %s'", opt->value);
- ok = 0; goto cleanup;
- }
- add_file_log(levelMin, levelMax, smartlist_get(elts, 2));
- goto cleanup;
- }
- if (smartlist_len(elts) != 2) {
- log_fn(LOG_WARN, "Bad syntax on Log option 'Log %s'", opt->value);
- ok = 0; goto cleanup;
- }
- if (!strcasecmp(smartlist_get(elts,1), "stdout")) {
- add_stream_log(levelMin, levelMax, "<stdout>", stdout);
- close_temp_logs();
- } else if (!strcasecmp(smartlist_get(elts,1), "stderr")) {
- add_stream_log(levelMin, levelMax, "<stderr>", stderr);
- close_temp_logs();
- } else if (!strcasecmp(smartlist_get(elts,1), "syslog")) {
- #ifdef HAVE_SYSLOG_H
- add_syslog_log(levelMin, levelMax);
- #else
- log_fn(LOG_WARN, "Syslog is not supported in this compilation.");
- #endif
- }
- cleanup:
- SMARTLIST_FOREACH(elts, char*, cp, tor_free(cp));
- smartlist_clear(elts);
- }
- smartlist_free(elts);
- close_temp_logs();
- return ok?0:-1;
- }
- static int
- add_single_log_option(or_options_t *options, int minSeverity, int maxSeverity,
- const char *type, const char *fname)
- {
- char buf[512];
- int n;
- n = tor_snprintf(buf, sizeof(buf), "%s-%s %s%s%s",
- log_level_to_string(minSeverity),
- log_level_to_string(maxSeverity),
- type, fname?" ":"", fname?fname:"");
- if (n<0) {
- log_fn(LOG_WARN, "Normalized log option too long.");
- return -1;
- }
- log_fn(LOG_WARN, "The old LogLevel/LogFile/DebugLogFile/SysLog options are deprecated, and will go away soon. New format: 'Log %s'", buf);
- options->Logs = config_line_prepend(options->Logs, "Log", buf);
- return 0;
- }
- static int
- normalize_log_options(or_options_t *options)
- {
- /* The order of options is: Level? (File Level?)+
- */
- struct config_line_t *opt = options->OldLogOptions;
- /* Special case for if first option is LogLevel. */
- if (opt && !strcasecmp(opt->key, "LogLevel")) {
- if (opt->next && (!strcasecmp(opt->next->key, "LogFile") ||
- !strcasecmp(opt->next->key, "SysLog"))) {
- if (convert_log_option(options, opt, opt->next, options->RunAsDaemon) < 0)
- return -1;
- opt = opt->next->next;
- } else if (!opt->next) {
- if (convert_log_option(options, 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 or SysLog");
- opt = opt->next;
- } else {
- tor_assert(!strcasecmp(opt->key, "LogFile") ||
- !strcasecmp(opt->key, "SysLog"));
- if (opt->next && !strcasecmp(opt->next->key, "LogLevel")) {
- /* LogFile/SysLog followed by LogLevel */
- if (convert_log_option(options,opt->next,opt, options->RunAsDaemon) < 0)
- return -1;
- opt = opt->next->next;
- } else {
- /* LogFile/SysLog followed by LogFile/SysLog or end of list. */
- if (convert_log_option(options,NULL, opt, options->RunAsDaemon) < 0)
- return -1;
- opt = opt->next;
- }
- }
- }
- if (options->DebugLogFile) {
- if (add_single_log_option(options, LOG_DEBUG, LOG_ERR, "file", options->DebugLogFile) < 0)
- return -1;
- }
- tor_free(options->DebugLogFile);
- config_free_lines(options->OldLogOptions);
- options->OldLogOptions = NULL;
- 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));
- elements = smartlist_create();
- 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 (0==strcasecmp(smartlist_get(elements,1), "pass")) {
- r->is_redirect = 0;
- } else {
- if (parse_addr_port(smartlist_get(elements,1),NULL,&r->addr_dest,
- &r->port_dest)) {
- log_fn(LOG_WARN, "Error parsing dest address in RedirectExit line");
- goto err;
- }
- r->is_redirect = 1;
- }
- 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);
- tor_free(address);
- return r;
- }
- const char *
- get_data_directory(void)
- {
- const char *d;
- or_options_t *options = get_options();
- if (options->DataDirectory) {
- d = options->DataDirectory;
- } else {
- #ifdef MS_WINDOWS
- char *p;
- p = tor_malloc(MAX_PATH);
- strlcpy(p,get_windows_conf_root(),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:
- */
|