Use p==NULL not !p (in if statements, mainly)
[openssl.git] / crypto / ts / ts_conf.c
1 /* crypto/ts/ts_conf.c */
2 /*
3  * Written by Zoltan Glozik (zglozik@stones.com) for the OpenSSL project
4  * 2002.
5  */
6 /* ====================================================================
7  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59
60 #include <string.h>
61
62 #include <openssl/crypto.h>
63 #include "cryptlib.h"
64 #include <openssl/pem.h>
65 #ifndef OPENSSL_NO_ENGINE
66 # include <openssl/engine.h>
67 #endif
68 #include <openssl/ts.h>
69
70 /* Macro definitions for the configuration file. */
71
72 #define BASE_SECTION                    "tsa"
73 #define ENV_DEFAULT_TSA                 "default_tsa"
74 #define ENV_SERIAL                      "serial"
75 #define ENV_CRYPTO_DEVICE               "crypto_device"
76 #define ENV_SIGNER_CERT                 "signer_cert"
77 #define ENV_CERTS                       "certs"
78 #define ENV_SIGNER_KEY                  "signer_key"
79 #define ENV_DEFAULT_POLICY              "default_policy"
80 #define ENV_OTHER_POLICIES              "other_policies"
81 #define ENV_DIGESTS                     "digests"
82 #define ENV_ACCURACY                    "accuracy"
83 #define ENV_ORDERING                    "ordering"
84 #define ENV_TSA_NAME                    "tsa_name"
85 #define ENV_ESS_CERT_ID_CHAIN           "ess_cert_id_chain"
86 #define ENV_VALUE_SECS                  "secs"
87 #define ENV_VALUE_MILLISECS             "millisecs"
88 #define ENV_VALUE_MICROSECS             "microsecs"
89 #define ENV_CLOCK_PRECISION_DIGITS      "clock_precision_digits"
90 #define ENV_VALUE_YES                   "yes"
91 #define ENV_VALUE_NO                    "no"
92
93 /* Function definitions for certificate and key loading. */
94
95 X509 *TS_CONF_load_cert(const char *file)
96 {
97     BIO *cert = NULL;
98     X509 *x = NULL;
99
100     if ((cert = BIO_new_file(file, "r")) == NULL)
101         goto end;
102     x = PEM_read_bio_X509_AUX(cert, NULL, NULL, NULL);
103  end:
104     if (x == NULL)
105         fprintf(stderr, "unable to load certificate: %s\n", file);
106     BIO_free(cert);
107     return x;
108 }
109
110 STACK_OF(X509) *TS_CONF_load_certs(const char *file)
111 {
112     BIO *certs = NULL;
113     STACK_OF(X509) *othercerts = NULL;
114     STACK_OF(X509_INFO) *allcerts = NULL;
115     int i;
116
117     if ((certs = BIO_new_file(file, "r")) == NULL)
118         goto end;
119     if ((othercerts = sk_X509_new_null()) == NULL)
120         goto end;
121
122     allcerts = PEM_X509_INFO_read_bio(certs, NULL, NULL, NULL);
123     for (i = 0; i < sk_X509_INFO_num(allcerts); i++) {
124         X509_INFO *xi = sk_X509_INFO_value(allcerts, i);
125         if (xi->x509) {
126             sk_X509_push(othercerts, xi->x509);
127             xi->x509 = NULL;
128         }
129     }
130  end:
131     if (othercerts == NULL)
132         fprintf(stderr, "unable to load certificates: %s\n", file);
133     sk_X509_INFO_pop_free(allcerts, X509_INFO_free);
134     BIO_free(certs);
135     return othercerts;
136 }
137
138 EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass)
139 {
140     BIO *key = NULL;
141     EVP_PKEY *pkey = NULL;
142
143     if ((key = BIO_new_file(file, "r")) == NULL)
144         goto end;
145     pkey = PEM_read_bio_PrivateKey(key, NULL, NULL, (char *)pass);
146  end:
147     if (pkey == NULL)
148         fprintf(stderr, "unable to load private key: %s\n", file);
149     BIO_free(key);
150     return pkey;
151 }
152
153 /* Function definitions for handling configuration options. */
154
155 static void TS_CONF_lookup_fail(const char *name, const char *tag)
156 {
157     fprintf(stderr, "variable lookup failed for %s::%s\n", name, tag);
158 }
159
160 static void TS_CONF_invalid(const char *name, const char *tag)
161 {
162     fprintf(stderr, "invalid variable value for %s::%s\n", name, tag);
163 }
164
165 const char *TS_CONF_get_tsa_section(CONF *conf, const char *section)
166 {
167     if (!section) {
168         section = NCONF_get_string(conf, BASE_SECTION, ENV_DEFAULT_TSA);
169         if (!section)
170             TS_CONF_lookup_fail(BASE_SECTION, ENV_DEFAULT_TSA);
171     }
172     return section;
173 }
174
175 int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb,
176                        TS_RESP_CTX *ctx)
177 {
178     int ret = 0;
179     char *serial = NCONF_get_string(conf, section, ENV_SERIAL);
180     if (!serial) {
181         TS_CONF_lookup_fail(section, ENV_SERIAL);
182         goto err;
183     }
184     TS_RESP_CTX_set_serial_cb(ctx, cb, serial);
185
186     ret = 1;
187  err:
188     return ret;
189 }
190
191 #ifndef OPENSSL_NO_ENGINE
192
193 int TS_CONF_set_crypto_device(CONF *conf, const char *section,
194                               const char *device)
195 {
196     int ret = 0;
197
198     if (device == NULL)
199         device = NCONF_get_string(conf, section, ENV_CRYPTO_DEVICE);
200
201     if (device && !TS_CONF_set_default_engine(device)) {
202         TS_CONF_invalid(section, ENV_CRYPTO_DEVICE);
203         goto err;
204     }
205     ret = 1;
206  err:
207     return ret;
208 }
209
210 int TS_CONF_set_default_engine(const char *name)
211 {
212     ENGINE *e = NULL;
213     int ret = 0;
214
215     /* Leave the default if builtin specified. */
216     if (strcmp(name, "builtin") == 0)
217         return 1;
218
219     if ((e = ENGINE_by_id(name)) == NULL)
220         goto err;
221
222     /* Enable the use of the NCipher HSM for forked children. */
223     if (strcmp(name, "chil") == 0)
224         ENGINE_ctrl(e, ENGINE_CTRL_CHIL_SET_FORKCHECK, 1, 0, 0);
225     /* All the operations are going to be carried out by the engine. */
226     if (!ENGINE_set_default(e, ENGINE_METHOD_ALL))
227         goto err;
228     ret = 1;
229  err:
230     if (!ret) {
231         TSerr(TS_F_TS_CONF_SET_DEFAULT_ENGINE, TS_R_COULD_NOT_SET_ENGINE);
232         ERR_add_error_data(2, "engine:", name);
233     }
234     ENGINE_free(e);
235     return ret;
236 }
237
238 #endif
239
240 int TS_CONF_set_signer_cert(CONF *conf, const char *section,
241                             const char *cert, TS_RESP_CTX *ctx)
242 {
243     int ret = 0;
244     X509 *cert_obj = NULL;
245
246     if (cert == NULL) {
247         cert = NCONF_get_string(conf, section, ENV_SIGNER_CERT);
248         if (cert == NULL) {
249             TS_CONF_lookup_fail(section, ENV_SIGNER_CERT);
250             goto err;
251         }
252     }
253     if ((cert_obj = TS_CONF_load_cert(cert)) == NULL)
254         goto err;
255     if (!TS_RESP_CTX_set_signer_cert(ctx, cert_obj))
256         goto err;
257
258     ret = 1;
259  err:
260     X509_free(cert_obj);
261     return ret;
262 }
263
264 int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs,
265                       TS_RESP_CTX *ctx)
266 {
267     int ret = 0;
268     STACK_OF(X509) *certs_obj = NULL;
269
270     if (certs == NULL) {
271         /* Certificate chain is optional. */
272         if ((certs = NCONF_get_string(conf, section, ENV_CERTS)) == NULL)
273             goto end;
274     }
275     if ((certs_obj = TS_CONF_load_certs(certs)) == NULL)
276         goto err;
277     if (!TS_RESP_CTX_set_certs(ctx, certs_obj))
278         goto err;
279  end:
280     ret = 1;
281  err:
282     sk_X509_pop_free(certs_obj, X509_free);
283     return ret;
284 }
285
286 int TS_CONF_set_signer_key(CONF *conf, const char *section,
287                            const char *key, const char *pass,
288                            TS_RESP_CTX *ctx)
289 {
290     int ret = 0;
291     EVP_PKEY *key_obj = NULL;
292     if (!key)
293         key = NCONF_get_string(conf, section, ENV_SIGNER_KEY);
294     if (!key) {
295         TS_CONF_lookup_fail(section, ENV_SIGNER_KEY);
296         goto err;
297     }
298     if ((key_obj = TS_CONF_load_key(key, pass)) == NULL)
299         goto err;
300     if (!TS_RESP_CTX_set_signer_key(ctx, key_obj))
301         goto err;
302
303     ret = 1;
304  err:
305     EVP_PKEY_free(key_obj);
306     return ret;
307 }
308
309 int TS_CONF_set_def_policy(CONF *conf, const char *section,
310                            const char *policy, TS_RESP_CTX *ctx)
311 {
312     int ret = 0;
313     ASN1_OBJECT *policy_obj = NULL;
314     if (!policy)
315         policy = NCONF_get_string(conf, section, ENV_DEFAULT_POLICY);
316     if (!policy) {
317         TS_CONF_lookup_fail(section, ENV_DEFAULT_POLICY);
318         goto err;
319     }
320     if ((policy_obj = OBJ_txt2obj(policy, 0)) == NULL) {
321         TS_CONF_invalid(section, ENV_DEFAULT_POLICY);
322         goto err;
323     }
324     if (!TS_RESP_CTX_set_def_policy(ctx, policy_obj))
325         goto err;
326
327     ret = 1;
328  err:
329     ASN1_OBJECT_free(policy_obj);
330     return ret;
331 }
332
333 int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx)
334 {
335     int ret = 0;
336     int i;
337     STACK_OF(CONF_VALUE) *list = NULL;
338     char *policies = NCONF_get_string(conf, section, ENV_OTHER_POLICIES);
339
340     /* If no other policy is specified, that's fine. */
341     if (policies && (list = X509V3_parse_list(policies)) == NULL) {
342         TS_CONF_invalid(section, ENV_OTHER_POLICIES);
343         goto err;
344     }
345     for (i = 0; i < sk_CONF_VALUE_num(list); ++i) {
346         CONF_VALUE *val = sk_CONF_VALUE_value(list, i);
347         const char *extval = val->value ? val->value : val->name;
348         ASN1_OBJECT *objtmp;
349
350         if ((objtmp = OBJ_txt2obj(extval, 0)) == NULL) {
351             TS_CONF_invalid(section, ENV_OTHER_POLICIES);
352             goto err;
353         }
354         if (!TS_RESP_CTX_add_policy(ctx, objtmp))
355             goto err;
356         ASN1_OBJECT_free(objtmp);
357     }
358
359     ret = 1;
360  err:
361     sk_CONF_VALUE_pop_free(list, X509V3_conf_free);
362     return ret;
363 }
364
365 int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx)
366 {
367     int ret = 0;
368     int i;
369     STACK_OF(CONF_VALUE) *list = NULL;
370     char *digests = NCONF_get_string(conf, section, ENV_DIGESTS);
371
372     if (digests == NULL) {
373         TS_CONF_lookup_fail(section, ENV_DIGESTS);
374         goto err;
375     }
376     if ((list = X509V3_parse_list(digests)) == NULL) {
377         TS_CONF_invalid(section, ENV_DIGESTS);
378         goto err;
379     }
380     if (sk_CONF_VALUE_num(list) == 0) {
381         TS_CONF_invalid(section, ENV_DIGESTS);
382         goto err;
383     }
384     for (i = 0; i < sk_CONF_VALUE_num(list); ++i) {
385         CONF_VALUE *val = sk_CONF_VALUE_value(list, i);
386         const char *extval = val->value ? val->value : val->name;
387         const EVP_MD *md;
388
389         if ((md = EVP_get_digestbyname(extval)) == NULL) {
390             TS_CONF_invalid(section, ENV_DIGESTS);
391             goto err;
392         }
393         if (!TS_RESP_CTX_add_md(ctx, md))
394             goto err;
395     }
396
397     ret = 1;
398  err:
399     sk_CONF_VALUE_pop_free(list, X509V3_conf_free);
400     return ret;
401 }
402
403 int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx)
404 {
405     int ret = 0;
406     int i;
407     int secs = 0, millis = 0, micros = 0;
408     STACK_OF(CONF_VALUE) *list = NULL;
409     char *accuracy = NCONF_get_string(conf, section, ENV_ACCURACY);
410
411     if (accuracy && (list = X509V3_parse_list(accuracy)) == NULL) {
412         TS_CONF_invalid(section, ENV_ACCURACY);
413         goto err;
414     }
415     for (i = 0; i < sk_CONF_VALUE_num(list); ++i) {
416         CONF_VALUE *val = sk_CONF_VALUE_value(list, i);
417         if (strcmp(val->name, ENV_VALUE_SECS) == 0) {
418             if (val->value)
419                 secs = atoi(val->value);
420         } else if (strcmp(val->name, ENV_VALUE_MILLISECS) == 0) {
421             if (val->value)
422                 millis = atoi(val->value);
423         } else if (strcmp(val->name, ENV_VALUE_MICROSECS) == 0) {
424             if (val->value)
425                 micros = atoi(val->value);
426         } else {
427             TS_CONF_invalid(section, ENV_ACCURACY);
428             goto err;
429         }
430     }
431     if (!TS_RESP_CTX_set_accuracy(ctx, secs, millis, micros))
432         goto err;
433
434     ret = 1;
435  err:
436     sk_CONF_VALUE_pop_free(list, X509V3_conf_free);
437     return ret;
438 }
439
440 int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section,
441                                        TS_RESP_CTX *ctx)
442 {
443     int ret = 0;
444     long digits = 0;
445
446     /*
447      * If not specified, set the default value to 0, i.e. sec precision
448      */
449     if (!NCONF_get_number_e(conf, section, ENV_CLOCK_PRECISION_DIGITS,
450                             &digits))
451         digits = 0;
452     if (digits < 0 || digits > TS_MAX_CLOCK_PRECISION_DIGITS) {
453         TS_CONF_invalid(section, ENV_CLOCK_PRECISION_DIGITS);
454         goto err;
455     }
456
457     if (!TS_RESP_CTX_set_clock_precision_digits(ctx, digits))
458         goto err;
459
460     return 1;
461  err:
462     return ret;
463 }
464
465 static int TS_CONF_add_flag(CONF *conf, const char *section,
466                             const char *field, int flag, TS_RESP_CTX *ctx)
467 {
468     /* Default is false. */
469     const char *value = NCONF_get_string(conf, section, field);
470     if (value) {
471         if (strcmp(value, ENV_VALUE_YES) == 0)
472             TS_RESP_CTX_add_flags(ctx, flag);
473         else if (strcmp(value, ENV_VALUE_NO) != 0) {
474             TS_CONF_invalid(section, field);
475             return 0;
476         }
477     }
478
479     return 1;
480 }
481
482 int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx)
483 {
484     return TS_CONF_add_flag(conf, section, ENV_ORDERING, TS_ORDERING, ctx);
485 }
486
487 int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx)
488 {
489     return TS_CONF_add_flag(conf, section, ENV_TSA_NAME, TS_TSA_NAME, ctx);
490 }
491
492 int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section,
493                                   TS_RESP_CTX *ctx)
494 {
495     return TS_CONF_add_flag(conf, section, ENV_ESS_CERT_ID_CHAIN,
496                             TS_ESS_CERT_ID_CHAIN, ctx);
497 }