cleaned up some, added validation to getoptions()

svn:r40
This commit is contained in:
Bruce Montrose 2002-07-11 14:50:26 +00:00
parent eb51576abf
commit 4c65f31340
2 changed files with 124 additions and 23 deletions

View File

@ -8,6 +8,9 @@
/* /*
* Changes : * Changes :
* $Log$ * $Log$
* Revision 1.7 2002/07/11 14:50:26 montrose
* cleaned up some, added validation to getoptions()
*
* Revision 1.6 2002/07/10 12:37:49 montrose * Revision 1.6 2002/07/10 12:37:49 montrose
* Added usage display on error. * Added usage display on error.
* *
@ -65,16 +68,18 @@ int getconfig(char *conf_filename, config_opt_t *options)
int getoptions(int argc, char **argv, or_options_t *options) int getoptions(int argc, char **argv, or_options_t *options)
/** /**
A replacement for getargs() and getconfig() which uses the <popt> library to parse A replacement for getargs() and getconfig() which uses the <popt> library to parse
both command-line arguments and configuration files. A specific configuration file both command-line arguments and configuration files. A specific configuration file
may be specified using the --ConfigFile option. If one is not specified, then the may be specified using the --ConfigFile option. If one is not specified, then the
configuration files at /etc/<cmd>rc and ~/.<cmd>rc will be loaded in that order (so configuration files at /etc/<cmd>rc and ~/.<cmd>rc will be loaded in that order so
user preferences will override the ones specified in /etc. Note: <cmd> is the user preferences will override the ones specified in /etc.
basename() or argv[0] so one could run the same executeable through soft links to
get different configuration files loaded for different instances of the same program. The --ConfigFile (-f) option may only be used on the command-line. All other command-line
The ConfigFile option may only be used on the command-line. All other command-line
options may also be specified in configuration files. <popt> aliases are enabled options may also be specified in configuration files. <popt> aliases are enabled
here so a user can define their own options in the /etc/popt or ~/.popt files. so a user can define their own options in the /etc/popt or ~/.popt files as outlined
in "man popt" pages.
RETURN VALUE: 0 on success, non-zero on error RETURN VALUE: 0 on success, non-zero on error
**/ **/
{ {
@ -85,17 +90,28 @@ RETURN VALUE: 0 on success, non-zero on error
char *cmd; char *cmd;
struct poptOption opt_tab[] = struct poptOption opt_tab[] =
{ {
{ "APPort", 'a', POPT_ARG_INT, &options->APPort, 0, "application proxy port", "<port>" }, { "APPort", 'a', POPT_ARG_INT, &options->APPort,
{ "CoinWeight", 'w', POPT_ARG_FLOAT, &options->CoinWeight, 0, "coin weight used in determining routes", "<weight>" }, 0, "application proxy port", "<port>" },
{ "ConfigFile", 'f', POPT_ARG_STRING, &ConfigFile, 0, "user specified configuration file", "<file>" }, { "CoinWeight", 'w', POPT_ARG_FLOAT, &options->CoinWeight,
{ "LogLevel", 'l', POPT_ARG_STRING, &options->LogLevel, 0, "emerg|alert|crit|err|warning|notice|info|debug", "<level>" }, 0, "coin weight used in determining routes", "<weight>" },
{ "MaxConn", 'm', POPT_ARG_INT, &options->MaxConn, 0, "maximum number of incoming connections", "<max>" }, { "ConfigFile", 'f', POPT_ARG_STRING, &ConfigFile,
{ "OPPort", 'o', POPT_ARG_INT, &options->OPPort, 0, "onion proxy port", "<port>" }, 0, "user specified configuration file", "<file>" },
{ "ORPort", 'p', POPT_ARG_INT, &options->ORPort, 0, "onion router port", "<port>" }, { "LogLevel", 'l', POPT_ARG_STRING, &options->LogLevel,
{ "PrivateKeyFile", 'k', POPT_ARG_STRING, &options->PrivateKeyFile, 0, "maximum number of incoming connections", "<max>" }, 0, "emerg|alert|crit|err|warning|notice|info|debug", "<level>" },
{ "RouterFile", 'r', POPT_ARG_STRING, &options->RouterFile, 0, "local port on which the onion proxy is running", "<port>" }, { "MaxConn", 'm', POPT_ARG_INT, &options->MaxConn,
{ "TrafficShaping", 't', POPT_ARG_INT, &options->TrafficShaping, 0, "which traffic shaping policy to use", "<policy>" }, 0, "maximum number of incoming connections", "<max>" },
{ "Verbose", 'v', POPT_ARG_NONE, &Verbose, 0, "display options selected before execution", NULL }, { "OPPort", 'o', POPT_ARG_INT, &options->OPPort,
0, "onion proxy port", "<port>" },
{ "ORPort", 'p', POPT_ARG_INT, &options->ORPort,
0, "onion router port", "<port>" },
{ "PrivateKeyFile", 'k', POPT_ARG_STRING, &options->PrivateKeyFile,
0, "maximum number of incoming connections", "<max>" },
{ "RouterFile", 'r', POPT_ARG_STRING, &options->RouterFile,
0, "local port on which the onion proxy is running", "<port>" },
{ "TrafficShaping", 't', POPT_ARG_INT, &options->TrafficShaping,
0, "which traffic shaping policy to use", "<policy>" },
{ "Verbose", 'v', POPT_ARG_NONE, &Verbose,
0, "display options selected before execution", NULL },
POPT_AUTOHELP /* handles --usage and --help automatically */ POPT_AUTOHELP /* handles --usage and --help automatically */
POPT_TABLEEND /* marks end of table */ POPT_TABLEEND /* marks end of table */
}; };
@ -109,7 +125,7 @@ RETURN VALUE: 0 on success, non-zero on error
code = poptGetNextOpt(optCon); /* first we handle command-line args */ code = poptGetNextOpt(optCon); /* first we handle command-line args */
if ( code == -1 ) if ( code == -1 )
{ {
if ( ConfigFile ) /* handle user-specified config file if any */ if ( ConfigFile ) /* handle user-specified config file */
code = poptReadOptions(optCon,ConfigFile); code = poptReadOptions(optCon,ConfigFile);
else /* load Default configuration files */ else /* load Default configuration files */
code = poptReadDefaultOptions(cmd,optCon); code = poptReadDefaultOptions(cmd,optCon);
@ -118,26 +134,110 @@ RETURN VALUE: 0 on success, non-zero on error
switch(code) /* error checking */ switch(code) /* error checking */
{ {
case INT_MIN: case INT_MIN:
fprintf(stderr, "%s: Unable to open configuration file.\n", ConfigFile); log(LOG_ERR, "%s: Unable to open configuration file.\n", ConfigFile);
break; break;
case -1: case -1:
if ( Verbose ) /* display options upon user request */ if ( Verbose ) /* display options upon user request */
{ {
printf("LogLevel=%s\n",options->LogLevel); printf("LogLevel=%s\n",options->LogLevel);
printf("RouterFile=%s, PrivateKeyFile=%s\n",options->RouterFile,options->PrivateKeyFile); printf("RouterFile=%s, PrivateKeyFile=%s\n",
printf("ORPort=%d, OPPort=%d, APPort=%d\n",options->ORPort,options->OPPort,options->APPort); options->RouterFile,
printf("CoinWeight=%6.4f, MaxConn=%d, TrafficShaping=%d\n",options->CoinWeight,options->MaxConn,options->TrafficShaping); options->PrivateKeyFile);
printf("ORPort=%d, OPPort=%d, APPort=%d\n",
options->ORPort,options->OPPort,
options->APPort);
printf("CoinWeight=%6.4f, MaxConn=%d, TrafficShaping=%d\n",
options->CoinWeight,
options->MaxConn,
options->TrafficShaping);
} }
code = 0; code = 0;
break; break;
default: default:
poptPrintUsage(optCon, stderr, 0); poptPrintUsage(optCon, stderr, 0);
fprintf(stderr, "%s: %s\n", poptBadOption(optCon, POPT_BADOPTION_NOALIAS), poptStrerror(code)); log(LOG_ERR, "%s: %s\n", poptBadOption(optCon, POPT_BADOPTION_NOALIAS), poptStrerror(code));
break; break;
} }
poptFreeContext(optCon); poptFreeContext(optCon);
/* Validate options */
if ( options->LogLevel )
{
if (!strcmp(options->LogLevel,"emerg"))
options->loglevel = LOG_EMERG;
else if (!strcmp(options->LogLevel,"alert"))
options->loglevel = LOG_ALERT;
else if (!strcmp(options->LogLevel,"crit"))
options->loglevel = LOG_CRIT;
else if (!strcmp(options->LogLevel,"err"))
options->loglevel = LOG_ERR;
else if (!strcmp(options->LogLevel,"warning"))
options->loglevel = LOG_WARNING;
else if (!strcmp(options->LogLevel,"notice"))
options->loglevel = LOG_NOTICE;
else if (!strcmp(options->LogLevel,"info"))
options->loglevel = LOG_INFO;
else if (!strcmp(options->LogLevel,"debug"))
options->loglevel = LOG_DEBUG;
else
{
log(LOG_ERR,"LogLevel must be one of emerg|alert|crit|err|warning|notice|info|debug.");
code = -1;
}
}
else
options->loglevel = LOG_DEBUG; /* default value */
if ( options->RouterFile == NULL )
{
log(LOG_ERR,"RouterFile option required, but not found.");
code = -1;
}
if ( options->PrivateKeyFile == NULL )
{
log(LOG_ERR,"PrivateKeyFile option required, but not found.");
code = -1;
}
if ( options->ORPort < 1 )
{
log(LOG_ERR,"ORPort option required and must be a positive integer value.");
code = -1;
}
if ( options->OPPort < 1 )
{
log(LOG_ERR,"OPPort option required and must be a positive integer value.");
code = -1;
}
if ( options->APPort < 1 )
{
log(LOG_ERR,"APPort option required and must be a positive integer value.");
code = -1;
}
if ( options->CoinWeight < 0.0 || options->CoinWeight >= 1.0 )
{
log(LOG_ERR,"CoinWeight option must a value from 0.0 upto 1.0, but not including 1.0.");
code = -1;
}
if ( options->MaxConn <= 0 )
{
log(LOG_ERR,"MaxConn option must be a non-zero positive integer.");
code = -1;
}
if ( options->TrafficShaping != 0 && options->TrafficShaping != 1 )
{
log(LOG_ERR,"TrafficShaping option must be either 0 or 1.");
code = -1;
}
return code; return code;
} }

View File

@ -295,6 +295,7 @@ typedef struct
int APPort; int APPort;
int MaxConn; int MaxConn;
int TrafficShaping; int TrafficShaping;
int loglevel;
} or_options_t; } or_options_t;