genericCMPClient_util.{c,h}: introduce OPT_SEL and OPT_POS_INT for CONF_read_check_options()

Author: DDvO

include/genericCMPClient_util.h

@@ -99,15 +99,17 @@ typedef void uta_ctx; /* dummy */
 /* config.h: */
 /* extended from opt.h */
 #define OPT_REQUIRED 0x8000U
-#define OPT_EMPTY_OK 0x4000U
+#define OPT_EMPTY_OK 0x4000U /* ignored unless OPT_REQUIRED is set */
 typedef enum
 {
     OPT_TXT, /** String variable receives a pointer to the option argument */
+    OPT_SEL, /** enumeration of selectable tags, index returned in 'int1' choice */
     OPT_NUM, /** Long integer variable receives the decimal number given as argument */
     OPT_INT, /** As before, but regular integer variable */
     OPT_POS_INT, /** As before, but restriction to positive integers */
     OPT_BOOL,/** Boolean variable receives a truth value */
     OPT_TXT_REQUIRED  = OPT_TXT  | OPT_REQUIRED,
+    OPT_SEL_REQUIRED  = OPT_SEL  | OPT_REQUIRED,
     OPT_NUM_REQUIRED  = OPT_NUM  | OPT_REQUIRED,
     OPT_INT_REQUIRED  = OPT_INT  | OPT_REQUIRED,
     OPT_POS_INT_REQUIRED  = OPT_POS_INT | OPT_REQUIRED,
@@ -117,7 +119,7 @@ typedef enum
 union varval_union {
     const char *txt; /** String value */
     long num;  /** Long integer value, or vpm_opt */
-    int  int1; /** Integer value, may be restricted to being positive */
+    int  int1; /** Integer/selection value, may be restricted to being positive */
     bool bit;  /** Boolean value */
 };
 
@@ -135,9 +137,11 @@ typedef struct opt_t
     union varval_union default_value; /** default value for the option */
     union varref_union varref_u; /** reference to the variable to receive the option value */
     const char *help_str; /** a short description of the option for help output */
-} opt_t; /** an option with its name, type, default value, variable, and help string */
+    const char **selectable; /** values to choose from with OPT_SEL, NULL-terminated array */
+} opt_t; /** an option with its name, type, default value, variable,
+             optional help string, and optional selectable tags */
 
-#define OPT_END { NULL, OPT_BOOL, {.bit = false}, {NULL}, NULL}
+#define OPT_END { NULL, OPT_BOOL, {.bit = false}, {.bit = NULL}, NULL}
 CONF *CONF_load_config(OPTIONAL ossl_unused uta_ctx *ctx, const char *file);
 bool CONF_entry_in_sections(const CONF *conf, const char *sections, const char *entry);
 bool CONF_read_check_options(const CONF *conf, const char *source,

src/genericCMPClient_util.c

@@ -454,8 +454,11 @@ static bool CONF_read_options_ex(const CONF *conf, const char *source,
     for (; opt->name != NULL; opt++) {
         opttype_t bare_type = opt->type & ~(OPT_REQUIRED | OPT_EMPTY_OK);
 
-        if (opt->varref_u.txt == NULL)
-            continue; /* skip if no variable reference given */
+        if (opt->varref_u.txt == NULL) {
+            LOG(FL_ERR, "internal: Config '%s' section(s) [%s] option '%s': missing referene to the variable where to store the value",
+                    source, sections, opt->name);
+            return false;
+        }
         ERR_set_mark();
         switch (bare_type) {
         case OPT_TXT:
@@ -465,6 +468,37 @@ static bool CONF_read_options_ex(const CONF *conf, const char *source,
                 *opt->varref_u.txt = str[0] == '\0' ? opt->default_value.txt : str;
             }
             break;
+        case OPT_SEL:
+            /* stores the selcetion from the key opt->name in opt->varref_u.int1 */
+            str = conf_get_string(conf, sections, opt->name);
+            if (str != NULL) {
+                const char *const *sel = ((opt_t *)opt)->selectable;
+
+                ERR_pop_to_mark();
+                if (sel == NULL) {
+                    LOG(FL_ERR, "internal: Config '%s' section(s) [%s] option '%s' of type OPT_SEL: missing list of selectable values",
+                    source, sections, opt->name);
+                    return false;
+                }
+                if (str[0] == '\0') {
+                    *opt->varref_u.int1 = opt->default_value.int1;
+                    return true;
+                }
+                for (; *sel != NULL && strcmp(*sel, str) != 0; sel++)
+                    val++;
+                if (*sel == NULL) {
+                    LOG(FL_ERR, "Config '%s' section(s) [%s] option '%s': illegal value '%s'",
+                        source, sections, opt->name, str);
+                    return false;
+                }
+                if (val > INT_MAX) {
+                    LOG(FL_ERR, "Config '%s' section(s) [%s] option '%s' selection value %ld is too large, can be at most %d",
+                        source, sections, opt->name, val, INT_MAX);
+                    return false;
+                }
+                *opt->varref_u.int1 = (int)val;
+            }
+            break;
         case OPT_NUM:
             /* restores default value if empty string is given */
             str = conf_get_string(conf, sections, opt->name);