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(out, "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 {" end_of_early_data", 1},
484 {" unexpected_message", 10},
485 {" bad_record_mac", 20},
486 {" decryption_failed", 21},
487 {" record_overflow", 22},
488 {" decompression_failure", 30},
489 {" handshake_failure", 40},
490 {" bad_certificate", 42},
491 {" unsupported_certificate", 43},
492 {" certificate_revoked", 44},
493 {" certificate_expired", 45},
494 {" certificate_unknown", 46},
495 {" illegal_parameter", 47},
497 {" access_denied", 49},
498 {" decode_error", 50},
499 {" decrypt_error", 51},
500 {" export_restriction", 60},
501 {" protocol_version", 70},
502 {" insufficient_security", 71},
503 {" internal_error", 80},
504 {" inappropriate_fallback", 86},
505 {" user_canceled", 90},
506 {" no_renegotiation", 100},
507 {" missing_extension", 109},
508 {" unsupported_extension", 110},
509 {" certificate_unobtainable", 111},
510 {" unrecognized_name", 112},
511 {" bad_certificate_status_response", 113},
512 {" bad_certificate_hash_value", 114},
513 {" unknown_psk_identity", 115},
514 {" certificate_required", 116},
518 static STRINT_PAIR handshakes[] = {
519 {", HelloRequest", SSL3_MT_HELLO_REQUEST},
520 {", ClientHello", SSL3_MT_CLIENT_HELLO},
521 {", ServerHello", SSL3_MT_SERVER_HELLO},
522 {", HelloVerifyRequest", DTLS1_MT_HELLO_VERIFY_REQUEST},
523 {", NewSessionTicket", SSL3_MT_NEWSESSION_TICKET},
524 {", EndOfEarlyData", SSL3_MT_END_OF_EARLY_DATA},
525 {", HelloRetryRequest", SSL3_MT_HELLO_RETRY_REQUEST},
526 {", EncryptedExtensions", SSL3_MT_ENCRYPTED_EXTENSIONS},
527 {", Certificate", SSL3_MT_CERTIFICATE},
528 {", ServerKeyExchange", SSL3_MT_SERVER_KEY_EXCHANGE},
529 {", CertificateRequest", SSL3_MT_CERTIFICATE_REQUEST},
530 {", ServerHelloDone", SSL3_MT_SERVER_DONE},
531 {", CertificateVerify", SSL3_MT_CERTIFICATE_VERIFY},
532 {", ClientKeyExchange", SSL3_MT_CLIENT_KEY_EXCHANGE},
533 {", Finished", SSL3_MT_FINISHED},
534 {", CertificateUrl", 21},
535 {", CertificateStatus", SSL3_MT_CERTIFICATE_STATUS},
536 {", SupplementalData", 23},
537 {", KeyUpdate", SSL3_MT_KEY_UPDATE},
538 #ifndef OPENSSL_NO_NEXTPROTONEG
539 {", NextProto", SSL3_MT_NEXT_PROTO},
541 {", MessageHash", SSL3_MT_MESSAGE_HASH},
545 void msg_cb(int write_p, int version, int content_type, const void *buf,
546 size_t len, SSL *ssl, void *arg)
549 const char *str_write_p = write_p ? ">>>" : "<<<";
550 const char *str_version = lookup(version, ssl_versions, "???");
551 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
552 const unsigned char* bp = buf;
554 if (version == SSL3_VERSION ||
555 version == TLS1_VERSION ||
556 version == TLS1_1_VERSION ||
557 version == TLS1_2_VERSION ||
558 version == TLS1_3_VERSION ||
559 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
560 switch (content_type) {
562 str_content_type = ", ChangeCipherSpec";
565 str_content_type = ", Alert";
566 str_details1 = ", ???";
570 str_details1 = ", warning";
573 str_details1 = ", fatal";
576 str_details2 = lookup((int)bp[1], alert_types, " ???");
580 str_content_type = ", Handshake";
581 str_details1 = "???";
583 str_details1 = lookup((int)bp[0], handshakes, "???");
586 str_content_type = ", ApplicationData";
588 #ifndef OPENSSL_NO_HEARTBEATS
590 str_details1 = ", Heartbeat";
595 str_details1 = ", HeartbeatRequest";
598 str_details1 = ", HeartbeatResponse";
607 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
608 str_content_type, (unsigned long)len, str_details1,
614 BIO_printf(bio, " ");
616 for (i = 0; i < num; i++) {
617 if (i % 16 == 0 && i > 0)
618 BIO_printf(bio, "\n ");
619 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
622 BIO_printf(bio, " ...");
623 BIO_printf(bio, "\n");
625 (void)BIO_flush(bio);
628 static STRINT_PAIR tlsext_types[] = {
629 {"server name", TLSEXT_TYPE_server_name},
630 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
631 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
632 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
633 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
634 {"status request", TLSEXT_TYPE_status_request},
635 {"user mapping", TLSEXT_TYPE_user_mapping},
636 {"client authz", TLSEXT_TYPE_client_authz},
637 {"server authz", TLSEXT_TYPE_server_authz},
638 {"cert type", TLSEXT_TYPE_cert_type},
639 {"supported_groups", TLSEXT_TYPE_supported_groups},
640 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
641 {"SRP", TLSEXT_TYPE_srp},
642 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
643 {"use SRTP", TLSEXT_TYPE_use_srtp},
644 {"heartbeat", TLSEXT_TYPE_heartbeat},
645 {"session ticket", TLSEXT_TYPE_session_ticket},
646 {"renegotiation info", TLSEXT_TYPE_renegotiate},
647 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
648 {"TLS padding", TLSEXT_TYPE_padding},
649 #ifdef TLSEXT_TYPE_next_proto_neg
650 {"next protocol", TLSEXT_TYPE_next_proto_neg},
652 #ifdef TLSEXT_TYPE_encrypt_then_mac
653 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
655 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
656 {"application layer protocol negotiation",
657 TLSEXT_TYPE_application_layer_protocol_negotiation},
659 #ifdef TLSEXT_TYPE_extended_master_secret
660 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
662 {"key share", TLSEXT_TYPE_key_share},
663 {"supported versions", TLSEXT_TYPE_supported_versions},
664 {"psk", TLSEXT_TYPE_psk},
665 {"psk kex modes", TLSEXT_TYPE_psk_kex_modes},
666 {"certificate authorities", TLSEXT_TYPE_certificate_authorities},
670 void tlsext_cb(SSL *s, int client_server, int type,
671 const unsigned char *data, int len, void *arg)
674 const char *extname = lookup(type, tlsext_types, "unknown");
676 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
677 client_server ? "server" : "client", extname, type, len);
678 BIO_dump(bio, (const char *)data, len);
679 (void)BIO_flush(bio);
682 #ifndef OPENSSL_NO_SOCK
683 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
684 unsigned int *cookie_len)
686 unsigned char *buffer;
689 BIO_ADDR *peer = NULL;
691 /* Initialize a random secret */
692 if (!cookie_initialized) {
693 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
694 BIO_printf(bio_err, "error setting random cookie secret\n");
697 cookie_initialized = 1;
700 peer = BIO_ADDR_new();
702 BIO_printf(bio_err, "memory full\n");
706 /* Read peer information */
707 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
709 /* Create buffer with peer's address and port */
710 BIO_ADDR_rawaddress(peer, NULL, &length);
711 OPENSSL_assert(length != 0);
712 port = BIO_ADDR_rawport(peer);
713 length += sizeof(port);
714 buffer = app_malloc(length, "cookie generate buffer");
716 memcpy(buffer, &port, sizeof(port));
717 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
719 /* Calculate HMAC of buffer using the secret */
720 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
721 buffer, length, cookie, cookie_len);
723 OPENSSL_free(buffer);
729 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
730 unsigned int cookie_len)
732 unsigned char result[EVP_MAX_MD_SIZE];
733 unsigned int resultlength;
735 /* Note: we check cookie_initialized because if it's not,
736 * it cannot be valid */
737 if (cookie_initialized
738 && generate_cookie_callback(ssl, result, &resultlength)
739 && cookie_len == resultlength
740 && memcmp(result, cookie, resultlength) == 0)
748 * Example of extended certificate handling. Where the standard support of
749 * one certificate per algorithm is not sufficient an application can decide
750 * which certificate(s) to use at runtime based on whatever criteria it deems
754 /* Linked list of certificates, keys and chains */
755 struct ssl_excert_st {
757 const char *certfile;
760 const char *chainfile;
763 STACK_OF(X509) *chain;
765 struct ssl_excert_st *next, *prev;
768 static STRINT_PAIR chain_flags[] = {
769 {"Overall Validity", CERT_PKEY_VALID},
770 {"Sign with EE key", CERT_PKEY_SIGN},
771 {"EE signature", CERT_PKEY_EE_SIGNATURE},
772 {"CA signature", CERT_PKEY_CA_SIGNATURE},
773 {"EE key parameters", CERT_PKEY_EE_PARAM},
774 {"CA key parameters", CERT_PKEY_CA_PARAM},
775 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
776 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
777 {"Certificate Type", CERT_PKEY_CERT_TYPE},
781 static void print_chain_flags(SSL *s, int flags)
785 for (pp = chain_flags; pp->name; ++pp)
786 BIO_printf(bio_err, "\t%s: %s\n",
788 (flags & pp->retval) ? "OK" : "NOT OK");
789 BIO_printf(bio_err, "\tSuite B: ");
790 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
791 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
793 BIO_printf(bio_err, "not tested\n");
797 * Very basic selection callback: just use any certificate chain reported as
798 * valid. More sophisticated could prioritise according to local policy.
800 static int set_cert_cb(SSL *ssl, void *arg)
803 SSL_EXCERT *exc = arg;
804 #ifdef CERT_CB_TEST_RETRY
805 static int retry_cnt;
809 "Certificate callback retry test: count %d\n",
814 SSL_certs_clear(ssl);
820 * Go to end of list and traverse backwards since we prepend newer
821 * entries this retains the original order.
830 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
831 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
832 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
834 BIO_puts(bio_err, "\n");
835 print_chain_flags(ssl, rv);
836 if (rv & CERT_PKEY_VALID) {
837 if (!SSL_use_certificate(ssl, exc->cert)
838 || !SSL_use_PrivateKey(ssl, exc->key)) {
842 * NB: we wouldn't normally do this as it is not efficient
843 * building chains on each connection better to cache the chain
846 if (exc->build_chain) {
847 if (!SSL_build_cert_chain(ssl, 0))
849 } else if (exc->chain)
850 SSL_set1_chain(ssl, exc->chain);
857 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
859 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
862 static int ssl_excert_prepend(SSL_EXCERT **pexc)
864 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
866 memset(exc, 0, sizeof(*exc));
872 exc->certform = exc->next->certform;
873 exc->keyform = exc->next->keyform;
874 exc->next->prev = exc;
876 exc->certform = FORMAT_PEM;
877 exc->keyform = FORMAT_PEM;
883 void ssl_excert_free(SSL_EXCERT *exc)
890 X509_free(exc->cert);
891 EVP_PKEY_free(exc->key);
892 sk_X509_pop_free(exc->chain, X509_free);
899 int load_excert(SSL_EXCERT **pexc)
901 SSL_EXCERT *exc = *pexc;
904 /* If nothing in list, free and set to NULL */
905 if (!exc->certfile && !exc->next) {
906 ssl_excert_free(exc);
910 for (; exc; exc = exc->next) {
911 if (!exc->certfile) {
912 BIO_printf(bio_err, "Missing filename\n");
915 exc->cert = load_cert(exc->certfile, exc->certform,
916 "Server Certificate");
920 exc->key = load_key(exc->keyfile, exc->keyform,
921 0, NULL, NULL, "Server Key");
923 exc->key = load_key(exc->certfile, exc->certform,
924 0, NULL, NULL, "Server Key");
928 if (exc->chainfile) {
929 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
937 enum range { OPT_X_ENUM };
939 int args_excert(int opt, SSL_EXCERT **pexc)
941 SSL_EXCERT *exc = *pexc;
943 assert(opt > OPT_X__FIRST);
944 assert(opt < OPT_X__LAST);
947 if (!ssl_excert_prepend(&exc)) {
948 BIO_printf(bio_err, " %s: Error initialising xcert\n",
955 switch ((enum range)opt) {
960 if (exc->certfile && !ssl_excert_prepend(&exc)) {
961 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
965 exc->certfile = opt_arg();
969 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
972 exc->keyfile = opt_arg();
975 if (exc->chainfile) {
976 BIO_printf(bio_err, "%s: Chain already specified\n",
980 exc->chainfile = opt_arg();
982 case OPT_X_CHAIN_BUILD:
983 exc->build_chain = 1;
986 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
990 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
997 ERR_print_errors(bio_err);
998 ssl_excert_free(exc);
1003 static void print_raw_cipherlist(SSL *s)
1005 const unsigned char *rlist;
1006 static const unsigned char scsv_id[] = { 0, 0xFF };
1007 size_t i, rlistlen, num;
1008 if (!SSL_is_server(s))
1010 num = SSL_get0_raw_cipherlist(s, NULL);
1011 OPENSSL_assert(num == 2);
1012 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1013 BIO_puts(bio_err, "Client cipher list: ");
1014 for (i = 0; i < rlistlen; i += num, rlist += num) {
1015 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1017 BIO_puts(bio_err, ":");
1019 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1020 else if (!memcmp(rlist, scsv_id, num))
1021 BIO_puts(bio_err, "SCSV");
1024 BIO_puts(bio_err, "0x");
1025 for (j = 0; j < num; j++)
1026 BIO_printf(bio_err, "%02X", rlist[j]);
1029 BIO_puts(bio_err, "\n");
1033 * Hex encoder for TLSA RRdata, not ':' delimited.
1035 static char *hexencode(const unsigned char *data, size_t len)
1037 static const char *hex = "0123456789abcdef";
1040 size_t outlen = 2 * len + 1;
1041 int ilen = (int) outlen;
1043 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1044 BIO_printf(bio_err, "%s: %zu-byte buffer too large to hexencode\n",
1045 opt_getprog(), len);
1048 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1051 *cp++ = hex[(*data >> 4) & 0x0f];
1052 *cp++ = hex[*data++ & 0x0f];
1058 void print_verify_detail(SSL *s, BIO *bio)
1062 long verify_err = SSL_get_verify_result(s);
1064 if (verify_err == X509_V_OK) {
1065 const char *peername = SSL_get0_peername(s);
1067 BIO_printf(bio, "Verification: OK\n");
1068 if (peername != NULL)
1069 BIO_printf(bio, "Verified peername: %s\n", peername);
1071 const char *reason = X509_verify_cert_error_string(verify_err);
1073 BIO_printf(bio, "Verification error: %s\n", reason);
1076 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1077 uint8_t usage, selector, mtype;
1078 const unsigned char *data = NULL;
1082 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1085 * The TLSA data field can be quite long when it is a certificate,
1086 * public key or even a SHA2-512 digest. Because the initial octets of
1087 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1088 * and lengths, we show the last 12 bytes of the data instead, as these
1089 * are more likely to distinguish distinct TLSA records.
1091 #define TLSA_TAIL_SIZE 12
1092 if (dlen > TLSA_TAIL_SIZE)
1093 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1095 hexdata = hexencode(data, dlen);
1096 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1097 usage, selector, mtype,
1098 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1099 (mspki != NULL) ? "signed the certificate" :
1100 mdpth ? "matched TA certificate" : "matched EE certificate",
1102 OPENSSL_free(hexdata);
1106 void print_ssl_summary(SSL *s)
1108 const SSL_CIPHER *c;
1111 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1112 print_raw_cipherlist(s);
1113 c = SSL_get_current_cipher(s);
1114 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1115 do_print_sigalgs(bio_err, s, 0);
1116 peer = SSL_get_peer_certificate(s);
1120 BIO_puts(bio_err, "Peer certificate: ");
1121 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1123 BIO_puts(bio_err, "\n");
1124 if (SSL_get_peer_signature_nid(s, &nid))
1125 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1126 if (SSL_get_peer_signature_type_nid(s, &nid))
1127 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1128 print_verify_detail(s, bio_err);
1130 BIO_puts(bio_err, "No peer certificate\n");
1132 #ifndef OPENSSL_NO_EC
1133 ssl_print_point_formats(bio_err, s);
1134 if (SSL_is_server(s))
1135 ssl_print_groups(bio_err, s, 1);
1137 ssl_print_tmp_key(bio_err, s);
1139 if (!SSL_is_server(s))
1140 ssl_print_tmp_key(bio_err, s);
1144 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1149 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1150 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1151 const char *flag = sk_OPENSSL_STRING_value(str, i);
1152 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1153 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1155 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1158 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1159 ERR_print_errors(bio_err);
1163 if (!SSL_CONF_CTX_finish(cctx)) {
1164 BIO_puts(bio_err, "Error finishing context\n");
1165 ERR_print_errors(bio_err);
1171 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1175 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1176 crl = sk_X509_CRL_value(crls, i);
1177 X509_STORE_add_crl(st, crl);
1182 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1185 st = SSL_CTX_get_cert_store(ctx);
1186 add_crls_store(st, crls);
1188 store_setup_crl_download(st);
1192 int ssl_load_stores(SSL_CTX *ctx,
1193 const char *vfyCApath, const char *vfyCAfile,
1194 const char *chCApath, const char *chCAfile,
1195 STACK_OF(X509_CRL) *crls, int crl_download)
1197 X509_STORE *vfy = NULL, *ch = NULL;
1199 if (vfyCApath != NULL || vfyCAfile != NULL) {
1200 vfy = X509_STORE_new();
1203 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1205 add_crls_store(vfy, crls);
1206 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1208 store_setup_crl_download(vfy);
1210 if (chCApath != NULL || chCAfile != NULL) {
1211 ch = X509_STORE_new();
1214 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1216 SSL_CTX_set1_chain_cert_store(ctx, ch);
1220 X509_STORE_free(vfy);
1221 X509_STORE_free(ch);
1225 /* Verbose print out of security callback */
1230 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1231 void *other, void *ex);
1232 } security_debug_ex;
1234 static STRINT_PAIR callback_types[] = {
1235 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1236 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1237 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1238 #ifndef OPENSSL_NO_DH
1239 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1241 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1242 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1243 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1244 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1245 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1246 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1247 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1248 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1249 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1250 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1251 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1252 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1253 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1254 {"SSL compression", SSL_SECOP_COMPRESSION},
1255 {"Session ticket", SSL_SECOP_TICKET},
1259 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1260 int op, int bits, int nid,
1261 void *other, void *ex)
1263 security_debug_ex *sdb = ex;
1264 int rv, show_bits = 1, cert_md = 0;
1266 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1267 if (rv == 1 && sdb->verbose < 2)
1269 BIO_puts(sdb->out, "Security callback: ");
1271 nm = lookup(op, callback_types, NULL);
1273 case SSL_SECOP_TICKET:
1274 case SSL_SECOP_COMPRESSION:
1278 case SSL_SECOP_VERSION:
1279 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1283 case SSL_SECOP_CA_MD:
1284 case SSL_SECOP_PEER_CA_MD:
1289 BIO_printf(sdb->out, "%s=", nm);
1291 switch (op & SSL_SECOP_OTHER_TYPE) {
1293 case SSL_SECOP_OTHER_CIPHER:
1294 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1297 #ifndef OPENSSL_NO_EC
1298 case SSL_SECOP_OTHER_CURVE:
1301 cname = EC_curve_nid2nist(nid);
1303 cname = OBJ_nid2sn(nid);
1304 BIO_puts(sdb->out, cname);
1308 #ifndef OPENSSL_NO_DH
1309 case SSL_SECOP_OTHER_DH:
1312 BIO_printf(sdb->out, "%d", DH_bits(dh));
1316 case SSL_SECOP_OTHER_CERT:
1319 int sig_nid = X509_get_signature_nid(other);
1320 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1322 EVP_PKEY *pkey = X509_get0_pubkey(other);
1323 const char *algname = "";
1324 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1325 &algname, EVP_PKEY_get0_asn1(pkey));
1326 BIO_printf(sdb->out, "%s, bits=%d",
1327 algname, EVP_PKEY_bits(pkey));
1331 case SSL_SECOP_OTHER_SIGALG:
1333 const unsigned char *salg = other;
1334 const char *sname = NULL;
1336 case TLSEXT_signature_anonymous:
1337 sname = "anonymous";
1339 case TLSEXT_signature_rsa:
1342 case TLSEXT_signature_dsa:
1345 case TLSEXT_signature_ecdsa:
1350 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1352 BIO_printf(sdb->out, ", algorithm=%s", sname);
1354 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1361 BIO_printf(sdb->out, ", security bits=%d", bits);
1362 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1366 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1368 static security_debug_ex sdb;
1371 sdb.verbose = verbose;
1372 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1373 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1374 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1377 static void keylog_callback(const SSL *ssl, const char *line)
1379 if (bio_keylog == NULL) {
1380 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1385 * There might be concurrent writers to the keylog file, so we must ensure
1386 * that the given line is written at once.
1388 BIO_printf(bio_keylog, "%s\n", line);
1389 (void)BIO_flush(bio_keylog);
1392 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1394 /* Close any open files */
1395 BIO_free_all(bio_keylog);
1398 if (ctx == NULL || keylog_file == NULL) {
1399 /* Keylogging is disabled, OK. */
1404 * Append rather than write in order to allow concurrent modification.
1405 * Furthermore, this preserves existing keylog files which is useful when
1406 * the tool is run multiple times.
1408 bio_keylog = BIO_new_file(keylog_file, "a");
1409 if (bio_keylog == NULL) {
1410 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1414 /* Write a header for seekable, empty files (this excludes pipes). */
1415 if (BIO_tell(bio_keylog) == 0) {
1416 BIO_puts(bio_keylog,
1417 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1418 (void)BIO_flush(bio_keylog);
1420 SSL_CTX_set_keylog_callback(ctx, keylog_callback);
1424 void print_ca_names(BIO *bio, SSL *s)
1426 const char *cs = SSL_is_server(s) ? "server" : "client";
1427 const STACK_OF(X509_NAME) *sk = SSL_get0_peer_CA_list(s);
1430 if (sk == NULL || sk_X509_NAME_num(sk) == 0) {
1431 BIO_printf(bio, "---\nNo %s certificate CA names sent\n", cs);
1435 BIO_printf(bio, "---\nAcceptable %s certificate CA names\n",cs);
1436 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
1437 X509_NAME_print_ex(bio, sk_X509_NAME_value(sk, i), 0, get_nameopt());
1438 BIO_write(bio, "\n", 1);