2 * Copyright 1995-2019 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 = { -1, 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 < 0 || 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:
237 case NID_id_GostR3410_2001:
240 case NID_id_GostR3410_2012_256:
241 return "gost2012_256";
243 case NID_id_GostR3410_2012_512:
244 return "gost2012_512";
251 static int do_print_sigalgs(BIO *out, SSL *s, int shared)
254 client = SSL_is_server(s) ? 0 : 1;
256 nsig = SSL_get_shared_sigalgs(s, 0, NULL, NULL, NULL, NULL, NULL);
258 nsig = SSL_get_sigalgs(s, -1, NULL, NULL, NULL, NULL, NULL);
263 BIO_puts(out, "Shared ");
266 BIO_puts(out, "Requested ");
267 BIO_puts(out, "Signature Algorithms: ");
268 for (i = 0; i < nsig; i++) {
269 int hash_nid, sign_nid;
270 unsigned char rhash, rsign;
271 const char *sstr = NULL;
273 SSL_get_shared_sigalgs(s, i, &sign_nid, &hash_nid, NULL,
276 SSL_get_sigalgs(s, i, &sign_nid, &hash_nid, NULL, &rsign, &rhash);
279 sstr = get_sigtype(sign_nid);
281 BIO_printf(out, "%s", sstr);
283 BIO_printf(out, "0x%02X", (int)rsign);
284 if (hash_nid != NID_undef)
285 BIO_printf(out, "+%s", OBJ_nid2sn(hash_nid));
286 else if (sstr == NULL)
287 BIO_printf(out, "+0x%02X", (int)rhash);
293 int ssl_print_sigalgs(BIO *out, SSL *s)
296 if (!SSL_is_server(s))
297 ssl_print_client_cert_types(out, s);
298 do_print_sigalgs(out, s, 0);
299 do_print_sigalgs(out, s, 1);
300 if (SSL_get_peer_signature_nid(s, &nid) && nid != NID_undef)
301 BIO_printf(out, "Peer signing digest: %s\n", OBJ_nid2sn(nid));
302 if (SSL_get_peer_signature_type_nid(s, &nid))
303 BIO_printf(out, "Peer signature type: %s\n", get_sigtype(nid));
307 #ifndef OPENSSL_NO_EC
308 int ssl_print_point_formats(BIO *out, SSL *s)
311 const char *pformats;
312 nformats = SSL_get0_ec_point_formats(s, &pformats);
315 BIO_puts(out, "Supported Elliptic Curve Point Formats: ");
316 for (i = 0; i < nformats; i++, pformats++) {
320 case TLSEXT_ECPOINTFORMAT_uncompressed:
321 BIO_puts(out, "uncompressed");
324 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime:
325 BIO_puts(out, "ansiX962_compressed_prime");
328 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2:
329 BIO_puts(out, "ansiX962_compressed_char2");
333 BIO_printf(out, "unknown(%d)", (int)*pformats);
342 int ssl_print_groups(BIO *out, SSL *s, int noshared)
344 int i, ngroups, *groups, nid;
347 ngroups = SSL_get1_groups(s, NULL);
350 groups = app_malloc(ngroups * sizeof(int), "groups to print");
351 SSL_get1_groups(s, groups);
353 BIO_puts(out, "Supported Elliptic Groups: ");
354 for (i = 0; i < ngroups; i++) {
358 /* If unrecognised print out hex version */
359 if (nid & TLSEXT_nid_unknown) {
360 BIO_printf(out, "0x%04X", nid & 0xFFFF);
362 /* TODO(TLS1.3): Get group name here */
363 /* Use NIST name for curve if it exists */
364 gname = EC_curve_nid2nist(nid);
366 gname = OBJ_nid2sn(nid);
367 BIO_printf(out, "%s", gname);
370 OPENSSL_free(groups);
375 BIO_puts(out, "\nShared Elliptic groups: ");
376 ngroups = SSL_get_shared_group(s, -1);
377 for (i = 0; i < ngroups; i++) {
380 nid = SSL_get_shared_group(s, i);
381 /* TODO(TLS1.3): Convert for DH groups */
382 gname = EC_curve_nid2nist(nid);
384 gname = OBJ_nid2sn(nid);
385 BIO_printf(out, "%s", gname);
388 BIO_puts(out, "NONE");
394 int ssl_print_tmp_key(BIO *out, SSL *s)
398 if (!SSL_get_peer_tmp_key(s, &key))
400 BIO_puts(out, "Server Temp Key: ");
401 switch (EVP_PKEY_id(key)) {
403 BIO_printf(out, "RSA, %d bits\n", EVP_PKEY_bits(key));
407 BIO_printf(out, "DH, %d bits\n", EVP_PKEY_bits(key));
409 #ifndef OPENSSL_NO_EC
412 EC_KEY *ec = EVP_PKEY_get1_EC_KEY(key);
415 nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
417 cname = EC_curve_nid2nist(nid);
419 cname = OBJ_nid2sn(nid);
420 BIO_printf(out, "ECDH, %s, %d bits\n", cname, EVP_PKEY_bits(key));
425 BIO_printf(out, "%s, %d bits\n", OBJ_nid2sn(EVP_PKEY_id(key)),
432 long bio_dump_callback(BIO *bio, int cmd, const char *argp,
433 int argi, long argl, long ret)
437 out = (BIO *)BIO_get_callback_arg(bio);
441 if (cmd == (BIO_CB_READ | BIO_CB_RETURN)) {
442 BIO_printf(out, "read from %p [%p] (%lu bytes => %ld (0x%lX))\n",
443 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
444 BIO_dump(out, argp, (int)ret);
446 } else if (cmd == (BIO_CB_WRITE | BIO_CB_RETURN)) {
447 BIO_printf(out, "write to %p [%p] (%lu bytes => %ld (0x%lX))\n",
448 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
449 BIO_dump(out, argp, (int)ret);
454 void apps_ssl_info_callback(const SSL *s, int where, int ret)
459 w = where & ~SSL_ST_MASK;
461 if (w & SSL_ST_CONNECT)
463 else if (w & SSL_ST_ACCEPT)
468 if (where & SSL_CB_LOOP) {
469 BIO_printf(bio_err, "%s:%s\n", str, SSL_state_string_long(s));
470 } else if (where & SSL_CB_ALERT) {
471 str = (where & SSL_CB_READ) ? "read" : "write";
472 BIO_printf(bio_err, "SSL3 alert %s:%s:%s\n",
474 SSL_alert_type_string_long(ret),
475 SSL_alert_desc_string_long(ret));
476 } else if (where & SSL_CB_EXIT) {
478 BIO_printf(bio_err, "%s:failed in %s\n",
479 str, SSL_state_string_long(s));
481 BIO_printf(bio_err, "%s:error in %s\n",
482 str, SSL_state_string_long(s));
486 static STRINT_PAIR ssl_versions[] = {
487 {"SSL 3.0", SSL3_VERSION},
488 {"TLS 1.0", TLS1_VERSION},
489 {"TLS 1.1", TLS1_1_VERSION},
490 {"TLS 1.2", TLS1_2_VERSION},
491 {"TLS 1.3", TLS1_3_VERSION},
492 {"DTLS 1.0", DTLS1_VERSION},
493 {"DTLS 1.0 (bad)", DTLS1_BAD_VER},
497 static STRINT_PAIR alert_types[] = {
498 {" close_notify", 0},
499 {" end_of_early_data", 1},
500 {" unexpected_message", 10},
501 {" bad_record_mac", 20},
502 {" decryption_failed", 21},
503 {" record_overflow", 22},
504 {" decompression_failure", 30},
505 {" handshake_failure", 40},
506 {" bad_certificate", 42},
507 {" unsupported_certificate", 43},
508 {" certificate_revoked", 44},
509 {" certificate_expired", 45},
510 {" certificate_unknown", 46},
511 {" illegal_parameter", 47},
513 {" access_denied", 49},
514 {" decode_error", 50},
515 {" decrypt_error", 51},
516 {" export_restriction", 60},
517 {" protocol_version", 70},
518 {" insufficient_security", 71},
519 {" internal_error", 80},
520 {" inappropriate_fallback", 86},
521 {" user_canceled", 90},
522 {" no_renegotiation", 100},
523 {" missing_extension", 109},
524 {" unsupported_extension", 110},
525 {" certificate_unobtainable", 111},
526 {" unrecognized_name", 112},
527 {" bad_certificate_status_response", 113},
528 {" bad_certificate_hash_value", 114},
529 {" unknown_psk_identity", 115},
530 {" certificate_required", 116},
534 static STRINT_PAIR handshakes[] = {
535 {", HelloRequest", SSL3_MT_HELLO_REQUEST},
536 {", ClientHello", SSL3_MT_CLIENT_HELLO},
537 {", ServerHello", SSL3_MT_SERVER_HELLO},
538 {", HelloVerifyRequest", DTLS1_MT_HELLO_VERIFY_REQUEST},
539 {", NewSessionTicket", SSL3_MT_NEWSESSION_TICKET},
540 {", EndOfEarlyData", SSL3_MT_END_OF_EARLY_DATA},
541 {", EncryptedExtensions", SSL3_MT_ENCRYPTED_EXTENSIONS},
542 {", Certificate", SSL3_MT_CERTIFICATE},
543 {", ServerKeyExchange", SSL3_MT_SERVER_KEY_EXCHANGE},
544 {", CertificateRequest", SSL3_MT_CERTIFICATE_REQUEST},
545 {", ServerHelloDone", SSL3_MT_SERVER_DONE},
546 {", CertificateVerify", SSL3_MT_CERTIFICATE_VERIFY},
547 {", ClientKeyExchange", SSL3_MT_CLIENT_KEY_EXCHANGE},
548 {", Finished", SSL3_MT_FINISHED},
549 {", CertificateUrl", SSL3_MT_CERTIFICATE_URL},
550 {", CertificateStatus", SSL3_MT_CERTIFICATE_STATUS},
551 {", SupplementalData", SSL3_MT_SUPPLEMENTAL_DATA},
552 {", KeyUpdate", SSL3_MT_KEY_UPDATE},
553 #ifndef OPENSSL_NO_NEXTPROTONEG
554 {", NextProto", SSL3_MT_NEXT_PROTO},
556 {", MessageHash", SSL3_MT_MESSAGE_HASH},
560 void msg_cb(int write_p, int version, int content_type, const void *buf,
561 size_t len, SSL *ssl, void *arg)
564 const char *str_write_p = write_p ? ">>>" : "<<<";
565 const char *str_version = lookup(version, ssl_versions, "???");
566 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
567 const unsigned char* bp = buf;
569 if (version == SSL3_VERSION ||
570 version == TLS1_VERSION ||
571 version == TLS1_1_VERSION ||
572 version == TLS1_2_VERSION ||
573 version == TLS1_3_VERSION ||
574 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
575 switch (content_type) {
577 str_content_type = ", ChangeCipherSpec";
580 str_content_type = ", Alert";
581 str_details1 = ", ???";
585 str_details1 = ", warning";
588 str_details1 = ", fatal";
591 str_details2 = lookup((int)bp[1], alert_types, " ???");
595 str_content_type = ", Handshake";
596 str_details1 = "???";
598 str_details1 = lookup((int)bp[0], handshakes, "???");
601 str_content_type = ", ApplicationData";
603 #ifndef OPENSSL_NO_HEARTBEATS
605 str_details1 = ", Heartbeat";
610 str_details1 = ", HeartbeatRequest";
613 str_details1 = ", HeartbeatResponse";
622 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
623 str_content_type, (unsigned long)len, str_details1,
629 BIO_printf(bio, " ");
631 for (i = 0; i < num; i++) {
632 if (i % 16 == 0 && i > 0)
633 BIO_printf(bio, "\n ");
634 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
637 BIO_printf(bio, " ...");
638 BIO_printf(bio, "\n");
640 (void)BIO_flush(bio);
643 static STRINT_PAIR tlsext_types[] = {
644 {"server name", TLSEXT_TYPE_server_name},
645 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
646 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
647 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
648 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
649 {"status request", TLSEXT_TYPE_status_request},
650 {"user mapping", TLSEXT_TYPE_user_mapping},
651 {"client authz", TLSEXT_TYPE_client_authz},
652 {"server authz", TLSEXT_TYPE_server_authz},
653 {"cert type", TLSEXT_TYPE_cert_type},
654 {"supported_groups", TLSEXT_TYPE_supported_groups},
655 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
656 {"SRP", TLSEXT_TYPE_srp},
657 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
658 {"use SRTP", TLSEXT_TYPE_use_srtp},
659 {"heartbeat", TLSEXT_TYPE_heartbeat},
660 {"session ticket", TLSEXT_TYPE_session_ticket},
661 {"renegotiation info", TLSEXT_TYPE_renegotiate},
662 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
663 {"TLS padding", TLSEXT_TYPE_padding},
664 #ifdef TLSEXT_TYPE_next_proto_neg
665 {"next protocol", TLSEXT_TYPE_next_proto_neg},
667 #ifdef TLSEXT_TYPE_encrypt_then_mac
668 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
670 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
671 {"application layer protocol negotiation",
672 TLSEXT_TYPE_application_layer_protocol_negotiation},
674 #ifdef TLSEXT_TYPE_extended_master_secret
675 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
677 {"key share", TLSEXT_TYPE_key_share},
678 {"supported versions", TLSEXT_TYPE_supported_versions},
679 {"psk", TLSEXT_TYPE_psk},
680 {"psk kex modes", TLSEXT_TYPE_psk_kex_modes},
681 {"certificate authorities", TLSEXT_TYPE_certificate_authorities},
682 {"post handshake auth", TLSEXT_TYPE_post_handshake_auth},
686 void tlsext_cb(SSL *s, int client_server, int type,
687 const unsigned char *data, int len, void *arg)
690 const char *extname = lookup(type, tlsext_types, "unknown");
692 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
693 client_server ? "server" : "client", extname, type, len);
694 BIO_dump(bio, (const char *)data, len);
695 (void)BIO_flush(bio);
698 #ifndef OPENSSL_NO_SOCK
699 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
700 unsigned int *cookie_len)
702 unsigned char *buffer;
705 BIO_ADDR *lpeer = NULL, *peer = NULL;
707 /* Initialize a random secret */
708 if (!cookie_initialized) {
709 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
710 BIO_printf(bio_err, "error setting random cookie secret\n");
713 cookie_initialized = 1;
716 if (SSL_is_dtls(ssl)) {
717 lpeer = peer = BIO_ADDR_new();
719 BIO_printf(bio_err, "memory full\n");
723 /* Read peer information */
724 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
729 /* Create buffer with peer's address and port */
730 if (!BIO_ADDR_rawaddress(peer, NULL, &length)) {
731 BIO_printf(bio_err, "Failed getting peer address\n");
734 OPENSSL_assert(length != 0);
735 port = BIO_ADDR_rawport(peer);
736 length += sizeof(port);
737 buffer = app_malloc(length, "cookie generate buffer");
739 memcpy(buffer, &port, sizeof(port));
740 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
742 /* Calculate HMAC of buffer using the secret */
743 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
744 buffer, length, cookie, cookie_len);
746 OPENSSL_free(buffer);
747 BIO_ADDR_free(lpeer);
752 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
753 unsigned int cookie_len)
755 unsigned char result[EVP_MAX_MD_SIZE];
756 unsigned int resultlength;
758 /* Note: we check cookie_initialized because if it's not,
759 * it cannot be valid */
760 if (cookie_initialized
761 && generate_cookie_callback(ssl, result, &resultlength)
762 && cookie_len == resultlength
763 && memcmp(result, cookie, resultlength) == 0)
769 int generate_stateless_cookie_callback(SSL *ssl, unsigned char *cookie,
773 int res = generate_cookie_callback(ssl, cookie, &temp);
778 int verify_stateless_cookie_callback(SSL *ssl, const unsigned char *cookie,
781 return verify_cookie_callback(ssl, cookie, cookie_len);
787 * Example of extended certificate handling. Where the standard support of
788 * one certificate per algorithm is not sufficient an application can decide
789 * which certificate(s) to use at runtime based on whatever criteria it deems
793 /* Linked list of certificates, keys and chains */
794 struct ssl_excert_st {
796 const char *certfile;
799 const char *chainfile;
802 STACK_OF(X509) *chain;
804 struct ssl_excert_st *next, *prev;
807 static STRINT_PAIR chain_flags[] = {
808 {"Overall Validity", CERT_PKEY_VALID},
809 {"Sign with EE key", CERT_PKEY_SIGN},
810 {"EE signature", CERT_PKEY_EE_SIGNATURE},
811 {"CA signature", CERT_PKEY_CA_SIGNATURE},
812 {"EE key parameters", CERT_PKEY_EE_PARAM},
813 {"CA key parameters", CERT_PKEY_CA_PARAM},
814 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
815 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
816 {"Certificate Type", CERT_PKEY_CERT_TYPE},
820 static void print_chain_flags(SSL *s, int flags)
824 for (pp = chain_flags; pp->name; ++pp)
825 BIO_printf(bio_err, "\t%s: %s\n",
827 (flags & pp->retval) ? "OK" : "NOT OK");
828 BIO_printf(bio_err, "\tSuite B: ");
829 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
830 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
832 BIO_printf(bio_err, "not tested\n");
836 * Very basic selection callback: just use any certificate chain reported as
837 * valid. More sophisticated could prioritise according to local policy.
839 static int set_cert_cb(SSL *ssl, void *arg)
842 SSL_EXCERT *exc = arg;
843 #ifdef CERT_CB_TEST_RETRY
844 static int retry_cnt;
848 "Certificate callback retry test: count %d\n",
853 SSL_certs_clear(ssl);
859 * Go to end of list and traverse backwards since we prepend newer
860 * entries this retains the original order.
862 while (exc->next != NULL)
867 while (exc != NULL) {
869 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
870 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
871 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
873 BIO_puts(bio_err, "\n");
874 print_chain_flags(ssl, rv);
875 if (rv & CERT_PKEY_VALID) {
876 if (!SSL_use_certificate(ssl, exc->cert)
877 || !SSL_use_PrivateKey(ssl, exc->key)) {
881 * NB: we wouldn't normally do this as it is not efficient
882 * building chains on each connection better to cache the chain
885 if (exc->build_chain) {
886 if (!SSL_build_cert_chain(ssl, 0))
888 } else if (exc->chain != NULL) {
889 SSL_set1_chain(ssl, exc->chain);
897 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
899 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
902 static int ssl_excert_prepend(SSL_EXCERT **pexc)
904 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
906 memset(exc, 0, sizeof(*exc));
912 exc->certform = exc->next->certform;
913 exc->keyform = exc->next->keyform;
914 exc->next->prev = exc;
916 exc->certform = FORMAT_PEM;
917 exc->keyform = FORMAT_PEM;
923 void ssl_excert_free(SSL_EXCERT *exc)
930 X509_free(exc->cert);
931 EVP_PKEY_free(exc->key);
932 sk_X509_pop_free(exc->chain, X509_free);
939 int load_excert(SSL_EXCERT **pexc)
941 SSL_EXCERT *exc = *pexc;
944 /* If nothing in list, free and set to NULL */
945 if (exc->certfile == NULL && exc->next == NULL) {
946 ssl_excert_free(exc);
950 for (; exc; exc = exc->next) {
951 if (exc->certfile == NULL) {
952 BIO_printf(bio_err, "Missing filename\n");
955 exc->cert = load_cert(exc->certfile, exc->certform,
956 "Server Certificate");
957 if (exc->cert == NULL)
959 if (exc->keyfile != NULL) {
960 exc->key = load_key(exc->keyfile, exc->keyform,
961 0, NULL, NULL, "Server Key");
963 exc->key = load_key(exc->certfile, exc->certform,
964 0, NULL, NULL, "Server Key");
966 if (exc->key == NULL)
968 if (exc->chainfile != NULL) {
969 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
977 enum range { OPT_X_ENUM };
979 int args_excert(int opt, SSL_EXCERT **pexc)
981 SSL_EXCERT *exc = *pexc;
983 assert(opt > OPT_X__FIRST);
984 assert(opt < OPT_X__LAST);
987 if (!ssl_excert_prepend(&exc)) {
988 BIO_printf(bio_err, " %s: Error initialising xcert\n",
995 switch ((enum range)opt) {
1000 if (exc->certfile != NULL && !ssl_excert_prepend(&exc)) {
1001 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
1005 exc->certfile = opt_arg();
1008 if (exc->keyfile != NULL) {
1009 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
1012 exc->keyfile = opt_arg();
1015 if (exc->chainfile != NULL) {
1016 BIO_printf(bio_err, "%s: Chain already specified\n",
1020 exc->chainfile = opt_arg();
1022 case OPT_X_CHAIN_BUILD:
1023 exc->build_chain = 1;
1025 case OPT_X_CERTFORM:
1026 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
1030 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
1037 ERR_print_errors(bio_err);
1038 ssl_excert_free(exc);
1043 static void print_raw_cipherlist(SSL *s)
1045 const unsigned char *rlist;
1046 static const unsigned char scsv_id[] = { 0, 0xFF };
1047 size_t i, rlistlen, num;
1048 if (!SSL_is_server(s))
1050 num = SSL_get0_raw_cipherlist(s, NULL);
1051 OPENSSL_assert(num == 2);
1052 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1053 BIO_puts(bio_err, "Client cipher list: ");
1054 for (i = 0; i < rlistlen; i += num, rlist += num) {
1055 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1057 BIO_puts(bio_err, ":");
1059 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1060 } else if (memcmp(rlist, scsv_id, num) == 0) {
1061 BIO_puts(bio_err, "SCSV");
1064 BIO_puts(bio_err, "0x");
1065 for (j = 0; j < num; j++)
1066 BIO_printf(bio_err, "%02X", rlist[j]);
1069 BIO_puts(bio_err, "\n");
1073 * Hex encoder for TLSA RRdata, not ':' delimited.
1075 static char *hexencode(const unsigned char *data, size_t len)
1077 static const char *hex = "0123456789abcdef";
1080 size_t outlen = 2 * len + 1;
1081 int ilen = (int) outlen;
1083 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1084 BIO_printf(bio_err, "%s: %zu-byte buffer too large to hexencode\n",
1085 opt_getprog(), len);
1088 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1091 *cp++ = hex[(*data >> 4) & 0x0f];
1092 *cp++ = hex[*data++ & 0x0f];
1098 void print_verify_detail(SSL *s, BIO *bio)
1102 long verify_err = SSL_get_verify_result(s);
1104 if (verify_err == X509_V_OK) {
1105 const char *peername = SSL_get0_peername(s);
1107 BIO_printf(bio, "Verification: OK\n");
1108 if (peername != NULL)
1109 BIO_printf(bio, "Verified peername: %s\n", peername);
1111 const char *reason = X509_verify_cert_error_string(verify_err);
1113 BIO_printf(bio, "Verification error: %s\n", reason);
1116 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1117 uint8_t usage, selector, mtype;
1118 const unsigned char *data = NULL;
1122 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1125 * The TLSA data field can be quite long when it is a certificate,
1126 * public key or even a SHA2-512 digest. Because the initial octets of
1127 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1128 * and lengths, we show the last 12 bytes of the data instead, as these
1129 * are more likely to distinguish distinct TLSA records.
1131 #define TLSA_TAIL_SIZE 12
1132 if (dlen > TLSA_TAIL_SIZE)
1133 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1135 hexdata = hexencode(data, dlen);
1136 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1137 usage, selector, mtype,
1138 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1139 (mspki != NULL) ? "signed the certificate" :
1140 mdpth ? "matched TA certificate" : "matched EE certificate",
1142 OPENSSL_free(hexdata);
1146 void print_ssl_summary(SSL *s)
1148 const SSL_CIPHER *c;
1151 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1152 print_raw_cipherlist(s);
1153 c = SSL_get_current_cipher(s);
1154 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1155 do_print_sigalgs(bio_err, s, 0);
1156 peer = SSL_get_peer_certificate(s);
1160 BIO_puts(bio_err, "Peer certificate: ");
1161 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1163 BIO_puts(bio_err, "\n");
1164 if (SSL_get_peer_signature_nid(s, &nid))
1165 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1166 if (SSL_get_peer_signature_type_nid(s, &nid))
1167 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1168 print_verify_detail(s, bio_err);
1170 BIO_puts(bio_err, "No peer certificate\n");
1173 #ifndef OPENSSL_NO_EC
1174 ssl_print_point_formats(bio_err, s);
1175 if (SSL_is_server(s))
1176 ssl_print_groups(bio_err, s, 1);
1178 ssl_print_tmp_key(bio_err, s);
1180 if (!SSL_is_server(s))
1181 ssl_print_tmp_key(bio_err, s);
1185 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1190 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1191 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1192 const char *flag = sk_OPENSSL_STRING_value(str, i);
1193 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1194 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1196 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1199 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1200 ERR_print_errors(bio_err);
1204 if (!SSL_CONF_CTX_finish(cctx)) {
1205 BIO_puts(bio_err, "Error finishing context\n");
1206 ERR_print_errors(bio_err);
1212 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1216 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1217 crl = sk_X509_CRL_value(crls, i);
1218 X509_STORE_add_crl(st, crl);
1223 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1226 st = SSL_CTX_get_cert_store(ctx);
1227 add_crls_store(st, crls);
1229 store_setup_crl_download(st);
1233 int ssl_load_stores(SSL_CTX *ctx,
1234 const char *vfyCApath, const char *vfyCAfile,
1235 const char *chCApath, const char *chCAfile,
1236 STACK_OF(X509_CRL) *crls, int crl_download)
1238 X509_STORE *vfy = NULL, *ch = NULL;
1240 if (vfyCApath != NULL || vfyCAfile != NULL) {
1241 vfy = X509_STORE_new();
1244 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1246 add_crls_store(vfy, crls);
1247 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1249 store_setup_crl_download(vfy);
1251 if (chCApath != NULL || chCAfile != NULL) {
1252 ch = X509_STORE_new();
1255 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1257 SSL_CTX_set1_chain_cert_store(ctx, ch);
1261 X509_STORE_free(vfy);
1262 X509_STORE_free(ch);
1266 /* Verbose print out of security callback */
1271 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1272 void *other, void *ex);
1273 } security_debug_ex;
1275 static STRINT_PAIR callback_types[] = {
1276 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1277 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1278 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1279 #ifndef OPENSSL_NO_DH
1280 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1282 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1283 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1284 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1285 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1286 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1287 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1288 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1289 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1290 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1291 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1292 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1293 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1294 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1295 {"SSL compression", SSL_SECOP_COMPRESSION},
1296 {"Session ticket", SSL_SECOP_TICKET},
1300 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1301 int op, int bits, int nid,
1302 void *other, void *ex)
1304 security_debug_ex *sdb = ex;
1305 int rv, show_bits = 1, cert_md = 0;
1307 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1308 if (rv == 1 && sdb->verbose < 2)
1310 BIO_puts(sdb->out, "Security callback: ");
1312 nm = lookup(op, callback_types, NULL);
1314 case SSL_SECOP_TICKET:
1315 case SSL_SECOP_COMPRESSION:
1319 case SSL_SECOP_VERSION:
1320 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1324 case SSL_SECOP_CA_MD:
1325 case SSL_SECOP_PEER_CA_MD:
1330 BIO_printf(sdb->out, "%s=", nm);
1332 switch (op & SSL_SECOP_OTHER_TYPE) {
1334 case SSL_SECOP_OTHER_CIPHER:
1335 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1338 #ifndef OPENSSL_NO_EC
1339 case SSL_SECOP_OTHER_CURVE:
1342 cname = EC_curve_nid2nist(nid);
1344 cname = OBJ_nid2sn(nid);
1345 BIO_puts(sdb->out, cname);
1349 #ifndef OPENSSL_NO_DH
1350 case SSL_SECOP_OTHER_DH:
1353 BIO_printf(sdb->out, "%d", DH_bits(dh));
1357 case SSL_SECOP_OTHER_CERT:
1360 int sig_nid = X509_get_signature_nid(other);
1361 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1363 EVP_PKEY *pkey = X509_get0_pubkey(other);
1364 const char *algname = "";
1365 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1366 &algname, EVP_PKEY_get0_asn1(pkey));
1367 BIO_printf(sdb->out, "%s, bits=%d",
1368 algname, EVP_PKEY_bits(pkey));
1372 case SSL_SECOP_OTHER_SIGALG:
1374 const unsigned char *salg = other;
1375 const char *sname = NULL;
1377 case TLSEXT_signature_anonymous:
1378 sname = "anonymous";
1380 case TLSEXT_signature_rsa:
1383 case TLSEXT_signature_dsa:
1386 case TLSEXT_signature_ecdsa:
1391 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1393 BIO_printf(sdb->out, ", algorithm=%s", sname);
1395 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1402 BIO_printf(sdb->out, ", security bits=%d", bits);
1403 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1407 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1409 static security_debug_ex sdb;
1412 sdb.verbose = verbose;
1413 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1414 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1415 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1418 static void keylog_callback(const SSL *ssl, const char *line)
1420 if (bio_keylog == NULL) {
1421 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1426 * There might be concurrent writers to the keylog file, so we must ensure
1427 * that the given line is written at once.
1429 BIO_printf(bio_keylog, "%s\n", line);
1430 (void)BIO_flush(bio_keylog);
1433 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1435 /* Close any open files */
1436 BIO_free_all(bio_keylog);
1439 if (ctx == NULL || keylog_file == NULL) {
1440 /* Keylogging is disabled, OK. */
1445 * Append rather than write in order to allow concurrent modification.
1446 * Furthermore, this preserves existing keylog files which is useful when
1447 * the tool is run multiple times.
1449 bio_keylog = BIO_new_file(keylog_file, "a");
1450 if (bio_keylog == NULL) {
1451 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1455 /* Write a header for seekable, empty files (this excludes pipes). */
1456 if (BIO_tell(bio_keylog) == 0) {
1457 BIO_puts(bio_keylog,
1458 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1459 (void)BIO_flush(bio_keylog);
1461 SSL_CTX_set_keylog_callback(ctx, keylog_callback);
1465 void print_ca_names(BIO *bio, SSL *s)
1467 const char *cs = SSL_is_server(s) ? "server" : "client";
1468 const STACK_OF(X509_NAME) *sk = SSL_get0_peer_CA_list(s);
1471 if (sk == NULL || sk_X509_NAME_num(sk) == 0) {
1472 BIO_printf(bio, "---\nNo %s certificate CA names sent\n", cs);
1476 BIO_printf(bio, "---\nAcceptable %s certificate CA names\n",cs);
1477 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
1478 X509_NAME_print_ex(bio, sk_X509_NAME_value(sk, i), 0, get_nameopt());
1479 BIO_write(bio, "\n", 1);