Module Name: src Committed By: christos Date: Tue Mar 3 03:10:32 UTC 2020
Added Files: src/external/bsd/pam-u2f/bin/pamu2fcfg: Makefile cmdline.c cmdline.h Log Message: Add build glue To generate a diff of this commit: cvs rdiff -u -r0 -r1.1 src/external/bsd/pam-u2f/bin/pamu2fcfg/Makefile \ src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.c \ src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.h Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.
Added files: Index: src/external/bsd/pam-u2f/bin/pamu2fcfg/Makefile diff -u /dev/null src/external/bsd/pam-u2f/bin/pamu2fcfg/Makefile:1.1 --- /dev/null Mon Mar 2 22:10:32 2020 +++ src/external/bsd/pam-u2f/bin/pamu2fcfg/Makefile Mon Mar 2 22:10:32 2020 @@ -0,0 +1,27 @@ +# $NetBSD: Makefile,v 1.1 2020/03/03 03:10:32 christos Exp $ + +NOMAN= + +.include <bsd.own.mk> + +DIST=${NETBSDSRCDIR}/external/bsd/pam-u2f/dist + +.PATH: ${DIST} ${DIST}/pamu2fcfg + +CFFILE=${DIST}/configure.ac +PACKAGE!= ${TOOL_SED} -ne 's/AC_INIT(\[\([a-zA-Z0-9_-]*\)\].*/\1/p' ${CFFILE} +VERSION!= ${TOOL_SED} -ne 's/AC_INIT(\[[a-zA-Z0-9_-]*\], \[\([0-9.]*\)\].*/\1/p' ${CFFILE} + +CPPFLAGS+= -I${DIST} -I${.CURDIR} +CPPFLAGS+= -DPACKAGE='"${PACKAGE}"' -DVERSION='"${VERSION}"' +CPPFLAGS+= -DHAVE_UNISTD_H + +BINDIR=/usr/bin +PROG=pamu2fcfg +SRCS=pamu2fcfg.c cmdline.c b64.c readpassphrase.c explicit_bzero.c util.c +COPTS.util.c += -Wno-error=stack-protector + +LDADD+=-lpam -lfido2 -lcbor -lusbhid -lcrypto +DPADD+=${LIBPAM} ${LIBFIDO2} ${LIBCBOR} ${LIBUSBHID} ${LIBCRYPTO} + +.include <bsd.prog.mk> Index: src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.c diff -u /dev/null src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.c:1.1 --- /dev/null Mon Mar 2 22:10:32 2020 +++ src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.c Mon Mar 2 22:10:32 2020 @@ -0,0 +1,731 @@ +/* + File autogenerated by gengetopt version 2.22.6 + generated with the following command: + gengetopt --no-handle-help --input cmdline.ggo Makefile.am + + The developers of gengetopt consider the fixed text that goes in all + gengetopt output files to be in the public domain: + we make no copyright claims on it. +*/ + +/* If we use autoconf. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +#ifndef FIX_UNUSED +#define FIX_UNUSED(X) (void) (X) /* avoid warnings for unused params */ +#endif + +#include <getopt.h> + +#include "cmdline.h" + +const char *gengetopt_args_info_purpose = "Perform a U2F registration operation and print a configuration line that can be\nused with the pam_u2f module."; + +const char *gengetopt_args_info_usage = "Usage: " CMDLINE_PARSER_PACKAGE " [OPTIONS]..."; + +const char *gengetopt_args_info_versiontext = ""; + +const char *gengetopt_args_info_description = ""; + +const char *gengetopt_args_info_help[] = { + " -h, --help Print help and exit", + " --version Print version and exit", + " -o, --origin=STRING Origin URL to use during registration. Defaults to\n pam://hostname", + " -i, --appid=STRING Application ID to use during registration. Defaults\n to pam://hostname", + " -t, --type=STRING COSE type to use during registration (ES256 or\n RS256). Defaults to ES256.", + " -r, --resident Generate a resident credential (default=off)", + " -P, --no-user-presence Allow the credential to be used without ensuring the\n user's presence (default=off)", + " -N, --pin-verification Require PIN verification during authentication\n (default=off)", + " -V, --user-verification Require user verification during authentication\n (default=off)", + " -d, --debug Print debug information (highly verbose)\n (default=off)", + " -v, --verbose Print information about chosen origin and appid\n (default=off)", + "\n Group: user", + " -u, --username=STRING The name of the user registering the device.\n Defaults to the current user name", + " -n, --nouser Print only registration information (keyHandle and\n public key). Useful for appending", + 0 +}; + +typedef enum {ARG_NO + , ARG_FLAG + , ARG_STRING +} cmdline_parser_arg_type; + +static +void clear_given (struct gengetopt_args_info *args_info); +static +void clear_args (struct gengetopt_args_info *args_info); + +static int +cmdline_parser_internal (int argc, char **argv, struct gengetopt_args_info *args_info, + struct cmdline_parser_params *params, const char *additional_error); + + +static char * +gengetopt_strdup (const char *s); + +static +void clear_given (struct gengetopt_args_info *args_info) +{ + args_info->help_given = 0 ; + args_info->version_given = 0 ; + args_info->origin_given = 0 ; + args_info->appid_given = 0 ; + args_info->type_given = 0 ; + args_info->resident_given = 0 ; + args_info->no_user_presence_given = 0 ; + args_info->pin_verification_given = 0 ; + args_info->user_verification_given = 0 ; + args_info->debug_given = 0 ; + args_info->verbose_given = 0 ; + args_info->username_given = 0 ; + args_info->nouser_given = 0 ; + args_info->user_group_counter = 0 ; +} + +static +void clear_args (struct gengetopt_args_info *args_info) +{ + FIX_UNUSED (args_info); + args_info->origin_arg = NULL; + args_info->origin_orig = NULL; + args_info->appid_arg = NULL; + args_info->appid_orig = NULL; + args_info->type_arg = NULL; + args_info->type_orig = NULL; + args_info->resident_flag = 0; + args_info->no_user_presence_flag = 0; + args_info->pin_verification_flag = 0; + args_info->user_verification_flag = 0; + args_info->debug_flag = 0; + args_info->verbose_flag = 0; + args_info->username_arg = NULL; + args_info->username_orig = NULL; + +} + +static +void init_args_info(struct gengetopt_args_info *args_info) +{ + + + args_info->help_help = gengetopt_args_info_help[0] ; + args_info->version_help = gengetopt_args_info_help[1] ; + args_info->origin_help = gengetopt_args_info_help[2] ; + args_info->appid_help = gengetopt_args_info_help[3] ; + args_info->type_help = gengetopt_args_info_help[4] ; + args_info->resident_help = gengetopt_args_info_help[5] ; + args_info->no_user_presence_help = gengetopt_args_info_help[6] ; + args_info->pin_verification_help = gengetopt_args_info_help[7] ; + args_info->user_verification_help = gengetopt_args_info_help[8] ; + args_info->debug_help = gengetopt_args_info_help[9] ; + args_info->verbose_help = gengetopt_args_info_help[10] ; + args_info->username_help = gengetopt_args_info_help[12] ; + args_info->nouser_help = gengetopt_args_info_help[13] ; + +} + +void +cmdline_parser_print_version (void) +{ + printf ("%s %s\n", + (strlen(CMDLINE_PARSER_PACKAGE_NAME) ? CMDLINE_PARSER_PACKAGE_NAME : CMDLINE_PARSER_PACKAGE), + CMDLINE_PARSER_VERSION); + + if (strlen(gengetopt_args_info_versiontext) > 0) + printf("\n%s\n", gengetopt_args_info_versiontext); +} + +static void print_help_common(void) { + cmdline_parser_print_version (); + + if (strlen(gengetopt_args_info_purpose) > 0) + printf("\n%s\n", gengetopt_args_info_purpose); + + if (strlen(gengetopt_args_info_usage) > 0) + printf("\n%s\n", gengetopt_args_info_usage); + + printf("\n"); + + if (strlen(gengetopt_args_info_description) > 0) + printf("%s\n\n", gengetopt_args_info_description); +} + +void +cmdline_parser_print_help (void) +{ + int i = 0; + print_help_common(); + while (gengetopt_args_info_help[i]) + printf("%s\n", gengetopt_args_info_help[i++]); +} + +void +cmdline_parser_init (struct gengetopt_args_info *args_info) +{ + clear_given (args_info); + clear_args (args_info); + init_args_info (args_info); +} + +void +cmdline_parser_params_init(struct cmdline_parser_params *params) +{ + if (params) + { + params->override = 0; + params->initialize = 1; + params->check_required = 1; + params->check_ambiguity = 0; + params->print_errors = 1; + } +} + +struct cmdline_parser_params * +cmdline_parser_params_create(void) +{ + struct cmdline_parser_params *params = + (struct cmdline_parser_params *)malloc(sizeof(struct cmdline_parser_params)); + cmdline_parser_params_init(params); + return params; +} + +static void +free_string_field (char **s) +{ + if (*s) + { + free (*s); + *s = 0; + } +} + + +static void +cmdline_parser_release (struct gengetopt_args_info *args_info) +{ + + free_string_field (&(args_info->origin_arg)); + free_string_field (&(args_info->origin_orig)); + free_string_field (&(args_info->appid_arg)); + free_string_field (&(args_info->appid_orig)); + free_string_field (&(args_info->type_arg)); + free_string_field (&(args_info->type_orig)); + free_string_field (&(args_info->username_arg)); + free_string_field (&(args_info->username_orig)); + + + + clear_given (args_info); +} + + +static void +write_into_file(FILE *outfile, const char *opt, const char *arg, const char *values[]) +{ + FIX_UNUSED (values); + if (arg) { + fprintf(outfile, "%s=\"%s\"\n", opt, arg); + } else { + fprintf(outfile, "%s\n", opt); + } +} + + +int +cmdline_parser_dump(FILE *outfile, struct gengetopt_args_info *args_info) +{ + int i = 0; + + if (!outfile) + { + fprintf (stderr, "%s: cannot dump options to stream\n", CMDLINE_PARSER_PACKAGE); + return EXIT_FAILURE; + } + + if (args_info->help_given) + write_into_file(outfile, "help", 0, 0 ); + if (args_info->version_given) + write_into_file(outfile, "version", 0, 0 ); + if (args_info->origin_given) + write_into_file(outfile, "origin", args_info->origin_orig, 0); + if (args_info->appid_given) + write_into_file(outfile, "appid", args_info->appid_orig, 0); + if (args_info->type_given) + write_into_file(outfile, "type", args_info->type_orig, 0); + if (args_info->resident_given) + write_into_file(outfile, "resident", 0, 0 ); + if (args_info->no_user_presence_given) + write_into_file(outfile, "no-user-presence", 0, 0 ); + if (args_info->pin_verification_given) + write_into_file(outfile, "pin-verification", 0, 0 ); + if (args_info->user_verification_given) + write_into_file(outfile, "user-verification", 0, 0 ); + if (args_info->debug_given) + write_into_file(outfile, "debug", 0, 0 ); + if (args_info->verbose_given) + write_into_file(outfile, "verbose", 0, 0 ); + if (args_info->username_given) + write_into_file(outfile, "username", args_info->username_orig, 0); + if (args_info->nouser_given) + write_into_file(outfile, "nouser", 0, 0 ); + + + i = EXIT_SUCCESS; + return i; +} + +int +cmdline_parser_file_save(const char *filename, struct gengetopt_args_info *args_info) +{ + FILE *outfile; + int i = 0; + + outfile = fopen(filename, "w"); + + if (!outfile) + { + fprintf (stderr, "%s: cannot open file for writing: %s\n", CMDLINE_PARSER_PACKAGE, filename); + return EXIT_FAILURE; + } + + i = cmdline_parser_dump(outfile, args_info); + fclose (outfile); + + return i; +} + +void +cmdline_parser_free (struct gengetopt_args_info *args_info) +{ + cmdline_parser_release (args_info); +} + +/** @brief replacement of strdup, which is not standard */ +char * +gengetopt_strdup (const char *s) +{ + char *result = 0; + if (!s) + return result; + + result = (char*)malloc(strlen(s) + 1); + if (result == (char*)0) + return (char*)0; + strcpy(result, s); + return result; +} + +static void +reset_group_user(struct gengetopt_args_info *args_info) +{ + if (! args_info->user_group_counter) + return; + + args_info->username_given = 0 ; + free_string_field (&(args_info->username_arg)); + free_string_field (&(args_info->username_orig)); + args_info->nouser_given = 0 ; + + args_info->user_group_counter = 0; +} + +int +cmdline_parser (int argc, char **argv, struct gengetopt_args_info *args_info) +{ + return cmdline_parser2 (argc, argv, args_info, 0, 1, 1); +} + +int +cmdline_parser_ext (int argc, char **argv, struct gengetopt_args_info *args_info, + struct cmdline_parser_params *params) +{ + int result; + result = cmdline_parser_internal (argc, argv, args_info, params, 0); + + if (result == EXIT_FAILURE) + { + cmdline_parser_free (args_info); + exit (EXIT_FAILURE); + } + + return result; +} + +int +cmdline_parser2 (int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required) +{ + int result; + struct cmdline_parser_params params; + + params.override = override; + params.initialize = initialize; + params.check_required = check_required; + params.check_ambiguity = 0; + params.print_errors = 1; + + result = cmdline_parser_internal (argc, argv, args_info, ¶ms, 0); + + if (result == EXIT_FAILURE) + { + cmdline_parser_free (args_info); + exit (EXIT_FAILURE); + } + + return result; +} + +int +cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name) +{ + FIX_UNUSED (args_info); + FIX_UNUSED (prog_name); + return EXIT_SUCCESS; +} + + +static char *package_name = 0; + +/** + * @brief updates an option + * @param field the generic pointer to the field to update + * @param orig_field the pointer to the orig field + * @param field_given the pointer to the number of occurrence of this option + * @param prev_given the pointer to the number of occurrence already seen + * @param value the argument for this option (if null no arg was specified) + * @param possible_values the possible values for this option (if specified) + * @param default_value the default value (in case the option only accepts fixed values) + * @param arg_type the type of this option + * @param check_ambiguity @see cmdline_parser_params.check_ambiguity + * @param override @see cmdline_parser_params.override + * @param no_free whether to free a possible previous value + * @param multiple_option whether this is a multiple option + * @param long_opt the corresponding long option + * @param short_opt the corresponding short option (or '-' if none) + * @param additional_error possible further error specification + */ +static +int update_arg(void *field, char **orig_field, + unsigned int *field_given, unsigned int *prev_given, + char *value, const char *possible_values[], + const char *default_value, + cmdline_parser_arg_type arg_type, + int check_ambiguity, int override, + int no_free, int multiple_option, + const char *long_opt, char short_opt, + const char *additional_error) +{ + char *stop_char = 0; + const char *val = value; + int found; + char **string_field; + FIX_UNUSED (field); + + stop_char = 0; + found = 0; + + if (!multiple_option && prev_given && (*prev_given || (check_ambiguity && *field_given))) + { + if (short_opt != '-') + fprintf (stderr, "%s: `--%s' (`-%c') option given more than once%s\n", + package_name, long_opt, short_opt, + (additional_error ? additional_error : "")); + else + fprintf (stderr, "%s: `--%s' option given more than once%s\n", + package_name, long_opt, + (additional_error ? additional_error : "")); + return 1; /* failure */ + } + + FIX_UNUSED (default_value); + + if (field_given && *field_given && ! override) + return 0; + if (prev_given) + (*prev_given)++; + if (field_given) + (*field_given)++; + if (possible_values) + val = possible_values[found]; + + switch(arg_type) { + case ARG_FLAG: + *((int *)field) = !*((int *)field); + break; + case ARG_STRING: + if (val) { + string_field = (char **)field; + if (!no_free && *string_field) + free (*string_field); /* free previous string */ + *string_field = gengetopt_strdup (val); + } + break; + default: + break; + }; + + + /* store the original value */ + switch(arg_type) { + case ARG_NO: + case ARG_FLAG: + break; + default: + if (value && orig_field) { + if (no_free) { + *orig_field = value; + } else { + if (*orig_field) + free (*orig_field); /* free previous string */ + *orig_field = gengetopt_strdup (value); + } + } + }; + + return 0; /* OK */ +} + + +int +cmdline_parser_internal ( + int argc, char **argv, struct gengetopt_args_info *args_info, + struct cmdline_parser_params *params, const char *additional_error) +{ + int c; /* Character of the parsed option. */ + + int error_occurred = 0; + struct gengetopt_args_info local_args_info; + + int override; + int initialize; + int check_required; + int check_ambiguity; + + package_name = argv[0]; + + override = params->override; + initialize = params->initialize; + check_required = params->check_required; + check_ambiguity = params->check_ambiguity; + + if (initialize) + cmdline_parser_init (args_info); + + cmdline_parser_init (&local_args_info); + + optarg = 0; + optind = 0; + opterr = params->print_errors; + optopt = '?'; + + while (1) + { + int option_index = 0; + + static struct option long_options[] = { + { "help", 0, NULL, 'h' }, + { "version", 0, NULL, 0 }, + { "origin", 1, NULL, 'o' }, + { "appid", 1, NULL, 'i' }, + { "type", 1, NULL, 't' }, + { "resident", 0, NULL, 'r' }, + { "no-user-presence", 0, NULL, 'P' }, + { "pin-verification", 0, NULL, 'N' }, + { "user-verification", 0, NULL, 'V' }, + { "debug", 0, NULL, 'd' }, + { "verbose", 0, NULL, 'v' }, + { "username", 1, NULL, 'u' }, + { "nouser", 0, NULL, 'n' }, + { 0, 0, 0, 0 } + }; + + c = getopt_long (argc, argv, "ho:i:t:rPNVdvu:n", long_options, &option_index); + + if (c == -1) break; /* Exit from `while (1)' loop. */ + + switch (c) + { + case 'h': /* Print help and exit. */ + + + if (update_arg( 0 , + 0 , &(args_info->help_given), + &(local_args_info.help_given), optarg, 0, 0, ARG_NO, + check_ambiguity, override, 0, 0, + "help", 'h', + additional_error)) + goto failure; + cmdline_parser_free (&local_args_info); + return 0; + + break; + case 'o': /* Origin URL to use during registration. Defaults to pam://hostname. */ + + + if (update_arg( (void *)&(args_info->origin_arg), + &(args_info->origin_orig), &(args_info->origin_given), + &(local_args_info.origin_given), optarg, 0, 0, ARG_STRING, + check_ambiguity, override, 0, 0, + "origin", 'o', + additional_error)) + goto failure; + + break; + case 'i': /* Application ID to use during registration. Defaults to pam://hostname. */ + + + if (update_arg( (void *)&(args_info->appid_arg), + &(args_info->appid_orig), &(args_info->appid_given), + &(local_args_info.appid_given), optarg, 0, 0, ARG_STRING, + check_ambiguity, override, 0, 0, + "appid", 'i', + additional_error)) + goto failure; + + break; + case 't': /* COSE type to use during registration (ES256 or RS256). Defaults to ES256.. */ + + + if (update_arg( (void *)&(args_info->type_arg), + &(args_info->type_orig), &(args_info->type_given), + &(local_args_info.type_given), optarg, 0, 0, ARG_STRING, + check_ambiguity, override, 0, 0, + "type", 't', + additional_error)) + goto failure; + + break; + case 'r': /* Generate a resident credential. */ + + + if (update_arg((void *)&(args_info->resident_flag), 0, &(args_info->resident_given), + &(local_args_info.resident_given), optarg, 0, 0, ARG_FLAG, + check_ambiguity, override, 1, 0, "resident", 'r', + additional_error)) + goto failure; + + break; + case 'P': /* Allow the credential to be used without ensuring the user's presence. */ + + + if (update_arg((void *)&(args_info->no_user_presence_flag), 0, &(args_info->no_user_presence_given), + &(local_args_info.no_user_presence_given), optarg, 0, 0, ARG_FLAG, + check_ambiguity, override, 1, 0, "no-user-presence", 'P', + additional_error)) + goto failure; + + break; + case 'N': /* Require PIN verification during authentication. */ + + + if (update_arg((void *)&(args_info->pin_verification_flag), 0, &(args_info->pin_verification_given), + &(local_args_info.pin_verification_given), optarg, 0, 0, ARG_FLAG, + check_ambiguity, override, 1, 0, "pin-verification", 'N', + additional_error)) + goto failure; + + break; + case 'V': /* Require user verification during authentication. */ + + + if (update_arg((void *)&(args_info->user_verification_flag), 0, &(args_info->user_verification_given), + &(local_args_info.user_verification_given), optarg, 0, 0, ARG_FLAG, + check_ambiguity, override, 1, 0, "user-verification", 'V', + additional_error)) + goto failure; + + break; + case 'd': /* Print debug information (highly verbose). */ + + + if (update_arg((void *)&(args_info->debug_flag), 0, &(args_info->debug_given), + &(local_args_info.debug_given), optarg, 0, 0, ARG_FLAG, + check_ambiguity, override, 1, 0, "debug", 'd', + additional_error)) + goto failure; + + break; + case 'v': /* Print information about chosen origin and appid. */ + + + if (update_arg((void *)&(args_info->verbose_flag), 0, &(args_info->verbose_given), + &(local_args_info.verbose_given), optarg, 0, 0, ARG_FLAG, + check_ambiguity, override, 1, 0, "verbose", 'v', + additional_error)) + goto failure; + + break; + case 'u': /* The name of the user registering the device. Defaults to the current user name. */ + + if (args_info->user_group_counter && override) + reset_group_user (args_info); + args_info->user_group_counter += 1; + + if (update_arg( (void *)&(args_info->username_arg), + &(args_info->username_orig), &(args_info->username_given), + &(local_args_info.username_given), optarg, 0, 0, ARG_STRING, + check_ambiguity, override, 0, 0, + "username", 'u', + additional_error)) + goto failure; + + break; + case 'n': /* Print only registration information (keyHandle and public key). Useful for appending. */ + + if (args_info->user_group_counter && override) + reset_group_user (args_info); + args_info->user_group_counter += 1; + + if (update_arg( 0 , + 0 , &(args_info->nouser_given), + &(local_args_info.nouser_given), optarg, 0, 0, ARG_NO, + check_ambiguity, override, 0, 0, + "nouser", 'n', + additional_error)) + goto failure; + + break; + + case 0: /* Long option with no short option */ + if (strcmp (long_options[option_index].name, "version") == 0) { + cmdline_parser_print_version (); + cmdline_parser_free (&local_args_info); + exit (EXIT_SUCCESS); + } + + case '?': /* Invalid option. */ + /* `getopt_long' already printed an error message. */ + goto failure; + + default: /* bug: option not considered. */ + fprintf (stderr, "%s: option unknown: %c%s\n", CMDLINE_PARSER_PACKAGE, c, (additional_error ? additional_error : "")); + abort (); + } /* switch */ + } /* while */ + + if (args_info->user_group_counter > 1) + { + fprintf (stderr, "%s: %d options of group user were given. At most one is required%s.\n", argv[0], args_info->user_group_counter, (additional_error ? additional_error : "")); + error_occurred = 1; + } + + + + + cmdline_parser_release (&local_args_info); + + if ( error_occurred ) + return (EXIT_FAILURE); + + return 0; + +failure: + + cmdline_parser_release (&local_args_info); + return (EXIT_FAILURE); +} Index: src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.h diff -u /dev/null src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.h:1.1 --- /dev/null Mon Mar 2 22:10:32 2020 +++ src/external/bsd/pam-u2f/bin/pamu2fcfg/cmdline.h Mon Mar 2 22:10:32 2020 @@ -0,0 +1,214 @@ +/** @file cmdline.h + * @brief The header file for the command line option parser + * generated by GNU Gengetopt version 2.22.6 + * http://www.gnu.org/software/gengetopt. + * DO NOT modify this file, since it can be overwritten + * @author GNU Gengetopt by Lorenzo Bettini */ + +#ifndef CMDLINE_H +#define CMDLINE_H + +/* If we use autoconf. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <stdio.h> /* for FILE */ + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +#ifndef CMDLINE_PARSER_PACKAGE +/** @brief the program name (used for printing errors) */ +#define CMDLINE_PARSER_PACKAGE PACKAGE +#endif + +#ifndef CMDLINE_PARSER_PACKAGE_NAME +/** @brief the complete program name (used for help and version) */ +#ifdef PACKAGE_NAME +#define CMDLINE_PARSER_PACKAGE_NAME PACKAGE_NAME +#else +#define CMDLINE_PARSER_PACKAGE_NAME PACKAGE +#endif +#endif + +#ifndef CMDLINE_PARSER_VERSION +/** @brief the program version */ +#define CMDLINE_PARSER_VERSION VERSION +#endif + +/** @brief Where the command line options are stored */ +struct gengetopt_args_info +{ + const char *help_help; /**< @brief Print help and exit help description. */ + const char *version_help; /**< @brief Print version and exit help description. */ + char * origin_arg; /**< @brief Origin URL to use during registration. Defaults to pam://hostname. */ + char * origin_orig; /**< @brief Origin URL to use during registration. Defaults to pam://hostname original value given at command line. */ + const char *origin_help; /**< @brief Origin URL to use during registration. Defaults to pam://hostname help description. */ + char * appid_arg; /**< @brief Application ID to use during registration. Defaults to pam://hostname. */ + char * appid_orig; /**< @brief Application ID to use during registration. Defaults to pam://hostname original value given at command line. */ + const char *appid_help; /**< @brief Application ID to use during registration. Defaults to pam://hostname help description. */ + char * type_arg; /**< @brief COSE type to use during registration (ES256 or RS256). Defaults to ES256.. */ + char * type_orig; /**< @brief COSE type to use during registration (ES256 or RS256). Defaults to ES256. original value given at command line. */ + const char *type_help; /**< @brief COSE type to use during registration (ES256 or RS256). Defaults to ES256. help description. */ + int resident_flag; /**< @brief Generate a resident credential (default=off). */ + const char *resident_help; /**< @brief Generate a resident credential help description. */ + int no_user_presence_flag; /**< @brief Allow the credential to be used without ensuring the user's presence (default=off). */ + const char *no_user_presence_help; /**< @brief Allow the credential to be used without ensuring the user's presence help description. */ + int pin_verification_flag; /**< @brief Require PIN verification during authentication (default=off). */ + const char *pin_verification_help; /**< @brief Require PIN verification during authentication help description. */ + int user_verification_flag; /**< @brief Require user verification during authentication (default=off). */ + const char *user_verification_help; /**< @brief Require user verification during authentication help description. */ + int debug_flag; /**< @brief Print debug information (highly verbose) (default=off). */ + const char *debug_help; /**< @brief Print debug information (highly verbose) help description. */ + int verbose_flag; /**< @brief Print information about chosen origin and appid (default=off). */ + const char *verbose_help; /**< @brief Print information about chosen origin and appid help description. */ + char * username_arg; /**< @brief The name of the user registering the device. Defaults to the current user name. */ + char * username_orig; /**< @brief The name of the user registering the device. Defaults to the current user name original value given at command line. */ + const char *username_help; /**< @brief The name of the user registering the device. Defaults to the current user name help description. */ + const char *nouser_help; /**< @brief Print only registration information (keyHandle and public key). Useful for appending help description. */ + + unsigned int help_given ; /**< @brief Whether help was given. */ + unsigned int version_given ; /**< @brief Whether version was given. */ + unsigned int origin_given ; /**< @brief Whether origin was given. */ + unsigned int appid_given ; /**< @brief Whether appid was given. */ + unsigned int type_given ; /**< @brief Whether type was given. */ + unsigned int resident_given ; /**< @brief Whether resident was given. */ + unsigned int no_user_presence_given ; /**< @brief Whether no-user-presence was given. */ + unsigned int pin_verification_given ; /**< @brief Whether pin-verification was given. */ + unsigned int user_verification_given ; /**< @brief Whether user-verification was given. */ + unsigned int debug_given ; /**< @brief Whether debug was given. */ + unsigned int verbose_given ; /**< @brief Whether verbose was given. */ + unsigned int username_given ; /**< @brief Whether username was given. */ + unsigned int nouser_given ; /**< @brief Whether nouser was given. */ + + int user_group_counter; /**< @brief Counter for group user */ +} ; + +/** @brief The additional parameters to pass to parser functions */ +struct cmdline_parser_params +{ + int override; /**< @brief whether to override possibly already present options (default 0) */ + int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */ + int check_required; /**< @brief whether to check that all required options were provided (default 1) */ + int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */ + int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */ +} ; + +/** @brief the purpose string of the program */ +extern const char *gengetopt_args_info_purpose; +/** @brief the usage string of the program */ +extern const char *gengetopt_args_info_usage; +/** @brief the description string of the program */ +extern const char *gengetopt_args_info_description; +/** @brief all the lines making the help output */ +extern const char *gengetopt_args_info_help[]; + +/** + * The command line parser + * @param argc the number of command line options + * @param argv the command line options + * @param args_info the structure where option information will be stored + * @return 0 if everything went fine, NON 0 if an error took place + */ +int cmdline_parser (int argc, char **argv, + struct gengetopt_args_info *args_info); + +/** + * The command line parser (version with additional parameters - deprecated) + * @param argc the number of command line options + * @param argv the command line options + * @param args_info the structure where option information will be stored + * @param override whether to override possibly already present options + * @param initialize whether to initialize the option structure my_args_info + * @param check_required whether to check that all required options were provided + * @return 0 if everything went fine, NON 0 if an error took place + * @deprecated use cmdline_parser_ext() instead + */ +int cmdline_parser2 (int argc, char **argv, + struct gengetopt_args_info *args_info, + int override, int initialize, int check_required); + +/** + * The command line parser (version with additional parameters) + * @param argc the number of command line options + * @param argv the command line options + * @param args_info the structure where option information will be stored + * @param params additional parameters for the parser + * @return 0 if everything went fine, NON 0 if an error took place + */ +int cmdline_parser_ext (int argc, char **argv, + struct gengetopt_args_info *args_info, + struct cmdline_parser_params *params); + +/** + * Save the contents of the option struct into an already open FILE stream. + * @param outfile the stream where to dump options + * @param args_info the option struct to dump + * @return 0 if everything went fine, NON 0 if an error took place + */ +int cmdline_parser_dump(FILE *outfile, + struct gengetopt_args_info *args_info); + +/** + * Save the contents of the option struct into a (text) file. + * This file can be read by the config file parser (if generated by gengetopt) + * @param filename the file where to save + * @param args_info the option struct to save + * @return 0 if everything went fine, NON 0 if an error took place + */ +int cmdline_parser_file_save(const char *filename, + struct gengetopt_args_info *args_info); + +/** + * Print the help + */ +void cmdline_parser_print_help(void); +/** + * Print the version + */ +void cmdline_parser_print_version(void); + +/** + * Initializes all the fields a cmdline_parser_params structure + * to their default values + * @param params the structure to initialize + */ +void cmdline_parser_params_init(struct cmdline_parser_params *params); + +/** + * Allocates dynamically a cmdline_parser_params structure and initializes + * all its fields to their default values + * @return the created and initialized cmdline_parser_params structure + */ +struct cmdline_parser_params *cmdline_parser_params_create(void); + +/** + * Initializes the passed gengetopt_args_info structure's fields + * (also set default values for options that have a default) + * @param args_info the structure to initialize + */ +void cmdline_parser_init (struct gengetopt_args_info *args_info); +/** + * Deallocates the string fields of the gengetopt_args_info structure + * (but does not deallocate the structure itself) + * @param args_info the structure to deallocate + */ +void cmdline_parser_free (struct gengetopt_args_info *args_info); + +/** + * Checks that all the required options were specified + * @param args_info the structure to check + * @param prog_name the name of the program that will be used to print + * possible errors + * @return + */ +int cmdline_parser_required (struct gengetopt_args_info *args_info, + const char *prog_name); + + +#ifdef __cplusplus +} +#endif /* __cplusplus */ +#endif /* CMDLINE_H */