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;
36 static unsigned long nmflag = XN_FLAG_ONELINE;
38 int set_nameopt(const char *arg)
40 return set_name_ex(&nmflag, arg);
43 static const char *lookup(int val, const STRINT_PAIR* list, const char* def)
45 for ( ; list->name; ++list)
46 if (list->retval == val)
51 int verify_callback(int ok, X509_STORE_CTX *ctx)
56 err_cert = X509_STORE_CTX_get_current_cert(ctx);
57 err = X509_STORE_CTX_get_error(ctx);
58 depth = X509_STORE_CTX_get_error_depth(ctx);
60 if (!verify_args.quiet || !ok) {
61 BIO_printf(bio_err, "depth=%d ", depth);
63 X509_NAME_print_ex(bio_err,
64 X509_get_subject_name(err_cert),
66 BIO_puts(bio_err, "\n");
68 BIO_puts(bio_err, "<no cert>\n");
71 BIO_printf(bio_err, "verify error:num=%d:%s\n", err,
72 X509_verify_cert_error_string(err));
73 if (verify_args.depth >= depth) {
74 if (!verify_args.return_error)
76 verify_args.error = err;
79 verify_args.error = X509_V_ERR_CERT_CHAIN_TOO_LONG;
83 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
84 BIO_puts(bio_err, "issuer= ");
85 X509_NAME_print_ex(bio_err, X509_get_issuer_name(err_cert),
87 BIO_puts(bio_err, "\n");
89 case X509_V_ERR_CERT_NOT_YET_VALID:
90 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
91 BIO_printf(bio_err, "notBefore=");
92 ASN1_TIME_print(bio_err, X509_get0_notBefore(err_cert));
93 BIO_printf(bio_err, "\n");
95 case X509_V_ERR_CERT_HAS_EXPIRED:
96 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
97 BIO_printf(bio_err, "notAfter=");
98 ASN1_TIME_print(bio_err, X509_get0_notAfter(err_cert));
99 BIO_printf(bio_err, "\n");
101 case X509_V_ERR_NO_EXPLICIT_POLICY:
102 if (!verify_args.quiet)
106 if (err == X509_V_OK && ok == 2 && !verify_args.quiet)
108 if (ok && !verify_args.quiet)
109 BIO_printf(bio_err, "verify return:%d\n", ok);
113 int set_cert_stuff(SSL_CTX *ctx, char *cert_file, char *key_file)
115 if (cert_file != NULL) {
116 if (SSL_CTX_use_certificate_file(ctx, cert_file,
117 SSL_FILETYPE_PEM) <= 0) {
118 BIO_printf(bio_err, "unable to get certificate from '%s'\n",
120 ERR_print_errors(bio_err);
123 if (key_file == NULL)
124 key_file = cert_file;
125 if (SSL_CTX_use_PrivateKey_file(ctx, key_file, SSL_FILETYPE_PEM) <= 0) {
126 BIO_printf(bio_err, "unable to get private key from '%s'\n",
128 ERR_print_errors(bio_err);
133 * If we are using DSA, we can copy the parameters from the private
138 * Now we know that a key and cert have been set against the SSL
141 if (!SSL_CTX_check_private_key(ctx)) {
143 "Private key does not match the certificate public key\n");
150 int set_cert_key_stuff(SSL_CTX *ctx, X509 *cert, EVP_PKEY *key,
151 STACK_OF(X509) *chain, int build_chain)
153 int chflags = chain ? SSL_BUILD_CHAIN_FLAG_CHECK : 0;
156 if (SSL_CTX_use_certificate(ctx, cert) <= 0) {
157 BIO_printf(bio_err, "error setting certificate\n");
158 ERR_print_errors(bio_err);
162 if (SSL_CTX_use_PrivateKey(ctx, key) <= 0) {
163 BIO_printf(bio_err, "error setting private key\n");
164 ERR_print_errors(bio_err);
169 * Now we know that a key and cert have been set against the SSL context
171 if (!SSL_CTX_check_private_key(ctx)) {
173 "Private key does not match the certificate public key\n");
176 if (chain && !SSL_CTX_set1_chain(ctx, chain)) {
177 BIO_printf(bio_err, "error setting certificate chain\n");
178 ERR_print_errors(bio_err);
181 if (build_chain && !SSL_CTX_build_cert_chain(ctx, chflags)) {
182 BIO_printf(bio_err, "error building certificate chain\n");
183 ERR_print_errors(bio_err);
189 static STRINT_PAIR cert_type_list[] = {
190 {"RSA sign", TLS_CT_RSA_SIGN},
191 {"DSA sign", TLS_CT_DSS_SIGN},
192 {"RSA fixed DH", TLS_CT_RSA_FIXED_DH},
193 {"DSS fixed DH", TLS_CT_DSS_FIXED_DH},
194 {"ECDSA sign", TLS_CT_ECDSA_SIGN},
195 {"RSA fixed ECDH", TLS_CT_RSA_FIXED_ECDH},
196 {"ECDSA fixed ECDH", TLS_CT_ECDSA_FIXED_ECDH},
197 {"GOST01 Sign", TLS_CT_GOST01_SIGN},
201 static void ssl_print_client_cert_types(BIO *bio, SSL *s)
203 const unsigned char *p;
205 int cert_type_num = SSL_get0_certificate_types(s, &p);
208 BIO_puts(bio, "Client Certificate Types: ");
209 for (i = 0; i < cert_type_num; i++) {
210 unsigned char cert_type = p[i];
211 const char *cname = lookup((int)cert_type, cert_type_list, NULL);
216 BIO_puts(bio, cname);
218 BIO_printf(bio, "UNKNOWN (%d),", cert_type);
223 static const char *get_sigtype(int nid)
229 case EVP_PKEY_RSA_PSS:
243 static int do_print_sigalgs(BIO *out, SSL *s, int shared)
246 client = SSL_is_server(s) ? 0 : 1;
248 nsig = SSL_get_shared_sigalgs(s, 0, NULL, NULL, NULL, NULL, NULL);
250 nsig = SSL_get_sigalgs(s, -1, NULL, NULL, NULL, NULL, NULL);
255 BIO_puts(out, "Shared ");
258 BIO_puts(out, "Requested ");
259 BIO_puts(out, "Signature Algorithms: ");
260 for (i = 0; i < nsig; i++) {
261 int hash_nid, sign_nid;
262 unsigned char rhash, rsign;
263 const char *sstr = NULL;
265 SSL_get_shared_sigalgs(s, i, &sign_nid, &hash_nid, NULL,
268 SSL_get_sigalgs(s, i, &sign_nid, &hash_nid, NULL, &rsign, &rhash);
271 sstr = get_sigtype(sign_nid);
273 BIO_printf(out, "%s+", sstr);
275 BIO_printf(out, "0x%02X+", (int)rsign);
276 if (hash_nid != NID_undef)
277 BIO_printf(out, "%s", OBJ_nid2sn(hash_nid));
279 BIO_printf(out, "0x%02X", (int)rhash);
285 int ssl_print_sigalgs(BIO *out, SSL *s)
288 if (!SSL_is_server(s))
289 ssl_print_client_cert_types(out, s);
290 do_print_sigalgs(out, s, 0);
291 do_print_sigalgs(out, s, 1);
292 if (SSL_get_peer_signature_nid(s, &nid))
293 BIO_printf(out, "Peer signing digest: %s\n", OBJ_nid2sn(nid));
294 if (SSL_get_peer_signature_type_nid(s, &nid))
295 BIO_printf(out, "Peer signature type: %s\n", get_sigtype(nid));
299 #ifndef OPENSSL_NO_EC
300 int ssl_print_point_formats(BIO *out, SSL *s)
303 const char *pformats;
304 nformats = SSL_get0_ec_point_formats(s, &pformats);
307 BIO_puts(out, "Supported Elliptic Curve Point Formats: ");
308 for (i = 0; i < nformats; i++, pformats++) {
312 case TLSEXT_ECPOINTFORMAT_uncompressed:
313 BIO_puts(out, "uncompressed");
316 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime:
317 BIO_puts(out, "ansiX962_compressed_prime");
320 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2:
321 BIO_puts(out, "ansiX962_compressed_char2");
325 BIO_printf(out, "unknown(%d)", (int)*pformats);
334 int ssl_print_groups(BIO *out, SSL *s, int noshared)
336 int i, ngroups, *groups, nid;
339 ngroups = SSL_get1_groups(s, NULL);
342 groups = app_malloc(ngroups * sizeof(int), "groups to print");
343 SSL_get1_groups(s, groups);
345 BIO_puts(out, "Supported Elliptic Groups: ");
346 for (i = 0; i < ngroups; i++) {
350 /* If unrecognised print out hex version */
351 if (nid & TLSEXT_nid_unknown)
352 BIO_printf(out, "0x%04X", nid & 0xFFFF);
354 /* TODO(TLS1.3): Get group name here */
355 /* Use NIST name for curve if it exists */
356 gname = EC_curve_nid2nist(nid);
358 gname = OBJ_nid2sn(nid);
359 BIO_printf(out, "%s", gname);
362 OPENSSL_free(groups);
367 BIO_puts(out, "\nShared Elliptic groups: ");
368 ngroups = SSL_get_shared_group(s, -1);
369 for (i = 0; i < ngroups; i++) {
372 nid = SSL_get_shared_group(s, i);
373 /* TODO(TLS1.3): Convert for DH groups */
374 gname = EC_curve_nid2nist(nid);
376 gname = OBJ_nid2sn(nid);
377 BIO_printf(out, "%s", gname);
380 BIO_puts(out, "NONE");
385 int ssl_print_tmp_key(BIO *out, SSL *s)
388 if (!SSL_get_server_tmp_key(s, &key))
390 BIO_puts(out, "Server Temp Key: ");
391 switch (EVP_PKEY_id(key)) {
393 BIO_printf(out, "RSA, %d bits\n", EVP_PKEY_bits(key));
397 BIO_printf(out, "DH, %d bits\n", EVP_PKEY_bits(key));
399 #ifndef OPENSSL_NO_EC
402 EC_KEY *ec = EVP_PKEY_get1_EC_KEY(key);
405 nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
407 cname = EC_curve_nid2nist(nid);
409 cname = OBJ_nid2sn(nid);
410 BIO_printf(out, "ECDH, %s, %d bits\n", cname, EVP_PKEY_bits(key));
415 BIO_printf(out, "%s, %d bits\n", OBJ_nid2sn(EVP_PKEY_id(key)),
422 long bio_dump_callback(BIO *bio, int cmd, const char *argp,
423 int argi, long argl, long ret)
427 out = (BIO *)BIO_get_callback_arg(bio);
431 if (cmd == (BIO_CB_READ | BIO_CB_RETURN)) {
432 BIO_printf(out, "read from %p [%p] (%lu bytes => %ld (0x%lX))\n",
433 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
434 BIO_dump(out, argp, (int)ret);
436 } else if (cmd == (BIO_CB_WRITE | BIO_CB_RETURN)) {
437 BIO_printf(out, "write to %p [%p] (%lu bytes => %ld (0x%lX))\n",
438 (void *)bio, (void *)argp, (unsigned long)argi, ret, ret);
439 BIO_dump(out, argp, (int)ret);
444 void apps_ssl_info_callback(const SSL *s, int where, int ret)
449 w = where & ~SSL_ST_MASK;
451 if (w & SSL_ST_CONNECT)
453 else if (w & SSL_ST_ACCEPT)
458 if (where & SSL_CB_LOOP) {
459 BIO_printf(bio_err, "%s:%s\n", str, SSL_state_string_long(s));
460 } else if (where & SSL_CB_ALERT) {
461 str = (where & SSL_CB_READ) ? "read" : "write";
462 BIO_printf(bio_err, "SSL3 alert %s:%s:%s\n",
464 SSL_alert_type_string_long(ret),
465 SSL_alert_desc_string_long(ret));
466 } else if (where & SSL_CB_EXIT) {
468 BIO_printf(bio_err, "%s:failed in %s\n",
469 str, SSL_state_string_long(s));
471 BIO_printf(bio_err, "%s:error in %s\n",
472 str, SSL_state_string_long(s));
477 static STRINT_PAIR ssl_versions[] = {
478 {"SSL 3.0", SSL3_VERSION},
479 {"TLS 1.0", TLS1_VERSION},
480 {"TLS 1.1", TLS1_1_VERSION},
481 {"TLS 1.2", TLS1_2_VERSION},
482 {"TLS 1.3", TLS1_3_VERSION},
483 {"DTLS 1.0", DTLS1_VERSION},
484 {"DTLS 1.0 (bad)", DTLS1_BAD_VER},
487 static STRINT_PAIR alert_types[] = {
488 {" close_notify", 0},
489 {" unexpected_message", 10},
490 {" bad_record_mac", 20},
491 {" decryption_failed", 21},
492 {" record_overflow", 22},
493 {" decompression_failure", 30},
494 {" handshake_failure", 40},
495 {" bad_certificate", 42},
496 {" unsupported_certificate", 43},
497 {" certificate_revoked", 44},
498 {" certificate_expired", 45},
499 {" certificate_unknown", 46},
500 {" illegal_parameter", 47},
502 {" access_denied", 49},
503 {" decode_error", 50},
504 {" decrypt_error", 51},
505 {" export_restriction", 60},
506 {" protocol_version", 70},
507 {" insufficient_security", 71},
508 {" internal_error", 80},
509 {" user_canceled", 90},
510 {" no_renegotiation", 100},
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},
520 static STRINT_PAIR handshakes[] = {
521 {", HelloRequest", 0},
522 {", ClientHello", 1},
523 {", ServerHello", 2},
524 {", HelloVerifyRequest", 3},
525 {", NewSessionTicket", 4},
526 {", Certificate", 11},
527 {", ServerKeyExchange", 12},
528 {", CertificateRequest", 13},
529 {", ServerHelloDone", 14},
530 {", CertificateVerify", 15},
531 {", ClientKeyExchange", 16},
533 {", CertificateUrl", 21},
534 {", CertificateStatus", 22},
535 {", SupplementalData", 23},
539 void msg_cb(int write_p, int version, int content_type, const void *buf,
540 size_t len, SSL *ssl, void *arg)
543 const char *str_write_p = write_p ? ">>>" : "<<<";
544 const char *str_version = lookup(version, ssl_versions, "???");
545 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
546 const unsigned char* bp = buf;
548 if (version == SSL3_VERSION ||
549 version == TLS1_VERSION ||
550 version == TLS1_1_VERSION ||
551 version == TLS1_2_VERSION ||
552 version == TLS1_3_VERSION ||
553 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
554 switch (content_type) {
556 str_content_type = "ChangeCipherSpec";
559 str_content_type = "Alert";
560 str_details1 = ", ???";
564 str_details1 = ", warning";
567 str_details1 = ", fatal";
570 str_details2 = lookup((int)bp[1], alert_types, " ???");
574 str_content_type = "Handshake";
575 str_details1 = "???";
577 str_details1 = lookup((int)bp[0], handshakes, "???");
580 str_content_type = "ApplicationData";
582 #ifndef OPENSSL_NO_HEARTBEATS
584 str_details1 = ", Heartbeat";
589 str_details1 = ", HeartbeatRequest";
592 str_details1 = ", HeartbeatResponse";
601 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
602 str_content_type, (unsigned long)len, str_details1,
608 BIO_printf(bio, " ");
610 for (i = 0; i < num; i++) {
611 if (i % 16 == 0 && i > 0)
612 BIO_printf(bio, "\n ");
613 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
616 BIO_printf(bio, " ...");
617 BIO_printf(bio, "\n");
619 (void)BIO_flush(bio);
622 static STRINT_PAIR tlsext_types[] = {
623 {"server name", TLSEXT_TYPE_server_name},
624 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
625 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
626 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
627 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
628 {"status request", TLSEXT_TYPE_status_request},
629 {"user mapping", TLSEXT_TYPE_user_mapping},
630 {"client authz", TLSEXT_TYPE_client_authz},
631 {"server authz", TLSEXT_TYPE_server_authz},
632 {"cert type", TLSEXT_TYPE_cert_type},
633 {"supported_groups", TLSEXT_TYPE_supported_groups},
634 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
635 {"SRP", TLSEXT_TYPE_srp},
636 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
637 {"use SRTP", TLSEXT_TYPE_use_srtp},
638 {"heartbeat", TLSEXT_TYPE_heartbeat},
639 {"session ticket", TLSEXT_TYPE_session_ticket},
640 {"renegotiation info", TLSEXT_TYPE_renegotiate},
641 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
642 {"TLS padding", TLSEXT_TYPE_padding},
643 #ifdef TLSEXT_TYPE_next_proto_neg
644 {"next protocol", TLSEXT_TYPE_next_proto_neg},
646 #ifdef TLSEXT_TYPE_encrypt_then_mac
647 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
649 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
650 {"application layer protocol negotiation",
651 TLSEXT_TYPE_application_layer_protocol_negotiation},
653 #ifdef TLSEXT_TYPE_extended_master_secret
654 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
659 void tlsext_cb(SSL *s, int client_server, int type,
660 const unsigned char *data, int len, void *arg)
663 const char *extname = lookup(type, tlsext_types, "unknown");
665 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
666 client_server ? "server" : "client", extname, type, len);
667 BIO_dump(bio, (const char *)data, len);
668 (void)BIO_flush(bio);
671 #ifndef OPENSSL_NO_SOCK
672 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
673 unsigned int *cookie_len)
675 unsigned char *buffer;
678 BIO_ADDR *peer = NULL;
680 /* Initialize a random secret */
681 if (!cookie_initialized) {
682 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
683 BIO_printf(bio_err, "error setting random cookie secret\n");
686 cookie_initialized = 1;
689 peer = BIO_ADDR_new();
691 BIO_printf(bio_err, "memory full\n");
695 /* Read peer information */
696 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
698 /* Create buffer with peer's address and port */
699 BIO_ADDR_rawaddress(peer, NULL, &length);
700 OPENSSL_assert(length != 0);
701 port = BIO_ADDR_rawport(peer);
702 length += sizeof(port);
703 buffer = app_malloc(length, "cookie generate buffer");
705 memcpy(buffer, &port, sizeof(port));
706 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
708 /* Calculate HMAC of buffer using the secret */
709 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
710 buffer, length, cookie, cookie_len);
712 OPENSSL_free(buffer);
718 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
719 unsigned int cookie_len)
721 unsigned char result[EVP_MAX_MD_SIZE];
722 unsigned int resultlength;
724 /* Note: we check cookie_initialized because if it's not,
725 * it cannot be valid */
726 if (cookie_initialized
727 && generate_cookie_callback(ssl, result, &resultlength)
728 && cookie_len == resultlength
729 && memcmp(result, cookie, resultlength) == 0)
737 * Example of extended certificate handling. Where the standard support of
738 * one certificate per algorithm is not sufficient an application can decide
739 * which certificate(s) to use at runtime based on whatever criteria it deems
743 /* Linked list of certificates, keys and chains */
744 struct ssl_excert_st {
746 const char *certfile;
749 const char *chainfile;
752 STACK_OF(X509) *chain;
754 struct ssl_excert_st *next, *prev;
757 static STRINT_PAIR chain_flags[] = {
758 {"Overall Validity", CERT_PKEY_VALID},
759 {"Sign with EE key", CERT_PKEY_SIGN},
760 {"EE signature", CERT_PKEY_EE_SIGNATURE},
761 {"CA signature", CERT_PKEY_CA_SIGNATURE},
762 {"EE key parameters", CERT_PKEY_EE_PARAM},
763 {"CA key parameters", CERT_PKEY_CA_PARAM},
764 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
765 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
766 {"Certificate Type", CERT_PKEY_CERT_TYPE},
770 static void print_chain_flags(SSL *s, int flags)
774 for (pp = chain_flags; pp->name; ++pp)
775 BIO_printf(bio_err, "\t%s: %s\n",
777 (flags & pp->retval) ? "OK" : "NOT OK");
778 BIO_printf(bio_err, "\tSuite B: ");
779 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
780 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
782 BIO_printf(bio_err, "not tested\n");
786 * Very basic selection callback: just use any certificate chain reported as
787 * valid. More sophisticated could prioritise according to local policy.
789 static int set_cert_cb(SSL *ssl, void *arg)
792 SSL_EXCERT *exc = arg;
793 #ifdef CERT_CB_TEST_RETRY
794 static int retry_cnt;
798 "Certificate callback retry test: count %d\n",
803 SSL_certs_clear(ssl);
809 * Go to end of list and traverse backwards since we prepend newer
810 * entries this retains the original order.
819 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
820 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
821 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
823 BIO_puts(bio_err, "\n");
824 print_chain_flags(ssl, rv);
825 if (rv & CERT_PKEY_VALID) {
826 if (!SSL_use_certificate(ssl, exc->cert)
827 || !SSL_use_PrivateKey(ssl, exc->key)) {
831 * NB: we wouldn't normally do this as it is not efficient
832 * building chains on each connection better to cache the chain
835 if (exc->build_chain) {
836 if (!SSL_build_cert_chain(ssl, 0))
838 } else if (exc->chain)
839 SSL_set1_chain(ssl, exc->chain);
846 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
848 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
851 static int ssl_excert_prepend(SSL_EXCERT **pexc)
853 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
855 memset(exc, 0, sizeof(*exc));
861 exc->certform = exc->next->certform;
862 exc->keyform = exc->next->keyform;
863 exc->next->prev = exc;
865 exc->certform = FORMAT_PEM;
866 exc->keyform = FORMAT_PEM;
872 void ssl_excert_free(SSL_EXCERT *exc)
879 X509_free(exc->cert);
880 EVP_PKEY_free(exc->key);
881 sk_X509_pop_free(exc->chain, X509_free);
888 int load_excert(SSL_EXCERT **pexc)
890 SSL_EXCERT *exc = *pexc;
893 /* If nothing in list, free and set to NULL */
894 if (!exc->certfile && !exc->next) {
895 ssl_excert_free(exc);
899 for (; exc; exc = exc->next) {
900 if (!exc->certfile) {
901 BIO_printf(bio_err, "Missing filename\n");
904 exc->cert = load_cert(exc->certfile, exc->certform,
905 "Server Certificate");
909 exc->key = load_key(exc->keyfile, exc->keyform,
910 0, NULL, NULL, "Server Key");
912 exc->key = load_key(exc->certfile, exc->certform,
913 0, NULL, NULL, "Server Key");
917 if (exc->chainfile) {
918 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
926 enum range { OPT_X_ENUM };
928 int args_excert(int opt, SSL_EXCERT **pexc)
930 SSL_EXCERT *exc = *pexc;
932 assert(opt > OPT_X__FIRST);
933 assert(opt < OPT_X__LAST);
936 if (!ssl_excert_prepend(&exc)) {
937 BIO_printf(bio_err, " %s: Error initialising xcert\n",
944 switch ((enum range)opt) {
949 if (exc->certfile && !ssl_excert_prepend(&exc)) {
950 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
954 exc->certfile = opt_arg();
958 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
961 exc->keyfile = opt_arg();
964 if (exc->chainfile) {
965 BIO_printf(bio_err, "%s: Chain already specified\n",
969 exc->chainfile = opt_arg();
971 case OPT_X_CHAIN_BUILD:
972 exc->build_chain = 1;
975 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
979 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
986 ERR_print_errors(bio_err);
987 ssl_excert_free(exc);
992 static void print_raw_cipherlist(SSL *s)
994 const unsigned char *rlist;
995 static const unsigned char scsv_id[] = { 0, 0xFF };
996 size_t i, rlistlen, num;
997 if (!SSL_is_server(s))
999 num = SSL_get0_raw_cipherlist(s, NULL);
1000 OPENSSL_assert(num == 2);
1001 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1002 BIO_puts(bio_err, "Client cipher list: ");
1003 for (i = 0; i < rlistlen; i += num, rlist += num) {
1004 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1006 BIO_puts(bio_err, ":");
1008 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1009 else if (!memcmp(rlist, scsv_id, num))
1010 BIO_puts(bio_err, "SCSV");
1013 BIO_puts(bio_err, "0x");
1014 for (j = 0; j < num; j++)
1015 BIO_printf(bio_err, "%02X", rlist[j]);
1018 BIO_puts(bio_err, "\n");
1022 * Hex encoder for TLSA RRdata, not ':' delimited.
1024 static char *hexencode(const unsigned char *data, size_t len)
1026 static const char *hex = "0123456789abcdef";
1029 size_t outlen = 2 * len + 1;
1030 int ilen = (int) outlen;
1032 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1033 BIO_printf(bio_err, "%s: %" PRIu64 "-byte buffer too large to hexencode\n",
1034 opt_getprog(), (uint64_t)len);
1037 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1040 *cp++ = hex[(*data >> 4) & 0x0f];
1041 *cp++ = hex[*data++ & 0x0f];
1047 void print_verify_detail(SSL *s, BIO *bio)
1051 long verify_err = SSL_get_verify_result(s);
1053 if (verify_err == X509_V_OK) {
1054 const char *peername = SSL_get0_peername(s);
1056 BIO_printf(bio, "Verification: OK\n");
1057 if (peername != NULL)
1058 BIO_printf(bio, "Verified peername: %s\n", peername);
1060 const char *reason = X509_verify_cert_error_string(verify_err);
1062 BIO_printf(bio, "Verification error: %s\n", reason);
1065 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1066 uint8_t usage, selector, mtype;
1067 const unsigned char *data = NULL;
1071 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1074 * The TLSA data field can be quite long when it is a certificate,
1075 * public key or even a SHA2-512 digest. Because the initial octets of
1076 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1077 * and lengths, we show the last 12 bytes of the data instead, as these
1078 * are more likely to distinguish distinct TLSA records.
1080 #define TLSA_TAIL_SIZE 12
1081 if (dlen > TLSA_TAIL_SIZE)
1082 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1084 hexdata = hexencode(data, dlen);
1085 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1086 usage, selector, mtype,
1087 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1088 (mspki != NULL) ? "signed the certificate" :
1089 mdpth ? "matched TA certificate" : "matched EE certificate",
1091 OPENSSL_free(hexdata);
1095 void print_ssl_summary(SSL *s)
1097 const SSL_CIPHER *c;
1099 /* const char *pnam = SSL_is_server(s) ? "client" : "server"; */
1101 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1102 print_raw_cipherlist(s);
1103 c = SSL_get_current_cipher(s);
1104 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1105 do_print_sigalgs(bio_err, s, 0);
1106 peer = SSL_get_peer_certificate(s);
1110 BIO_puts(bio_err, "Peer certificate: ");
1111 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1113 BIO_puts(bio_err, "\n");
1114 if (SSL_get_peer_signature_nid(s, &nid))
1115 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1116 if (SSL_get_peer_signature_type_nid(s, &nid))
1117 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1118 print_verify_detail(s, bio_err);
1120 BIO_puts(bio_err, "No peer certificate\n");
1122 #ifndef OPENSSL_NO_EC
1123 ssl_print_point_formats(bio_err, s);
1124 if (SSL_is_server(s))
1125 ssl_print_groups(bio_err, s, 1);
1127 ssl_print_tmp_key(bio_err, s);
1129 if (!SSL_is_server(s))
1130 ssl_print_tmp_key(bio_err, s);
1134 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1139 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1140 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1141 const char *flag = sk_OPENSSL_STRING_value(str, i);
1142 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1143 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1145 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1148 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1149 ERR_print_errors(bio_err);
1153 if (!SSL_CONF_CTX_finish(cctx)) {
1154 BIO_puts(bio_err, "Error finishing context\n");
1155 ERR_print_errors(bio_err);
1161 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1165 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1166 crl = sk_X509_CRL_value(crls, i);
1167 X509_STORE_add_crl(st, crl);
1172 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1175 st = SSL_CTX_get_cert_store(ctx);
1176 add_crls_store(st, crls);
1178 store_setup_crl_download(st);
1182 int ssl_load_stores(SSL_CTX *ctx,
1183 const char *vfyCApath, const char *vfyCAfile,
1184 const char *chCApath, const char *chCAfile,
1185 STACK_OF(X509_CRL) *crls, int crl_download)
1187 X509_STORE *vfy = NULL, *ch = NULL;
1189 if (vfyCApath != NULL || vfyCAfile != NULL) {
1190 vfy = X509_STORE_new();
1193 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1195 add_crls_store(vfy, crls);
1196 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1198 store_setup_crl_download(vfy);
1200 if (chCApath != NULL || chCAfile != NULL) {
1201 ch = X509_STORE_new();
1204 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1206 SSL_CTX_set1_chain_cert_store(ctx, ch);
1210 X509_STORE_free(vfy);
1211 X509_STORE_free(ch);
1215 /* Verbose print out of security callback */
1220 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1221 void *other, void *ex);
1222 } security_debug_ex;
1224 static STRINT_PAIR callback_types[] = {
1225 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1226 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1227 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1228 #ifndef OPENSSL_NO_DH
1229 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1231 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1232 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1233 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1234 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1235 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1236 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1237 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1238 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1239 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1240 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1241 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1242 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1243 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1244 {"SSL compression", SSL_SECOP_COMPRESSION},
1245 {"Session ticket", SSL_SECOP_TICKET},
1249 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1250 int op, int bits, int nid,
1251 void *other, void *ex)
1253 security_debug_ex *sdb = ex;
1254 int rv, show_bits = 1, cert_md = 0;
1256 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1257 if (rv == 1 && sdb->verbose < 2)
1259 BIO_puts(sdb->out, "Security callback: ");
1261 nm = lookup(op, callback_types, NULL);
1263 case SSL_SECOP_TICKET:
1264 case SSL_SECOP_COMPRESSION:
1268 case SSL_SECOP_VERSION:
1269 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1273 case SSL_SECOP_CA_MD:
1274 case SSL_SECOP_PEER_CA_MD:
1279 BIO_printf(sdb->out, "%s=", nm);
1281 switch (op & SSL_SECOP_OTHER_TYPE) {
1283 case SSL_SECOP_OTHER_CIPHER:
1284 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1287 #ifndef OPENSSL_NO_EC
1288 case SSL_SECOP_OTHER_CURVE:
1291 cname = EC_curve_nid2nist(nid);
1293 cname = OBJ_nid2sn(nid);
1294 BIO_puts(sdb->out, cname);
1298 #ifndef OPENSSL_NO_DH
1299 case SSL_SECOP_OTHER_DH:
1302 BIO_printf(sdb->out, "%d", DH_bits(dh));
1306 case SSL_SECOP_OTHER_CERT:
1309 int sig_nid = X509_get_signature_nid(other);
1310 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1312 EVP_PKEY *pkey = X509_get0_pubkey(other);
1313 const char *algname = "";
1314 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1315 &algname, EVP_PKEY_get0_asn1(pkey));
1316 BIO_printf(sdb->out, "%s, bits=%d",
1317 algname, EVP_PKEY_bits(pkey));
1321 case SSL_SECOP_OTHER_SIGALG:
1323 const unsigned char *salg = other;
1324 const char *sname = NULL;
1326 case TLSEXT_signature_anonymous:
1327 sname = "anonymous";
1329 case TLSEXT_signature_rsa:
1332 case TLSEXT_signature_dsa:
1335 case TLSEXT_signature_ecdsa:
1340 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1342 BIO_printf(sdb->out, ", algorithm=%s", sname);
1344 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1351 BIO_printf(sdb->out, ", security bits=%d", bits);
1352 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1356 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1358 static security_debug_ex sdb;
1361 sdb.verbose = verbose;
1362 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1363 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1364 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1367 static void keylog_callback(const SSL *ssl, const char *line)
1369 if (bio_keylog == NULL) {
1370 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1375 * There might be concurrent writers to the keylog file, so we must ensure
1376 * that the given line is written at once.
1378 BIO_printf(bio_keylog, "%s\n", line);
1379 (void)BIO_flush(bio_keylog);
1382 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1384 /* Close any open files */
1385 BIO_free_all(bio_keylog);
1388 if (ctx == NULL || keylog_file == NULL) {
1389 /* Keylogging is disabled, OK. */
1394 * Append rather than write in order to allow concurrent modification.
1395 * Furthermore, this preserves existing keylog files which is useful when
1396 * the tool is run multiple times.
1398 bio_keylog = BIO_new_file(keylog_file, "a");
1399 if (bio_keylog == NULL) {
1400 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1404 /* Write a header for seekable, empty files (this excludes pipes). */
1405 if (BIO_tell(bio_keylog) == 0) {
1406 BIO_puts(bio_keylog,
1407 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1408 (void)BIO_flush(bio_keylog);
1410 SSL_CTX_set_keylog_callback(ctx, keylog_callback);