Rewrite man5/config.pod and related conf code cleanup
[openssl.git] / crypto / conf / conf_api.c
index 919aebe313558ab5a3be0d205f049e1fb2958cd1..4c7349a3057ece19609eb7b053840facd9c574c3 100644 (file)
-/* conf_api.c */
-/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
- * All rights reserved.
+/*
+ * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
  *
- * This package is an SSL implementation written
- * by Eric Young (eay@cryptsoft.com).
- * The implementation was written so as to conform with Netscapes SSL.
- * 
- * This library is free for commercial and non-commercial use as long as
- * the following conditions are aheared to.  The following conditions
- * apply to all code found in this distribution, be it the RC4, RSA,
- * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
- * included with this distribution is covered by the same copyright terms
- * except that the holder is Tim Hudson (tjh@cryptsoft.com).
- * 
- * Copyright remains Eric Young's, and as such any Copyright notices in
- * the code are not to be removed.
- * If this package is used in a product, Eric Young should be given attribution
- * as the author of the parts of the library used.
- * This can be in the form of a textual message at program startup or
- * in documentation (online or textual) provided with the package.
- * 
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- * 3. All advertising materials mentioning features or use of this software
- *    must display the following acknowledgement:
- *    "This product includes cryptographic software written by
- *     Eric Young (eay@cryptsoft.com)"
- *    The word 'cryptographic' can be left out if the rouines from the library
- *    being used are not cryptographic related :-).
- * 4. If you include any Windows specific code (or a derivative thereof) from 
- *    the apps directory (application code) you must include an acknowledgement:
- *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
- * 
- * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * 
- * The licence and distribution terms for any publically available version or
- * derivative of this code cannot be changed.  i.e. this code cannot simply be
- * copied and put under another distribution licence
- * [including the GNU Public Licence.]
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
  */
 
 /* Part of the code in here was originally in conf.c, which is now removed */
 
-#ifndef CONF_DEBUG
-# undef NDEBUG /* avoid conflicting definitions */
-# define NDEBUG
-#endif
-
-#include <assert.h>
+#include "e_os.h"
+#include "internal/cryptlib.h"
+#include <stdlib.h>
+#include <string.h>
 #include <openssl/conf.h>
 #include <openssl/conf_api.h>
 
-static void value_free_hash(CONF_VALUE *a, LHASH *conf);
-static void value_free_stack(CONF_VALUE *a,LHASH *conf);
-static unsigned long hash(CONF_VALUE *v);
-static int cmp_conf(CONF_VALUE *a,CONF_VALUE *b);
-
-/* Up until OpenSSL 0.9.5a, this was get_section */
-CONF_VALUE *_CONF_get_section(CONF *conf, char *section)
-       {
-       CONF_VALUE *v,vv;
-
-       if ((conf == NULL) || (section == NULL)) return(NULL);
-       vv.name=NULL;
-       vv.section=section;
-       v=(CONF_VALUE *)lh_retrieve(conf->data,&vv);
-       return(v);
-       }
-
-/* Up until OpenSSL 0.9.5a, this was CONF_get_section */
-STACK_OF(CONF_VALUE) *_CONF_get_section_values(CONF *conf, char *section)
-       {
-       CONF_VALUE *v;
-
-       v=_CONF_get_section(conf,section);
-       if (v != NULL)
-               return((STACK_OF(CONF_VALUE) *)v->value);
-       else
-               return(NULL);
-       }
+static void value_free_hash(const CONF_VALUE *a, LHASH_OF(CONF_VALUE) *conf);
+static void value_free_stack_doall(CONF_VALUE *a);
+
+CONF_VALUE *_CONF_get_section(const CONF *conf, const char *section)
+{
+    CONF_VALUE vv;
+
+    if (conf == NULL || section == NULL)
+        return NULL;
+    vv.name = NULL;
+    vv.section = (char *)section;
+    return lh_CONF_VALUE_retrieve(conf->data, &vv);
+}
+
+STACK_OF(CONF_VALUE) *_CONF_get_section_values(const CONF *conf,
+                                               const char *section)
+{
+    CONF_VALUE *v;
+
+    v = _CONF_get_section(conf, section);
+    if (v == NULL)
+        return NULL;
+    return ((STACK_OF(CONF_VALUE) *)v->value);
+}
 
 int _CONF_add_string(CONF *conf, CONF_VALUE *section, CONF_VALUE *value)
-       {
-       CONF_VALUE *v = NULL;
-       STACK_OF(CONF_VALUE) *ts;
-
-       ts = (STACK_OF(CONF_VALUE) *)section->value;
-
-       value->section=section->section;        
-       if (!sk_CONF_VALUE_push(ts,value))
-               {
-               return 0;
-               }
-
-       v = (CONF_VALUE *)lh_insert(conf->data, value);
-       if (v != NULL)
-               {
-               sk_CONF_VALUE_delete_ptr(ts,v);
-               OPENSSL_free(v->name);
-               OPENSSL_free(v->value);
-               OPENSSL_free(v);
-               }
-       return 1;
-       }
-
-char *_CONF_get_string(CONF *conf, char *section, char *name)
-       {
-       CONF_VALUE *v,vv;
-       char *p;
-
-       if (name == NULL) return(NULL);
-       if (conf != NULL)
-               {
-               if (section != NULL)
-                       {
-                       vv.name=name;
-                       vv.section=section;
-                       v=(CONF_VALUE *)lh_retrieve(conf->data,&vv);
-                       if (v != NULL) return(v->value);
-                       if (strcmp(section,"ENV") == 0)
-                               {
-                               p=Getenv(name);
-                               if (p != NULL) return(p);
-                               }
-                       }
-               vv.section="default";
-               vv.name=name;
-               v=(CONF_VALUE *)lh_retrieve(conf->data,&vv);
-               if (v != NULL)
-                       return(v->value);
-               else
-                       return(NULL);
-               }
-       else
-               return(Getenv(name));
-       }
-
-long _CONF_get_number(CONF *conf, char *section, char *name)
-       {
-       char *str;
-       long ret=0;
-
-       str=_CONF_get_string(conf,section,name);
-       if (str == NULL) return(0);
-       for (;;)
-               {
-               if (conf->meth->is_number(conf, *str))
-                       ret=ret*10+conf->meth->to_int(conf, *str);
-               else
-                       return(ret);
-               str++;
-               }
-       }
+{
+    CONF_VALUE *v = NULL;
+    STACK_OF(CONF_VALUE) *ts;
+
+    ts = (STACK_OF(CONF_VALUE) *)section->value;
+
+    value->section = section->section;
+    if (!sk_CONF_VALUE_push(ts, value))
+        return 0;
+
+    v = lh_CONF_VALUE_insert(conf->data, value);
+    if (v != NULL) {
+        (void)sk_CONF_VALUE_delete_ptr(ts, v);
+        OPENSSL_free(v->name);
+        OPENSSL_free(v->value);
+        OPENSSL_free(v);
+    }
+    return 1;
+}
+
+char *_CONF_get_string(const CONF *conf, const char *section,
+                       const char *name)
+{
+    CONF_VALUE *v, vv;
+    char *p;
+
+    if (name == NULL)
+        return NULL;
+    if (conf == NULL)
+        return ossl_safe_getenv(name);
+    if (section != NULL) {
+        vv.name = (char *)name;
+        vv.section = (char *)section;
+        v = lh_CONF_VALUE_retrieve(conf->data, &vv);
+        if (v != NULL)
+            return v->value;
+        if (strcmp(section, "ENV") == 0) {
+            p = ossl_safe_getenv(name);
+            if (p != NULL)
+                return p;
+        }
+    }
+    vv.section = "default";
+    vv.name = (char *)name;
+    v = lh_CONF_VALUE_retrieve(conf->data, &vv);
+    if (v == NULL)
+        return NULL;
+    return v->value;
+}
+
+static unsigned long conf_value_hash(const CONF_VALUE *v)
+{
+    return (OPENSSL_LH_strhash(v->section) << 2) ^ OPENSSL_LH_strhash(v->name);
+}
+
+static int conf_value_cmp(const CONF_VALUE *a, const CONF_VALUE *b)
+{
+    int i;
+
+    if (a->section != b->section) {
+        i = strcmp(a->section, b->section);
+        if (i != 0)
+            return i;
+    }
+
+    if (a->name != NULL && b->name != NULL)
+        return strcmp(a->name, b->name);
+    if (a->name == b->name)
+        return 0;
+    return (a->name == NULL) ? -1 : 1;
+}
 
 int _CONF_new_data(CONF *conf)
-       {
-       if (conf == NULL)
-               {
-               return 0;
-               }
-       if (conf->data == NULL)
-               if ((conf->data = lh_new(hash,cmp_conf)) == NULL)
-                       {
-                       return 0;
-                       }
-       return 1;
-       }
+{
+    if (conf == NULL)
+        return 0;
+    if (conf->data == NULL) {
+        conf->data = lh_CONF_VALUE_new(conf_value_hash, conf_value_cmp);
+        if (conf->data == NULL)
+            return 0;
+    }
+    return 1;
+}
+
+typedef LHASH_OF(CONF_VALUE) LH_CONF_VALUE;
+
+IMPLEMENT_LHASH_DOALL_ARG_CONST(CONF_VALUE, LH_CONF_VALUE);
 
 void _CONF_free_data(CONF *conf)
-       {
-       if (conf == NULL || conf->data == NULL) return;
-
-       conf->data->down_load=0; /* evil thing to make sure the 'OPENSSL_free()'
-                                 * works as expected */
-       lh_doall_arg(conf->data,(void (*)())value_free_hash,conf->data);
-
-       /* We now have only 'section' entries in the hash table.
-        * Due to problems with */
-
-       lh_doall_arg(conf->data,(void (*)())value_free_stack,conf->data);
-       lh_free(conf->data);
-       }
-
-static void value_free_hash(CONF_VALUE *a, LHASH *conf)
-       {
-       if (a->name != NULL)
-               {
-               a=(CONF_VALUE *)lh_delete(conf,a);
-               }
-       }
-
-static void value_free_stack(CONF_VALUE *a, LHASH *conf)
-       {
-       CONF_VALUE *vv;
-       STACK *sk;
-       int i;
-
-       if (a->name != NULL) return;
-
-       sk=(STACK *)a->value;
-       for (i=sk_num(sk)-1; i>=0; i--)
-               {
-               vv=(CONF_VALUE *)sk_value(sk,i);
-               OPENSSL_free(vv->value);
-               OPENSSL_free(vv->name);
-               OPENSSL_free(vv);
-               }
-       if (sk != NULL) sk_free(sk);
-       OPENSSL_free(a->section);
-       OPENSSL_free(a);
-       }
-
-static unsigned long hash(CONF_VALUE *v)
-       {
-       return((lh_strhash(v->section)<<2)^lh_strhash(v->name));
-       }
-
-static int cmp_conf(CONF_VALUE *a, CONF_VALUE *b)
-       {
-       int i;
-
-       if (a->section != b->section)
-               {
-               i=strcmp(a->section,b->section);
-               if (i) return(i);
-               }
-
-       if ((a->name != NULL) && (b->name != NULL))
-               {
-               i=strcmp(a->name,b->name);
-               return(i);
-               }
-       else if (a->name == b->name)
-               return(0);
-       else
-               return((a->name == NULL)?-1:1);
-       }
-
-/* Up until OpenSSL 0.9.5a, this was new_section */
-CONF_VALUE *_CONF_new_section(CONF *conf, char *section)
-       {
-       STACK *sk=NULL;
-       int ok=0,i;
-       CONF_VALUE *v=NULL,*vv;
-
-       if ((sk=sk_new_null()) == NULL)
-               goto err;
-       if ((v=(CONF_VALUE *)OPENSSL_malloc(sizeof(CONF_VALUE))) == NULL)
-               goto err;
-       i=strlen(section)+1;
-       if ((v->section=(char *)OPENSSL_malloc(i)) == NULL)
-               goto err;
-
-       memcpy(v->section,section,i);
-       v->name=NULL;
-       v->value=(char *)sk;
-       
-       vv=(CONF_VALUE *)lh_insert(conf->data,v);
-       assert(vv == NULL);
-       ok=1;
-err:
-       if (!ok)
-               {
-               if (sk != NULL) sk_free(sk);
-               if (v != NULL) OPENSSL_free(v);
-               v=NULL;
-               }
-       return(v);
-       }
-
-IMPLEMENT_STACK_OF(CONF_VALUE)
+{
+    if (conf == NULL || conf->data == NULL)
+        return;
+
+    /* evil thing to make sure the 'OPENSSL_free()' works as expected */
+    lh_CONF_VALUE_set_down_load(conf->data, 0);
+    lh_CONF_VALUE_doall_LH_CONF_VALUE(conf->data, value_free_hash, conf->data);
+
+    /*
+     * We now have only 'section' entries in the hash table. Due to problems
+     * with
+     */
+
+    lh_CONF_VALUE_doall(conf->data, value_free_stack_doall);
+    lh_CONF_VALUE_free(conf->data);
+}
+
+static void value_free_hash(const CONF_VALUE *a, LHASH_OF(CONF_VALUE) *conf)
+{
+    if (a->name != NULL)
+        (void)lh_CONF_VALUE_delete(conf, a);
+}
+
+static void value_free_stack_doall(CONF_VALUE *a)
+{
+    CONF_VALUE *vv;
+    STACK_OF(CONF_VALUE) *sk;
+    int i;
+
+    if (a->name != NULL)
+        return;
+
+    sk = (STACK_OF(CONF_VALUE) *)a->value;
+    for (i = sk_CONF_VALUE_num(sk) - 1; i >= 0; i--) {
+        vv = sk_CONF_VALUE_value(sk, i);
+        OPENSSL_free(vv->value);
+        OPENSSL_free(vv->name);
+        OPENSSL_free(vv);
+    }
+    sk_CONF_VALUE_free(sk);
+    OPENSSL_free(a->section);
+    OPENSSL_free(a);
+}
+
+CONF_VALUE *_CONF_new_section(CONF *conf, const char *section)
+{
+    STACK_OF(CONF_VALUE) *sk = NULL;
+    int i;
+    CONF_VALUE *v = NULL, *vv;
+
+    if ((sk = sk_CONF_VALUE_new_null()) == NULL)
+        goto err;
+    if ((v = OPENSSL_malloc(sizeof(*v))) == NULL)
+        goto err;
+    i = strlen(section) + 1;
+    if ((v->section = OPENSSL_malloc(i)) == NULL)
+        goto err;
+
+    memcpy(v->section, section, i);
+    v->name = NULL;
+    v->value = (char *)sk;
+
+    vv = lh_CONF_VALUE_insert(conf->data, v);
+    if (vv != NULL || lh_CONF_VALUE_error(conf->data) > 0)
+        goto err;
+    return v;
+
+ err:
+    sk_CONF_VALUE_free(sk);
+    if (v != NULL)
+        OPENSSL_free(v->section);
+    OPENSSL_free(v);
+    return NULL;
+}