2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* callback functions used by s_client, s_server, and s_time */
13 #include <string.h> /* for memcpy() and strcmp() */
17 #include <openssl/err.h>
18 #include <openssl/rand.h>
19 #include <openssl/x509.h>
20 #include <openssl/ssl.h>
21 #include <openssl/bn.h>
23 # include <openssl/dh.h>
27 #define COOKIE_SECRET_LENGTH 16
29 VERIFY_CB_ARGS verify_args = { 0, 0, X509_V_OK, 0 };
31 #ifndef OPENSSL_NO_SOCK
32 static unsigned char cookie_secret[COOKIE_SECRET_LENGTH];
33 static int cookie_initialized = 0;
35 static BIO *bio_keylog = NULL;
37 static const char *lookup(int val, const STRINT_PAIR* list, const char* def)
39 for ( ; list->name; ++list)
40 if (list->retval == val)
45 int verify_callback(int ok, X509_STORE_CTX *ctx)
50 err_cert = X509_STORE_CTX_get_current_cert(ctx);
51 err = X509_STORE_CTX_get_error(ctx);
52 depth = X509_STORE_CTX_get_error_depth(ctx);
54 if (!verify_args.quiet || !ok) {
55 BIO_printf(bio_err, "depth=%d ", depth);
57 X509_NAME_print_ex(bio_err,
58 X509_get_subject_name(err_cert),
60 BIO_puts(bio_err, "\n");
62 BIO_puts(bio_err, "<no cert>\n");
65 BIO_printf(bio_err, "verify error:num=%d:%s\n", err,
66 X509_verify_cert_error_string(err));
67 if (verify_args.depth >= depth) {
68 if (!verify_args.return_error)
70 verify_args.error = err;
73 verify_args.error = X509_V_ERR_CERT_CHAIN_TOO_LONG;
77 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
78 BIO_puts(bio_err, "issuer= ");
79 X509_NAME_print_ex(bio_err, X509_get_issuer_name(err_cert),
81 BIO_puts(bio_err, "\n");
83 case X509_V_ERR_CERT_NOT_YET_VALID:
84 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
85 BIO_printf(bio_err, "notBefore=");
86 ASN1_TIME_print(bio_err, X509_get0_notBefore(err_cert));
87 BIO_printf(bio_err, "\n");
89 case X509_V_ERR_CERT_HAS_EXPIRED:
90 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
91 BIO_printf(bio_err, "notAfter=");
92 ASN1_TIME_print(bio_err, X509_get0_notAfter(err_cert));
93 BIO_printf(bio_err, "\n");
95 case X509_V_ERR_NO_EXPLICIT_POLICY:
96 if (!verify_args.quiet)
100 if (err == X509_V_OK && ok == 2 && !verify_args.quiet)
102 if (ok && !verify_args.quiet)
103 BIO_printf(bio_err, "verify return:%d\n", ok);
107 int set_cert_stuff(SSL_CTX *ctx, char *cert_file, char *key_file)
109 if (cert_file != NULL) {
110 if (SSL_CTX_use_certificate_file(ctx, cert_file,
111 SSL_FILETYPE_PEM) <= 0) {
112 BIO_printf(bio_err, "unable to get certificate from '%s'\n",
114 ERR_print_errors(bio_err);
117 if (key_file == NULL)
118 key_file = cert_file;
119 if (SSL_CTX_use_PrivateKey_file(ctx, key_file, SSL_FILETYPE_PEM) <= 0) {
120 BIO_printf(bio_err, "unable to get private key from '%s'\n",
122 ERR_print_errors(bio_err);
127 * If we are using DSA, we can copy the parameters from the private
132 * Now we know that a key and cert have been set against the SSL
135 if (!SSL_CTX_check_private_key(ctx)) {
137 "Private key does not match the certificate public key\n");
144 int set_cert_key_stuff(SSL_CTX *ctx, X509 *cert, EVP_PKEY *key,
145 STACK_OF(X509) *chain, int build_chain)
147 int chflags = chain ? SSL_BUILD_CHAIN_FLAG_CHECK : 0;
150 if (SSL_CTX_use_certificate(ctx, cert) <= 0) {
151 BIO_printf(bio_err, "error setting certificate\n");
152 ERR_print_errors(bio_err);
156 if (SSL_CTX_use_PrivateKey(ctx, key) <= 0) {
157 BIO_printf(bio_err, "error setting private key\n");
158 ERR_print_errors(bio_err);
163 * Now we know that a key and cert have been set against the SSL context
165 if (!SSL_CTX_check_private_key(ctx)) {
167 "Private key does not match the certificate public key\n");
170 if (chain && !SSL_CTX_set1_chain(ctx, chain)) {
171 BIO_printf(bio_err, "error setting certificate chain\n");
172 ERR_print_errors(bio_err);
175 if (build_chain && !SSL_CTX_build_cert_chain(ctx, chflags)) {
176 BIO_printf(bio_err, "error building certificate chain\n");
177 ERR_print_errors(bio_err);
183 static STRINT_PAIR cert_type_list[] = {
184 {"RSA sign", TLS_CT_RSA_SIGN},
185 {"DSA sign", TLS_CT_DSS_SIGN},
186 {"RSA fixed DH", TLS_CT_RSA_FIXED_DH},
187 {"DSS fixed DH", TLS_CT_DSS_FIXED_DH},
188 {"ECDSA sign", TLS_CT_ECDSA_SIGN},
189 {"RSA fixed ECDH", TLS_CT_RSA_FIXED_ECDH},
190 {"ECDSA fixed ECDH", TLS_CT_ECDSA_FIXED_ECDH},
191 {"GOST01 Sign", TLS_CT_GOST01_SIGN},
195 static void ssl_print_client_cert_types(BIO *bio, SSL *s)
197 const unsigned char *p;
199 int cert_type_num = SSL_get0_certificate_types(s, &p);
202 BIO_puts(bio, "Client Certificate Types: ");
203 for (i = 0; i < cert_type_num; i++) {
204 unsigned char cert_type = p[i];
205 const char *cname = lookup((int)cert_type, cert_type_list, NULL);
210 BIO_puts(bio, cname);
212 BIO_printf(bio, "UNKNOWN (%d),", cert_type);
217 static const char *get_sigtype(int nid)
223 case EVP_PKEY_RSA_PSS:
237 static int do_print_sigalgs(BIO *out, SSL *s, int shared)
240 client = SSL_is_server(s) ? 0 : 1;
242 nsig = SSL_get_shared_sigalgs(s, 0, NULL, NULL, NULL, NULL, NULL);
244 nsig = SSL_get_sigalgs(s, -1, NULL, NULL, NULL, NULL, NULL);
249 BIO_puts(out, "Shared ");
252 BIO_puts(out, "Requested ");
253 BIO_puts(out, "Signature Algorithms: ");
254 for (i = 0; i < nsig; i++) {
255 int hash_nid, sign_nid;
256 unsigned char rhash, rsign;
257 const char *sstr = NULL;
259 SSL_get_shared_sigalgs(s, i, &sign_nid, &hash_nid, NULL,
262 SSL_get_sigalgs(s, i, &sign_nid, &hash_nid, NULL, &rsign, &rhash);
265 sstr = get_sigtype(sign_nid);
267 BIO_printf(out, "%s+", sstr);
269 BIO_printf(out, "0x%02X+", (int)rsign);
270 if (hash_nid != NID_undef)
271 BIO_printf(out, "%s", OBJ_nid2sn(hash_nid));
273 BIO_printf(out, "0x%02X", (int)rhash);
279 int ssl_print_sigalgs(BIO *out, SSL *s)
282 if (!SSL_is_server(s))
283 ssl_print_client_cert_types(out, s);
284 do_print_sigalgs(out, s, 0);
285 do_print_sigalgs(out, s, 1);
286 if (SSL_get_peer_signature_nid(s, &nid))
287 BIO_printf(out, "Peer signing digest: %s\n", OBJ_nid2sn(nid));
288 if (SSL_get_peer_signature_type_nid(s, &nid))
289 BIO_printf(bio_err, "Peer signature type: %s\n", get_sigtype(nid));
293 #ifndef OPENSSL_NO_EC
294 int ssl_print_point_formats(BIO *out, SSL *s)
297 const char *pformats;
298 nformats = SSL_get0_ec_point_formats(s, &pformats);
301 BIO_puts(out, "Supported Elliptic Curve Point Formats: ");
302 for (i = 0; i < nformats; i++, pformats++) {
306 case TLSEXT_ECPOINTFORMAT_uncompressed:
307 BIO_puts(out, "uncompressed");
310 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime:
311 BIO_puts(out, "ansiX962_compressed_prime");
314 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2:
315 BIO_puts(out, "ansiX962_compressed_char2");
319 BIO_printf(out, "unknown(%d)", (int)*pformats);
328 int ssl_print_groups(BIO *out, SSL *s, int noshared)
330 int i, ngroups, *groups, nid;
333 ngroups = SSL_get1_groups(s, NULL);
336 groups = app_malloc(ngroups * sizeof(int), "groups to print");
337 SSL_get1_groups(s, groups);
339 BIO_puts(out, "Supported Elliptic Groups: ");
340 for (i = 0; i < ngroups; i++) {
344 /* If unrecognised print out hex version */
345 if (nid & TLSEXT_nid_unknown)
346 BIO_printf(out, "0x%04X", nid & 0xFFFF);
348 /* TODO(TLS1.3): Get group name here */
349 /* Use NIST name for curve if it exists */
350 gname = EC_curve_nid2nist(nid);
352 gname = OBJ_nid2sn(nid);
353 BIO_printf(out, "%s", gname);
356 OPENSSL_free(groups);
361 BIO_puts(out, "\nShared Elliptic groups: ");
362 ngroups = SSL_get_shared_group(s, -1);
363 for (i = 0; i < ngroups; i++) {
366 nid = SSL_get_shared_group(s, i);
367 /* TODO(TLS1.3): Convert for DH groups */
368 gname = EC_curve_nid2nist(nid);
370 gname = OBJ_nid2sn(nid);
371 BIO_printf(out, "%s", gname);
374 BIO_puts(out, "NONE");
379 int ssl_print_tmp_key(BIO *out, SSL *s)
382 if (!SSL_get_server_tmp_key(s, &key))
384 BIO_puts(out, "Server Temp Key: ");
385 switch (EVP_PKEY_id(key)) {
387 BIO_printf(out, "RSA, %d bits\n", EVP_PKEY_bits(key));
391 BIO_printf(out, "DH, %d bits\n", EVP_PKEY_bits(key));
393 #ifndef OPENSSL_NO_EC
396 EC_KEY *ec = EVP_PKEY_get1_EC_KEY(key);
399 nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
401 cname = EC_curve_nid2nist(nid);
403 cname = OBJ_nid2sn(nid);
404 BIO_printf(out, "ECDH, %s, %d bits\n", cname, EVP_PKEY_bits(key));
409 BIO_printf(out, "%s, %d bits\n", OBJ_nid2sn(EVP_PKEY_id(key)),
416 long bio_dump_callback(BIO *bio, int cmd, const char *argp,
417 int argi, long argl, long ret)
421 out = (BIO *)BIO_get_callback_arg(bio);
425 if (cmd == (BIO_CB_READ | BIO_CB_RETURN)) {
426 BIO_printf(out, "read from %p [%p] (%lu bytes => %ld (0x%lX))\n",
427 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
428 BIO_dump(out, argp, (int)ret);
430 } else if (cmd == (BIO_CB_WRITE | BIO_CB_RETURN)) {
431 BIO_printf(out, "write to %p [%p] (%lu bytes => %ld (0x%lX))\n",
432 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
433 BIO_dump(out, argp, (int)ret);
438 void apps_ssl_info_callback(const SSL *s, int where, int ret)
443 w = where & ~SSL_ST_MASK;
445 if (w & SSL_ST_CONNECT)
447 else if (w & SSL_ST_ACCEPT)
452 if (where & SSL_CB_LOOP) {
453 BIO_printf(bio_err, "%s:%s\n", str, SSL_state_string_long(s));
454 } else if (where & SSL_CB_ALERT) {
455 str = (where & SSL_CB_READ) ? "read" : "write";
456 BIO_printf(bio_err, "SSL3 alert %s:%s:%s\n",
458 SSL_alert_type_string_long(ret),
459 SSL_alert_desc_string_long(ret));
460 } else if (where & SSL_CB_EXIT) {
462 BIO_printf(bio_err, "%s:failed in %s\n",
463 str, SSL_state_string_long(s));
465 BIO_printf(bio_err, "%s:error in %s\n",
466 str, SSL_state_string_long(s));
471 static STRINT_PAIR ssl_versions[] = {
472 {"SSL 3.0", SSL3_VERSION},
473 {"TLS 1.0", TLS1_VERSION},
474 {"TLS 1.1", TLS1_1_VERSION},
475 {"TLS 1.2", TLS1_2_VERSION},
476 {"TLS 1.3", TLS1_3_VERSION},
477 {"DTLS 1.0", DTLS1_VERSION},
478 {"DTLS 1.0 (bad)", DTLS1_BAD_VER},
481 static STRINT_PAIR alert_types[] = {
482 {" close_notify", 0},
483 {" unexpected_message", 10},
484 {" bad_record_mac", 20},
485 {" decryption_failed", 21},
486 {" record_overflow", 22},
487 {" decompression_failure", 30},
488 {" handshake_failure", 40},
489 {" bad_certificate", 42},
490 {" unsupported_certificate", 43},
491 {" certificate_revoked", 44},
492 {" certificate_expired", 45},
493 {" certificate_unknown", 46},
494 {" illegal_parameter", 47},
496 {" access_denied", 49},
497 {" decode_error", 50},
498 {" decrypt_error", 51},
499 {" export_restriction", 60},
500 {" protocol_version", 70},
501 {" insufficient_security", 71},
502 {" internal_error", 80},
503 {" user_canceled", 90},
504 {" no_renegotiation", 100},
505 {" unsupported_extension", 110},
506 {" certificate_unobtainable", 111},
507 {" unrecognized_name", 112},
508 {" bad_certificate_status_response", 113},
509 {" bad_certificate_hash_value", 114},
510 {" unknown_psk_identity", 115},
514 static STRINT_PAIR handshakes[] = {
515 {", HelloRequest", 0},
516 {", ClientHello", 1},
517 {", ServerHello", 2},
518 {", HelloVerifyRequest", 3},
519 {", NewSessionTicket", 4},
520 {", Certificate", 11},
521 {", ServerKeyExchange", 12},
522 {", CertificateRequest", 13},
523 {", ServerHelloDone", 14},
524 {", CertificateVerify", 15},
525 {", ClientKeyExchange", 16},
527 {", CertificateUrl", 21},
528 {", CertificateStatus", 22},
529 {", SupplementalData", 23},
533 void msg_cb(int write_p, int version, int content_type, const void *buf,
534 size_t len, SSL *ssl, void *arg)
537 const char *str_write_p = write_p ? ">>>" : "<<<";
538 const char *str_version = lookup(version, ssl_versions, "???");
539 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
540 const unsigned char* bp = buf;
542 if (version == SSL3_VERSION ||
543 version == TLS1_VERSION ||
544 version == TLS1_1_VERSION ||
545 version == TLS1_2_VERSION ||
546 version == TLS1_3_VERSION ||
547 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
548 switch (content_type) {
550 str_content_type = "ChangeCipherSpec";
553 str_content_type = "Alert";
554 str_details1 = ", ???";
558 str_details1 = ", warning";
561 str_details1 = ", fatal";
564 str_details2 = lookup((int)bp[1], alert_types, " ???");
568 str_content_type = "Handshake";
569 str_details1 = "???";
571 str_details1 = lookup((int)bp[0], handshakes, "???");
574 str_content_type = "ApplicationData";
576 #ifndef OPENSSL_NO_HEARTBEATS
578 str_details1 = ", Heartbeat";
583 str_details1 = ", HeartbeatRequest";
586 str_details1 = ", HeartbeatResponse";
595 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
596 str_content_type, (unsigned long)len, str_details1,
602 BIO_printf(bio, " ");
604 for (i = 0; i < num; i++) {
605 if (i % 16 == 0 && i > 0)
606 BIO_printf(bio, "\n ");
607 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
610 BIO_printf(bio, " ...");
611 BIO_printf(bio, "\n");
613 (void)BIO_flush(bio);
616 static STRINT_PAIR tlsext_types[] = {
617 {"server name", TLSEXT_TYPE_server_name},
618 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
619 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
620 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
621 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
622 {"status request", TLSEXT_TYPE_status_request},
623 {"user mapping", TLSEXT_TYPE_user_mapping},
624 {"client authz", TLSEXT_TYPE_client_authz},
625 {"server authz", TLSEXT_TYPE_server_authz},
626 {"cert type", TLSEXT_TYPE_cert_type},
627 {"supported_groups", TLSEXT_TYPE_supported_groups},
628 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
629 {"SRP", TLSEXT_TYPE_srp},
630 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
631 {"use SRTP", TLSEXT_TYPE_use_srtp},
632 {"heartbeat", TLSEXT_TYPE_heartbeat},
633 {"session ticket", TLSEXT_TYPE_session_ticket},
634 {"renegotiation info", TLSEXT_TYPE_renegotiate},
635 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
636 {"TLS padding", TLSEXT_TYPE_padding},
637 #ifdef TLSEXT_TYPE_next_proto_neg
638 {"next protocol", TLSEXT_TYPE_next_proto_neg},
640 #ifdef TLSEXT_TYPE_encrypt_then_mac
641 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
643 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
644 {"application layer protocol negotiation",
645 TLSEXT_TYPE_application_layer_protocol_negotiation},
647 #ifdef TLSEXT_TYPE_extended_master_secret
648 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
653 void tlsext_cb(SSL *s, int client_server, int type,
654 const unsigned char *data, int len, void *arg)
657 const char *extname = lookup(type, tlsext_types, "unknown");
659 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
660 client_server ? "server" : "client", extname, type, len);
661 BIO_dump(bio, (const char *)data, len);
662 (void)BIO_flush(bio);
665 #ifndef OPENSSL_NO_SOCK
666 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
667 unsigned int *cookie_len)
669 unsigned char *buffer;
672 BIO_ADDR *peer = NULL;
674 /* Initialize a random secret */
675 if (!cookie_initialized) {
676 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
677 BIO_printf(bio_err, "error setting random cookie secret\n");
680 cookie_initialized = 1;
683 peer = BIO_ADDR_new();
685 BIO_printf(bio_err, "memory full\n");
689 /* Read peer information */
690 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
692 /* Create buffer with peer's address and port */
693 BIO_ADDR_rawaddress(peer, NULL, &length);
694 OPENSSL_assert(length != 0);
695 port = BIO_ADDR_rawport(peer);
696 length += sizeof(port);
697 buffer = app_malloc(length, "cookie generate buffer");
699 memcpy(buffer, &port, sizeof(port));
700 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
702 /* Calculate HMAC of buffer using the secret */
703 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
704 buffer, length, cookie, cookie_len);
706 OPENSSL_free(buffer);
712 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
713 unsigned int cookie_len)
715 unsigned char result[EVP_MAX_MD_SIZE];
716 unsigned int resultlength;
718 /* Note: we check cookie_initialized because if it's not,
719 * it cannot be valid */
720 if (cookie_initialized
721 && generate_cookie_callback(ssl, result, &resultlength)
722 && cookie_len == resultlength
723 && memcmp(result, cookie, resultlength) == 0)
731 * Example of extended certificate handling. Where the standard support of
732 * one certificate per algorithm is not sufficient an application can decide
733 * which certificate(s) to use at runtime based on whatever criteria it deems
737 /* Linked list of certificates, keys and chains */
738 struct ssl_excert_st {
740 const char *certfile;
743 const char *chainfile;
746 STACK_OF(X509) *chain;
748 struct ssl_excert_st *next, *prev;
751 static STRINT_PAIR chain_flags[] = {
752 {"Overall Validity", CERT_PKEY_VALID},
753 {"Sign with EE key", CERT_PKEY_SIGN},
754 {"EE signature", CERT_PKEY_EE_SIGNATURE},
755 {"CA signature", CERT_PKEY_CA_SIGNATURE},
756 {"EE key parameters", CERT_PKEY_EE_PARAM},
757 {"CA key parameters", CERT_PKEY_CA_PARAM},
758 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
759 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
760 {"Certificate Type", CERT_PKEY_CERT_TYPE},
764 static void print_chain_flags(SSL *s, int flags)
768 for (pp = chain_flags; pp->name; ++pp)
769 BIO_printf(bio_err, "\t%s: %s\n",
771 (flags & pp->retval) ? "OK" : "NOT OK");
772 BIO_printf(bio_err, "\tSuite B: ");
773 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
774 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
776 BIO_printf(bio_err, "not tested\n");
780 * Very basic selection callback: just use any certificate chain reported as
781 * valid. More sophisticated could prioritise according to local policy.
783 static int set_cert_cb(SSL *ssl, void *arg)
786 SSL_EXCERT *exc = arg;
787 #ifdef CERT_CB_TEST_RETRY
788 static int retry_cnt;
792 "Certificate callback retry test: count %d\n",
797 SSL_certs_clear(ssl);
803 * Go to end of list and traverse backwards since we prepend newer
804 * entries this retains the original order.
813 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
814 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
815 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
817 BIO_puts(bio_err, "\n");
818 print_chain_flags(ssl, rv);
819 if (rv & CERT_PKEY_VALID) {
820 if (!SSL_use_certificate(ssl, exc->cert)
821 || !SSL_use_PrivateKey(ssl, exc->key)) {
825 * NB: we wouldn't normally do this as it is not efficient
826 * building chains on each connection better to cache the chain
829 if (exc->build_chain) {
830 if (!SSL_build_cert_chain(ssl, 0))
832 } else if (exc->chain)
833 SSL_set1_chain(ssl, exc->chain);
840 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
842 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
845 static int ssl_excert_prepend(SSL_EXCERT **pexc)
847 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
849 memset(exc, 0, sizeof(*exc));
855 exc->certform = exc->next->certform;
856 exc->keyform = exc->next->keyform;
857 exc->next->prev = exc;
859 exc->certform = FORMAT_PEM;
860 exc->keyform = FORMAT_PEM;
866 void ssl_excert_free(SSL_EXCERT *exc)
873 X509_free(exc->cert);
874 EVP_PKEY_free(exc->key);
875 sk_X509_pop_free(exc->chain, X509_free);
882 int load_excert(SSL_EXCERT **pexc)
884 SSL_EXCERT *exc = *pexc;
887 /* If nothing in list, free and set to NULL */
888 if (!exc->certfile && !exc->next) {
889 ssl_excert_free(exc);
893 for (; exc; exc = exc->next) {
894 if (!exc->certfile) {
895 BIO_printf(bio_err, "Missing filename\n");
898 exc->cert = load_cert(exc->certfile, exc->certform,
899 "Server Certificate");
903 exc->key = load_key(exc->keyfile, exc->keyform,
904 0, NULL, NULL, "Server Key");
906 exc->key = load_key(exc->certfile, exc->certform,
907 0, NULL, NULL, "Server Key");
911 if (exc->chainfile) {
912 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
920 enum range { OPT_X_ENUM };
922 int args_excert(int opt, SSL_EXCERT **pexc)
924 SSL_EXCERT *exc = *pexc;
926 assert(opt > OPT_X__FIRST);
927 assert(opt < OPT_X__LAST);
930 if (!ssl_excert_prepend(&exc)) {
931 BIO_printf(bio_err, " %s: Error initialising xcert\n",
938 switch ((enum range)opt) {
943 if (exc->certfile && !ssl_excert_prepend(&exc)) {
944 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
947 exc->certfile = opt_arg();
951 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
954 exc->keyfile = opt_arg();
957 if (exc->chainfile) {
958 BIO_printf(bio_err, "%s: Chain already specified\n",
962 exc->chainfile = opt_arg();
964 case OPT_X_CHAIN_BUILD:
965 exc->build_chain = 1;
968 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
972 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
979 ERR_print_errors(bio_err);
980 ssl_excert_free(exc);
985 static void print_raw_cipherlist(SSL *s)
987 const unsigned char *rlist;
988 static const unsigned char scsv_id[] = { 0, 0xFF };
989 size_t i, rlistlen, num;
990 if (!SSL_is_server(s))
992 num = SSL_get0_raw_cipherlist(s, NULL);
993 OPENSSL_assert(num == 2);
994 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
995 BIO_puts(bio_err, "Client cipher list: ");
996 for (i = 0; i < rlistlen; i += num, rlist += num) {
997 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
999 BIO_puts(bio_err, ":");
1001 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1002 else if (!memcmp(rlist, scsv_id, num))
1003 BIO_puts(bio_err, "SCSV");
1006 BIO_puts(bio_err, "0x");
1007 for (j = 0; j < num; j++)
1008 BIO_printf(bio_err, "%02X", rlist[j]);
1011 BIO_puts(bio_err, "\n");
1015 * Hex encoder for TLSA RRdata, not ':' delimited.
1017 static char *hexencode(const unsigned char *data, size_t len)
1019 static const char *hex = "0123456789abcdef";
1022 size_t outlen = 2 * len + 1;
1023 int ilen = (int) outlen;
1025 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1026 BIO_printf(bio_err, "%s: %" PRIu64 "-byte buffer too large to hexencode\n",
1027 opt_getprog(), (uint64_t)len);
1030 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1033 *cp++ = hex[(*data >> 4) & 0x0f];
1034 *cp++ = hex[*data++ & 0x0f];
1040 void print_verify_detail(SSL *s, BIO *bio)
1044 long verify_err = SSL_get_verify_result(s);
1046 if (verify_err == X509_V_OK) {
1047 const char *peername = SSL_get0_peername(s);
1049 BIO_printf(bio, "Verification: OK\n");
1050 if (peername != NULL)
1051 BIO_printf(bio, "Verified peername: %s\n", peername);
1053 const char *reason = X509_verify_cert_error_string(verify_err);
1055 BIO_printf(bio, "Verification error: %s\n", reason);
1058 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1059 uint8_t usage, selector, mtype;
1060 const unsigned char *data = NULL;
1064 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1067 * The TLSA data field can be quite long when it is a certificate,
1068 * public key or even a SHA2-512 digest. Because the initial octets of
1069 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1070 * and lengths, we show the last 12 bytes of the data instead, as these
1071 * are more likely to distinguish distinct TLSA records.
1073 #define TLSA_TAIL_SIZE 12
1074 if (dlen > TLSA_TAIL_SIZE)
1075 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1077 hexdata = hexencode(data, dlen);
1078 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1079 usage, selector, mtype,
1080 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1081 (mspki != NULL) ? "signed the certificate" :
1082 mdpth ? "matched TA certificate" : "matched EE certificate",
1084 OPENSSL_free(hexdata);
1088 void print_ssl_summary(SSL *s)
1090 const SSL_CIPHER *c;
1092 /* const char *pnam = SSL_is_server(s) ? "client" : "server"; */
1094 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1095 print_raw_cipherlist(s);
1096 c = SSL_get_current_cipher(s);
1097 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1098 do_print_sigalgs(bio_err, s, 0);
1099 peer = SSL_get_peer_certificate(s);
1103 BIO_puts(bio_err, "Peer certificate: ");
1104 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1105 0, XN_FLAG_ONELINE);
1106 BIO_puts(bio_err, "\n");
1107 if (SSL_get_peer_signature_nid(s, &nid))
1108 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1109 if (SSL_get_peer_signature_type_nid(s, &nid))
1110 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1111 print_verify_detail(s, bio_err);
1113 BIO_puts(bio_err, "No peer certificate\n");
1115 #ifndef OPENSSL_NO_EC
1116 ssl_print_point_formats(bio_err, s);
1117 if (SSL_is_server(s))
1118 ssl_print_groups(bio_err, s, 1);
1120 ssl_print_tmp_key(bio_err, s);
1122 if (!SSL_is_server(s))
1123 ssl_print_tmp_key(bio_err, s);
1127 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1132 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1133 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1134 const char *flag = sk_OPENSSL_STRING_value(str, i);
1135 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1136 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1138 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1141 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1142 ERR_print_errors(bio_err);
1146 if (!SSL_CONF_CTX_finish(cctx)) {
1147 BIO_puts(bio_err, "Error finishing context\n");
1148 ERR_print_errors(bio_err);
1154 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1158 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1159 crl = sk_X509_CRL_value(crls, i);
1160 X509_STORE_add_crl(st, crl);
1165 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1168 st = SSL_CTX_get_cert_store(ctx);
1169 add_crls_store(st, crls);
1171 store_setup_crl_download(st);
1175 int ssl_load_stores(SSL_CTX *ctx,
1176 const char *vfyCApath, const char *vfyCAfile,
1177 const char *chCApath, const char *chCAfile,
1178 STACK_OF(X509_CRL) *crls, int crl_download)
1180 X509_STORE *vfy = NULL, *ch = NULL;
1182 if (vfyCApath != NULL || vfyCAfile != NULL) {
1183 vfy = X509_STORE_new();
1186 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1188 add_crls_store(vfy, crls);
1189 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1191 store_setup_crl_download(vfy);
1193 if (chCApath != NULL || chCAfile != NULL) {
1194 ch = X509_STORE_new();
1197 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1199 SSL_CTX_set1_chain_cert_store(ctx, ch);
1203 X509_STORE_free(vfy);
1204 X509_STORE_free(ch);
1208 /* Verbose print out of security callback */
1213 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1214 void *other, void *ex);
1215 } security_debug_ex;
1217 static STRINT_PAIR callback_types[] = {
1218 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1219 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1220 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1221 #ifndef OPENSSL_NO_DH
1222 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1224 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1225 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1226 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1227 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1228 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1229 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1230 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1231 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1232 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1233 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1234 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1235 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1236 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1237 {"SSL compression", SSL_SECOP_COMPRESSION},
1238 {"Session ticket", SSL_SECOP_TICKET},
1242 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1243 int op, int bits, int nid,
1244 void *other, void *ex)
1246 security_debug_ex *sdb = ex;
1247 int rv, show_bits = 1, cert_md = 0;
1249 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1250 if (rv == 1 && sdb->verbose < 2)
1252 BIO_puts(sdb->out, "Security callback: ");
1254 nm = lookup(op, callback_types, NULL);
1256 case SSL_SECOP_TICKET:
1257 case SSL_SECOP_COMPRESSION:
1261 case SSL_SECOP_VERSION:
1262 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1266 case SSL_SECOP_CA_MD:
1267 case SSL_SECOP_PEER_CA_MD:
1272 BIO_printf(sdb->out, "%s=", nm);
1274 switch (op & SSL_SECOP_OTHER_TYPE) {
1276 case SSL_SECOP_OTHER_CIPHER:
1277 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1280 #ifndef OPENSSL_NO_EC
1281 case SSL_SECOP_OTHER_CURVE:
1284 cname = EC_curve_nid2nist(nid);
1286 cname = OBJ_nid2sn(nid);
1287 BIO_puts(sdb->out, cname);
1291 #ifndef OPENSSL_NO_DH
1292 case SSL_SECOP_OTHER_DH:
1295 BIO_printf(sdb->out, "%d", DH_bits(dh));
1299 case SSL_SECOP_OTHER_CERT:
1302 int sig_nid = X509_get_signature_nid(other);
1303 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1305 EVP_PKEY *pkey = X509_get0_pubkey(other);
1306 const char *algname = "";
1307 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1308 &algname, EVP_PKEY_get0_asn1(pkey));
1309 BIO_printf(sdb->out, "%s, bits=%d",
1310 algname, EVP_PKEY_bits(pkey));
1314 case SSL_SECOP_OTHER_SIGALG:
1316 const unsigned char *salg = other;
1317 const char *sname = NULL;
1319 case TLSEXT_signature_anonymous:
1320 sname = "anonymous";
1322 case TLSEXT_signature_rsa:
1325 case TLSEXT_signature_dsa:
1328 case TLSEXT_signature_ecdsa:
1333 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1335 BIO_printf(sdb->out, ", algorithm=%s", sname);
1337 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1344 BIO_printf(sdb->out, ", security bits=%d", bits);
1345 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1349 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1351 static security_debug_ex sdb;
1354 sdb.verbose = verbose;
1355 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1356 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1357 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1360 static void keylog_callback(const SSL *ssl, const char *line)
1362 if (bio_keylog == NULL) {
1363 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1368 * There might be concurrent writers to the keylog file, so we must ensure
1369 * that the given line is written at once.
1371 BIO_printf(bio_keylog, "%s\n", line);
1372 (void)BIO_flush(bio_keylog);
1375 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1377 /* Close any open files */
1378 BIO_free_all(bio_keylog);
1381 if (ctx == NULL || keylog_file == NULL) {
1382 /* Keylogging is disabled, OK. */
1387 * Append rather than write in order to allow concurrent modification.
1388 * Furthermore, this preserves existing keylog files which is useful when
1389 * the tool is run multiple times.
1391 bio_keylog = BIO_new_file(keylog_file, "a");
1392 if (bio_keylog == NULL) {
1393 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1397 /* Write a header for seekable, empty files (this excludes pipes). */
1398 if (BIO_tell(bio_keylog) == 0) {
1399 BIO_puts(bio_keylog,
1400 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1401 (void)BIO_flush(bio_keylog);
1403 SSL_CTX_set_keylog_callback(ctx, keylog_callback);