1/*
2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3 * 2004.
4 */
5/* ====================================================================
6 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24 *
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
29 *
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
33 *
34 * 6. Redistributions of any form whatsoever must retain the following
35 * acknowledgment:
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38 *
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
52 *
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com). */
56
57#include <string.h>
58
59#include <openssl/buf.h>
60#include <openssl/mem.h>
61#include <openssl/obj.h>
62#include <openssl/stack.h>
63#include <openssl/x509.h>
64#include <openssl/x509v3.h>
65
66#include "vpm_int.h"
67#include "../internal.h"
68
69
70/* X509_VERIFY_PARAM functions */
71
72#define SET_HOST 0
73#define ADD_HOST 1
74
75static char *str_copy(char *s)
76{
77 return OPENSSL_strdup(s);
78}
79
80static void str_free(char *s)
81{
82 OPENSSL_free(s);
83}
84
85#define string_stack_free(sk) sk_OPENSSL_STRING_pop_free(sk, str_free)
86
87static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID *id, int mode,
88 const char *name, size_t namelen)
89{
90 char *copy;
91
92 if (name == NULL || namelen == 0) {
93 // Unlike OpenSSL, we reject trying to set or add an empty name.
94 return 0;
95 }
96
97 /*
98 * Refuse names with embedded NUL bytes.
99 * XXX: Do we need to push an error onto the error stack?
100 */
101 if (name && OPENSSL_memchr(name, '\0', namelen))
102 return 0;
103
104 if (mode == SET_HOST && id->hosts) {
105 string_stack_free(id->hosts);
106 id->hosts = NULL;
107 }
108
109 copy = BUF_strndup(name, namelen);
110 if (copy == NULL)
111 return 0;
112
113 if (id->hosts == NULL &&
114 (id->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
115 OPENSSL_free(copy);
116 return 0;
117 }
118
119 if (!sk_OPENSSL_STRING_push(id->hosts, copy)) {
120 OPENSSL_free(copy);
121 if (sk_OPENSSL_STRING_num(id->hosts) == 0) {
122 sk_OPENSSL_STRING_free(id->hosts);
123 id->hosts = NULL;
124 }
125 return 0;
126 }
127
128 return 1;
129}
130
131static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
132{
133 X509_VERIFY_PARAM_ID *paramid;
134 if (!param)
135 return;
136 param->name = NULL;
137 param->purpose = 0;
138 param->trust = 0;
139 /*
140 * param->inh_flags = X509_VP_FLAG_DEFAULT;
141 */
142 param->inh_flags = 0;
143 param->flags = 0;
144 param->depth = -1;
145 if (param->policies) {
146 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
147 param->policies = NULL;
148 }
149 paramid = param->id;
150 if (paramid->hosts) {
151 string_stack_free(paramid->hosts);
152 paramid->hosts = NULL;
153 }
154 if (paramid->peername) {
155 OPENSSL_free(paramid->peername);
156 paramid->peername = NULL;
157 }
158 if (paramid->email) {
159 OPENSSL_free(paramid->email);
160 paramid->email = NULL;
161 paramid->emaillen = 0;
162 }
163 if (paramid->ip) {
164 OPENSSL_free(paramid->ip);
165 paramid->ip = NULL;
166 paramid->iplen = 0;
167 }
168 paramid->poison = 0;
169}
170
171X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
172{
173 X509_VERIFY_PARAM *param;
174 X509_VERIFY_PARAM_ID *paramid;
175 param = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
176 if (!param)
177 return NULL;
178 paramid = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM_ID));
179 if (!paramid) {
180 OPENSSL_free(param);
181 return NULL;
182 }
183 OPENSSL_memset(param, 0, sizeof(X509_VERIFY_PARAM));
184 OPENSSL_memset(paramid, 0, sizeof(X509_VERIFY_PARAM_ID));
185 param->id = paramid;
186 x509_verify_param_zero(param);
187 return param;
188}
189
190void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
191{
192 if (param == NULL)
193 return;
194 x509_verify_param_zero(param);
195 OPENSSL_free(param->id);
196 OPENSSL_free(param);
197}
198
199/*-
200 * This function determines how parameters are "inherited" from one structure
201 * to another. There are several different ways this can happen.
202 *
203 * 1. If a child structure needs to have its values initialized from a parent
204 * they are simply copied across. For example SSL_CTX copied to SSL.
205 * 2. If the structure should take on values only if they are currently unset.
206 * For example the values in an SSL structure will take appropriate value
207 * for SSL servers or clients but only if the application has not set new
208 * ones.
209 *
210 * The "inh_flags" field determines how this function behaves.
211 *
212 * Normally any values which are set in the default are not copied from the
213 * destination and verify flags are ORed together.
214 *
215 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
216 * to the destination. Effectively the values in "to" become default values
217 * which will be used only if nothing new is set in "from".
218 *
219 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
220 * they are set or not. Flags is still Ored though.
221 *
222 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
223 * of ORed.
224 *
225 * If X509_VP_FLAG_LOCKED is set then no values are copied.
226 *
227 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
228 * after the next call.
229 */
230
231/* Macro to test if a field should be copied from src to dest */
232
233#define test_x509_verify_param_copy(field, def) \
234 (to_overwrite || \
235 ((src->field != (def)) && (to_default || (dest->field == (def)))))
236
237/* As above but for ID fields */
238
239#define test_x509_verify_param_copy_id(idf, def) \
240 test_x509_verify_param_copy(id->idf, def)
241
242/* Macro to test and copy a field if necessary */
243
244#define x509_verify_param_copy(field, def) \
245 if (test_x509_verify_param_copy(field, def)) \
246 dest->field = src->field
247
248int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
249 const X509_VERIFY_PARAM *src)
250{
251 unsigned long inh_flags;
252 int to_default, to_overwrite;
253 X509_VERIFY_PARAM_ID *id;
254 if (!src)
255 return 1;
256 id = src->id;
257 inh_flags = dest->inh_flags | src->inh_flags;
258
259 if (inh_flags & X509_VP_FLAG_ONCE)
260 dest->inh_flags = 0;
261
262 if (inh_flags & X509_VP_FLAG_LOCKED)
263 return 1;
264
265 if (inh_flags & X509_VP_FLAG_DEFAULT)
266 to_default = 1;
267 else
268 to_default = 0;
269
270 if (inh_flags & X509_VP_FLAG_OVERWRITE)
271 to_overwrite = 1;
272 else
273 to_overwrite = 0;
274
275 x509_verify_param_copy(purpose, 0);
276 x509_verify_param_copy(trust, 0);
277 x509_verify_param_copy(depth, -1);
278
279 /* If overwrite or check time not set, copy across */
280
281 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
282 dest->check_time = src->check_time;
283 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
284 /* Don't need to copy flag: that is done below */
285 }
286
287 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
288 dest->flags = 0;
289
290 dest->flags |= src->flags;
291
292 if (test_x509_verify_param_copy(policies, NULL)) {
293 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
294 return 0;
295 }
296
297 /* Copy the host flags if and only if we're copying the host list */
298 if (test_x509_verify_param_copy_id(hosts, NULL)) {
299 if (dest->id->hosts) {
300 string_stack_free(dest->id->hosts);
301 dest->id->hosts = NULL;
302 }
303 if (id->hosts) {
304 dest->id->hosts =
305 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free);
306 if (dest->id->hosts == NULL)
307 return 0;
308 dest->id->hostflags = id->hostflags;
309 }
310 }
311
312 if (test_x509_verify_param_copy_id(email, NULL)) {
313 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
314 return 0;
315 }
316
317 if (test_x509_verify_param_copy_id(ip, NULL)) {
318 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
319 return 0;
320 }
321
322 dest->id->poison = src->id->poison;
323
324 return 1;
325}
326
327int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
328 const X509_VERIFY_PARAM *from)
329{
330 unsigned long save_flags = to->inh_flags;
331 int ret;
332 to->inh_flags |= X509_VP_FLAG_DEFAULT;
333 ret = X509_VERIFY_PARAM_inherit(to, from);
334 to->inh_flags = save_flags;
335 return ret;
336}
337
338static int int_x509_param_set1(char **pdest, size_t *pdestlen,
339 const char *src, size_t srclen)
340{
341 void *tmp;
342 if (src == NULL || srclen == 0) {
343 // Unlike OpenSSL, we do not allow an empty string to disable previously
344 // configured checks.
345 return 0;
346 }
347
348 tmp = BUF_memdup(src, srclen);
349 if (!tmp) {
350 return 0;
351 }
352
353 if (*pdest)
354 OPENSSL_free(*pdest);
355 *pdest = tmp;
356 if (pdestlen)
357 *pdestlen = srclen;
358 return 1;
359}
360
361int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
362{
363 if (param->name)
364 OPENSSL_free(param->name);
365 param->name = BUF_strdup(name);
366 if (param->name)
367 return 1;
368 return 0;
369}
370
371int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
372{
373 param->flags |= flags;
374 if (flags & X509_V_FLAG_POLICY_MASK)
375 param->flags |= X509_V_FLAG_POLICY_CHECK;
376 return 1;
377}
378
379int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
380 unsigned long flags)
381{
382 param->flags &= ~flags;
383 return 1;
384}
385
386unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
387{
388 return param->flags;
389}
390
391int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
392{
393 return X509_PURPOSE_set(&param->purpose, purpose);
394}
395
396int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
397{
398 return X509_TRUST_set(&param->trust, trust);
399}
400
401void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
402{
403 param->depth = depth;
404}
405
406void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
407{
408 param->check_time = t;
409 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
410}
411
412int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
413 ASN1_OBJECT *policy)
414{
415 if (!param->policies) {
416 param->policies = sk_ASN1_OBJECT_new_null();
417 if (!param->policies)
418 return 0;
419 }
420 if (!sk_ASN1_OBJECT_push(param->policies, policy))
421 return 0;
422 return 1;
423}
424
425int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
426 STACK_OF(ASN1_OBJECT) *policies)
427{
428 size_t i;
429 ASN1_OBJECT *oid, *doid;
430 if (!param)
431 return 0;
432 if (param->policies)
433 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
434
435 if (!policies) {
436 param->policies = NULL;
437 return 1;
438 }
439
440 param->policies = sk_ASN1_OBJECT_new_null();
441 if (!param->policies)
442 return 0;
443
444 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
445 oid = sk_ASN1_OBJECT_value(policies, i);
446 doid = OBJ_dup(oid);
447 if (!doid)
448 return 0;
449 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
450 ASN1_OBJECT_free(doid);
451 return 0;
452 }
453 }
454 param->flags |= X509_V_FLAG_POLICY_CHECK;
455 return 1;
456}
457
458int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
459 const char *name, size_t namelen)
460{
461 if (!int_x509_param_set_hosts(param->id, SET_HOST, name, namelen)) {
462 param->id->poison = 1;
463 return 0;
464 }
465 return 1;
466}
467
468int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
469 const char *name, size_t namelen)
470{
471 if (!int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen)) {
472 param->id->poison = 1;
473 return 0;
474 }
475 return 1;
476}
477
478void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
479 unsigned int flags)
480{
481 param->id->hostflags = flags;
482}
483
484char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
485{
486 return param->id->peername;
487}
488
489int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
490 const char *email, size_t emaillen)
491{
492 if (OPENSSL_memchr(email, '\0', emaillen) != NULL ||
493 !int_x509_param_set1(&param->id->email, &param->id->emaillen,
494 email, emaillen)) {
495 param->id->poison = 1;
496 return 0;
497 }
498
499 return 1;
500}
501
502int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
503 const unsigned char *ip, size_t iplen)
504{
505 if ((iplen != 4 && iplen != 16) ||
506 !int_x509_param_set1((char **)&param->id->ip, &param->id->iplen,
507 (char *)ip, iplen)) {
508 param->id->poison = 1;
509 return 0;
510 }
511
512 return 1;
513}
514
515int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
516{
517 unsigned char ipout[16];
518 size_t iplen;
519
520 iplen = (size_t)a2i_ipadd(ipout, ipasc);
521 if (iplen == 0)
522 return 0;
523 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
524}
525
526int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
527{
528 return param->depth;
529}
530
531const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
532{
533 return param->name;
534}
535
536static const X509_VERIFY_PARAM_ID _empty_id =
537 { NULL, 0U, NULL, NULL, 0, NULL, 0, 0 };
538
539#define vpm_empty_id ((X509_VERIFY_PARAM_ID *)&_empty_id)
540
541/*
542 * Default verify parameters: these are used for various applications and can
543 * be overridden by the user specified table. NB: the 'name' field *must* be
544 * in alphabetical order because it will be searched using OBJ_search.
545 */
546
547static const X509_VERIFY_PARAM default_table[] = {
548 {
549 (char *)"default", /* X509 default parameters */
550 0, /* Check time */
551 0, /* internal flags */
552 0, /* flags */
553 0, /* purpose */
554 0, /* trust */
555 100, /* depth */
556 NULL, /* policies */
557 vpm_empty_id},
558 {
559 (char *)"pkcs7", /* S/MIME sign parameters */
560 0, /* Check time */
561 0, /* internal flags */
562 0, /* flags */
563 X509_PURPOSE_SMIME_SIGN, /* purpose */
564 X509_TRUST_EMAIL, /* trust */
565 -1, /* depth */
566 NULL, /* policies */
567 vpm_empty_id},
568 {
569 (char *)"smime_sign", /* S/MIME sign parameters */
570 0, /* Check time */
571 0, /* internal flags */
572 0, /* flags */
573 X509_PURPOSE_SMIME_SIGN, /* purpose */
574 X509_TRUST_EMAIL, /* trust */
575 -1, /* depth */
576 NULL, /* policies */
577 vpm_empty_id},
578 {
579 (char *)"ssl_client", /* SSL/TLS client parameters */
580 0, /* Check time */
581 0, /* internal flags */
582 0, /* flags */
583 X509_PURPOSE_SSL_CLIENT, /* purpose */
584 X509_TRUST_SSL_CLIENT, /* trust */
585 -1, /* depth */
586 NULL, /* policies */
587 vpm_empty_id},
588 {
589 (char *)"ssl_server", /* SSL/TLS server parameters */
590 0, /* Check time */
591 0, /* internal flags */
592 0, /* flags */
593 X509_PURPOSE_SSL_SERVER, /* purpose */
594 X509_TRUST_SSL_SERVER, /* trust */
595 -1, /* depth */
596 NULL, /* policies */
597 vpm_empty_id}
598};
599
600static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
601
602static int param_cmp(const X509_VERIFY_PARAM **a, const X509_VERIFY_PARAM **b)
603{
604 return strcmp((*a)->name, (*b)->name);
605}
606
607int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
608{
609 X509_VERIFY_PARAM *ptmp;
610 if (!param_table) {
611 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
612 if (!param_table)
613 return 0;
614 } else {
615 size_t idx;
616
617 sk_X509_VERIFY_PARAM_sort(param_table);
618 if (sk_X509_VERIFY_PARAM_find(param_table, &idx, param)) {
619 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
620 X509_VERIFY_PARAM_free(ptmp);
621 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
622 }
623 }
624 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
625 return 0;
626 return 1;
627}
628
629int X509_VERIFY_PARAM_get_count(void)
630{
631 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
632 if (param_table)
633 num += sk_X509_VERIFY_PARAM_num(param_table);
634 return num;
635}
636
637const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
638{
639 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
640 if (id < num)
641 return default_table + id;
642 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
643}
644
645const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
646{
647 X509_VERIFY_PARAM pm;
648 unsigned i, limit;
649
650 pm.name = (char *)name;
651 if (param_table) {
652 size_t idx;
653 sk_X509_VERIFY_PARAM_sort(param_table);
654 if (sk_X509_VERIFY_PARAM_find(param_table, &idx, &pm))
655 return sk_X509_VERIFY_PARAM_value(param_table, idx);
656 }
657
658 limit = sizeof(default_table) / sizeof(X509_VERIFY_PARAM);
659 for (i = 0; i < limit; i++) {
660 if (strcmp(default_table[i].name, name) == 0) {
661 return &default_table[i];
662 }
663 }
664 return NULL;
665}
666
667void X509_VERIFY_PARAM_table_cleanup(void)
668{
669 if (param_table)
670 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
671 param_table = NULL;
672}
673