2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
10 /* callback functions used by s_client, s_server, and s_time */
13 #include <string.h> /* for memcpy() and strcmp() */
15 #include <openssl/err.h>
16 #include <openssl/rand.h>
17 #include <openssl/x509.h>
18 #include <openssl/ssl.h>
19 #include <openssl/bn.h>
21 # include <openssl/dh.h>
25 #define COOKIE_SECRET_LENGTH 16
27 VERIFY_CB_ARGS verify_args = { 0, 0, X509_V_OK, 0 };
29 #ifndef OPENSSL_NO_SOCK
30 static unsigned char cookie_secret[COOKIE_SECRET_LENGTH];
31 static int cookie_initialized = 0;
33 static BIO *bio_keylog = NULL;
35 static const char *lookup(int val, const STRINT_PAIR* list, const char* def)
37 for ( ; list->name; ++list)
38 if (list->retval == val)
43 int verify_callback(int ok, X509_STORE_CTX *ctx)
48 err_cert = X509_STORE_CTX_get_current_cert(ctx);
49 err = X509_STORE_CTX_get_error(ctx);
50 depth = X509_STORE_CTX_get_error_depth(ctx);
52 if (!verify_args.quiet || !ok) {
53 BIO_printf(bio_err, "depth=%d ", depth);
54 if (err_cert != NULL) {
55 X509_NAME_print_ex(bio_err,
56 X509_get_subject_name(err_cert),
58 BIO_puts(bio_err, "\n");
60 BIO_puts(bio_err, "<no cert>\n");
64 BIO_printf(bio_err, "verify error:num=%d:%s\n", err,
65 X509_verify_cert_error_string(err));
66 if (verify_args.depth >= depth) {
67 if (!verify_args.return_error)
69 verify_args.error = err;
72 verify_args.error = X509_V_ERR_CERT_CHAIN_TOO_LONG;
76 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
77 BIO_puts(bio_err, "issuer= ");
78 X509_NAME_print_ex(bio_err, X509_get_issuer_name(err_cert),
80 BIO_puts(bio_err, "\n");
82 case X509_V_ERR_CERT_NOT_YET_VALID:
83 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
84 BIO_printf(bio_err, "notBefore=");
85 ASN1_TIME_print(bio_err, X509_get0_notBefore(err_cert));
86 BIO_printf(bio_err, "\n");
88 case X509_V_ERR_CERT_HAS_EXPIRED:
89 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
90 BIO_printf(bio_err, "notAfter=");
91 ASN1_TIME_print(bio_err, X509_get0_notAfter(err_cert));
92 BIO_printf(bio_err, "\n");
94 case X509_V_ERR_NO_EXPLICIT_POLICY:
95 if (!verify_args.quiet)
99 if (err == X509_V_OK && ok == 2 && !verify_args.quiet)
101 if (ok && !verify_args.quiet)
102 BIO_printf(bio_err, "verify return:%d\n", ok);
106 int set_cert_stuff(SSL_CTX *ctx, char *cert_file, char *key_file)
108 if (cert_file != NULL) {
109 if (SSL_CTX_use_certificate_file(ctx, cert_file,
110 SSL_FILETYPE_PEM) <= 0) {
111 BIO_printf(bio_err, "unable to get certificate from '%s'\n",
113 ERR_print_errors(bio_err);
116 if (key_file == NULL)
117 key_file = cert_file;
118 if (SSL_CTX_use_PrivateKey_file(ctx, key_file, SSL_FILETYPE_PEM) <= 0) {
119 BIO_printf(bio_err, "unable to get private key from '%s'\n",
121 ERR_print_errors(bio_err);
126 * If we are using DSA, we can copy the parameters from the private
131 * Now we know that a key and cert have been set against the SSL
134 if (!SSL_CTX_check_private_key(ctx)) {
136 "Private key does not match the certificate public key\n");
143 int set_cert_key_stuff(SSL_CTX *ctx, X509 *cert, EVP_PKEY *key,
144 STACK_OF(X509) *chain, int build_chain)
146 int chflags = chain ? SSL_BUILD_CHAIN_FLAG_CHECK : 0;
149 if (SSL_CTX_use_certificate(ctx, cert) <= 0) {
150 BIO_printf(bio_err, "error setting certificate\n");
151 ERR_print_errors(bio_err);
155 if (SSL_CTX_use_PrivateKey(ctx, key) <= 0) {
156 BIO_printf(bio_err, "error setting private key\n");
157 ERR_print_errors(bio_err);
162 * Now we know that a key and cert have been set against the SSL context
164 if (!SSL_CTX_check_private_key(ctx)) {
166 "Private key does not match the certificate public key\n");
169 if (chain && !SSL_CTX_set1_chain(ctx, chain)) {
170 BIO_printf(bio_err, "error setting certificate chain\n");
171 ERR_print_errors(bio_err);
174 if (build_chain && !SSL_CTX_build_cert_chain(ctx, chflags)) {
175 BIO_printf(bio_err, "error building certificate chain\n");
176 ERR_print_errors(bio_err);
182 static STRINT_PAIR cert_type_list[] = {
183 {"RSA sign", TLS_CT_RSA_SIGN},
184 {"DSA sign", TLS_CT_DSS_SIGN},
185 {"RSA fixed DH", TLS_CT_RSA_FIXED_DH},
186 {"DSS fixed DH", TLS_CT_DSS_FIXED_DH},
187 {"ECDSA sign", TLS_CT_ECDSA_SIGN},
188 {"RSA fixed ECDH", TLS_CT_RSA_FIXED_ECDH},
189 {"ECDSA fixed ECDH", TLS_CT_ECDSA_FIXED_ECDH},
190 {"GOST01 Sign", TLS_CT_GOST01_SIGN},
194 static void ssl_print_client_cert_types(BIO *bio, SSL *s)
196 const unsigned char *p;
198 int cert_type_num = SSL_get0_certificate_types(s, &p);
201 BIO_puts(bio, "Client Certificate Types: ");
202 for (i = 0; i < cert_type_num; i++) {
203 unsigned char cert_type = p[i];
204 const char *cname = lookup((int)cert_type, cert_type_list, NULL);
209 BIO_puts(bio, cname);
211 BIO_printf(bio, "UNKNOWN (%d),", cert_type);
216 static const char *get_sigtype(int nid)
222 case EVP_PKEY_RSA_PSS:
239 static int do_print_sigalgs(BIO *out, SSL *s, int shared)
242 client = SSL_is_server(s) ? 0 : 1;
244 nsig = SSL_get_shared_sigalgs(s, 0, NULL, NULL, NULL, NULL, NULL);
246 nsig = SSL_get_sigalgs(s, -1, NULL, NULL, NULL, NULL, NULL);
251 BIO_puts(out, "Shared ");
254 BIO_puts(out, "Requested ");
255 BIO_puts(out, "Signature Algorithms: ");
256 for (i = 0; i < nsig; i++) {
257 int hash_nid, sign_nid;
258 unsigned char rhash, rsign;
259 const char *sstr = NULL;
261 SSL_get_shared_sigalgs(s, i, &sign_nid, &hash_nid, NULL,
264 SSL_get_sigalgs(s, i, &sign_nid, &hash_nid, NULL, &rsign, &rhash);
267 sstr = get_sigtype(sign_nid);
269 BIO_printf(out, "%s", sstr);
271 BIO_printf(out, "0x%02X", (int)rsign);
272 if (hash_nid != NID_undef)
273 BIO_printf(out, "+%s", OBJ_nid2sn(hash_nid));
274 else if (sstr == NULL)
275 BIO_printf(out, "+0x%02X", (int)rhash);
281 int ssl_print_sigalgs(BIO *out, SSL *s)
284 if (!SSL_is_server(s))
285 ssl_print_client_cert_types(out, s);
286 do_print_sigalgs(out, s, 0);
287 do_print_sigalgs(out, s, 1);
288 if (SSL_get_peer_signature_nid(s, &nid) && nid != NID_undef)
289 BIO_printf(out, "Peer signing digest: %s\n", OBJ_nid2sn(nid));
290 if (SSL_get_peer_signature_type_nid(s, &nid))
291 BIO_printf(out, "Peer signature type: %s\n", get_sigtype(nid));
295 #ifndef OPENSSL_NO_EC
296 int ssl_print_point_formats(BIO *out, SSL *s)
299 const char *pformats;
300 nformats = SSL_get0_ec_point_formats(s, &pformats);
303 BIO_puts(out, "Supported Elliptic Curve Point Formats: ");
304 for (i = 0; i < nformats; i++, pformats++) {
308 case TLSEXT_ECPOINTFORMAT_uncompressed:
309 BIO_puts(out, "uncompressed");
312 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime:
313 BIO_puts(out, "ansiX962_compressed_prime");
316 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2:
317 BIO_puts(out, "ansiX962_compressed_char2");
321 BIO_printf(out, "unknown(%d)", (int)*pformats);
330 int ssl_print_groups(BIO *out, SSL *s, int noshared)
332 int i, ngroups, *groups, nid;
335 ngroups = SSL_get1_groups(s, NULL);
338 groups = app_malloc(ngroups * sizeof(int), "groups to print");
339 SSL_get1_groups(s, groups);
341 BIO_puts(out, "Supported Elliptic Groups: ");
342 for (i = 0; i < ngroups; i++) {
346 /* If unrecognised print out hex version */
347 if (nid & TLSEXT_nid_unknown) {
348 BIO_printf(out, "0x%04X", nid & 0xFFFF);
350 /* TODO(TLS1.3): Get group name here */
351 /* Use NIST name for curve if it exists */
352 gname = EC_curve_nid2nist(nid);
354 gname = OBJ_nid2sn(nid);
355 BIO_printf(out, "%s", gname);
358 OPENSSL_free(groups);
363 BIO_puts(out, "\nShared Elliptic groups: ");
364 ngroups = SSL_get_shared_group(s, -1);
365 for (i = 0; i < ngroups; i++) {
368 nid = SSL_get_shared_group(s, i);
369 /* TODO(TLS1.3): Convert for DH groups */
370 gname = EC_curve_nid2nist(nid);
372 gname = OBJ_nid2sn(nid);
373 BIO_printf(out, "%s", gname);
376 BIO_puts(out, "NONE");
382 int ssl_print_tmp_key(BIO *out, SSL *s)
385 if (!SSL_get_server_tmp_key(s, &key))
387 BIO_puts(out, "Server Temp Key: ");
388 switch (EVP_PKEY_id(key)) {
390 BIO_printf(out, "RSA, %d bits\n", EVP_PKEY_bits(key));
394 BIO_printf(out, "DH, %d bits\n", EVP_PKEY_bits(key));
396 #ifndef OPENSSL_NO_EC
399 EC_KEY *ec = EVP_PKEY_get1_EC_KEY(key);
402 nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
404 cname = EC_curve_nid2nist(nid);
406 cname = OBJ_nid2sn(nid);
407 BIO_printf(out, "ECDH, %s, %d bits\n", cname, EVP_PKEY_bits(key));
412 BIO_printf(out, "%s, %d bits\n", OBJ_nid2sn(EVP_PKEY_id(key)),
419 long bio_dump_callback(BIO *bio, int cmd, const char *argp,
420 int argi, long argl, long ret)
424 out = (BIO *)BIO_get_callback_arg(bio);
428 if (cmd == (BIO_CB_READ | BIO_CB_RETURN)) {
429 BIO_printf(out, "read from %p [%p] (%lu bytes => %ld (0x%lX))\n",
430 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
431 BIO_dump(out, argp, (int)ret);
433 } else if (cmd == (BIO_CB_WRITE | BIO_CB_RETURN)) {
434 BIO_printf(out, "write to %p [%p] (%lu bytes => %ld (0x%lX))\n",
435 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
436 BIO_dump(out, argp, (int)ret);
441 void apps_ssl_info_callback(const SSL *s, int where, int ret)
446 w = where & ~SSL_ST_MASK;
448 if (w & SSL_ST_CONNECT)
450 else if (w & SSL_ST_ACCEPT)
455 if (where & SSL_CB_LOOP) {
456 BIO_printf(bio_err, "%s:%s\n", str, SSL_state_string_long(s));
457 } else if (where & SSL_CB_ALERT) {
458 str = (where & SSL_CB_READ) ? "read" : "write";
459 BIO_printf(bio_err, "SSL3 alert %s:%s:%s\n",
461 SSL_alert_type_string_long(ret),
462 SSL_alert_desc_string_long(ret));
463 } else if (where & SSL_CB_EXIT) {
465 BIO_printf(bio_err, "%s:failed in %s\n",
466 str, SSL_state_string_long(s));
468 BIO_printf(bio_err, "%s:error in %s\n",
469 str, SSL_state_string_long(s));
473 static STRINT_PAIR ssl_versions[] = {
474 {"SSL 3.0", SSL3_VERSION},
475 {"TLS 1.0", TLS1_VERSION},
476 {"TLS 1.1", TLS1_1_VERSION},
477 {"TLS 1.2", TLS1_2_VERSION},
478 {"TLS 1.3", TLS1_3_VERSION},
479 {"DTLS 1.0", DTLS1_VERSION},
480 {"DTLS 1.0 (bad)", DTLS1_BAD_VER},
484 static STRINT_PAIR alert_types[] = {
485 {" close_notify", 0},
486 {" end_of_early_data", 1},
487 {" unexpected_message", 10},
488 {" bad_record_mac", 20},
489 {" decryption_failed", 21},
490 {" record_overflow", 22},
491 {" decompression_failure", 30},
492 {" handshake_failure", 40},
493 {" bad_certificate", 42},
494 {" unsupported_certificate", 43},
495 {" certificate_revoked", 44},
496 {" certificate_expired", 45},
497 {" certificate_unknown", 46},
498 {" illegal_parameter", 47},
500 {" access_denied", 49},
501 {" decode_error", 50},
502 {" decrypt_error", 51},
503 {" export_restriction", 60},
504 {" protocol_version", 70},
505 {" insufficient_security", 71},
506 {" internal_error", 80},
507 {" inappropriate_fallback", 86},
508 {" user_canceled", 90},
509 {" no_renegotiation", 100},
510 {" missing_extension", 109},
511 {" unsupported_extension", 110},
512 {" certificate_unobtainable", 111},
513 {" unrecognized_name", 112},
514 {" bad_certificate_status_response", 113},
515 {" bad_certificate_hash_value", 114},
516 {" unknown_psk_identity", 115},
517 {" certificate_required", 116},
521 static STRINT_PAIR handshakes[] = {
522 {", HelloRequest", SSL3_MT_HELLO_REQUEST},
523 {", ClientHello", SSL3_MT_CLIENT_HELLO},
524 {", ServerHello", SSL3_MT_SERVER_HELLO},
525 {", HelloVerifyRequest", DTLS1_MT_HELLO_VERIFY_REQUEST},
526 {", NewSessionTicket", SSL3_MT_NEWSESSION_TICKET},
527 {", EndOfEarlyData", SSL3_MT_END_OF_EARLY_DATA},
528 {", EncryptedExtensions", SSL3_MT_ENCRYPTED_EXTENSIONS},
529 {", Certificate", SSL3_MT_CERTIFICATE},
530 {", ServerKeyExchange", SSL3_MT_SERVER_KEY_EXCHANGE},
531 {", CertificateRequest", SSL3_MT_CERTIFICATE_REQUEST},
532 {", ServerHelloDone", SSL3_MT_SERVER_DONE},
533 {", CertificateVerify", SSL3_MT_CERTIFICATE_VERIFY},
534 {", ClientKeyExchange", SSL3_MT_CLIENT_KEY_EXCHANGE},
535 {", Finished", SSL3_MT_FINISHED},
536 {", CertificateUrl", 21},
537 {", CertificateStatus", SSL3_MT_CERTIFICATE_STATUS},
538 {", SupplementalData", 23},
539 {", KeyUpdate", SSL3_MT_KEY_UPDATE},
540 #ifndef OPENSSL_NO_NEXTPROTONEG
541 {", NextProto", SSL3_MT_NEXT_PROTO},
543 {", MessageHash", SSL3_MT_MESSAGE_HASH},
547 void msg_cb(int write_p, int version, int content_type, const void *buf,
548 size_t len, SSL *ssl, void *arg)
551 const char *str_write_p = write_p ? ">>>" : "<<<";
552 const char *str_version = lookup(version, ssl_versions, "???");
553 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
554 const unsigned char* bp = buf;
556 if (version == SSL3_VERSION ||
557 version == TLS1_VERSION ||
558 version == TLS1_1_VERSION ||
559 version == TLS1_2_VERSION ||
560 version == TLS1_3_VERSION ||
561 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
562 switch (content_type) {
564 str_content_type = ", ChangeCipherSpec";
567 str_content_type = ", Alert";
568 str_details1 = ", ???";
572 str_details1 = ", warning";
575 str_details1 = ", fatal";
578 str_details2 = lookup((int)bp[1], alert_types, " ???");
582 str_content_type = ", Handshake";
583 str_details1 = "???";
585 str_details1 = lookup((int)bp[0], handshakes, "???");
588 str_content_type = ", ApplicationData";
590 #ifndef OPENSSL_NO_HEARTBEATS
592 str_details1 = ", Heartbeat";
597 str_details1 = ", HeartbeatRequest";
600 str_details1 = ", HeartbeatResponse";
609 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
610 str_content_type, (unsigned long)len, str_details1,
616 BIO_printf(bio, " ");
618 for (i = 0; i < num; i++) {
619 if (i % 16 == 0 && i > 0)
620 BIO_printf(bio, "\n ");
621 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
624 BIO_printf(bio, " ...");
625 BIO_printf(bio, "\n");
627 (void)BIO_flush(bio);
630 static STRINT_PAIR tlsext_types[] = {
631 {"server name", TLSEXT_TYPE_server_name},
632 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
633 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
634 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
635 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
636 {"status request", TLSEXT_TYPE_status_request},
637 {"user mapping", TLSEXT_TYPE_user_mapping},
638 {"client authz", TLSEXT_TYPE_client_authz},
639 {"server authz", TLSEXT_TYPE_server_authz},
640 {"cert type", TLSEXT_TYPE_cert_type},
641 {"supported_groups", TLSEXT_TYPE_supported_groups},
642 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
643 {"SRP", TLSEXT_TYPE_srp},
644 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
645 {"use SRTP", TLSEXT_TYPE_use_srtp},
646 {"heartbeat", TLSEXT_TYPE_heartbeat},
647 {"session ticket", TLSEXT_TYPE_session_ticket},
648 {"renegotiation info", TLSEXT_TYPE_renegotiate},
649 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
650 {"TLS padding", TLSEXT_TYPE_padding},
651 #ifdef TLSEXT_TYPE_next_proto_neg
652 {"next protocol", TLSEXT_TYPE_next_proto_neg},
654 #ifdef TLSEXT_TYPE_encrypt_then_mac
655 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
657 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
658 {"application layer protocol negotiation",
659 TLSEXT_TYPE_application_layer_protocol_negotiation},
661 #ifdef TLSEXT_TYPE_extended_master_secret
662 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
664 {"key share", TLSEXT_TYPE_key_share},
665 {"supported versions", TLSEXT_TYPE_supported_versions},
666 {"psk", TLSEXT_TYPE_psk},
667 {"psk kex modes", TLSEXT_TYPE_psk_kex_modes},
668 {"certificate authorities", TLSEXT_TYPE_certificate_authorities},
672 void tlsext_cb(SSL *s, int client_server, int type,
673 const unsigned char *data, int len, void *arg)
676 const char *extname = lookup(type, tlsext_types, "unknown");
678 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
679 client_server ? "server" : "client", extname, type, len);
680 BIO_dump(bio, (const char *)data, len);
681 (void)BIO_flush(bio);
684 #ifndef OPENSSL_NO_SOCK
685 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
686 unsigned int *cookie_len)
688 unsigned char *buffer;
691 BIO_ADDR *lpeer = NULL, *peer = NULL;
693 /* Initialize a random secret */
694 if (!cookie_initialized) {
695 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
696 BIO_printf(bio_err, "error setting random cookie secret\n");
699 cookie_initialized = 1;
702 if (SSL_is_dtls(ssl)) {
703 lpeer = peer = BIO_ADDR_new();
705 BIO_printf(bio_err, "memory full\n");
709 /* Read peer information */
710 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
715 /* Create buffer with peer's address and port */
716 if (!BIO_ADDR_rawaddress(peer, NULL, &length)) {
717 BIO_printf(bio_err, "Failed getting peer address\n");
720 OPENSSL_assert(length != 0);
721 port = BIO_ADDR_rawport(peer);
722 length += sizeof(port);
723 buffer = app_malloc(length, "cookie generate buffer");
725 memcpy(buffer, &port, sizeof(port));
726 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
728 /* Calculate HMAC of buffer using the secret */
729 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
730 buffer, length, cookie, cookie_len);
732 OPENSSL_free(buffer);
733 BIO_ADDR_free(lpeer);
738 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
739 unsigned int cookie_len)
741 unsigned char result[EVP_MAX_MD_SIZE];
742 unsigned int resultlength;
744 /* Note: we check cookie_initialized because if it's not,
745 * it cannot be valid */
746 if (cookie_initialized
747 && generate_cookie_callback(ssl, result, &resultlength)
748 && cookie_len == resultlength
749 && memcmp(result, cookie, resultlength) == 0)
757 * Example of extended certificate handling. Where the standard support of
758 * one certificate per algorithm is not sufficient an application can decide
759 * which certificate(s) to use at runtime based on whatever criteria it deems
763 /* Linked list of certificates, keys and chains */
764 struct ssl_excert_st {
766 const char *certfile;
769 const char *chainfile;
772 STACK_OF(X509) *chain;
774 struct ssl_excert_st *next, *prev;
777 static STRINT_PAIR chain_flags[] = {
778 {"Overall Validity", CERT_PKEY_VALID},
779 {"Sign with EE key", CERT_PKEY_SIGN},
780 {"EE signature", CERT_PKEY_EE_SIGNATURE},
781 {"CA signature", CERT_PKEY_CA_SIGNATURE},
782 {"EE key parameters", CERT_PKEY_EE_PARAM},
783 {"CA key parameters", CERT_PKEY_CA_PARAM},
784 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
785 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
786 {"Certificate Type", CERT_PKEY_CERT_TYPE},
790 static void print_chain_flags(SSL *s, int flags)
794 for (pp = chain_flags; pp->name; ++pp)
795 BIO_printf(bio_err, "\t%s: %s\n",
797 (flags & pp->retval) ? "OK" : "NOT OK");
798 BIO_printf(bio_err, "\tSuite B: ");
799 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
800 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
802 BIO_printf(bio_err, "not tested\n");
806 * Very basic selection callback: just use any certificate chain reported as
807 * valid. More sophisticated could prioritise according to local policy.
809 static int set_cert_cb(SSL *ssl, void *arg)
812 SSL_EXCERT *exc = arg;
813 #ifdef CERT_CB_TEST_RETRY
814 static int retry_cnt;
818 "Certificate callback retry test: count %d\n",
823 SSL_certs_clear(ssl);
829 * Go to end of list and traverse backwards since we prepend newer
830 * entries this retains the original order.
832 while (exc->next != NULL)
837 while (exc != NULL) {
839 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
840 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
841 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
843 BIO_puts(bio_err, "\n");
844 print_chain_flags(ssl, rv);
845 if (rv & CERT_PKEY_VALID) {
846 if (!SSL_use_certificate(ssl, exc->cert)
847 || !SSL_use_PrivateKey(ssl, exc->key)) {
851 * NB: we wouldn't normally do this as it is not efficient
852 * building chains on each connection better to cache the chain
855 if (exc->build_chain) {
856 if (!SSL_build_cert_chain(ssl, 0))
858 } else if (exc->chain != NULL) {
859 SSL_set1_chain(ssl, exc->chain);
867 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
869 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
872 static int ssl_excert_prepend(SSL_EXCERT **pexc)
874 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
876 memset(exc, 0, sizeof(*exc));
882 exc->certform = exc->next->certform;
883 exc->keyform = exc->next->keyform;
884 exc->next->prev = exc;
886 exc->certform = FORMAT_PEM;
887 exc->keyform = FORMAT_PEM;
893 void ssl_excert_free(SSL_EXCERT *exc)
900 X509_free(exc->cert);
901 EVP_PKEY_free(exc->key);
902 sk_X509_pop_free(exc->chain, X509_free);
909 int load_excert(SSL_EXCERT **pexc)
911 SSL_EXCERT *exc = *pexc;
914 /* If nothing in list, free and set to NULL */
915 if (exc->certfile == NULL && exc->next == NULL) {
916 ssl_excert_free(exc);
920 for (; exc; exc = exc->next) {
921 if (exc->certfile == NULL) {
922 BIO_printf(bio_err, "Missing filename\n");
925 exc->cert = load_cert(exc->certfile, exc->certform,
926 "Server Certificate");
927 if (exc->cert == NULL)
929 if (exc->keyfile != NULL) {
930 exc->key = load_key(exc->keyfile, exc->keyform,
931 0, NULL, NULL, "Server Key");
933 exc->key = load_key(exc->certfile, exc->certform,
934 0, NULL, NULL, "Server Key");
936 if (exc->key == NULL)
938 if (exc->chainfile != NULL) {
939 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
947 enum range { OPT_X_ENUM };
949 int args_excert(int opt, SSL_EXCERT **pexc)
951 SSL_EXCERT *exc = *pexc;
953 assert(opt > OPT_X__FIRST);
954 assert(opt < OPT_X__LAST);
957 if (!ssl_excert_prepend(&exc)) {
958 BIO_printf(bio_err, " %s: Error initialising xcert\n",
965 switch ((enum range)opt) {
970 if (exc->certfile != NULL && !ssl_excert_prepend(&exc)) {
971 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
975 exc->certfile = opt_arg();
978 if (exc->keyfile != NULL) {
979 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
982 exc->keyfile = opt_arg();
985 if (exc->chainfile != NULL) {
986 BIO_printf(bio_err, "%s: Chain already specified\n",
990 exc->chainfile = opt_arg();
992 case OPT_X_CHAIN_BUILD:
993 exc->build_chain = 1;
996 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
1000 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
1007 ERR_print_errors(bio_err);
1008 ssl_excert_free(exc);
1013 static void print_raw_cipherlist(SSL *s)
1015 const unsigned char *rlist;
1016 static const unsigned char scsv_id[] = { 0, 0xFF };
1017 size_t i, rlistlen, num;
1018 if (!SSL_is_server(s))
1020 num = SSL_get0_raw_cipherlist(s, NULL);
1021 OPENSSL_assert(num == 2);
1022 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1023 BIO_puts(bio_err, "Client cipher list: ");
1024 for (i = 0; i < rlistlen; i += num, rlist += num) {
1025 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1027 BIO_puts(bio_err, ":");
1029 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1030 } else if (memcmp(rlist, scsv_id, num) == 0) {
1031 BIO_puts(bio_err, "SCSV");
1034 BIO_puts(bio_err, "0x");
1035 for (j = 0; j < num; j++)
1036 BIO_printf(bio_err, "%02X", rlist[j]);
1039 BIO_puts(bio_err, "\n");
1043 * Hex encoder for TLSA RRdata, not ':' delimited.
1045 static char *hexencode(const unsigned char *data, size_t len)
1047 static const char *hex = "0123456789abcdef";
1050 size_t outlen = 2 * len + 1;
1051 int ilen = (int) outlen;
1053 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1054 BIO_printf(bio_err, "%s: %zu-byte buffer too large to hexencode\n",
1055 opt_getprog(), len);
1058 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1061 *cp++ = hex[(*data >> 4) & 0x0f];
1062 *cp++ = hex[*data++ & 0x0f];
1068 void print_verify_detail(SSL *s, BIO *bio)
1072 long verify_err = SSL_get_verify_result(s);
1074 if (verify_err == X509_V_OK) {
1075 const char *peername = SSL_get0_peername(s);
1077 BIO_printf(bio, "Verification: OK\n");
1078 if (peername != NULL)
1079 BIO_printf(bio, "Verified peername: %s\n", peername);
1081 const char *reason = X509_verify_cert_error_string(verify_err);
1083 BIO_printf(bio, "Verification error: %s\n", reason);
1086 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1087 uint8_t usage, selector, mtype;
1088 const unsigned char *data = NULL;
1092 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1095 * The TLSA data field can be quite long when it is a certificate,
1096 * public key or even a SHA2-512 digest. Because the initial octets of
1097 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1098 * and lengths, we show the last 12 bytes of the data instead, as these
1099 * are more likely to distinguish distinct TLSA records.
1101 #define TLSA_TAIL_SIZE 12
1102 if (dlen > TLSA_TAIL_SIZE)
1103 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1105 hexdata = hexencode(data, dlen);
1106 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1107 usage, selector, mtype,
1108 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1109 (mspki != NULL) ? "signed the certificate" :
1110 mdpth ? "matched TA certificate" : "matched EE certificate",
1112 OPENSSL_free(hexdata);
1116 void print_ssl_summary(SSL *s)
1118 const SSL_CIPHER *c;
1121 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1122 print_raw_cipherlist(s);
1123 c = SSL_get_current_cipher(s);
1124 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1125 do_print_sigalgs(bio_err, s, 0);
1126 peer = SSL_get_peer_certificate(s);
1130 BIO_puts(bio_err, "Peer certificate: ");
1131 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1133 BIO_puts(bio_err, "\n");
1134 if (SSL_get_peer_signature_nid(s, &nid))
1135 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1136 if (SSL_get_peer_signature_type_nid(s, &nid))
1137 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1138 print_verify_detail(s, bio_err);
1140 BIO_puts(bio_err, "No peer certificate\n");
1143 #ifndef OPENSSL_NO_EC
1144 ssl_print_point_formats(bio_err, s);
1145 if (SSL_is_server(s))
1146 ssl_print_groups(bio_err, s, 1);
1148 ssl_print_tmp_key(bio_err, s);
1150 if (!SSL_is_server(s))
1151 ssl_print_tmp_key(bio_err, s);
1155 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1160 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1161 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1162 const char *flag = sk_OPENSSL_STRING_value(str, i);
1163 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1164 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1166 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1169 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1170 ERR_print_errors(bio_err);
1174 if (!SSL_CONF_CTX_finish(cctx)) {
1175 BIO_puts(bio_err, "Error finishing context\n");
1176 ERR_print_errors(bio_err);
1182 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1186 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1187 crl = sk_X509_CRL_value(crls, i);
1188 X509_STORE_add_crl(st, crl);
1193 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1196 st = SSL_CTX_get_cert_store(ctx);
1197 add_crls_store(st, crls);
1199 store_setup_crl_download(st);
1203 int ssl_load_stores(SSL_CTX *ctx,
1204 const char *vfyCApath, const char *vfyCAfile,
1205 const char *chCApath, const char *chCAfile,
1206 STACK_OF(X509_CRL) *crls, int crl_download)
1208 X509_STORE *vfy = NULL, *ch = NULL;
1210 if (vfyCApath != NULL || vfyCAfile != NULL) {
1211 vfy = X509_STORE_new();
1214 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1216 add_crls_store(vfy, crls);
1217 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1219 store_setup_crl_download(vfy);
1221 if (chCApath != NULL || chCAfile != NULL) {
1222 ch = X509_STORE_new();
1225 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1227 SSL_CTX_set1_chain_cert_store(ctx, ch);
1231 X509_STORE_free(vfy);
1232 X509_STORE_free(ch);
1236 /* Verbose print out of security callback */
1241 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1242 void *other, void *ex);
1243 } security_debug_ex;
1245 static STRINT_PAIR callback_types[] = {
1246 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1247 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1248 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1249 #ifndef OPENSSL_NO_DH
1250 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1252 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1253 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1254 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1255 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1256 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1257 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1258 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1259 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1260 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1261 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1262 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1263 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1264 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1265 {"SSL compression", SSL_SECOP_COMPRESSION},
1266 {"Session ticket", SSL_SECOP_TICKET},
1270 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1271 int op, int bits, int nid,
1272 void *other, void *ex)
1274 security_debug_ex *sdb = ex;
1275 int rv, show_bits = 1, cert_md = 0;
1277 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1278 if (rv == 1 && sdb->verbose < 2)
1280 BIO_puts(sdb->out, "Security callback: ");
1282 nm = lookup(op, callback_types, NULL);
1284 case SSL_SECOP_TICKET:
1285 case SSL_SECOP_COMPRESSION:
1289 case SSL_SECOP_VERSION:
1290 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1294 case SSL_SECOP_CA_MD:
1295 case SSL_SECOP_PEER_CA_MD:
1300 BIO_printf(sdb->out, "%s=", nm);
1302 switch (op & SSL_SECOP_OTHER_TYPE) {
1304 case SSL_SECOP_OTHER_CIPHER:
1305 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1308 #ifndef OPENSSL_NO_EC
1309 case SSL_SECOP_OTHER_CURVE:
1312 cname = EC_curve_nid2nist(nid);
1314 cname = OBJ_nid2sn(nid);
1315 BIO_puts(sdb->out, cname);
1319 #ifndef OPENSSL_NO_DH
1320 case SSL_SECOP_OTHER_DH:
1323 BIO_printf(sdb->out, "%d", DH_bits(dh));
1327 case SSL_SECOP_OTHER_CERT:
1330 int sig_nid = X509_get_signature_nid(other);
1331 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1333 EVP_PKEY *pkey = X509_get0_pubkey(other);
1334 const char *algname = "";
1335 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1336 &algname, EVP_PKEY_get0_asn1(pkey));
1337 BIO_printf(sdb->out, "%s, bits=%d",
1338 algname, EVP_PKEY_bits(pkey));
1342 case SSL_SECOP_OTHER_SIGALG:
1344 const unsigned char *salg = other;
1345 const char *sname = NULL;
1347 case TLSEXT_signature_anonymous:
1348 sname = "anonymous";
1350 case TLSEXT_signature_rsa:
1353 case TLSEXT_signature_dsa:
1356 case TLSEXT_signature_ecdsa:
1361 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1363 BIO_printf(sdb->out, ", algorithm=%s", sname);
1365 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1372 BIO_printf(sdb->out, ", security bits=%d", bits);
1373 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1377 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1379 static security_debug_ex sdb;
1382 sdb.verbose = verbose;
1383 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1384 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1385 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1388 static void keylog_callback(const SSL *ssl, const char *line)
1390 if (bio_keylog == NULL) {
1391 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1396 * There might be concurrent writers to the keylog file, so we must ensure
1397 * that the given line is written at once.
1399 BIO_printf(bio_keylog, "%s\n", line);
1400 (void)BIO_flush(bio_keylog);
1403 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1405 /* Close any open files */
1406 BIO_free_all(bio_keylog);
1409 if (ctx == NULL || keylog_file == NULL) {
1410 /* Keylogging is disabled, OK. */
1415 * Append rather than write in order to allow concurrent modification.
1416 * Furthermore, this preserves existing keylog files which is useful when
1417 * the tool is run multiple times.
1419 bio_keylog = BIO_new_file(keylog_file, "a");
1420 if (bio_keylog == NULL) {
1421 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1425 /* Write a header for seekable, empty files (this excludes pipes). */
1426 if (BIO_tell(bio_keylog) == 0) {
1427 BIO_puts(bio_keylog,
1428 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1429 (void)BIO_flush(bio_keylog);
1431 SSL_CTX_set_keylog_callback(ctx, keylog_callback);
1435 void print_ca_names(BIO *bio, SSL *s)
1437 const char *cs = SSL_is_server(s) ? "server" : "client";
1438 const STACK_OF(X509_NAME) *sk = SSL_get0_peer_CA_list(s);
1441 if (sk == NULL || sk_X509_NAME_num(sk) == 0) {
1442 BIO_printf(bio, "---\nNo %s certificate CA names sent\n", cs);
1446 BIO_printf(bio, "---\nAcceptable %s certificate CA names\n",cs);
1447 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
1448 X509_NAME_print_ex(bio, sk_X509_NAME_value(sk, i), 0, get_nameopt());
1449 BIO_write(bio, "\n", 1);