Rewrite man5/config.pod and related conf code cleanup
[openssl.git] / crypto / conf / conf_api.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /* Part of the code in here was originally in conf.c, which is now removed */
11
12 #include "e_os.h"
13 #include "internal/cryptlib.h"
14 #include <stdlib.h>
15 #include <string.h>
16 #include <openssl/conf.h>
17 #include <openssl/conf_api.h>
18
19 static void value_free_hash(const CONF_VALUE *a, LHASH_OF(CONF_VALUE) *conf);
20 static void value_free_stack_doall(CONF_VALUE *a);
21
22 CONF_VALUE *_CONF_get_section(const CONF *conf, const char *section)
23 {
24     CONF_VALUE vv;
25
26     if (conf == NULL || section == NULL)
27         return NULL;
28     vv.name = NULL;
29     vv.section = (char *)section;
30     return lh_CONF_VALUE_retrieve(conf->data, &vv);
31 }
32
33 STACK_OF(CONF_VALUE) *_CONF_get_section_values(const CONF *conf,
34                                                const char *section)
35 {
36     CONF_VALUE *v;
37
38     v = _CONF_get_section(conf, section);
39     if (v == NULL)
40         return NULL;
41     return ((STACK_OF(CONF_VALUE) *)v->value);
42 }
43
44 int _CONF_add_string(CONF *conf, CONF_VALUE *section, CONF_VALUE *value)
45 {
46     CONF_VALUE *v = NULL;
47     STACK_OF(CONF_VALUE) *ts;
48
49     ts = (STACK_OF(CONF_VALUE) *)section->value;
50
51     value->section = section->section;
52     if (!sk_CONF_VALUE_push(ts, value))
53         return 0;
54
55     v = lh_CONF_VALUE_insert(conf->data, value);
56     if (v != NULL) {
57         (void)sk_CONF_VALUE_delete_ptr(ts, v);
58         OPENSSL_free(v->name);
59         OPENSSL_free(v->value);
60         OPENSSL_free(v);
61     }
62     return 1;
63 }
64
65 char *_CONF_get_string(const CONF *conf, const char *section,
66                        const char *name)
67 {
68     CONF_VALUE *v, vv;
69     char *p;
70
71     if (name == NULL)
72         return NULL;
73     if (conf == NULL)
74         return ossl_safe_getenv(name);
75     if (section != NULL) {
76         vv.name = (char *)name;
77         vv.section = (char *)section;
78         v = lh_CONF_VALUE_retrieve(conf->data, &vv);
79         if (v != NULL)
80             return v->value;
81         if (strcmp(section, "ENV") == 0) {
82             p = ossl_safe_getenv(name);
83             if (p != NULL)
84                 return p;
85         }
86     }
87     vv.section = "default";
88     vv.name = (char *)name;
89     v = lh_CONF_VALUE_retrieve(conf->data, &vv);
90     if (v == NULL)
91         return NULL;
92     return v->value;
93 }
94
95 static unsigned long conf_value_hash(const CONF_VALUE *v)
96 {
97     return (OPENSSL_LH_strhash(v->section) << 2) ^ OPENSSL_LH_strhash(v->name);
98 }
99
100 static int conf_value_cmp(const CONF_VALUE *a, const CONF_VALUE *b)
101 {
102     int i;
103
104     if (a->section != b->section) {
105         i = strcmp(a->section, b->section);
106         if (i != 0)
107             return i;
108     }
109
110     if (a->name != NULL && b->name != NULL)
111         return strcmp(a->name, b->name);
112     if (a->name == b->name)
113         return 0;
114     return (a->name == NULL) ? -1 : 1;
115 }
116
117 int _CONF_new_data(CONF *conf)
118 {
119     if (conf == NULL)
120         return 0;
121     if (conf->data == NULL) {
122         conf->data = lh_CONF_VALUE_new(conf_value_hash, conf_value_cmp);
123         if (conf->data == NULL)
124             return 0;
125     }
126     return 1;
127 }
128
129 typedef LHASH_OF(CONF_VALUE) LH_CONF_VALUE;
130
131 IMPLEMENT_LHASH_DOALL_ARG_CONST(CONF_VALUE, LH_CONF_VALUE);
132
133 void _CONF_free_data(CONF *conf)
134 {
135     if (conf == NULL || conf->data == NULL)
136         return;
137
138     /* evil thing to make sure the 'OPENSSL_free()' works as expected */
139     lh_CONF_VALUE_set_down_load(conf->data, 0);
140     lh_CONF_VALUE_doall_LH_CONF_VALUE(conf->data, value_free_hash, conf->data);
141
142     /*
143      * We now have only 'section' entries in the hash table. Due to problems
144      * with
145      */
146
147     lh_CONF_VALUE_doall(conf->data, value_free_stack_doall);
148     lh_CONF_VALUE_free(conf->data);
149 }
150
151 static void value_free_hash(const CONF_VALUE *a, LHASH_OF(CONF_VALUE) *conf)
152 {
153     if (a->name != NULL)
154         (void)lh_CONF_VALUE_delete(conf, a);
155 }
156
157 static void value_free_stack_doall(CONF_VALUE *a)
158 {
159     CONF_VALUE *vv;
160     STACK_OF(CONF_VALUE) *sk;
161     int i;
162
163     if (a->name != NULL)
164         return;
165
166     sk = (STACK_OF(CONF_VALUE) *)a->value;
167     for (i = sk_CONF_VALUE_num(sk) - 1; i >= 0; i--) {
168         vv = sk_CONF_VALUE_value(sk, i);
169         OPENSSL_free(vv->value);
170         OPENSSL_free(vv->name);
171         OPENSSL_free(vv);
172     }
173     sk_CONF_VALUE_free(sk);
174     OPENSSL_free(a->section);
175     OPENSSL_free(a);
176 }
177
178 CONF_VALUE *_CONF_new_section(CONF *conf, const char *section)
179 {
180     STACK_OF(CONF_VALUE) *sk = NULL;
181     int i;
182     CONF_VALUE *v = NULL, *vv;
183
184     if ((sk = sk_CONF_VALUE_new_null()) == NULL)
185         goto err;
186     if ((v = OPENSSL_malloc(sizeof(*v))) == NULL)
187         goto err;
188     i = strlen(section) + 1;
189     if ((v->section = OPENSSL_malloc(i)) == NULL)
190         goto err;
191
192     memcpy(v->section, section, i);
193     v->name = NULL;
194     v->value = (char *)sk;
195
196     vv = lh_CONF_VALUE_insert(conf->data, v);
197     if (vv != NULL || lh_CONF_VALUE_error(conf->data) > 0)
198         goto err;
199     return v;
200
201  err:
202     sk_CONF_VALUE_free(sk);
203     if (v != NULL)
204         OPENSSL_free(v->section);
205     OPENSSL_free(v);
206     return NULL;
207 }