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:
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},
669 {"post handshake auth", TLSEXT_TYPE_post_handshake_auth},
673 void tlsext_cb(SSL *s, int client_server, int type,
674 const unsigned char *data, int len, void *arg)
677 const char *extname = lookup(type, tlsext_types, "unknown");
679 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
680 client_server ? "server" : "client", extname, type, len);
681 BIO_dump(bio, (const char *)data, len);
682 (void)BIO_flush(bio);
685 #ifndef OPENSSL_NO_SOCK
686 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
687 unsigned int *cookie_len)
689 unsigned char *buffer;
692 BIO_ADDR *lpeer = NULL, *peer = NULL;
694 /* Initialize a random secret */
695 if (!cookie_initialized) {
696 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
697 BIO_printf(bio_err, "error setting random cookie secret\n");
700 cookie_initialized = 1;
703 if (SSL_is_dtls(ssl)) {
704 lpeer = peer = BIO_ADDR_new();
706 BIO_printf(bio_err, "memory full\n");
710 /* Read peer information */
711 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
716 /* Create buffer with peer's address and port */
717 if (!BIO_ADDR_rawaddress(peer, NULL, &length)) {
718 BIO_printf(bio_err, "Failed getting peer address\n");
721 OPENSSL_assert(length != 0);
722 port = BIO_ADDR_rawport(peer);
723 length += sizeof(port);
724 buffer = app_malloc(length, "cookie generate buffer");
726 memcpy(buffer, &port, sizeof(port));
727 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
729 /* Calculate HMAC of buffer using the secret */
730 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
731 buffer, length, cookie, cookie_len);
733 OPENSSL_free(buffer);
734 BIO_ADDR_free(lpeer);
739 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
740 unsigned int cookie_len)
742 unsigned char result[EVP_MAX_MD_SIZE];
743 unsigned int resultlength;
745 /* Note: we check cookie_initialized because if it's not,
746 * it cannot be valid */
747 if (cookie_initialized
748 && generate_cookie_callback(ssl, result, &resultlength)
749 && cookie_len == resultlength
750 && memcmp(result, cookie, resultlength) == 0)
758 * Example of extended certificate handling. Where the standard support of
759 * one certificate per algorithm is not sufficient an application can decide
760 * which certificate(s) to use at runtime based on whatever criteria it deems
764 /* Linked list of certificates, keys and chains */
765 struct ssl_excert_st {
767 const char *certfile;
770 const char *chainfile;
773 STACK_OF(X509) *chain;
775 struct ssl_excert_st *next, *prev;
778 static STRINT_PAIR chain_flags[] = {
779 {"Overall Validity", CERT_PKEY_VALID},
780 {"Sign with EE key", CERT_PKEY_SIGN},
781 {"EE signature", CERT_PKEY_EE_SIGNATURE},
782 {"CA signature", CERT_PKEY_CA_SIGNATURE},
783 {"EE key parameters", CERT_PKEY_EE_PARAM},
784 {"CA key parameters", CERT_PKEY_CA_PARAM},
785 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
786 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
787 {"Certificate Type", CERT_PKEY_CERT_TYPE},
791 static void print_chain_flags(SSL *s, int flags)
795 for (pp = chain_flags; pp->name; ++pp)
796 BIO_printf(bio_err, "\t%s: %s\n",
798 (flags & pp->retval) ? "OK" : "NOT OK");
799 BIO_printf(bio_err, "\tSuite B: ");
800 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
801 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
803 BIO_printf(bio_err, "not tested\n");
807 * Very basic selection callback: just use any certificate chain reported as
808 * valid. More sophisticated could prioritise according to local policy.
810 static int set_cert_cb(SSL *ssl, void *arg)
813 SSL_EXCERT *exc = arg;
814 #ifdef CERT_CB_TEST_RETRY
815 static int retry_cnt;
819 "Certificate callback retry test: count %d\n",
824 SSL_certs_clear(ssl);
830 * Go to end of list and traverse backwards since we prepend newer
831 * entries this retains the original order.
833 while (exc->next != NULL)
838 while (exc != NULL) {
840 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
841 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
842 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
844 BIO_puts(bio_err, "\n");
845 print_chain_flags(ssl, rv);
846 if (rv & CERT_PKEY_VALID) {
847 if (!SSL_use_certificate(ssl, exc->cert)
848 || !SSL_use_PrivateKey(ssl, exc->key)) {
852 * NB: we wouldn't normally do this as it is not efficient
853 * building chains on each connection better to cache the chain
856 if (exc->build_chain) {
857 if (!SSL_build_cert_chain(ssl, 0))
859 } else if (exc->chain != NULL) {
860 SSL_set1_chain(ssl, exc->chain);
868 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
870 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
873 static int ssl_excert_prepend(SSL_EXCERT **pexc)
875 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
877 memset(exc, 0, sizeof(*exc));
883 exc->certform = exc->next->certform;
884 exc->keyform = exc->next->keyform;
885 exc->next->prev = exc;
887 exc->certform = FORMAT_PEM;
888 exc->keyform = FORMAT_PEM;
894 void ssl_excert_free(SSL_EXCERT *exc)
901 X509_free(exc->cert);
902 EVP_PKEY_free(exc->key);
903 sk_X509_pop_free(exc->chain, X509_free);
910 int load_excert(SSL_EXCERT **pexc)
912 SSL_EXCERT *exc = *pexc;
915 /* If nothing in list, free and set to NULL */
916 if (exc->certfile == NULL && exc->next == NULL) {
917 ssl_excert_free(exc);
921 for (; exc; exc = exc->next) {
922 if (exc->certfile == NULL) {
923 BIO_printf(bio_err, "Missing filename\n");
926 exc->cert = load_cert(exc->certfile, exc->certform,
927 "Server Certificate");
928 if (exc->cert == NULL)
930 if (exc->keyfile != NULL) {
931 exc->key = load_key(exc->keyfile, exc->keyform,
932 0, NULL, NULL, "Server Key");
934 exc->key = load_key(exc->certfile, exc->certform,
935 0, NULL, NULL, "Server Key");
937 if (exc->key == NULL)
939 if (exc->chainfile != NULL) {
940 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
948 enum range { OPT_X_ENUM };
950 int args_excert(int opt, SSL_EXCERT **pexc)
952 SSL_EXCERT *exc = *pexc;
954 assert(opt > OPT_X__FIRST);
955 assert(opt < OPT_X__LAST);
958 if (!ssl_excert_prepend(&exc)) {
959 BIO_printf(bio_err, " %s: Error initialising xcert\n",
966 switch ((enum range)opt) {
971 if (exc->certfile != NULL && !ssl_excert_prepend(&exc)) {
972 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
976 exc->certfile = opt_arg();
979 if (exc->keyfile != NULL) {
980 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
983 exc->keyfile = opt_arg();
986 if (exc->chainfile != NULL) {
987 BIO_printf(bio_err, "%s: Chain already specified\n",
991 exc->chainfile = opt_arg();
993 case OPT_X_CHAIN_BUILD:
994 exc->build_chain = 1;
997 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
1001 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
1008 ERR_print_errors(bio_err);
1009 ssl_excert_free(exc);
1014 static void print_raw_cipherlist(SSL *s)
1016 const unsigned char *rlist;
1017 static const unsigned char scsv_id[] = { 0, 0xFF };
1018 size_t i, rlistlen, num;
1019 if (!SSL_is_server(s))
1021 num = SSL_get0_raw_cipherlist(s, NULL);
1022 OPENSSL_assert(num == 2);
1023 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1024 BIO_puts(bio_err, "Client cipher list: ");
1025 for (i = 0; i < rlistlen; i += num, rlist += num) {
1026 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1028 BIO_puts(bio_err, ":");
1030 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1031 } else if (memcmp(rlist, scsv_id, num) == 0) {
1032 BIO_puts(bio_err, "SCSV");
1035 BIO_puts(bio_err, "0x");
1036 for (j = 0; j < num; j++)
1037 BIO_printf(bio_err, "%02X", rlist[j]);
1040 BIO_puts(bio_err, "\n");
1044 * Hex encoder for TLSA RRdata, not ':' delimited.
1046 static char *hexencode(const unsigned char *data, size_t len)
1048 static const char *hex = "0123456789abcdef";
1051 size_t outlen = 2 * len + 1;
1052 int ilen = (int) outlen;
1054 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1055 BIO_printf(bio_err, "%s: %zu-byte buffer too large to hexencode\n",
1056 opt_getprog(), len);
1059 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1062 *cp++ = hex[(*data >> 4) & 0x0f];
1063 *cp++ = hex[*data++ & 0x0f];
1069 void print_verify_detail(SSL *s, BIO *bio)
1073 long verify_err = SSL_get_verify_result(s);
1075 if (verify_err == X509_V_OK) {
1076 const char *peername = SSL_get0_peername(s);
1078 BIO_printf(bio, "Verification: OK\n");
1079 if (peername != NULL)
1080 BIO_printf(bio, "Verified peername: %s\n", peername);
1082 const char *reason = X509_verify_cert_error_string(verify_err);
1084 BIO_printf(bio, "Verification error: %s\n", reason);
1087 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1088 uint8_t usage, selector, mtype;
1089 const unsigned char *data = NULL;
1093 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1096 * The TLSA data field can be quite long when it is a certificate,
1097 * public key or even a SHA2-512 digest. Because the initial octets of
1098 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1099 * and lengths, we show the last 12 bytes of the data instead, as these
1100 * are more likely to distinguish distinct TLSA records.
1102 #define TLSA_TAIL_SIZE 12
1103 if (dlen > TLSA_TAIL_SIZE)
1104 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1106 hexdata = hexencode(data, dlen);
1107 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1108 usage, selector, mtype,
1109 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1110 (mspki != NULL) ? "signed the certificate" :
1111 mdpth ? "matched TA certificate" : "matched EE certificate",
1113 OPENSSL_free(hexdata);
1117 void print_ssl_summary(SSL *s)
1119 const SSL_CIPHER *c;
1122 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1123 print_raw_cipherlist(s);
1124 c = SSL_get_current_cipher(s);
1125 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1126 do_print_sigalgs(bio_err, s, 0);
1127 peer = SSL_get_peer_certificate(s);
1131 BIO_puts(bio_err, "Peer certificate: ");
1132 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1134 BIO_puts(bio_err, "\n");
1135 if (SSL_get_peer_signature_nid(s, &nid))
1136 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1137 if (SSL_get_peer_signature_type_nid(s, &nid))
1138 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1139 print_verify_detail(s, bio_err);
1141 BIO_puts(bio_err, "No peer certificate\n");
1144 #ifndef OPENSSL_NO_EC
1145 ssl_print_point_formats(bio_err, s);
1146 if (SSL_is_server(s))
1147 ssl_print_groups(bio_err, s, 1);
1149 ssl_print_tmp_key(bio_err, s);
1151 if (!SSL_is_server(s))
1152 ssl_print_tmp_key(bio_err, s);
1156 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1161 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1162 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1163 const char *flag = sk_OPENSSL_STRING_value(str, i);
1164 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1165 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1167 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1170 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1171 ERR_print_errors(bio_err);
1175 if (!SSL_CONF_CTX_finish(cctx)) {
1176 BIO_puts(bio_err, "Error finishing context\n");
1177 ERR_print_errors(bio_err);
1183 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1187 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1188 crl = sk_X509_CRL_value(crls, i);
1189 X509_STORE_add_crl(st, crl);
1194 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1197 st = SSL_CTX_get_cert_store(ctx);
1198 add_crls_store(st, crls);
1200 store_setup_crl_download(st);
1204 int ssl_load_stores(SSL_CTX *ctx,
1205 const char *vfyCApath, const char *vfyCAfile,
1206 const char *chCApath, const char *chCAfile,
1207 STACK_OF(X509_CRL) *crls, int crl_download)
1209 X509_STORE *vfy = NULL, *ch = NULL;
1211 if (vfyCApath != NULL || vfyCAfile != NULL) {
1212 vfy = X509_STORE_new();
1215 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1217 add_crls_store(vfy, crls);
1218 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1220 store_setup_crl_download(vfy);
1222 if (chCApath != NULL || chCAfile != NULL) {
1223 ch = X509_STORE_new();
1226 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1228 SSL_CTX_set1_chain_cert_store(ctx, ch);
1232 X509_STORE_free(vfy);
1233 X509_STORE_free(ch);
1237 /* Verbose print out of security callback */
1242 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1243 void *other, void *ex);
1244 } security_debug_ex;
1246 static STRINT_PAIR callback_types[] = {
1247 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1248 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1249 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1250 #ifndef OPENSSL_NO_DH
1251 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1253 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1254 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1255 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1256 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1257 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1258 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1259 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1260 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1261 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1262 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1263 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1264 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1265 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1266 {"SSL compression", SSL_SECOP_COMPRESSION},
1267 {"Session ticket", SSL_SECOP_TICKET},
1271 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1272 int op, int bits, int nid,
1273 void *other, void *ex)
1275 security_debug_ex *sdb = ex;
1276 int rv, show_bits = 1, cert_md = 0;
1278 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1279 if (rv == 1 && sdb->verbose < 2)
1281 BIO_puts(sdb->out, "Security callback: ");
1283 nm = lookup(op, callback_types, NULL);
1285 case SSL_SECOP_TICKET:
1286 case SSL_SECOP_COMPRESSION:
1290 case SSL_SECOP_VERSION:
1291 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1295 case SSL_SECOP_CA_MD:
1296 case SSL_SECOP_PEER_CA_MD:
1301 BIO_printf(sdb->out, "%s=", nm);
1303 switch (op & SSL_SECOP_OTHER_TYPE) {
1305 case SSL_SECOP_OTHER_CIPHER:
1306 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1309 #ifndef OPENSSL_NO_EC
1310 case SSL_SECOP_OTHER_CURVE:
1313 cname = EC_curve_nid2nist(nid);
1315 cname = OBJ_nid2sn(nid);
1316 BIO_puts(sdb->out, cname);
1320 #ifndef OPENSSL_NO_DH
1321 case SSL_SECOP_OTHER_DH:
1324 BIO_printf(sdb->out, "%d", DH_bits(dh));
1328 case SSL_SECOP_OTHER_CERT:
1331 int sig_nid = X509_get_signature_nid(other);
1332 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1334 EVP_PKEY *pkey = X509_get0_pubkey(other);
1335 const char *algname = "";
1336 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1337 &algname, EVP_PKEY_get0_asn1(pkey));
1338 BIO_printf(sdb->out, "%s, bits=%d",
1339 algname, EVP_PKEY_bits(pkey));
1343 case SSL_SECOP_OTHER_SIGALG:
1345 const unsigned char *salg = other;
1346 const char *sname = NULL;
1348 case TLSEXT_signature_anonymous:
1349 sname = "anonymous";
1351 case TLSEXT_signature_rsa:
1354 case TLSEXT_signature_dsa:
1357 case TLSEXT_signature_ecdsa:
1362 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1364 BIO_printf(sdb->out, ", algorithm=%s", sname);
1366 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1373 BIO_printf(sdb->out, ", security bits=%d", bits);
1374 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1378 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1380 static security_debug_ex sdb;
1383 sdb.verbose = verbose;
1384 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1385 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1386 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1389 static void keylog_callback(const SSL *ssl, const char *line)
1391 if (bio_keylog == NULL) {
1392 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1397 * There might be concurrent writers to the keylog file, so we must ensure
1398 * that the given line is written at once.
1400 BIO_printf(bio_keylog, "%s\n", line);
1401 (void)BIO_flush(bio_keylog);
1404 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1406 /* Close any open files */
1407 BIO_free_all(bio_keylog);
1410 if (ctx == NULL || keylog_file == NULL) {
1411 /* Keylogging is disabled, OK. */
1416 * Append rather than write in order to allow concurrent modification.
1417 * Furthermore, this preserves existing keylog files which is useful when
1418 * the tool is run multiple times.
1420 bio_keylog = BIO_new_file(keylog_file, "a");
1421 if (bio_keylog == NULL) {
1422 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1426 /* Write a header for seekable, empty files (this excludes pipes). */
1427 if (BIO_tell(bio_keylog) == 0) {
1428 BIO_puts(bio_keylog,
1429 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1430 (void)BIO_flush(bio_keylog);
1432 SSL_CTX_set_keylog_callback(ctx, keylog_callback);
1436 void print_ca_names(BIO *bio, SSL *s)
1438 const char *cs = SSL_is_server(s) ? "server" : "client";
1439 const STACK_OF(X509_NAME) *sk = SSL_get0_peer_CA_list(s);
1442 if (sk == NULL || sk_X509_NAME_num(sk) == 0) {
1443 BIO_printf(bio, "---\nNo %s certificate CA names sent\n", cs);
1447 BIO_printf(bio, "---\nAcceptable %s certificate CA names\n",cs);
1448 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
1449 X509_NAME_print_ex(bio, sk_X509_NAME_value(sk, i), 0, get_nameopt());
1450 BIO_write(bio, "\n", 1);