1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
57 /* ====================================================================
58 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
86 * 6. Redistributions of any form whatsoever must retain the following
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
111 /* callback functions used by s_client, s_server, and s_time */
114 #include <string.h> /* for memcpy() and strcmp() */
118 #include <openssl/err.h>
119 #include <openssl/rand.h>
120 #include <openssl/x509.h>
121 #include <openssl/ssl.h>
122 #include <openssl/bn.h>
123 #ifndef OPENSSL_NO_DH
124 # include <openssl/dh.h>
128 #define COOKIE_SECRET_LENGTH 16
130 int verify_depth = 0;
131 int verify_quiet = 0;
132 int verify_error = X509_V_OK;
133 int verify_return_error = 0;
134 #ifndef OPENSSL_NO_SOCK
135 static unsigned char cookie_secret[COOKIE_SECRET_LENGTH];
136 static int cookie_initialized = 0;
139 static const char *lookup(int val, const STRINT_PAIR* list, const char* def)
141 for ( ; list->name; ++list)
142 if (list->retval == val)
147 int verify_callback(int ok, X509_STORE_CTX *ctx)
152 err_cert = X509_STORE_CTX_get_current_cert(ctx);
153 err = X509_STORE_CTX_get_error(ctx);
154 depth = X509_STORE_CTX_get_error_depth(ctx);
156 if (!verify_quiet || !ok) {
157 BIO_printf(bio_err, "depth=%d ", depth);
159 X509_NAME_print_ex(bio_err,
160 X509_get_subject_name(err_cert),
162 BIO_puts(bio_err, "\n");
164 BIO_puts(bio_err, "<no cert>\n");
167 BIO_printf(bio_err, "verify error:num=%d:%s\n", err,
168 X509_verify_cert_error_string(err));
169 if (verify_depth >= depth) {
170 if (!verify_return_error)
175 verify_error = X509_V_ERR_CERT_CHAIN_TOO_LONG;
179 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
180 BIO_puts(bio_err, "issuer= ");
181 X509_NAME_print_ex(bio_err, X509_get_issuer_name(err_cert),
183 BIO_puts(bio_err, "\n");
185 case X509_V_ERR_CERT_NOT_YET_VALID:
186 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
187 BIO_printf(bio_err, "notBefore=");
188 ASN1_TIME_print(bio_err, X509_get_notBefore(err_cert));
189 BIO_printf(bio_err, "\n");
191 case X509_V_ERR_CERT_HAS_EXPIRED:
192 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
193 BIO_printf(bio_err, "notAfter=");
194 ASN1_TIME_print(bio_err, X509_get_notAfter(err_cert));
195 BIO_printf(bio_err, "\n");
197 case X509_V_ERR_NO_EXPLICIT_POLICY:
202 if (err == X509_V_OK && ok == 2 && !verify_quiet)
204 if (ok && !verify_quiet)
205 BIO_printf(bio_err, "verify return:%d\n", ok);
209 int set_cert_stuff(SSL_CTX *ctx, char *cert_file, char *key_file)
211 if (cert_file != NULL) {
212 if (SSL_CTX_use_certificate_file(ctx, cert_file,
213 SSL_FILETYPE_PEM) <= 0) {
214 BIO_printf(bio_err, "unable to get certificate from '%s'\n",
216 ERR_print_errors(bio_err);
219 if (key_file == NULL)
220 key_file = cert_file;
221 if (SSL_CTX_use_PrivateKey_file(ctx, key_file, SSL_FILETYPE_PEM) <= 0) {
222 BIO_printf(bio_err, "unable to get private key from '%s'\n",
224 ERR_print_errors(bio_err);
229 * If we are using DSA, we can copy the parameters from the private
234 * Now we know that a key and cert have been set against the SSL
237 if (!SSL_CTX_check_private_key(ctx)) {
239 "Private key does not match the certificate public key\n");
246 int set_cert_key_stuff(SSL_CTX *ctx, X509 *cert, EVP_PKEY *key,
247 STACK_OF(X509) *chain, int build_chain)
249 int chflags = chain ? SSL_BUILD_CHAIN_FLAG_CHECK : 0;
252 if (SSL_CTX_use_certificate(ctx, cert) <= 0) {
253 BIO_printf(bio_err, "error setting certificate\n");
254 ERR_print_errors(bio_err);
258 if (SSL_CTX_use_PrivateKey(ctx, key) <= 0) {
259 BIO_printf(bio_err, "error setting private key\n");
260 ERR_print_errors(bio_err);
265 * Now we know that a key and cert have been set against the SSL context
267 if (!SSL_CTX_check_private_key(ctx)) {
269 "Private key does not match the certificate public key\n");
272 if (chain && !SSL_CTX_set1_chain(ctx, chain)) {
273 BIO_printf(bio_err, "error setting certificate chain\n");
274 ERR_print_errors(bio_err);
277 if (build_chain && !SSL_CTX_build_cert_chain(ctx, chflags)) {
278 BIO_printf(bio_err, "error building certificate chain\n");
279 ERR_print_errors(bio_err);
285 static STRINT_PAIR cert_type_list[] = {
286 {"RSA sign", TLS_CT_RSA_SIGN},
287 {"DSA sign", TLS_CT_DSS_SIGN},
288 {"RSA fixed DH", TLS_CT_RSA_FIXED_DH},
289 {"DSS fixed DH", TLS_CT_DSS_FIXED_DH},
290 {"ECDSA sign", TLS_CT_ECDSA_SIGN},
291 {"RSA fixed ECDH", TLS_CT_RSA_FIXED_ECDH},
292 {"ECDSA fixed ECDH", TLS_CT_ECDSA_FIXED_ECDH},
293 {"GOST01 Sign", TLS_CT_GOST01_SIGN},
297 static void ssl_print_client_cert_types(BIO *bio, SSL *s)
299 const unsigned char *p;
301 int cert_type_num = SSL_get0_certificate_types(s, &p);
304 BIO_puts(bio, "Client Certificate Types: ");
305 for (i = 0; i < cert_type_num; i++) {
306 unsigned char cert_type = p[i];
307 const char *cname = lookup((int)cert_type, cert_type_list, NULL);
312 BIO_puts(bio, cname);
314 BIO_printf(bio, "UNKNOWN (%d),", cert_type);
319 static int do_print_sigalgs(BIO *out, SSL *s, int shared)
322 client = SSL_is_server(s) ? 0 : 1;
324 nsig = SSL_get_shared_sigalgs(s, -1, NULL, NULL, NULL, NULL, NULL);
326 nsig = SSL_get_sigalgs(s, -1, NULL, NULL, NULL, NULL, NULL);
331 BIO_puts(out, "Shared ");
334 BIO_puts(out, "Requested ");
335 BIO_puts(out, "Signature Algorithms: ");
336 for (i = 0; i < nsig; i++) {
337 int hash_nid, sign_nid;
338 unsigned char rhash, rsign;
339 const char *sstr = NULL;
341 SSL_get_shared_sigalgs(s, i, &sign_nid, &hash_nid, NULL,
344 SSL_get_sigalgs(s, i, &sign_nid, &hash_nid, NULL, &rsign, &rhash);
347 if (sign_nid == EVP_PKEY_RSA)
349 else if (sign_nid == EVP_PKEY_DSA)
351 else if (sign_nid == EVP_PKEY_EC)
354 BIO_printf(out, "%s+", sstr);
356 BIO_printf(out, "0x%02X+", (int)rsign);
357 if (hash_nid != NID_undef)
358 BIO_printf(out, "%s", OBJ_nid2sn(hash_nid));
360 BIO_printf(out, "0x%02X", (int)rhash);
366 int ssl_print_sigalgs(BIO *out, SSL *s)
369 if (!SSL_is_server(s))
370 ssl_print_client_cert_types(out, s);
371 do_print_sigalgs(out, s, 0);
372 do_print_sigalgs(out, s, 1);
373 if (SSL_get_peer_signature_nid(s, &mdnid))
374 BIO_printf(out, "Peer signing digest: %s\n", OBJ_nid2sn(mdnid));
378 #ifndef OPENSSL_NO_EC
379 int ssl_print_point_formats(BIO *out, SSL *s)
382 const char *pformats;
383 nformats = SSL_get0_ec_point_formats(s, &pformats);
386 BIO_puts(out, "Supported Elliptic Curve Point Formats: ");
387 for (i = 0; i < nformats; i++, pformats++) {
391 case TLSEXT_ECPOINTFORMAT_uncompressed:
392 BIO_puts(out, "uncompressed");
395 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime:
396 BIO_puts(out, "ansiX962_compressed_prime");
399 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2:
400 BIO_puts(out, "ansiX962_compressed_char2");
404 BIO_printf(out, "unknown(%d)", (int)*pformats);
410 BIO_puts(out, "NONE");
415 int ssl_print_curves(BIO *out, SSL *s, int noshared)
417 int i, ncurves, *curves, nid;
420 ncurves = SSL_get1_curves(s, NULL);
423 curves = app_malloc(ncurves * sizeof(int), "curves to print");
424 SSL_get1_curves(s, curves);
426 BIO_puts(out, "Supported Elliptic Curves: ");
427 for (i = 0; i < ncurves; i++) {
431 /* If unrecognised print out hex version */
432 if (nid & TLSEXT_nid_unknown)
433 BIO_printf(out, "0x%04X", nid & 0xFFFF);
435 /* Use NIST name for curve if it exists */
436 cname = EC_curve_nid2nist(nid);
438 cname = OBJ_nid2sn(nid);
439 BIO_printf(out, "%s", cname);
443 BIO_puts(out, "NONE");
444 OPENSSL_free(curves);
449 BIO_puts(out, "\nShared Elliptic curves: ");
450 ncurves = SSL_get_shared_curve(s, -1);
451 for (i = 0; i < ncurves; i++) {
454 nid = SSL_get_shared_curve(s, i);
455 cname = EC_curve_nid2nist(nid);
457 cname = OBJ_nid2sn(nid);
458 BIO_printf(out, "%s", cname);
461 BIO_puts(out, "NONE");
466 int ssl_print_tmp_key(BIO *out, SSL *s)
469 if (!SSL_get_server_tmp_key(s, &key))
471 BIO_puts(out, "Server Temp Key: ");
472 switch (EVP_PKEY_id(key)) {
474 BIO_printf(out, "RSA, %d bits\n", EVP_PKEY_bits(key));
478 BIO_printf(out, "DH, %d bits\n", EVP_PKEY_bits(key));
480 #ifndef OPENSSL_NO_EC
483 EC_KEY *ec = EVP_PKEY_get1_EC_KEY(key);
486 nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
488 cname = EC_curve_nid2nist(nid);
490 cname = OBJ_nid2sn(nid);
491 BIO_printf(out, "ECDH, %s, %d bits\n", cname, EVP_PKEY_bits(key));
499 long bio_dump_callback(BIO *bio, int cmd, const char *argp,
500 int argi, long argl, long ret)
504 out = (BIO *)BIO_get_callback_arg(bio);
508 if (cmd == (BIO_CB_READ | BIO_CB_RETURN)) {
509 BIO_printf(out, "read from %p [%p] (%lu bytes => %ld (0x%lX))\n",
510 (void *)bio, argp, (unsigned long)argi, ret, ret);
511 BIO_dump(out, argp, (int)ret);
513 } else if (cmd == (BIO_CB_WRITE | BIO_CB_RETURN)) {
514 BIO_printf(out, "write to %p [%p] (%lu bytes => %ld (0x%lX))\n",
515 (void *)bio, argp, (unsigned long)argi, ret, ret);
516 BIO_dump(out, argp, (int)ret);
521 void apps_ssl_info_callback(const SSL *s, int where, int ret)
526 w = where & ~SSL_ST_MASK;
528 if (w & SSL_ST_CONNECT)
530 else if (w & SSL_ST_ACCEPT)
535 if (where & SSL_CB_LOOP) {
536 BIO_printf(bio_err, "%s:%s\n", str, SSL_state_string_long(s));
537 } else if (where & SSL_CB_ALERT) {
538 str = (where & SSL_CB_READ) ? "read" : "write";
539 BIO_printf(bio_err, "SSL3 alert %s:%s:%s\n",
541 SSL_alert_type_string_long(ret),
542 SSL_alert_desc_string_long(ret));
543 } else if (where & SSL_CB_EXIT) {
545 BIO_printf(bio_err, "%s:failed in %s\n",
546 str, SSL_state_string_long(s));
548 BIO_printf(bio_err, "%s:error in %s\n",
549 str, SSL_state_string_long(s));
554 static STRINT_PAIR ssl_versions[] = {
555 {"SSL 3.0", SSL3_VERSION},
556 {"TLS 1.0", TLS1_VERSION},
557 {"TLS 1.1", TLS1_1_VERSION},
558 {"TLS 1.2", TLS1_2_VERSION},
559 {"DTLS 1.0", DTLS1_VERSION},
560 {"DTLS 1.0 (bad)", DTLS1_BAD_VER},
563 static STRINT_PAIR alert_types[] = {
564 {" close_notify", 0},
565 {" unexpected_message", 10},
566 {" bad_record_mac", 20},
567 {" decryption_failed", 21},
568 {" record_overflow", 22},
569 {" decompression_failure", 30},
570 {" handshake_failure", 40},
571 {" bad_certificate", 42},
572 {" unsupported_certificate", 43},
573 {" certificate_revoked", 44},
574 {" certificate_expired", 45},
575 {" certificate_unknown", 46},
576 {" illegal_parameter", 47},
578 {" access_denied", 49},
579 {" decode_error", 50},
580 {" decrypt_error", 51},
581 {" export_restriction", 60},
582 {" protocol_version", 70},
583 {" insufficient_security", 71},
584 {" internal_error", 80},
585 {" user_canceled", 90},
586 {" no_renegotiation", 100},
587 {" unsupported_extension", 110},
588 {" certificate_unobtainable", 111},
589 {" unrecognized_name", 112},
590 {" bad_certificate_status_response", 113},
591 {" bad_certificate_hash_value", 114},
592 {" unknown_psk_identity", 115},
596 static STRINT_PAIR handshakes[] = {
597 {", HelloRequest", 0},
598 {", ClientHello", 1},
599 {", ServerHello", 2},
600 {", HelloVerifyRequest", 3},
601 {", NewSessionTicket", 4},
602 {", Certificate", 11},
603 {", ServerKeyExchange", 12},
604 {", CertificateRequest", 13},
605 {", ServerHelloDone", 14},
606 {", CertificateVerify", 15},
607 {", ClientKeyExchange", 16},
609 {", CertificateUrl", 21},
610 {", CertificateStatus", 22},
611 {", SupplementalData", 23},
615 void msg_cb(int write_p, int version, int content_type, const void *buf,
616 size_t len, SSL *ssl, void *arg)
619 const char *str_write_p = write_p ? ">>>" : "<<<";
620 const char *str_version = lookup(version, ssl_versions, "???");
621 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
622 const unsigned char* bp = buf;
624 if (version == SSL3_VERSION ||
625 version == TLS1_VERSION ||
626 version == TLS1_1_VERSION ||
627 version == TLS1_2_VERSION ||
628 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
629 switch (content_type) {
631 str_content_type = "ChangeCipherSpec";
634 str_content_type = "Alert";
635 str_details1 = ", ???";
639 str_details1 = ", warning";
642 str_details1 = ", fatal";
645 str_details2 = lookup((int)bp[1], alert_types, " ???");
649 str_content_type = "Handshake";
650 str_details1 = "???";
652 str_details1 = lookup((int)bp[0], handshakes, "???");
655 str_content_type = "ApplicationData";
657 #ifndef OPENSSL_NO_HEARTBEATS
659 str_details1 = ", Heartbeat";
664 str_details1 = ", HeartbeatRequest";
667 str_details1 = ", HeartbeatResponse";
676 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
677 str_content_type, (unsigned long)len, str_details1,
683 BIO_printf(bio, " ");
685 for (i = 0; i < num; i++) {
686 if (i % 16 == 0 && i > 0)
687 BIO_printf(bio, "\n ");
688 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
691 BIO_printf(bio, " ...");
692 BIO_printf(bio, "\n");
694 (void)BIO_flush(bio);
697 static STRINT_PAIR tlsext_types[] = {
698 {"server name", TLSEXT_TYPE_server_name},
699 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
700 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
701 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
702 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
703 {"status request", TLSEXT_TYPE_status_request},
704 {"user mapping", TLSEXT_TYPE_user_mapping},
705 {"client authz", TLSEXT_TYPE_client_authz},
706 {"server authz", TLSEXT_TYPE_server_authz},
707 {"cert type", TLSEXT_TYPE_cert_type},
708 {"elliptic curves", TLSEXT_TYPE_elliptic_curves},
709 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
710 {"SRP", TLSEXT_TYPE_srp},
711 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
712 {"use SRTP", TLSEXT_TYPE_use_srtp},
713 {"heartbeat", TLSEXT_TYPE_heartbeat},
714 {"session ticket", TLSEXT_TYPE_session_ticket},
715 {"renegotiation info", TLSEXT_TYPE_renegotiate},
716 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
717 {"TLS padding", TLSEXT_TYPE_padding},
718 #ifdef TLSEXT_TYPE_next_proto_neg
719 {"next protocol", TLSEXT_TYPE_next_proto_neg},
721 #ifdef TLSEXT_TYPE_encrypt_then_mac
722 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
724 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
725 {"application layer protocol negotiation",
726 TLSEXT_TYPE_application_layer_protocol_negotiation},
728 #ifdef TLSEXT_TYPE_extended_master_secret
729 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
734 void tlsext_cb(SSL *s, int client_server, int type,
735 const unsigned char *data, int len, void *arg)
738 const char *extname = lookup(type, tlsext_types, "unknown");
740 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
741 client_server ? "server" : "client", extname, type, len);
742 BIO_dump(bio, (const char *)data, len);
743 (void)BIO_flush(bio);
746 #ifndef OPENSSL_NO_SOCK
747 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
748 unsigned int *cookie_len)
750 unsigned char *buffer;
753 BIO_ADDR *peer = NULL;
755 /* Initialize a random secret */
756 if (!cookie_initialized) {
757 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
758 BIO_printf(bio_err, "error setting random cookie secret\n");
761 cookie_initialized = 1;
764 peer = BIO_ADDR_new();
766 BIO_printf(bio_err, "memory full\n");
770 /* Read peer information */
771 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
773 /* Create buffer with peer's address and port */
774 BIO_ADDR_rawaddress(peer, NULL, &length);
775 OPENSSL_assert(length != 0);
776 port = BIO_ADDR_rawport(peer);
777 length += sizeof(port);
778 buffer = app_malloc(length, "cookie generate buffer");
780 memcpy(buffer, &port, sizeof(port));
781 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
783 /* Calculate HMAC of buffer using the secret */
784 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
785 buffer, length, cookie, cookie_len);
787 OPENSSL_free(buffer);
793 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
794 unsigned int cookie_len)
796 unsigned char result[EVP_MAX_MD_SIZE];
797 unsigned int resultlength;
799 /* Note: we check cookie_initialized because if it's not,
800 * it cannot be valid */
801 if (cookie_initialized
802 && generate_cookie_callback(ssl, result, &resultlength)
803 && cookie_len == resultlength
804 && memcmp(result, cookie, resultlength) == 0)
812 * Example of extended certificate handling. Where the standard support of
813 * one certificate per algorithm is not sufficient an application can decide
814 * which certificate(s) to use at runtime based on whatever criteria it deems
818 /* Linked list of certificates, keys and chains */
819 struct ssl_excert_st {
821 const char *certfile;
824 const char *chainfile;
827 STACK_OF(X509) *chain;
829 struct ssl_excert_st *next, *prev;
832 static STRINT_PAIR chain_flags[] = {
833 {"Overall Validity", CERT_PKEY_VALID},
834 {"Sign with EE key", CERT_PKEY_SIGN},
835 {"EE signature", CERT_PKEY_EE_SIGNATURE},
836 {"CA signature", CERT_PKEY_CA_SIGNATURE},
837 {"EE key parameters", CERT_PKEY_EE_PARAM},
838 {"CA key parameters", CERT_PKEY_CA_PARAM},
839 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
840 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
841 {"Certificate Type", CERT_PKEY_CERT_TYPE},
845 static void print_chain_flags(SSL *s, int flags)
849 for (pp = chain_flags; pp->name; ++pp)
850 BIO_printf(bio_err, "\t%s: %s\n",
852 (flags & pp->retval) ? "OK" : "NOT OK");
853 BIO_printf(bio_err, "\tSuite B: ");
854 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
855 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
857 BIO_printf(bio_err, "not tested\n");
861 * Very basic selection callback: just use any certificate chain reported as
862 * valid. More sophisticated could prioritise according to local policy.
864 static int set_cert_cb(SSL *ssl, void *arg)
867 SSL_EXCERT *exc = arg;
868 #ifdef CERT_CB_TEST_RETRY
869 static int retry_cnt;
873 "Certificate callback retry test: count %d\n",
878 SSL_certs_clear(ssl);
884 * Go to end of list and traverse backwards since we prepend newer
885 * entries this retains the original order.
894 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
895 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
896 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
898 BIO_puts(bio_err, "\n");
899 print_chain_flags(ssl, rv);
900 if (rv & CERT_PKEY_VALID) {
901 if (!SSL_use_certificate(ssl, exc->cert)
902 || !SSL_use_PrivateKey(ssl, exc->key)) {
906 * NB: we wouldn't normally do this as it is not efficient
907 * building chains on each connection better to cache the chain
910 if (exc->build_chain) {
911 if (!SSL_build_cert_chain(ssl, 0))
913 } else if (exc->chain)
914 SSL_set1_chain(ssl, exc->chain);
921 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
923 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
926 static int ssl_excert_prepend(SSL_EXCERT **pexc)
928 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
930 memset(exc, 0, sizeof(*exc));
936 exc->certform = exc->next->certform;
937 exc->keyform = exc->next->keyform;
938 exc->next->prev = exc;
940 exc->certform = FORMAT_PEM;
941 exc->keyform = FORMAT_PEM;
947 void ssl_excert_free(SSL_EXCERT *exc)
954 X509_free(exc->cert);
955 EVP_PKEY_free(exc->key);
956 sk_X509_pop_free(exc->chain, X509_free);
963 int load_excert(SSL_EXCERT **pexc)
965 SSL_EXCERT *exc = *pexc;
968 /* If nothing in list, free and set to NULL */
969 if (!exc->certfile && !exc->next) {
970 ssl_excert_free(exc);
974 for (; exc; exc = exc->next) {
975 if (!exc->certfile) {
976 BIO_printf(bio_err, "Missing filename\n");
979 exc->cert = load_cert(exc->certfile, exc->certform,
980 "Server Certificate");
984 exc->key = load_key(exc->keyfile, exc->keyform,
985 0, NULL, NULL, "Server Key");
987 exc->key = load_key(exc->certfile, exc->certform,
988 0, NULL, NULL, "Server Key");
992 if (exc->chainfile) {
993 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
1001 enum range { OPT_X_ENUM };
1003 int args_excert(int opt, SSL_EXCERT **pexc)
1005 SSL_EXCERT *exc = *pexc;
1007 assert(opt > OPT_X__FIRST);
1008 assert(opt < OPT_X__LAST);
1011 if (!ssl_excert_prepend(&exc)) {
1012 BIO_printf(bio_err, " %s: Error initialising xcert\n",
1019 switch ((enum range)opt) {
1024 if (exc->certfile && !ssl_excert_prepend(&exc)) {
1025 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
1028 exc->certfile = opt_arg();
1032 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
1035 exc->keyfile = opt_arg();
1038 if (exc->chainfile) {
1039 BIO_printf(bio_err, "%s: Chain already specified\n",
1043 exc->chainfile = opt_arg();
1045 case OPT_X_CHAIN_BUILD:
1046 exc->build_chain = 1;
1048 case OPT_X_CERTFORM:
1049 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
1053 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
1060 ERR_print_errors(bio_err);
1061 ssl_excert_free(exc);
1066 static void print_raw_cipherlist(SSL *s)
1068 const unsigned char *rlist;
1069 static const unsigned char scsv_id[] = { 0, 0xFF };
1070 size_t i, rlistlen, num;
1071 if (!SSL_is_server(s))
1073 num = SSL_get0_raw_cipherlist(s, NULL);
1074 OPENSSL_assert(num == 2);
1075 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1076 BIO_puts(bio_err, "Client cipher list: ");
1077 for (i = 0; i < rlistlen; i += num, rlist += num) {
1078 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1080 BIO_puts(bio_err, ":");
1082 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1083 else if (!memcmp(rlist, scsv_id, num))
1084 BIO_puts(bio_err, "SCSV");
1087 BIO_puts(bio_err, "0x");
1088 for (j = 0; j < num; j++)
1089 BIO_printf(bio_err, "%02X", rlist[j]);
1092 BIO_puts(bio_err, "\n");
1096 * Hex encoder for TLSA RRdata, not ':' delimited.
1098 static char *hexencode(const unsigned char *data, size_t len)
1100 static const char *hex = "0123456789abcdef";
1103 size_t outlen = 2 * len + 1;
1104 int ilen = (int) outlen;
1106 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1107 BIO_printf(bio_err, "%s: %" PRIu64 "-byte buffer too large to hexencode\n",
1108 opt_getprog(), (uint64_t)len);
1111 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1114 *cp++ = hex[(*data >> 4) & 0x0f];
1115 *cp++ = hex[*data++ & 0x0f];
1121 void print_verify_detail(SSL *s, BIO *bio)
1125 long verify_err = SSL_get_verify_result(s);
1127 if (verify_err == X509_V_OK) {
1128 const char *peername = SSL_get0_peername(s);
1130 BIO_printf(bio, "Verification: OK\n");
1131 if (peername != NULL)
1132 BIO_printf(bio, "Verified peername: %s\n", peername);
1134 const char *reason = X509_verify_cert_error_string(verify_err);
1136 BIO_printf(bio, "Verification error: %s\n", reason);
1139 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1140 uint8_t usage, selector, mtype;
1141 const unsigned char *data = NULL;
1145 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1148 * The TLSA data field can be quite long when it is a certificate,
1149 * public key or even a SHA2-512 digest. Because the initial octets of
1150 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1151 * and lengths, we show the last 12 bytes of the data instead, as these
1152 * are more likely to distinguish distinct TLSA records.
1154 #define TLSA_TAIL_SIZE 12
1155 if (dlen > TLSA_TAIL_SIZE)
1156 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1158 hexdata = hexencode(data, dlen);
1159 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1160 usage, selector, mtype,
1161 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1162 (mspki != NULL) ? "signed the certificate" :
1163 mdpth ? "matched TA certificate" : "matched EE certificate",
1165 OPENSSL_free(hexdata);
1169 void print_ssl_summary(SSL *s)
1171 const SSL_CIPHER *c;
1173 /* const char *pnam = SSL_is_server(s) ? "client" : "server"; */
1175 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1176 print_raw_cipherlist(s);
1177 c = SSL_get_current_cipher(s);
1178 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1179 do_print_sigalgs(bio_err, s, 0);
1180 peer = SSL_get_peer_certificate(s);
1184 BIO_puts(bio_err, "Peer certificate: ");
1185 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1186 0, XN_FLAG_ONELINE);
1187 BIO_puts(bio_err, "\n");
1188 if (SSL_get_peer_signature_nid(s, &nid))
1189 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1190 print_verify_detail(s, bio_err);
1192 BIO_puts(bio_err, "No peer certificate\n");
1194 #ifndef OPENSSL_NO_EC
1195 ssl_print_point_formats(bio_err, s);
1196 if (SSL_is_server(s))
1197 ssl_print_curves(bio_err, s, 1);
1199 ssl_print_tmp_key(bio_err, s);
1201 if (!SSL_is_server(s))
1202 ssl_print_tmp_key(bio_err, s);
1206 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1211 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1212 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1213 const char *flag = sk_OPENSSL_STRING_value(str, i);
1214 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1215 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1217 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1220 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1221 ERR_print_errors(bio_err);
1225 if (!SSL_CONF_CTX_finish(cctx)) {
1226 BIO_puts(bio_err, "Error finishing context\n");
1227 ERR_print_errors(bio_err);
1233 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1237 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1238 crl = sk_X509_CRL_value(crls, i);
1239 X509_STORE_add_crl(st, crl);
1244 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1247 st = SSL_CTX_get_cert_store(ctx);
1248 add_crls_store(st, crls);
1250 store_setup_crl_download(st);
1254 int ssl_load_stores(SSL_CTX *ctx,
1255 const char *vfyCApath, const char *vfyCAfile,
1256 const char *chCApath, const char *chCAfile,
1257 STACK_OF(X509_CRL) *crls, int crl_download)
1259 X509_STORE *vfy = NULL, *ch = NULL;
1261 if (vfyCApath != NULL || vfyCAfile != NULL) {
1262 vfy = X509_STORE_new();
1265 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1267 add_crls_store(vfy, crls);
1268 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1270 store_setup_crl_download(vfy);
1272 if (chCApath != NULL || chCAfile != NULL) {
1273 ch = X509_STORE_new();
1276 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1278 SSL_CTX_set1_chain_cert_store(ctx, ch);
1282 X509_STORE_free(vfy);
1283 X509_STORE_free(ch);
1287 /* Verbose print out of security callback */
1292 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1293 void *other, void *ex);
1294 } security_debug_ex;
1296 static STRINT_PAIR callback_types[] = {
1297 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1298 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1299 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1300 #ifndef OPENSSL_NO_DH
1301 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1303 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1304 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1305 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1306 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1307 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1308 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1309 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1310 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1311 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1312 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1313 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1314 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1315 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1316 {"SSL compression", SSL_SECOP_COMPRESSION},
1317 {"Session ticket", SSL_SECOP_TICKET},
1321 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1322 int op, int bits, int nid,
1323 void *other, void *ex)
1325 security_debug_ex *sdb = ex;
1326 int rv, show_bits = 1, cert_md = 0;
1328 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1329 if (rv == 1 && sdb->verbose < 2)
1331 BIO_puts(sdb->out, "Security callback: ");
1333 nm = lookup(op, callback_types, NULL);
1335 case SSL_SECOP_TICKET:
1336 case SSL_SECOP_COMPRESSION:
1340 case SSL_SECOP_VERSION:
1341 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1345 case SSL_SECOP_CA_MD:
1346 case SSL_SECOP_PEER_CA_MD:
1351 BIO_printf(sdb->out, "%s=", nm);
1353 switch (op & SSL_SECOP_OTHER_TYPE) {
1355 case SSL_SECOP_OTHER_CIPHER:
1356 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1359 #ifndef OPENSSL_NO_EC
1360 case SSL_SECOP_OTHER_CURVE:
1363 cname = EC_curve_nid2nist(nid);
1365 cname = OBJ_nid2sn(nid);
1366 BIO_puts(sdb->out, cname);
1370 #ifndef OPENSSL_NO_DH
1371 case SSL_SECOP_OTHER_DH:
1374 BIO_printf(sdb->out, "%d", BN_num_bits(dh->p));
1378 case SSL_SECOP_OTHER_CERT:
1381 int sig_nid = X509_get_signature_nid(other);
1382 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1384 EVP_PKEY *pkey = X509_get0_pubkey(other);
1385 const char *algname = "";
1386 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1387 &algname, EVP_PKEY_get0_asn1(pkey));
1388 BIO_printf(sdb->out, "%s, bits=%d",
1389 algname, EVP_PKEY_bits(pkey));
1393 case SSL_SECOP_OTHER_SIGALG:
1395 const unsigned char *salg = other;
1396 const char *sname = NULL;
1398 case TLSEXT_signature_anonymous:
1399 sname = "anonymous";
1401 case TLSEXT_signature_rsa:
1404 case TLSEXT_signature_dsa:
1407 case TLSEXT_signature_ecdsa:
1412 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1414 BIO_printf(sdb->out, ", algorithm=%s", sname);
1416 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1423 BIO_printf(sdb->out, ", security bits=%d", bits);
1424 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1428 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1430 static security_debug_ex sdb;
1433 sdb.verbose = verbose;
1434 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1435 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1436 SSL_CTX_set0_security_ex_data(ctx, &sdb);