Strengthen X509_STORE_CTX_print_verify_cb() to print expected host etc.
[openssl.git] / crypto / x509 / x509_vpm.c
1 /*
2  * Copyright 2004-2020 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 #include <stdio.h>
11
12 #include "internal/cryptlib.h"
13 #include <openssl/crypto.h>
14 #include <openssl/buffer.h>
15 #include <openssl/x509.h>
16 #include <openssl/x509v3.h>
17 #include "crypto/x509.h"
18
19 #include "x509_local.h"
20
21 DEFINE_STACK_OF(ASN1_OBJECT)
22 DEFINE_STACK_OF(X509_VERIFY_PARAM)
23 DEFINE_STACK_OF_STRING()
24
25 /* X509_VERIFY_PARAM functions */
26
27 #define SET_HOST 0
28 #define ADD_HOST 1
29
30 static char *str_copy(const char *s)
31 {
32     return OPENSSL_strdup(s);
33 }
34
35 static void str_free(char *s)
36 {
37     OPENSSL_free(s);
38 }
39
40 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
41                                     const char *name, size_t namelen)
42 {
43     char *copy;
44
45     /*
46      * Refuse names with embedded NUL bytes, except perhaps as final byte.
47      * XXX: Do we need to push an error onto the error stack?
48      */
49     if (namelen == 0 || name == NULL)
50         namelen = name ? strlen(name) : 0;
51     else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
52         return 0;
53     if (namelen > 0 && name[namelen - 1] == '\0')
54         --namelen;
55
56     if (mode == SET_HOST) {
57         sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
58         vpm->hosts = NULL;
59     }
60     if (name == NULL || namelen == 0)
61         return 1;
62
63     copy = OPENSSL_strndup(name, namelen);
64     if (copy == NULL)
65         return 0;
66
67     if (vpm->hosts == NULL &&
68         (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
69         OPENSSL_free(copy);
70         return 0;
71     }
72
73     if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
74         OPENSSL_free(copy);
75         if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
76             sk_OPENSSL_STRING_free(vpm->hosts);
77             vpm->hosts = NULL;
78         }
79         return 0;
80     }
81
82     return 1;
83 }
84
85
86 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
87 {
88     X509_VERIFY_PARAM *param;
89
90     param = OPENSSL_zalloc(sizeof(*param));
91     if (param == NULL) {
92         X509err(X509_F_X509_VERIFY_PARAM_NEW, ERR_R_MALLOC_FAILURE);
93         return NULL;
94     }
95     param->trust = X509_TRUST_DEFAULT;
96     /* param->inh_flags = X509_VP_FLAG_DEFAULT; */
97     param->depth = -1;
98     param->auth_level = -1; /* -1 means unset, 0 is explicit */
99     return param;
100 }
101
102 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
103 {
104     if (param == NULL)
105         return;
106     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
107     sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
108     OPENSSL_free(param->peername);
109     OPENSSL_free(param->email);
110     OPENSSL_free(param->ip);
111     OPENSSL_free(param);
112 }
113
114 /*-
115  * This function determines how parameters are "inherited" from one structure
116  * to another. There are several different ways this can happen.
117  *
118  * 1. If a child structure needs to have its values initialized from a parent
119  *    they are simply copied across. For example SSL_CTX copied to SSL.
120  * 2. If the structure should take on values only if they are currently unset.
121  *    For example the values in an SSL structure will take appropriate value
122  *    for SSL servers or clients but only if the application has not set new
123  *    ones.
124  *
125  * The "inh_flags" field determines how this function behaves.
126  *
127  * Normally any values which are set in the default are not copied from the
128  * destination and verify flags are ORed together.
129  *
130  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
131  * to the destination. Effectively the values in "to" become default values
132  * which will be used only if nothing new is set in "from".
133  *
134  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
135  * they are set or not. Flags is still Ored though.
136  *
137  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
138  * of ORed.
139  *
140  * If X509_VP_FLAG_LOCKED is set then no values are copied.
141  *
142  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
143  * after the next call.
144  */
145
146 /* Macro to test if a field should be copied from src to dest */
147
148 #define test_x509_verify_param_copy(field, def) \
149     (to_overwrite \
150          || ((src->field != def) && (to_default || (dest->field == def))))
151
152 /* Macro to test and copy a field if necessary */
153
154 #define x509_verify_param_copy(field, def) \
155     if (test_x509_verify_param_copy(field, def)) \
156         dest->field = src->field;
157
158 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
159                               const X509_VERIFY_PARAM *src)
160 {
161     unsigned long inh_flags;
162     int to_default, to_overwrite;
163     if (!src)
164         return 1;
165     inh_flags = dest->inh_flags | src->inh_flags;
166
167     if (inh_flags & X509_VP_FLAG_ONCE)
168         dest->inh_flags = 0;
169
170     if (inh_flags & X509_VP_FLAG_LOCKED)
171         return 1;
172
173     if (inh_flags & X509_VP_FLAG_DEFAULT)
174         to_default = 1;
175     else
176         to_default = 0;
177
178     if (inh_flags & X509_VP_FLAG_OVERWRITE)
179         to_overwrite = 1;
180     else
181         to_overwrite = 0;
182
183     x509_verify_param_copy(purpose, 0);
184     x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
185     x509_verify_param_copy(depth, -1);
186     x509_verify_param_copy(auth_level, -1);
187
188     /* If overwrite or check time not set, copy across */
189
190     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
191         dest->check_time = src->check_time;
192         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
193         /* Don't need to copy flag: that is done below */
194     }
195
196     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
197         dest->flags = 0;
198
199     dest->flags |= src->flags;
200
201     if (test_x509_verify_param_copy(policies, NULL)) {
202         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
203             return 0;
204     }
205
206     /* Copy the host flags if and only if we're copying the host list */
207     if (test_x509_verify_param_copy(hosts, NULL)) {
208         sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
209         dest->hosts = NULL;
210         if (src->hosts) {
211             dest->hosts =
212                 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
213             if (dest->hosts == NULL)
214                 return 0;
215             dest->hostflags = src->hostflags;
216         }
217     }
218
219     if (test_x509_verify_param_copy(email, NULL)) {
220         if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
221             return 0;
222     }
223
224     if (test_x509_verify_param_copy(ip, NULL)) {
225         if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
226             return 0;
227     }
228
229     return 1;
230 }
231
232 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
233                            const X509_VERIFY_PARAM *from)
234 {
235     unsigned long save_flags = to->inh_flags;
236     int ret;
237     to->inh_flags |= X509_VP_FLAG_DEFAULT;
238     ret = X509_VERIFY_PARAM_inherit(to, from);
239     to->inh_flags = save_flags;
240     return ret;
241 }
242
243 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
244                                const char *src, size_t srclen)
245 {
246     char *tmp;
247     if (src) {
248         if (srclen == 0)
249             srclen = strlen(src);
250
251         tmp = OPENSSL_malloc(srclen + 1);
252         if (tmp == NULL)
253             return 0;
254         memcpy(tmp, src, srclen);
255         tmp[srclen] = '\0'; /* enforce NUL termination */
256     } else {
257         tmp = NULL;
258         srclen = 0;
259     }
260     OPENSSL_free(*pdest);
261     *pdest = tmp;
262     if (pdestlen != NULL)
263         *pdestlen = srclen;
264     return 1;
265 }
266
267 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
268 {
269     OPENSSL_free(param->name);
270     param->name = OPENSSL_strdup(name);
271     if (param->name)
272         return 1;
273     return 0;
274 }
275
276 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
277 {
278     param->flags |= flags;
279     if (flags & X509_V_FLAG_POLICY_MASK)
280         param->flags |= X509_V_FLAG_POLICY_CHECK;
281     return 1;
282 }
283
284 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
285                                   unsigned long flags)
286 {
287     param->flags &= ~flags;
288     return 1;
289 }
290
291 unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM *param)
292 {
293     return param->flags;
294 }
295
296 uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param)
297 {
298     return param->inh_flags;
299 }
300
301 int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param, uint32_t flags)
302 {
303     param->inh_flags = flags;
304     return 1;
305 }
306
307 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
308 {
309     return X509_PURPOSE_set(&param->purpose, purpose);
310 }
311
312 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
313 {
314     return X509_TRUST_set(&param->trust, trust);
315 }
316
317 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
318 {
319     param->depth = depth;
320 }
321
322 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
323 {
324     param->auth_level = auth_level;
325 }
326
327 time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param)
328 {
329     return param->check_time;
330 }
331
332 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
333 {
334     param->check_time = t;
335     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
336 }
337
338 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
339                                   ASN1_OBJECT *policy)
340 {
341     if (param->policies == NULL) {
342         param->policies = sk_ASN1_OBJECT_new_null();
343         if (param->policies == NULL)
344             return 0;
345     }
346     if (!sk_ASN1_OBJECT_push(param->policies, policy))
347         return 0;
348     return 1;
349 }
350
351 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
352                                     STACK_OF(ASN1_OBJECT) *policies)
353 {
354     int i;
355     ASN1_OBJECT *oid, *doid;
356
357     if (param == NULL)
358         return 0;
359     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
360
361     if (policies == NULL) {
362         param->policies = NULL;
363         return 1;
364     }
365
366     param->policies = sk_ASN1_OBJECT_new_null();
367     if (param->policies == NULL)
368         return 0;
369
370     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
371         oid = sk_ASN1_OBJECT_value(policies, i);
372         doid = OBJ_dup(oid);
373         if (!doid)
374             return 0;
375         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
376             ASN1_OBJECT_free(doid);
377             return 0;
378         }
379     }
380     param->flags |= X509_V_FLAG_POLICY_CHECK;
381     return 1;
382 }
383
384 char *X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM *param, int idx)
385 {
386     return sk_OPENSSL_STRING_value(param->hosts, idx);
387 }
388
389 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
390                                 const char *name, size_t namelen)
391 {
392     return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
393 }
394
395 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
396                                 const char *name, size_t namelen)
397 {
398     return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
399 }
400
401 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
402                                      unsigned int flags)
403 {
404     param->hostflags = flags;
405 }
406
407 unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param)
408 {
409     return param->hostflags;
410 }
411
412 char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM *param)
413 {
414     return param->peername;
415 }
416
417 /*
418  * Move peername from one param structure to another, freeing any name present
419  * at the target.  If the source is a NULL parameter structure, free and zero
420  * the target peername.
421  */
422 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
423                                      X509_VERIFY_PARAM *from)
424 {
425     char *peername = (from != NULL) ? from->peername : NULL;
426
427     if (to->peername != peername) {
428         OPENSSL_free(to->peername);
429         to->peername = peername;
430     }
431     if (from)
432         from->peername = NULL;
433 }
434
435 char *X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM *param)
436 {
437     return param->email;
438 }
439
440 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
441                                  const char *email, size_t emaillen)
442 {
443     return int_x509_param_set1(&param->email, &param->emaillen,
444                                email, emaillen);
445 }
446
447 static unsigned char
448 *int_X509_VERIFY_PARAM_get0_ip(X509_VERIFY_PARAM *param, size_t *plen)
449 {
450     if (param == NULL || param->ip == NULL)
451         return NULL;
452     if (plen != NULL)
453         *plen = param->iplen;
454     return param->ip;
455 }
456
457 char *X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM *param)
458 {
459     size_t iplen;
460     unsigned char *ip = int_X509_VERIFY_PARAM_get0_ip(param, &iplen);
461
462     return  ip == NULL ? NULL : ipaddr_to_asc(ip, iplen);
463 }
464
465 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
466                               const unsigned char *ip, size_t iplen)
467 {
468     if (iplen != 0 && iplen != 4 && iplen != 16)
469         return 0;
470     return int_x509_param_set1((char **)&param->ip, &param->iplen,
471                                (char *)ip, iplen);
472 }
473
474 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
475 {
476     unsigned char ipout[16];
477     size_t iplen;
478
479     iplen = (size_t)a2i_ipadd(ipout, ipasc);
480     if (iplen == 0)
481         return 0;
482     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
483 }
484
485 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
486 {
487     return param->depth;
488 }
489
490 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
491 {
492     return param->auth_level;
493 }
494
495 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
496 {
497     return param->name;
498 }
499
500 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
501
502 /*
503  * Default verify parameters: these are used for various applications and can
504  * be overridden by the user specified table. NB: the 'name' field *must* be
505  * in alphabetical order because it will be searched using OBJ_search.
506  */
507
508 static const X509_VERIFY_PARAM default_table[] = {
509     {
510      "default",                 /* X509 default parameters */
511      0,                         /* Check time */
512      0,                         /* internal flags */
513      X509_V_FLAG_TRUSTED_FIRST, /* flags */
514      0,                         /* purpose */
515      0,                         /* trust */
516      100,                       /* depth */
517      -1,                        /* auth_level */
518      NULL,                      /* policies */
519      vpm_empty_id},
520     {
521      "pkcs7",                   /* S/MIME sign parameters */
522      0,                         /* Check time */
523      0,                         /* internal flags */
524      0,                         /* flags */
525      X509_PURPOSE_SMIME_SIGN,   /* purpose */
526      X509_TRUST_EMAIL,          /* trust */
527      -1,                        /* depth */
528      -1,                        /* auth_level */
529      NULL,                      /* policies */
530      vpm_empty_id},
531     {
532      "smime_sign",              /* S/MIME sign parameters */
533      0,                         /* Check time */
534      0,                         /* internal flags */
535      0,                         /* flags */
536      X509_PURPOSE_SMIME_SIGN,   /* purpose */
537      X509_TRUST_EMAIL,          /* trust */
538      -1,                        /* depth */
539      -1,                        /* auth_level */
540      NULL,                      /* policies */
541      vpm_empty_id},
542     {
543      "ssl_client",              /* SSL/TLS client parameters */
544      0,                         /* Check time */
545      0,                         /* internal flags */
546      0,                         /* flags */
547      X509_PURPOSE_SSL_CLIENT,   /* purpose */
548      X509_TRUST_SSL_CLIENT,     /* trust */
549      -1,                        /* depth */
550      -1,                        /* auth_level */
551      NULL,                      /* policies */
552      vpm_empty_id},
553     {
554      "ssl_server",              /* SSL/TLS server parameters */
555      0,                         /* Check time */
556      0,                         /* internal flags */
557      0,                         /* flags */
558      X509_PURPOSE_SSL_SERVER,   /* purpose */
559      X509_TRUST_SSL_SERVER,     /* trust */
560      -1,                        /* depth */
561      -1,                        /* auth_level */
562      NULL,                      /* policies */
563      vpm_empty_id}
564 };
565
566 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
567
568 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
569 {
570     return strcmp(a->name, b->name);
571 }
572
573 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
574 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
575
576 static int param_cmp(const X509_VERIFY_PARAM *const *a,
577                      const X509_VERIFY_PARAM *const *b)
578 {
579     return strcmp((*a)->name, (*b)->name);
580 }
581
582 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
583 {
584     int idx;
585     X509_VERIFY_PARAM *ptmp;
586     if (param_table == NULL) {
587         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
588         if (param_table == NULL)
589             return 0;
590     } else {
591         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
592         if (idx >= 0) {
593             ptmp = sk_X509_VERIFY_PARAM_delete(param_table, idx);
594             X509_VERIFY_PARAM_free(ptmp);
595         }
596     }
597     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
598         return 0;
599     return 1;
600 }
601
602 int X509_VERIFY_PARAM_get_count(void)
603 {
604     int num = OSSL_NELEM(default_table);
605     if (param_table)
606         num += sk_X509_VERIFY_PARAM_num(param_table);
607     return num;
608 }
609
610 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
611 {
612     int num = OSSL_NELEM(default_table);
613     if (id < num)
614         return default_table + id;
615     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
616 }
617
618 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
619 {
620     int idx;
621     X509_VERIFY_PARAM pm;
622
623     pm.name = (char *)name;
624     if (param_table != NULL) {
625         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
626         if (idx >= 0)
627             return sk_X509_VERIFY_PARAM_value(param_table, idx);
628     }
629     return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
630 }
631
632 void X509_VERIFY_PARAM_table_cleanup(void)
633 {
634     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
635     param_table = NULL;
636 }