2 * Copyright 1995-2018 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:
242 static int do_print_sigalgs(BIO *out, SSL *s, int shared)
245 client = SSL_is_server(s) ? 0 : 1;
247 nsig = SSL_get_shared_sigalgs(s, 0, NULL, NULL, NULL, NULL, NULL);
249 nsig = SSL_get_sigalgs(s, -1, NULL, NULL, NULL, NULL, NULL);
254 BIO_puts(out, "Shared ");
257 BIO_puts(out, "Requested ");
258 BIO_puts(out, "Signature Algorithms: ");
259 for (i = 0; i < nsig; i++) {
260 int hash_nid, sign_nid;
261 unsigned char rhash, rsign;
262 const char *sstr = NULL;
264 SSL_get_shared_sigalgs(s, i, &sign_nid, &hash_nid, NULL,
267 SSL_get_sigalgs(s, i, &sign_nid, &hash_nid, NULL, &rsign, &rhash);
270 sstr = get_sigtype(sign_nid);
272 BIO_printf(out, "%s", sstr);
274 BIO_printf(out, "0x%02X", (int)rsign);
275 if (hash_nid != NID_undef)
276 BIO_printf(out, "+%s", OBJ_nid2sn(hash_nid));
277 else if (sstr == NULL)
278 BIO_printf(out, "+0x%02X", (int)rhash);
284 int ssl_print_sigalgs(BIO *out, SSL *s)
287 if (!SSL_is_server(s))
288 ssl_print_client_cert_types(out, s);
289 do_print_sigalgs(out, s, 0);
290 do_print_sigalgs(out, s, 1);
291 if (SSL_get_peer_signature_nid(s, &nid) && nid != NID_undef)
292 BIO_printf(out, "Peer signing digest: %s\n", OBJ_nid2sn(nid));
293 if (SSL_get_peer_signature_type_nid(s, &nid))
294 BIO_printf(out, "Peer signature type: %s\n", get_sigtype(nid));
298 #ifndef OPENSSL_NO_EC
299 int ssl_print_point_formats(BIO *out, SSL *s)
302 const char *pformats;
303 nformats = SSL_get0_ec_point_formats(s, &pformats);
306 BIO_puts(out, "Supported Elliptic Curve Point Formats: ");
307 for (i = 0; i < nformats; i++, pformats++) {
311 case TLSEXT_ECPOINTFORMAT_uncompressed:
312 BIO_puts(out, "uncompressed");
315 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime:
316 BIO_puts(out, "ansiX962_compressed_prime");
319 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2:
320 BIO_puts(out, "ansiX962_compressed_char2");
324 BIO_printf(out, "unknown(%d)", (int)*pformats);
333 int ssl_print_groups(BIO *out, SSL *s, int noshared)
335 int i, ngroups, *groups, nid;
338 ngroups = SSL_get1_groups(s, NULL);
341 groups = app_malloc(ngroups * sizeof(int), "groups to print");
342 SSL_get1_groups(s, groups);
344 BIO_puts(out, "Supported Elliptic Groups: ");
345 for (i = 0; i < ngroups; i++) {
349 /* If unrecognised print out hex version */
350 if (nid & TLSEXT_nid_unknown) {
351 BIO_printf(out, "0x%04X", nid & 0xFFFF);
353 /* TODO(TLS1.3): Get group name here */
354 /* Use NIST name for curve if it exists */
355 gname = EC_curve_nid2nist(nid);
357 gname = OBJ_nid2sn(nid);
358 BIO_printf(out, "%s", gname);
361 OPENSSL_free(groups);
366 BIO_puts(out, "\nShared Elliptic groups: ");
367 ngroups = SSL_get_shared_group(s, -1);
368 for (i = 0; i < ngroups; i++) {
371 nid = SSL_get_shared_group(s, i);
372 /* TODO(TLS1.3): Convert for DH groups */
373 gname = EC_curve_nid2nist(nid);
375 gname = OBJ_nid2sn(nid);
376 BIO_printf(out, "%s", gname);
379 BIO_puts(out, "NONE");
385 int ssl_print_tmp_key(BIO *out, SSL *s)
388 if (!SSL_get_server_tmp_key(s, &key))
390 BIO_puts(out, "Server Temp Key: ");
391 switch (EVP_PKEY_id(key)) {
393 BIO_printf(out, "RSA, %d bits\n", EVP_PKEY_bits(key));
397 BIO_printf(out, "DH, %d bits\n", EVP_PKEY_bits(key));
399 #ifndef OPENSSL_NO_EC
402 EC_KEY *ec = EVP_PKEY_get1_EC_KEY(key);
405 nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
407 cname = EC_curve_nid2nist(nid);
409 cname = OBJ_nid2sn(nid);
410 BIO_printf(out, "ECDH, %s, %d bits\n", cname, EVP_PKEY_bits(key));
415 BIO_printf(out, "%s, %d bits\n", OBJ_nid2sn(EVP_PKEY_id(key)),
422 long bio_dump_callback(BIO *bio, int cmd, const char *argp,
423 int argi, long argl, long ret)
427 out = (BIO *)BIO_get_callback_arg(bio);
431 if (cmd == (BIO_CB_READ | BIO_CB_RETURN)) {
432 BIO_printf(out, "read from %p [%p] (%lu bytes => %ld (0x%lX))\n",
433 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
434 BIO_dump(out, argp, (int)ret);
436 } else if (cmd == (BIO_CB_WRITE | BIO_CB_RETURN)) {
437 BIO_printf(out, "write to %p [%p] (%lu bytes => %ld (0x%lX))\n",
438 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
439 BIO_dump(out, argp, (int)ret);
444 void apps_ssl_info_callback(const SSL *s, int where, int ret)
449 w = where & ~SSL_ST_MASK;
451 if (w & SSL_ST_CONNECT)
453 else if (w & SSL_ST_ACCEPT)
458 if (where & SSL_CB_LOOP) {
459 BIO_printf(bio_err, "%s:%s\n", str, SSL_state_string_long(s));
460 } else if (where & SSL_CB_ALERT) {
461 str = (where & SSL_CB_READ) ? "read" : "write";
462 BIO_printf(bio_err, "SSL3 alert %s:%s:%s\n",
464 SSL_alert_type_string_long(ret),
465 SSL_alert_desc_string_long(ret));
466 } else if (where & SSL_CB_EXIT) {
468 BIO_printf(bio_err, "%s:failed in %s\n",
469 str, SSL_state_string_long(s));
471 BIO_printf(bio_err, "%s:error in %s\n",
472 str, SSL_state_string_long(s));
476 static STRINT_PAIR ssl_versions[] = {
477 {"SSL 3.0", SSL3_VERSION},
478 {"TLS 1.0", TLS1_VERSION},
479 {"TLS 1.1", TLS1_1_VERSION},
480 {"TLS 1.2", TLS1_2_VERSION},
481 {"TLS 1.3", TLS1_3_VERSION},
482 {"DTLS 1.0", DTLS1_VERSION},
483 {"DTLS 1.0 (bad)", DTLS1_BAD_VER},
487 static STRINT_PAIR alert_types[] = {
488 {" close_notify", 0},
489 {" end_of_early_data", 1},
490 {" unexpected_message", 10},
491 {" bad_record_mac", 20},
492 {" decryption_failed", 21},
493 {" record_overflow", 22},
494 {" decompression_failure", 30},
495 {" handshake_failure", 40},
496 {" bad_certificate", 42},
497 {" unsupported_certificate", 43},
498 {" certificate_revoked", 44},
499 {" certificate_expired", 45},
500 {" certificate_unknown", 46},
501 {" illegal_parameter", 47},
503 {" access_denied", 49},
504 {" decode_error", 50},
505 {" decrypt_error", 51},
506 {" export_restriction", 60},
507 {" protocol_version", 70},
508 {" insufficient_security", 71},
509 {" internal_error", 80},
510 {" inappropriate_fallback", 86},
511 {" user_canceled", 90},
512 {" no_renegotiation", 100},
513 {" missing_extension", 109},
514 {" unsupported_extension", 110},
515 {" certificate_unobtainable", 111},
516 {" unrecognized_name", 112},
517 {" bad_certificate_status_response", 113},
518 {" bad_certificate_hash_value", 114},
519 {" unknown_psk_identity", 115},
520 {" certificate_required", 116},
524 static STRINT_PAIR handshakes[] = {
525 {", HelloRequest", SSL3_MT_HELLO_REQUEST},
526 {", ClientHello", SSL3_MT_CLIENT_HELLO},
527 {", ServerHello", SSL3_MT_SERVER_HELLO},
528 {", HelloVerifyRequest", DTLS1_MT_HELLO_VERIFY_REQUEST},
529 {", NewSessionTicket", SSL3_MT_NEWSESSION_TICKET},
530 {", EndOfEarlyData", SSL3_MT_END_OF_EARLY_DATA},
531 {", EncryptedExtensions", SSL3_MT_ENCRYPTED_EXTENSIONS},
532 {", Certificate", SSL3_MT_CERTIFICATE},
533 {", ServerKeyExchange", SSL3_MT_SERVER_KEY_EXCHANGE},
534 {", CertificateRequest", SSL3_MT_CERTIFICATE_REQUEST},
535 {", ServerHelloDone", SSL3_MT_SERVER_DONE},
536 {", CertificateVerify", SSL3_MT_CERTIFICATE_VERIFY},
537 {", ClientKeyExchange", SSL3_MT_CLIENT_KEY_EXCHANGE},
538 {", Finished", SSL3_MT_FINISHED},
539 {", CertificateUrl", SSL3_MT_CERTIFICATE_URL},
540 {", CertificateStatus", SSL3_MT_CERTIFICATE_STATUS},
541 {", SupplementalData", SSL3_MT_SUPPLEMENTAL_DATA},
542 {", KeyUpdate", SSL3_MT_KEY_UPDATE},
543 #ifndef OPENSSL_NO_NEXTPROTONEG
544 {", NextProto", SSL3_MT_NEXT_PROTO},
546 {", MessageHash", SSL3_MT_MESSAGE_HASH},
550 void msg_cb(int write_p, int version, int content_type, const void *buf,
551 size_t len, SSL *ssl, void *arg)
554 const char *str_write_p = write_p ? ">>>" : "<<<";
555 const char *str_version = lookup(version, ssl_versions, "???");
556 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
557 const unsigned char* bp = buf;
559 if (version == SSL3_VERSION ||
560 version == TLS1_VERSION ||
561 version == TLS1_1_VERSION ||
562 version == TLS1_2_VERSION ||
563 version == TLS1_3_VERSION ||
564 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
565 switch (content_type) {
567 str_content_type = ", ChangeCipherSpec";
570 str_content_type = ", Alert";
571 str_details1 = ", ???";
575 str_details1 = ", warning";
578 str_details1 = ", fatal";
581 str_details2 = lookup((int)bp[1], alert_types, " ???");
585 str_content_type = ", Handshake";
586 str_details1 = "???";
588 str_details1 = lookup((int)bp[0], handshakes, "???");
591 str_content_type = ", ApplicationData";
593 #ifndef OPENSSL_NO_HEARTBEATS
595 str_details1 = ", Heartbeat";
600 str_details1 = ", HeartbeatRequest";
603 str_details1 = ", HeartbeatResponse";
612 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
613 str_content_type, (unsigned long)len, str_details1,
619 BIO_printf(bio, " ");
621 for (i = 0; i < num; i++) {
622 if (i % 16 == 0 && i > 0)
623 BIO_printf(bio, "\n ");
624 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
627 BIO_printf(bio, " ...");
628 BIO_printf(bio, "\n");
630 (void)BIO_flush(bio);
633 static STRINT_PAIR tlsext_types[] = {
634 {"server name", TLSEXT_TYPE_server_name},
635 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
636 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
637 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
638 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
639 {"status request", TLSEXT_TYPE_status_request},
640 {"user mapping", TLSEXT_TYPE_user_mapping},
641 {"client authz", TLSEXT_TYPE_client_authz},
642 {"server authz", TLSEXT_TYPE_server_authz},
643 {"cert type", TLSEXT_TYPE_cert_type},
644 {"supported_groups", TLSEXT_TYPE_supported_groups},
645 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
646 {"SRP", TLSEXT_TYPE_srp},
647 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
648 {"use SRTP", TLSEXT_TYPE_use_srtp},
649 {"heartbeat", TLSEXT_TYPE_heartbeat},
650 {"session ticket", TLSEXT_TYPE_session_ticket},
651 {"renegotiation info", TLSEXT_TYPE_renegotiate},
652 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
653 {"TLS padding", TLSEXT_TYPE_padding},
654 #ifdef TLSEXT_TYPE_next_proto_neg
655 {"next protocol", TLSEXT_TYPE_next_proto_neg},
657 #ifdef TLSEXT_TYPE_encrypt_then_mac
658 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
660 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
661 {"application layer protocol negotiation",
662 TLSEXT_TYPE_application_layer_protocol_negotiation},
664 #ifdef TLSEXT_TYPE_extended_master_secret
665 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
667 {"key share", TLSEXT_TYPE_key_share},
668 {"supported versions", TLSEXT_TYPE_supported_versions},
669 {"psk", TLSEXT_TYPE_psk},
670 {"psk kex modes", TLSEXT_TYPE_psk_kex_modes},
671 {"certificate authorities", TLSEXT_TYPE_certificate_authorities},
672 {"post handshake auth", TLSEXT_TYPE_post_handshake_auth},
676 void tlsext_cb(SSL *s, int client_server, int type,
677 const unsigned char *data, int len, void *arg)
680 const char *extname = lookup(type, tlsext_types, "unknown");
682 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
683 client_server ? "server" : "client", extname, type, len);
684 BIO_dump(bio, (const char *)data, len);
685 (void)BIO_flush(bio);
688 #ifndef OPENSSL_NO_SOCK
689 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
690 unsigned int *cookie_len)
692 unsigned char *buffer;
695 BIO_ADDR *lpeer = NULL, *peer = NULL;
697 /* Initialize a random secret */
698 if (!cookie_initialized) {
699 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
700 BIO_printf(bio_err, "error setting random cookie secret\n");
703 cookie_initialized = 1;
706 if (SSL_is_dtls(ssl)) {
707 lpeer = peer = BIO_ADDR_new();
709 BIO_printf(bio_err, "memory full\n");
713 /* Read peer information */
714 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
719 /* Create buffer with peer's address and port */
720 if (!BIO_ADDR_rawaddress(peer, NULL, &length)) {
721 BIO_printf(bio_err, "Failed getting peer address\n");
724 OPENSSL_assert(length != 0);
725 port = BIO_ADDR_rawport(peer);
726 length += sizeof(port);
727 buffer = app_malloc(length, "cookie generate buffer");
729 memcpy(buffer, &port, sizeof(port));
730 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
732 /* Calculate HMAC of buffer using the secret */
733 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
734 buffer, length, cookie, cookie_len);
736 OPENSSL_free(buffer);
737 BIO_ADDR_free(lpeer);
742 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
743 unsigned int cookie_len)
745 unsigned char result[EVP_MAX_MD_SIZE];
746 unsigned int resultlength;
748 /* Note: we check cookie_initialized because if it's not,
749 * it cannot be valid */
750 if (cookie_initialized
751 && generate_cookie_callback(ssl, result, &resultlength)
752 && cookie_len == resultlength
753 && memcmp(result, cookie, resultlength) == 0)
759 int generate_stateless_cookie_callback(SSL *ssl, unsigned char *cookie,
763 int res = generate_cookie_callback(ssl, cookie, &temp);
768 int verify_stateless_cookie_callback(SSL *ssl, const unsigned char *cookie,
771 return verify_cookie_callback(ssl, cookie, cookie_len);
777 * Example of extended certificate handling. Where the standard support of
778 * one certificate per algorithm is not sufficient an application can decide
779 * which certificate(s) to use at runtime based on whatever criteria it deems
783 /* Linked list of certificates, keys and chains */
784 struct ssl_excert_st {
786 const char *certfile;
789 const char *chainfile;
792 STACK_OF(X509) *chain;
794 struct ssl_excert_st *next, *prev;
797 static STRINT_PAIR chain_flags[] = {
798 {"Overall Validity", CERT_PKEY_VALID},
799 {"Sign with EE key", CERT_PKEY_SIGN},
800 {"EE signature", CERT_PKEY_EE_SIGNATURE},
801 {"CA signature", CERT_PKEY_CA_SIGNATURE},
802 {"EE key parameters", CERT_PKEY_EE_PARAM},
803 {"CA key parameters", CERT_PKEY_CA_PARAM},
804 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
805 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
806 {"Certificate Type", CERT_PKEY_CERT_TYPE},
810 static void print_chain_flags(SSL *s, int flags)
814 for (pp = chain_flags; pp->name; ++pp)
815 BIO_printf(bio_err, "\t%s: %s\n",
817 (flags & pp->retval) ? "OK" : "NOT OK");
818 BIO_printf(bio_err, "\tSuite B: ");
819 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
820 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
822 BIO_printf(bio_err, "not tested\n");
826 * Very basic selection callback: just use any certificate chain reported as
827 * valid. More sophisticated could prioritise according to local policy.
829 static int set_cert_cb(SSL *ssl, void *arg)
832 SSL_EXCERT *exc = arg;
833 #ifdef CERT_CB_TEST_RETRY
834 static int retry_cnt;
838 "Certificate callback retry test: count %d\n",
843 SSL_certs_clear(ssl);
849 * Go to end of list and traverse backwards since we prepend newer
850 * entries this retains the original order.
852 while (exc->next != NULL)
857 while (exc != NULL) {
859 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
860 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
861 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
863 BIO_puts(bio_err, "\n");
864 print_chain_flags(ssl, rv);
865 if (rv & CERT_PKEY_VALID) {
866 if (!SSL_use_certificate(ssl, exc->cert)
867 || !SSL_use_PrivateKey(ssl, exc->key)) {
871 * NB: we wouldn't normally do this as it is not efficient
872 * building chains on each connection better to cache the chain
875 if (exc->build_chain) {
876 if (!SSL_build_cert_chain(ssl, 0))
878 } else if (exc->chain != NULL) {
879 SSL_set1_chain(ssl, exc->chain);
887 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
889 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
892 static int ssl_excert_prepend(SSL_EXCERT **pexc)
894 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
896 memset(exc, 0, sizeof(*exc));
902 exc->certform = exc->next->certform;
903 exc->keyform = exc->next->keyform;
904 exc->next->prev = exc;
906 exc->certform = FORMAT_PEM;
907 exc->keyform = FORMAT_PEM;
913 void ssl_excert_free(SSL_EXCERT *exc)
920 X509_free(exc->cert);
921 EVP_PKEY_free(exc->key);
922 sk_X509_pop_free(exc->chain, X509_free);
929 int load_excert(SSL_EXCERT **pexc)
931 SSL_EXCERT *exc = *pexc;
934 /* If nothing in list, free and set to NULL */
935 if (exc->certfile == NULL && exc->next == NULL) {
936 ssl_excert_free(exc);
940 for (; exc; exc = exc->next) {
941 if (exc->certfile == NULL) {
942 BIO_printf(bio_err, "Missing filename\n");
945 exc->cert = load_cert(exc->certfile, exc->certform,
946 "Server Certificate");
947 if (exc->cert == NULL)
949 if (exc->keyfile != NULL) {
950 exc->key = load_key(exc->keyfile, exc->keyform,
951 0, NULL, NULL, "Server Key");
953 exc->key = load_key(exc->certfile, exc->certform,
954 0, NULL, NULL, "Server Key");
956 if (exc->key == NULL)
958 if (exc->chainfile != NULL) {
959 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
967 enum range { OPT_X_ENUM };
969 int args_excert(int opt, SSL_EXCERT **pexc)
971 SSL_EXCERT *exc = *pexc;
973 assert(opt > OPT_X__FIRST);
974 assert(opt < OPT_X__LAST);
977 if (!ssl_excert_prepend(&exc)) {
978 BIO_printf(bio_err, " %s: Error initialising xcert\n",
985 switch ((enum range)opt) {
990 if (exc->certfile != NULL && !ssl_excert_prepend(&exc)) {
991 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
995 exc->certfile = opt_arg();
998 if (exc->keyfile != NULL) {
999 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
1002 exc->keyfile = opt_arg();
1005 if (exc->chainfile != NULL) {
1006 BIO_printf(bio_err, "%s: Chain already specified\n",
1010 exc->chainfile = opt_arg();
1012 case OPT_X_CHAIN_BUILD:
1013 exc->build_chain = 1;
1015 case OPT_X_CERTFORM:
1016 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
1020 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
1027 ERR_print_errors(bio_err);
1028 ssl_excert_free(exc);
1033 static void print_raw_cipherlist(SSL *s)
1035 const unsigned char *rlist;
1036 static const unsigned char scsv_id[] = { 0, 0xFF };
1037 size_t i, rlistlen, num;
1038 if (!SSL_is_server(s))
1040 num = SSL_get0_raw_cipherlist(s, NULL);
1041 OPENSSL_assert(num == 2);
1042 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1043 BIO_puts(bio_err, "Client cipher list: ");
1044 for (i = 0; i < rlistlen; i += num, rlist += num) {
1045 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1047 BIO_puts(bio_err, ":");
1049 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1050 } else if (memcmp(rlist, scsv_id, num) == 0) {
1051 BIO_puts(bio_err, "SCSV");
1054 BIO_puts(bio_err, "0x");
1055 for (j = 0; j < num; j++)
1056 BIO_printf(bio_err, "%02X", rlist[j]);
1059 BIO_puts(bio_err, "\n");
1063 * Hex encoder for TLSA RRdata, not ':' delimited.
1065 static char *hexencode(const unsigned char *data, size_t len)
1067 static const char *hex = "0123456789abcdef";
1070 size_t outlen = 2 * len + 1;
1071 int ilen = (int) outlen;
1073 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1074 BIO_printf(bio_err, "%s: %zu-byte buffer too large to hexencode\n",
1075 opt_getprog(), len);
1078 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1081 *cp++ = hex[(*data >> 4) & 0x0f];
1082 *cp++ = hex[*data++ & 0x0f];
1088 void print_verify_detail(SSL *s, BIO *bio)
1092 long verify_err = SSL_get_verify_result(s);
1094 if (verify_err == X509_V_OK) {
1095 const char *peername = SSL_get0_peername(s);
1097 BIO_printf(bio, "Verification: OK\n");
1098 if (peername != NULL)
1099 BIO_printf(bio, "Verified peername: %s\n", peername);
1101 const char *reason = X509_verify_cert_error_string(verify_err);
1103 BIO_printf(bio, "Verification error: %s\n", reason);
1106 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1107 uint8_t usage, selector, mtype;
1108 const unsigned char *data = NULL;
1112 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1115 * The TLSA data field can be quite long when it is a certificate,
1116 * public key or even a SHA2-512 digest. Because the initial octets of
1117 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1118 * and lengths, we show the last 12 bytes of the data instead, as these
1119 * are more likely to distinguish distinct TLSA records.
1121 #define TLSA_TAIL_SIZE 12
1122 if (dlen > TLSA_TAIL_SIZE)
1123 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1125 hexdata = hexencode(data, dlen);
1126 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1127 usage, selector, mtype,
1128 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1129 (mspki != NULL) ? "signed the certificate" :
1130 mdpth ? "matched TA certificate" : "matched EE certificate",
1132 OPENSSL_free(hexdata);
1136 void print_ssl_summary(SSL *s)
1138 const SSL_CIPHER *c;
1141 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1142 print_raw_cipherlist(s);
1143 c = SSL_get_current_cipher(s);
1144 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1145 do_print_sigalgs(bio_err, s, 0);
1146 peer = SSL_get_peer_certificate(s);
1150 BIO_puts(bio_err, "Peer certificate: ");
1151 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1153 BIO_puts(bio_err, "\n");
1154 if (SSL_get_peer_signature_nid(s, &nid))
1155 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1156 if (SSL_get_peer_signature_type_nid(s, &nid))
1157 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1158 print_verify_detail(s, bio_err);
1160 BIO_puts(bio_err, "No peer certificate\n");
1163 #ifndef OPENSSL_NO_EC
1164 ssl_print_point_formats(bio_err, s);
1165 if (SSL_is_server(s))
1166 ssl_print_groups(bio_err, s, 1);
1168 ssl_print_tmp_key(bio_err, s);
1170 if (!SSL_is_server(s))
1171 ssl_print_tmp_key(bio_err, s);
1175 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1180 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1181 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1182 const char *flag = sk_OPENSSL_STRING_value(str, i);
1183 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1184 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1186 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1189 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1190 ERR_print_errors(bio_err);
1194 if (!SSL_CONF_CTX_finish(cctx)) {
1195 BIO_puts(bio_err, "Error finishing context\n");
1196 ERR_print_errors(bio_err);
1202 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1206 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1207 crl = sk_X509_CRL_value(crls, i);
1208 X509_STORE_add_crl(st, crl);
1213 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1216 st = SSL_CTX_get_cert_store(ctx);
1217 add_crls_store(st, crls);
1219 store_setup_crl_download(st);
1223 int ssl_load_stores(SSL_CTX *ctx,
1224 const char *vfyCApath, const char *vfyCAfile,
1225 const char *chCApath, const char *chCAfile,
1226 STACK_OF(X509_CRL) *crls, int crl_download)
1228 X509_STORE *vfy = NULL, *ch = NULL;
1230 if (vfyCApath != NULL || vfyCAfile != NULL) {
1231 vfy = X509_STORE_new();
1234 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1236 add_crls_store(vfy, crls);
1237 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1239 store_setup_crl_download(vfy);
1241 if (chCApath != NULL || chCAfile != NULL) {
1242 ch = X509_STORE_new();
1245 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1247 SSL_CTX_set1_chain_cert_store(ctx, ch);
1251 X509_STORE_free(vfy);
1252 X509_STORE_free(ch);
1256 /* Verbose print out of security callback */
1261 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1262 void *other, void *ex);
1263 } security_debug_ex;
1265 static STRINT_PAIR callback_types[] = {
1266 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1267 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1268 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1269 #ifndef OPENSSL_NO_DH
1270 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1272 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1273 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1274 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1275 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1276 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1277 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1278 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1279 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1280 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1281 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1282 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1283 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1284 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1285 {"SSL compression", SSL_SECOP_COMPRESSION},
1286 {"Session ticket", SSL_SECOP_TICKET},
1290 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1291 int op, int bits, int nid,
1292 void *other, void *ex)
1294 security_debug_ex *sdb = ex;
1295 int rv, show_bits = 1, cert_md = 0;
1297 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1298 if (rv == 1 && sdb->verbose < 2)
1300 BIO_puts(sdb->out, "Security callback: ");
1302 nm = lookup(op, callback_types, NULL);
1304 case SSL_SECOP_TICKET:
1305 case SSL_SECOP_COMPRESSION:
1309 case SSL_SECOP_VERSION:
1310 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1314 case SSL_SECOP_CA_MD:
1315 case SSL_SECOP_PEER_CA_MD:
1320 BIO_printf(sdb->out, "%s=", nm);
1322 switch (op & SSL_SECOP_OTHER_TYPE) {
1324 case SSL_SECOP_OTHER_CIPHER:
1325 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1328 #ifndef OPENSSL_NO_EC
1329 case SSL_SECOP_OTHER_CURVE:
1332 cname = EC_curve_nid2nist(nid);
1334 cname = OBJ_nid2sn(nid);
1335 BIO_puts(sdb->out, cname);
1339 #ifndef OPENSSL_NO_DH
1340 case SSL_SECOP_OTHER_DH:
1343 BIO_printf(sdb->out, "%d", DH_bits(dh));
1347 case SSL_SECOP_OTHER_CERT:
1350 int sig_nid = X509_get_signature_nid(other);
1351 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1353 EVP_PKEY *pkey = X509_get0_pubkey(other);
1354 const char *algname = "";
1355 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1356 &algname, EVP_PKEY_get0_asn1(pkey));
1357 BIO_printf(sdb->out, "%s, bits=%d",
1358 algname, EVP_PKEY_bits(pkey));
1362 case SSL_SECOP_OTHER_SIGALG:
1364 const unsigned char *salg = other;
1365 const char *sname = NULL;
1367 case TLSEXT_signature_anonymous:
1368 sname = "anonymous";
1370 case TLSEXT_signature_rsa:
1373 case TLSEXT_signature_dsa:
1376 case TLSEXT_signature_ecdsa:
1381 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1383 BIO_printf(sdb->out, ", algorithm=%s", sname);
1385 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1392 BIO_printf(sdb->out, ", security bits=%d", bits);
1393 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1397 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1399 static security_debug_ex sdb;
1402 sdb.verbose = verbose;
1403 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1404 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1405 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1408 static void keylog_callback(const SSL *ssl, const char *line)
1410 if (bio_keylog == NULL) {
1411 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1416 * There might be concurrent writers to the keylog file, so we must ensure
1417 * that the given line is written at once.
1419 BIO_printf(bio_keylog, "%s\n", line);
1420 (void)BIO_flush(bio_keylog);
1423 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1425 /* Close any open files */
1426 BIO_free_all(bio_keylog);
1429 if (ctx == NULL || keylog_file == NULL) {
1430 /* Keylogging is disabled, OK. */
1435 * Append rather than write in order to allow concurrent modification.
1436 * Furthermore, this preserves existing keylog files which is useful when
1437 * the tool is run multiple times.
1439 bio_keylog = BIO_new_file(keylog_file, "a");
1440 if (bio_keylog == NULL) {
1441 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1445 /* Write a header for seekable, empty files (this excludes pipes). */
1446 if (BIO_tell(bio_keylog) == 0) {
1447 BIO_puts(bio_keylog,
1448 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1449 (void)BIO_flush(bio_keylog);
1451 SSL_CTX_set_keylog_callback(ctx, keylog_callback);
1455 void print_ca_names(BIO *bio, SSL *s)
1457 const char *cs = SSL_is_server(s) ? "server" : "client";
1458 const STACK_OF(X509_NAME) *sk = SSL_get0_peer_CA_list(s);
1461 if (sk == NULL || sk_X509_NAME_num(sk) == 0) {
1462 BIO_printf(bio, "---\nNo %s certificate CA names sent\n", cs);
1466 BIO_printf(bio, "---\nAcceptable %s certificate CA names\n",cs);
1467 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
1468 X509_NAME_print_ex(bio, sk_X509_NAME_value(sk, i), 0, get_nameopt());
1469 BIO_write(bio, "\n", 1);