1 /*! \file ssl/ssl_cert.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
58 /* ====================================================================
59 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@OpenSSL.org.
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
110 #ifndef NO_SYS_TYPES_H
111 # include <sys/types.h>
114 #if !defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_SYS_VMS) && !defined(NeXT) && !defined(MAC_OS_pre_X)
120 #define dirent direct
123 #include <openssl/objects.h>
124 #include <openssl/bio.h>
125 #include <openssl/pem.h>
126 #include <openssl/x509v3.h>
127 #include "ssl_locl.h"
129 int SSL_get_ex_data_X509_STORE_CTX_idx(void)
131 static volatile int ssl_x509_store_ctx_idx= -1;
133 if (ssl_x509_store_ctx_idx < 0)
135 /* any write lock will do; usually this branch
136 * will only be taken once anyway */
137 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
139 if (ssl_x509_store_ctx_idx < 0)
141 ssl_x509_store_ctx_idx=X509_STORE_CTX_get_ex_new_index(
142 0,"SSL for verify callback",NULL,NULL,NULL);
145 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
147 return ssl_x509_store_ctx_idx;
150 CERT *ssl_cert_new(void)
154 ret=(CERT *)OPENSSL_malloc(sizeof(CERT));
157 SSLerr(SSL_F_SSL_CERT_NEW,ERR_R_MALLOC_FAILURE);
160 memset(ret,0,sizeof(CERT));
162 ret->key= &(ret->pkeys[SSL_PKEY_RSA_ENC]);
168 CERT *ssl_cert_dup(CERT *cert)
173 ret = (CERT *)OPENSSL_malloc(sizeof(CERT));
176 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_MALLOC_FAILURE);
180 memset(ret, 0, sizeof(CERT));
182 ret->key = &ret->pkeys[cert->key - &cert->pkeys[0]];
183 /* or ret->key = ret->pkeys + (cert->key - cert->pkeys),
184 * if you find that more readable */
186 ret->valid = cert->valid;
187 ret->mask = cert->mask;
188 ret->export_mask = cert->export_mask;
190 #ifndef OPENSSL_NO_RSA
191 if (cert->rsa_tmp != NULL)
193 ret->rsa_tmp = cert->rsa_tmp;
194 CRYPTO_add(&ret->rsa_tmp->references, 1, CRYPTO_LOCK_RSA);
196 ret->rsa_tmp_cb = cert->rsa_tmp_cb;
199 #ifndef OPENSSL_NO_DH
200 if (cert->dh_tmp != NULL)
202 /* DH parameters don't have a reference count */
203 ret->dh_tmp = DHparams_dup(cert->dh_tmp);
204 if (ret->dh_tmp == NULL)
206 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_DH_LIB);
209 if (cert->dh_tmp->priv_key)
211 BIGNUM *b = BN_dup(cert->dh_tmp->priv_key);
214 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_BN_LIB);
217 ret->dh_tmp->priv_key = b;
219 if (cert->dh_tmp->pub_key)
221 BIGNUM *b = BN_dup(cert->dh_tmp->pub_key);
224 SSLerr(SSL_F_SSL_CERT_DUP, ERR_R_BN_LIB);
227 ret->dh_tmp->pub_key = b;
230 ret->dh_tmp_cb = cert->dh_tmp_cb;
233 for (i = 0; i < SSL_PKEY_NUM; i++)
235 if (cert->pkeys[i].x509 != NULL)
237 ret->pkeys[i].x509 = cert->pkeys[i].x509;
238 CRYPTO_add(&ret->pkeys[i].x509->references, 1,
242 if (cert->pkeys[i].privatekey != NULL)
244 ret->pkeys[i].privatekey = cert->pkeys[i].privatekey;
245 CRYPTO_add(&ret->pkeys[i].privatekey->references, 1,
246 CRYPTO_LOCK_EVP_PKEY);
250 /* If there was anything special to do for
251 * certain types of keys, we'd do it here.
252 * (Nothing at the moment, I think.) */
254 case SSL_PKEY_RSA_ENC:
255 case SSL_PKEY_RSA_SIGN:
256 /* We have an RSA key. */
259 case SSL_PKEY_DSA_SIGN:
260 /* We have a DSA key. */
263 case SSL_PKEY_DH_RSA:
264 case SSL_PKEY_DH_DSA:
265 /* We have a DH key. */
270 SSLerr(SSL_F_SSL_CERT_DUP, SSL_R_LIBRARY_BUG);
275 /* ret->extra_certs *should* exist, but currently the own certificate
276 * chain is held inside SSL_CTX */
282 #ifndef OPENSSL_NO_DH /* avoid 'unreferenced label' warning if OPENSSL_NO_DH is defined */
285 #ifndef OPENSSL_NO_RSA
286 if (ret->rsa_tmp != NULL)
287 RSA_free(ret->rsa_tmp);
289 #ifndef OPENSSL_NO_DH
290 if (ret->dh_tmp != NULL)
291 DH_free(ret->dh_tmp);
294 for (i = 0; i < SSL_PKEY_NUM; i++)
296 if (ret->pkeys[i].x509 != NULL)
297 X509_free(ret->pkeys[i].x509);
298 if (ret->pkeys[i].privatekey != NULL)
299 EVP_PKEY_free(ret->pkeys[i].privatekey);
306 void ssl_cert_free(CERT *c)
313 i=CRYPTO_add(&c->references,-1,CRYPTO_LOCK_SSL_CERT);
321 fprintf(stderr,"ssl_cert_free, bad reference count\n");
326 #ifndef OPENSSL_NO_RSA
327 if (c->rsa_tmp) RSA_free(c->rsa_tmp);
329 #ifndef OPENSSL_NO_DH
330 if (c->dh_tmp) DH_free(c->dh_tmp);
333 for (i=0; i<SSL_PKEY_NUM; i++)
335 if (c->pkeys[i].x509 != NULL)
336 X509_free(c->pkeys[i].x509);
337 if (c->pkeys[i].privatekey != NULL)
338 EVP_PKEY_free(c->pkeys[i].privatekey);
340 if (c->pkeys[i].publickey != NULL)
341 EVP_PKEY_free(c->pkeys[i].publickey);
347 int ssl_cert_inst(CERT **o)
349 /* Create a CERT if there isn't already one
350 * (which cannot really happen, as it is initially created in
351 * SSL_CTX_new; but the earlier code usually allows for that one
352 * being non-existant, so we follow that behaviour, as it might
353 * turn out that there actually is a reason for it -- but I'm
354 * not sure that *all* of the existing code could cope with
355 * s->cert being NULL, otherwise we could do without the
356 * initialization in SSL_CTX_new).
361 SSLerr(SSL_F_SSL_CERT_INST, ERR_R_PASSED_NULL_PARAMETER);
366 if ((*o = ssl_cert_new()) == NULL)
368 SSLerr(SSL_F_SSL_CERT_INST, ERR_R_MALLOC_FAILURE);
376 SESS_CERT *ssl_sess_cert_new(void)
380 ret = OPENSSL_malloc(sizeof *ret);
383 SSLerr(SSL_F_SSL_SESS_CERT_NEW, ERR_R_MALLOC_FAILURE);
387 memset(ret, 0 ,sizeof *ret);
388 ret->peer_key = &(ret->peer_pkeys[SSL_PKEY_RSA_ENC]);
394 void ssl_sess_cert_free(SESS_CERT *sc)
401 i = CRYPTO_add(&sc->references, -1, CRYPTO_LOCK_SSL_SESS_CERT);
403 REF_PRINT("SESS_CERT", sc);
410 fprintf(stderr,"ssl_sess_cert_free, bad reference count\n");
416 if (sc->cert_chain != NULL)
417 sk_X509_pop_free(sc->cert_chain, X509_free);
418 for (i = 0; i < SSL_PKEY_NUM; i++)
420 if (sc->peer_pkeys[i].x509 != NULL)
421 X509_free(sc->peer_pkeys[i].x509);
422 #if 0 /* We don't have the peer's private key. These lines are just
423 * here as a reminder that we're still using a not-quite-appropriate
425 if (sc->peer_pkeys[i].privatekey != NULL)
426 EVP_PKEY_free(sc->peer_pkeys[i].privatekey);
430 #ifndef OPENSSL_NO_RSA
431 if (sc->peer_rsa_tmp != NULL)
432 RSA_free(sc->peer_rsa_tmp);
434 #ifndef OPENSSL_NO_DH
435 if (sc->peer_dh_tmp != NULL)
436 DH_free(sc->peer_dh_tmp);
442 int ssl_set_peer_cert_type(SESS_CERT *sc,int type)
444 sc->peer_cert_type = type;
448 int ssl_verify_cert_chain(SSL *s,STACK_OF(X509) *sk)
454 if ((sk == NULL) || (sk_X509_num(sk) == 0))
457 x=sk_X509_value(sk,0);
458 X509_STORE_CTX_init(&ctx,s->ctx->cert_store,x,sk);
459 if (SSL_get_verify_depth(s) >= 0)
460 X509_STORE_CTX_set_depth(&ctx, SSL_get_verify_depth(s));
461 X509_STORE_CTX_set_ex_data(&ctx,SSL_get_ex_data_X509_STORE_CTX_idx(),s);
463 /* We need to set the verify purpose. The purpose can be determined by
464 * the context: if its a server it will verify SSL client certificates
468 i = X509_PURPOSE_SSL_CLIENT;
470 i = X509_PURPOSE_SSL_SERVER;
472 X509_STORE_CTX_purpose_inherit(&ctx, i, s->purpose, s->trust);
474 if (s->ctx->app_verify_callback != NULL)
475 i=s->ctx->app_verify_callback(&ctx); /* should pass app_verify_arg */
478 #ifndef OPENSSL_NO_X509_VERIFY
479 i=X509_verify_cert(&ctx);
482 ctx.error=X509_V_ERR_APPLICATION_VERIFICATION;
483 SSLerr(SSL_F_SSL_VERIFY_CERT_CHAIN,SSL_R_NO_VERIFY_CALLBACK);
487 s->verify_result=ctx.error;
488 X509_STORE_CTX_cleanup(&ctx);
493 static void set_client_CA_list(STACK_OF(X509_NAME) **ca_list,STACK_OF(X509_NAME) *list)
495 if (*ca_list != NULL)
496 sk_X509_NAME_pop_free(*ca_list,X509_NAME_free);
501 STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk)
504 STACK_OF(X509_NAME) *ret;
507 ret=sk_X509_NAME_new_null();
508 for (i=0; i<sk_X509_NAME_num(sk); i++)
510 name=X509_NAME_dup(sk_X509_NAME_value(sk,i));
511 if ((name == NULL) || !sk_X509_NAME_push(ret,name))
513 sk_X509_NAME_pop_free(ret,X509_NAME_free);
520 void SSL_set_client_CA_list(SSL *s,STACK_OF(X509_NAME) *list)
522 set_client_CA_list(&(s->client_CA),list);
525 void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,STACK_OF(X509_NAME) *list)
527 set_client_CA_list(&(ctx->client_CA),list);
530 STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(SSL_CTX *ctx)
532 return(ctx->client_CA);
535 STACK_OF(X509_NAME) *SSL_get_client_CA_list(SSL *s)
537 if (s->type == SSL_ST_CONNECT)
538 { /* we are in the client */
539 if (((s->version>>8) == SSL3_VERSION_MAJOR) &&
541 return(s->s3->tmp.ca_names);
547 if (s->client_CA != NULL)
548 return(s->client_CA);
550 return(s->ctx->client_CA);
554 static int add_client_CA(STACK_OF(X509_NAME) **sk,X509 *x)
558 if (x == NULL) return(0);
559 if ((*sk == NULL) && ((*sk=sk_X509_NAME_new_null()) == NULL))
562 if ((name=X509_NAME_dup(X509_get_subject_name(x))) == NULL)
565 if (!sk_X509_NAME_push(*sk,name))
567 X509_NAME_free(name);
573 int SSL_add_client_CA(SSL *ssl,X509 *x)
575 return(add_client_CA(&(ssl->client_CA),x));
578 int SSL_CTX_add_client_CA(SSL_CTX *ctx,X509 *x)
580 return(add_client_CA(&(ctx->client_CA),x));
583 static int xname_cmp(const X509_NAME * const *a, const X509_NAME * const *b)
585 return(X509_NAME_cmp(*a,*b));
588 #ifndef OPENSSL_NO_STDIO
590 * Load CA certs from a file into a ::STACK. Note that it is somewhat misnamed;
591 * it doesn't really have anything to do with clients (except that a common use
592 * for a stack of CAs is to send it to the client). Actually, it doesn't have
593 * much to do with CAs, either, since it will load any old cert.
594 * \param file the file containing one or more certs.
595 * \return a ::STACK containing the certs.
597 STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file)
602 STACK_OF(X509_NAME) *ret,*sk;
604 ret=sk_X509_NAME_new_null();
605 sk=sk_X509_NAME_new(xname_cmp);
607 in=BIO_new(BIO_s_file_internal());
609 if ((ret == NULL) || (sk == NULL) || (in == NULL))
611 SSLerr(SSL_F_SSL_LOAD_CLIENT_CA_FILE,ERR_R_MALLOC_FAILURE);
615 if (!BIO_read_filename(in,file))
620 if (PEM_read_bio_X509(in,&x,NULL,NULL) == NULL)
622 if ((xn=X509_get_subject_name(x)) == NULL) goto err;
623 /* check for duplicates */
624 xn=X509_NAME_dup(xn);
625 if (xn == NULL) goto err;
626 if (sk_X509_NAME_find(sk,xn) >= 0)
630 sk_X509_NAME_push(sk,xn);
631 sk_X509_NAME_push(ret,xn);
638 if (ret != NULL) sk_X509_NAME_pop_free(ret,X509_NAME_free);
641 if (sk != NULL) sk_X509_NAME_free(sk);
642 if (in != NULL) BIO_free(in);
643 if (x != NULL) X509_free(x);
649 * Add a file of certs to a stack.
650 * \param stack the stack to add to.
651 * \param file the file to add from. All certs in this file that are not
652 * already in the stack will be added.
653 * \return 1 for success, 0 for failure. Note that in the case of failure some
654 * certs may have been added to \c stack.
657 int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
664 int (*oldcmp)(const X509_NAME * const *a, const X509_NAME * const *b);
666 oldcmp=sk_X509_NAME_set_cmp_func(stack,xname_cmp);
668 in=BIO_new(BIO_s_file_internal());
672 SSLerr(SSL_F_SSL_ADD_FILE_CERT_SUBJECTS_TO_STACK,ERR_R_MALLOC_FAILURE);
676 if (!BIO_read_filename(in,file))
681 if (PEM_read_bio_X509(in,&x,NULL,NULL) == NULL)
683 if ((xn=X509_get_subject_name(x)) == NULL) goto err;
684 xn=X509_NAME_dup(xn);
685 if (xn == NULL) goto err;
686 if (sk_X509_NAME_find(stack,xn) >= 0)
689 sk_X509_NAME_push(stack,xn);
702 sk_X509_NAME_set_cmp_func(stack,oldcmp);
708 * Add a directory of certs to a stack.
709 * \param stack the stack to append to.
710 * \param dir the directory to append from. All files in this directory will be
711 * examined as potential certs. Any that are acceptable to
712 * SSL_add_dir_cert_subjects_to_stack() that are not already in the stack will be
714 * \return 1 for success, 0 for failure. Note that in the case of failure some
715 * certs may have been added to \c stack.
718 #ifndef OPENSSL_SYS_WIN32
719 #ifndef OPENSSL_SYS_VMS /* XXXX This may be fixed in the future */
722 int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
726 struct dirent *dstruct;
729 CRYPTO_w_lock(CRYPTO_LOCK_READDIR);
732 /* Note that a side effect is that the CAs will be sorted by name */
735 SYSerr(SYS_F_OPENDIR, get_last_sys_error());
736 ERR_add_error_data(3, "opendir('", dir, "')");
737 SSLerr(SSL_F_SSL_ADD_DIR_CERT_SUBJECTS_TO_STACK, ERR_R_SYS_LIB);
741 while((dstruct=readdir(d)))
746 if(strlen(dir)+strlen(dstruct->d_name)+2 > sizeof buf)
748 SSLerr(SSL_F_SSL_ADD_DIR_CERT_SUBJECTS_TO_STACK,SSL_R_PATH_TOO_LONG);
752 r = BIO_snprintf(buf,sizeof buf,"%s/%s",dir,dstruct->d_name);
753 if (r <= 0 || r >= sizeof buf)
755 if(!SSL_add_file_cert_subjects_to_stack(stack,buf))
761 CRYPTO_w_unlock(CRYPTO_LOCK_READDIR);