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 {" end_of_early_data", 1},
490 {" unexpected_message", 10},
491 {" bad_record_mac", 20},
492 {" decryption_failed", 21},
493 {" record_overflow", 22},
494 {" decompression_failure", 30},
495 {" handshake_failure", 40},
496 {" bad_certificate", 42},
497 {" unsupported_certificate", 43},
498 {" certificate_revoked", 44},
499 {" certificate_expired", 45},
500 {" certificate_unknown", 46},
501 {" illegal_parameter", 47},
503 {" access_denied", 49},
504 {" decode_error", 50},
505 {" decrypt_error", 51},
506 {" export_restriction", 60},
507 {" protocol_version", 70},
508 {" insufficient_security", 71},
509 {" internal_error", 80},
510 {" inappropriate_fallback", 86},
511 {" user_canceled", 90},
512 {" no_renegotiation", 100},
513 {" missing_extension", 109},
514 {" unsupported_extension", 110},
515 {" certificate_unobtainable", 111},
516 {" unrecognized_name", 112},
517 {" bad_certificate_status_response", 113},
518 {" bad_certificate_hash_value", 114},
519 {" unknown_psk_identity", 115},
520 {" certificate_required", 116},
524 static STRINT_PAIR handshakes[] = {
525 {", HelloRequest", SSL3_MT_HELLO_REQUEST},
526 {", ClientHello", SSL3_MT_CLIENT_HELLO},
527 {", ServerHello", SSL3_MT_SERVER_HELLO},
528 {", HelloVerifyRequest", DTLS1_MT_HELLO_VERIFY_REQUEST},
529 {", NewSessionTicket", SSL3_MT_NEWSESSION_TICKET},
530 {", EndOfEarlyData", SSL3_MT_END_OF_EARLY_DATA},
531 {", HelloRetryRequest", SSL3_MT_HELLO_RETRY_REQUEST},
532 {", EncryptedExtensions", SSL3_MT_ENCRYPTED_EXTENSIONS},
533 {", Certificate", SSL3_MT_CERTIFICATE},
534 {", ServerKeyExchange", SSL3_MT_SERVER_KEY_EXCHANGE},
535 {", CertificateRequest", SSL3_MT_CERTIFICATE_REQUEST},
536 {", ServerHelloDone", SSL3_MT_SERVER_DONE},
537 {", CertificateVerify", SSL3_MT_CERTIFICATE_VERIFY},
538 {", ClientKeyExchange", SSL3_MT_CLIENT_KEY_EXCHANGE},
539 {", Finished", SSL3_MT_FINISHED},
540 {", CertificateUrl", 21},
541 {", CertificateStatus", SSL3_MT_CERTIFICATE_STATUS},
542 {", SupplementalData", 23},
543 {", KeyUpdate", SSL3_MT_KEY_UPDATE},
544 #ifndef OPENSSL_NO_NEXTPROTONEG
545 {", NextProto", SSL3_MT_NEXT_PROTO},
547 {", MessageHash", SSL3_MT_MESSAGE_HASH},
551 void msg_cb(int write_p, int version, int content_type, const void *buf,
552 size_t len, SSL *ssl, void *arg)
555 const char *str_write_p = write_p ? ">>>" : "<<<";
556 const char *str_version = lookup(version, ssl_versions, "???");
557 const char *str_content_type = "", *str_details1 = "", *str_details2 = "";
558 const unsigned char* bp = buf;
560 if (version == SSL3_VERSION ||
561 version == TLS1_VERSION ||
562 version == TLS1_1_VERSION ||
563 version == TLS1_2_VERSION ||
564 version == TLS1_3_VERSION ||
565 version == DTLS1_VERSION || version == DTLS1_BAD_VER) {
566 switch (content_type) {
568 str_content_type = ", ChangeCipherSpec";
571 str_content_type = ", Alert";
572 str_details1 = ", ???";
576 str_details1 = ", warning";
579 str_details1 = ", fatal";
582 str_details2 = lookup((int)bp[1], alert_types, " ???");
586 str_content_type = ", Handshake";
587 str_details1 = "???";
589 str_details1 = lookup((int)bp[0], handshakes, "???");
592 str_content_type = ", ApplicationData";
594 #ifndef OPENSSL_NO_HEARTBEATS
596 str_details1 = ", Heartbeat";
601 str_details1 = ", HeartbeatRequest";
604 str_details1 = ", HeartbeatResponse";
613 BIO_printf(bio, "%s %s%s [length %04lx]%s%s\n", str_write_p, str_version,
614 str_content_type, (unsigned long)len, str_details1,
620 BIO_printf(bio, " ");
622 for (i = 0; i < num; i++) {
623 if (i % 16 == 0 && i > 0)
624 BIO_printf(bio, "\n ");
625 BIO_printf(bio, " %02x", ((const unsigned char *)buf)[i]);
628 BIO_printf(bio, " ...");
629 BIO_printf(bio, "\n");
631 (void)BIO_flush(bio);
634 static STRINT_PAIR tlsext_types[] = {
635 {"server name", TLSEXT_TYPE_server_name},
636 {"max fragment length", TLSEXT_TYPE_max_fragment_length},
637 {"client certificate URL", TLSEXT_TYPE_client_certificate_url},
638 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys},
639 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac},
640 {"status request", TLSEXT_TYPE_status_request},
641 {"user mapping", TLSEXT_TYPE_user_mapping},
642 {"client authz", TLSEXT_TYPE_client_authz},
643 {"server authz", TLSEXT_TYPE_server_authz},
644 {"cert type", TLSEXT_TYPE_cert_type},
645 {"supported_groups", TLSEXT_TYPE_supported_groups},
646 {"EC point formats", TLSEXT_TYPE_ec_point_formats},
647 {"SRP", TLSEXT_TYPE_srp},
648 {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
649 {"use SRTP", TLSEXT_TYPE_use_srtp},
650 {"heartbeat", TLSEXT_TYPE_heartbeat},
651 {"session ticket", TLSEXT_TYPE_session_ticket},
652 {"renegotiation info", TLSEXT_TYPE_renegotiate},
653 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp},
654 {"TLS padding", TLSEXT_TYPE_padding},
655 #ifdef TLSEXT_TYPE_next_proto_neg
656 {"next protocol", TLSEXT_TYPE_next_proto_neg},
658 #ifdef TLSEXT_TYPE_encrypt_then_mac
659 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac},
661 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
662 {"application layer protocol negotiation",
663 TLSEXT_TYPE_application_layer_protocol_negotiation},
665 #ifdef TLSEXT_TYPE_extended_master_secret
666 {"extended master secret", TLSEXT_TYPE_extended_master_secret},
671 void tlsext_cb(SSL *s, int client_server, int type,
672 const unsigned char *data, int len, void *arg)
675 const char *extname = lookup(type, tlsext_types, "unknown");
677 BIO_printf(bio, "TLS %s extension \"%s\" (id=%d), len=%d\n",
678 client_server ? "server" : "client", extname, type, len);
679 BIO_dump(bio, (const char *)data, len);
680 (void)BIO_flush(bio);
683 #ifndef OPENSSL_NO_SOCK
684 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
685 unsigned int *cookie_len)
687 unsigned char *buffer;
690 BIO_ADDR *peer = NULL;
692 /* Initialize a random secret */
693 if (!cookie_initialized) {
694 if (RAND_bytes(cookie_secret, COOKIE_SECRET_LENGTH) <= 0) {
695 BIO_printf(bio_err, "error setting random cookie secret\n");
698 cookie_initialized = 1;
701 peer = BIO_ADDR_new();
703 BIO_printf(bio_err, "memory full\n");
707 /* Read peer information */
708 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl), peer);
710 /* Create buffer with peer's address and port */
711 BIO_ADDR_rawaddress(peer, NULL, &length);
712 OPENSSL_assert(length != 0);
713 port = BIO_ADDR_rawport(peer);
714 length += sizeof(port);
715 buffer = app_malloc(length, "cookie generate buffer");
717 memcpy(buffer, &port, sizeof(port));
718 BIO_ADDR_rawaddress(peer, buffer + sizeof(port), NULL);
720 /* Calculate HMAC of buffer using the secret */
721 HMAC(EVP_sha1(), cookie_secret, COOKIE_SECRET_LENGTH,
722 buffer, length, cookie, cookie_len);
724 OPENSSL_free(buffer);
730 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
731 unsigned int cookie_len)
733 unsigned char result[EVP_MAX_MD_SIZE];
734 unsigned int resultlength;
736 /* Note: we check cookie_initialized because if it's not,
737 * it cannot be valid */
738 if (cookie_initialized
739 && generate_cookie_callback(ssl, result, &resultlength)
740 && cookie_len == resultlength
741 && memcmp(result, cookie, resultlength) == 0)
749 * Example of extended certificate handling. Where the standard support of
750 * one certificate per algorithm is not sufficient an application can decide
751 * which certificate(s) to use at runtime based on whatever criteria it deems
755 /* Linked list of certificates, keys and chains */
756 struct ssl_excert_st {
758 const char *certfile;
761 const char *chainfile;
764 STACK_OF(X509) *chain;
766 struct ssl_excert_st *next, *prev;
769 static STRINT_PAIR chain_flags[] = {
770 {"Overall Validity", CERT_PKEY_VALID},
771 {"Sign with EE key", CERT_PKEY_SIGN},
772 {"EE signature", CERT_PKEY_EE_SIGNATURE},
773 {"CA signature", CERT_PKEY_CA_SIGNATURE},
774 {"EE key parameters", CERT_PKEY_EE_PARAM},
775 {"CA key parameters", CERT_PKEY_CA_PARAM},
776 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN},
777 {"Issuer Name", CERT_PKEY_ISSUER_NAME},
778 {"Certificate Type", CERT_PKEY_CERT_TYPE},
782 static void print_chain_flags(SSL *s, int flags)
786 for (pp = chain_flags; pp->name; ++pp)
787 BIO_printf(bio_err, "\t%s: %s\n",
789 (flags & pp->retval) ? "OK" : "NOT OK");
790 BIO_printf(bio_err, "\tSuite B: ");
791 if (SSL_set_cert_flags(s, 0) & SSL_CERT_FLAG_SUITEB_128_LOS)
792 BIO_puts(bio_err, flags & CERT_PKEY_SUITEB ? "OK\n" : "NOT OK\n");
794 BIO_printf(bio_err, "not tested\n");
798 * Very basic selection callback: just use any certificate chain reported as
799 * valid. More sophisticated could prioritise according to local policy.
801 static int set_cert_cb(SSL *ssl, void *arg)
804 SSL_EXCERT *exc = arg;
805 #ifdef CERT_CB_TEST_RETRY
806 static int retry_cnt;
810 "Certificate callback retry test: count %d\n",
815 SSL_certs_clear(ssl);
821 * Go to end of list and traverse backwards since we prepend newer
822 * entries this retains the original order.
831 rv = SSL_check_chain(ssl, exc->cert, exc->key, exc->chain);
832 BIO_printf(bio_err, "Checking cert chain %d:\nSubject: ", i);
833 X509_NAME_print_ex(bio_err, X509_get_subject_name(exc->cert), 0,
835 BIO_puts(bio_err, "\n");
836 print_chain_flags(ssl, rv);
837 if (rv & CERT_PKEY_VALID) {
838 if (!SSL_use_certificate(ssl, exc->cert)
839 || !SSL_use_PrivateKey(ssl, exc->key)) {
843 * NB: we wouldn't normally do this as it is not efficient
844 * building chains on each connection better to cache the chain
847 if (exc->build_chain) {
848 if (!SSL_build_cert_chain(ssl, 0))
850 } else if (exc->chain)
851 SSL_set1_chain(ssl, exc->chain);
858 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc)
860 SSL_CTX_set_cert_cb(ctx, set_cert_cb, exc);
863 static int ssl_excert_prepend(SSL_EXCERT **pexc)
865 SSL_EXCERT *exc = app_malloc(sizeof(*exc), "prepend cert");
867 memset(exc, 0, sizeof(*exc));
873 exc->certform = exc->next->certform;
874 exc->keyform = exc->next->keyform;
875 exc->next->prev = exc;
877 exc->certform = FORMAT_PEM;
878 exc->keyform = FORMAT_PEM;
884 void ssl_excert_free(SSL_EXCERT *exc)
891 X509_free(exc->cert);
892 EVP_PKEY_free(exc->key);
893 sk_X509_pop_free(exc->chain, X509_free);
900 int load_excert(SSL_EXCERT **pexc)
902 SSL_EXCERT *exc = *pexc;
905 /* If nothing in list, free and set to NULL */
906 if (!exc->certfile && !exc->next) {
907 ssl_excert_free(exc);
911 for (; exc; exc = exc->next) {
912 if (!exc->certfile) {
913 BIO_printf(bio_err, "Missing filename\n");
916 exc->cert = load_cert(exc->certfile, exc->certform,
917 "Server Certificate");
921 exc->key = load_key(exc->keyfile, exc->keyform,
922 0, NULL, NULL, "Server Key");
924 exc->key = load_key(exc->certfile, exc->certform,
925 0, NULL, NULL, "Server Key");
929 if (exc->chainfile) {
930 if (!load_certs(exc->chainfile, &exc->chain, FORMAT_PEM, NULL,
938 enum range { OPT_X_ENUM };
940 int args_excert(int opt, SSL_EXCERT **pexc)
942 SSL_EXCERT *exc = *pexc;
944 assert(opt > OPT_X__FIRST);
945 assert(opt < OPT_X__LAST);
948 if (!ssl_excert_prepend(&exc)) {
949 BIO_printf(bio_err, " %s: Error initialising xcert\n",
956 switch ((enum range)opt) {
961 if (exc->certfile && !ssl_excert_prepend(&exc)) {
962 BIO_printf(bio_err, "%s: Error adding xcert\n", opt_getprog());
966 exc->certfile = opt_arg();
970 BIO_printf(bio_err, "%s: Key already specified\n", opt_getprog());
973 exc->keyfile = opt_arg();
976 if (exc->chainfile) {
977 BIO_printf(bio_err, "%s: Chain already specified\n",
981 exc->chainfile = opt_arg();
983 case OPT_X_CHAIN_BUILD:
984 exc->build_chain = 1;
987 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->certform))
991 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &exc->keyform))
998 ERR_print_errors(bio_err);
999 ssl_excert_free(exc);
1004 static void print_raw_cipherlist(SSL *s)
1006 const unsigned char *rlist;
1007 static const unsigned char scsv_id[] = { 0, 0xFF };
1008 size_t i, rlistlen, num;
1009 if (!SSL_is_server(s))
1011 num = SSL_get0_raw_cipherlist(s, NULL);
1012 OPENSSL_assert(num == 2);
1013 rlistlen = SSL_get0_raw_cipherlist(s, &rlist);
1014 BIO_puts(bio_err, "Client cipher list: ");
1015 for (i = 0; i < rlistlen; i += num, rlist += num) {
1016 const SSL_CIPHER *c = SSL_CIPHER_find(s, rlist);
1018 BIO_puts(bio_err, ":");
1020 BIO_puts(bio_err, SSL_CIPHER_get_name(c));
1021 else if (!memcmp(rlist, scsv_id, num))
1022 BIO_puts(bio_err, "SCSV");
1025 BIO_puts(bio_err, "0x");
1026 for (j = 0; j < num; j++)
1027 BIO_printf(bio_err, "%02X", rlist[j]);
1030 BIO_puts(bio_err, "\n");
1034 * Hex encoder for TLSA RRdata, not ':' delimited.
1036 static char *hexencode(const unsigned char *data, size_t len)
1038 static const char *hex = "0123456789abcdef";
1041 size_t outlen = 2 * len + 1;
1042 int ilen = (int) outlen;
1044 if (outlen < len || ilen < 0 || outlen != (size_t)ilen) {
1045 BIO_printf(bio_err, "%s: %" PRIu64 "-byte buffer too large to hexencode\n",
1046 opt_getprog(), (uint64_t)len);
1049 cp = out = app_malloc(ilen, "TLSA hex data buffer");
1052 *cp++ = hex[(*data >> 4) & 0x0f];
1053 *cp++ = hex[*data++ & 0x0f];
1059 void print_verify_detail(SSL *s, BIO *bio)
1063 long verify_err = SSL_get_verify_result(s);
1065 if (verify_err == X509_V_OK) {
1066 const char *peername = SSL_get0_peername(s);
1068 BIO_printf(bio, "Verification: OK\n");
1069 if (peername != NULL)
1070 BIO_printf(bio, "Verified peername: %s\n", peername);
1072 const char *reason = X509_verify_cert_error_string(verify_err);
1074 BIO_printf(bio, "Verification error: %s\n", reason);
1077 if ((mdpth = SSL_get0_dane_authority(s, NULL, &mspki)) >= 0) {
1078 uint8_t usage, selector, mtype;
1079 const unsigned char *data = NULL;
1083 mdpth = SSL_get0_dane_tlsa(s, &usage, &selector, &mtype, &data, &dlen);
1086 * The TLSA data field can be quite long when it is a certificate,
1087 * public key or even a SHA2-512 digest. Because the initial octets of
1088 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1089 * and lengths, we show the last 12 bytes of the data instead, as these
1090 * are more likely to distinguish distinct TLSA records.
1092 #define TLSA_TAIL_SIZE 12
1093 if (dlen > TLSA_TAIL_SIZE)
1094 hexdata = hexencode(data + dlen - TLSA_TAIL_SIZE, TLSA_TAIL_SIZE);
1096 hexdata = hexencode(data, dlen);
1097 BIO_printf(bio, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1098 usage, selector, mtype,
1099 (dlen > TLSA_TAIL_SIZE) ? "..." : "", hexdata,
1100 (mspki != NULL) ? "signed the certificate" :
1101 mdpth ? "matched TA certificate" : "matched EE certificate",
1103 OPENSSL_free(hexdata);
1107 void print_ssl_summary(SSL *s)
1109 const SSL_CIPHER *c;
1112 BIO_printf(bio_err, "Protocol version: %s\n", SSL_get_version(s));
1113 print_raw_cipherlist(s);
1114 c = SSL_get_current_cipher(s);
1115 BIO_printf(bio_err, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c));
1116 do_print_sigalgs(bio_err, s, 0);
1117 peer = SSL_get_peer_certificate(s);
1121 BIO_puts(bio_err, "Peer certificate: ");
1122 X509_NAME_print_ex(bio_err, X509_get_subject_name(peer),
1124 BIO_puts(bio_err, "\n");
1125 if (SSL_get_peer_signature_nid(s, &nid))
1126 BIO_printf(bio_err, "Hash used: %s\n", OBJ_nid2sn(nid));
1127 if (SSL_get_peer_signature_type_nid(s, &nid))
1128 BIO_printf(bio_err, "Signature type: %s\n", get_sigtype(nid));
1129 print_verify_detail(s, bio_err);
1131 BIO_puts(bio_err, "No peer certificate\n");
1133 #ifndef OPENSSL_NO_EC
1134 ssl_print_point_formats(bio_err, s);
1135 if (SSL_is_server(s))
1136 ssl_print_groups(bio_err, s, 1);
1138 ssl_print_tmp_key(bio_err, s);
1140 if (!SSL_is_server(s))
1141 ssl_print_tmp_key(bio_err, s);
1145 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str,
1150 SSL_CONF_CTX_set_ssl_ctx(cctx, ctx);
1151 for (i = 0; i < sk_OPENSSL_STRING_num(str); i += 2) {
1152 const char *flag = sk_OPENSSL_STRING_value(str, i);
1153 const char *arg = sk_OPENSSL_STRING_value(str, i + 1);
1154 if (SSL_CONF_cmd(cctx, flag, arg) <= 0) {
1156 BIO_printf(bio_err, "Error with command: \"%s %s\"\n",
1159 BIO_printf(bio_err, "Error with command: \"%s\"\n", flag);
1160 ERR_print_errors(bio_err);
1164 if (!SSL_CONF_CTX_finish(cctx)) {
1165 BIO_puts(bio_err, "Error finishing context\n");
1166 ERR_print_errors(bio_err);
1172 static int add_crls_store(X509_STORE *st, STACK_OF(X509_CRL) *crls)
1176 for (i = 0; i < sk_X509_CRL_num(crls); i++) {
1177 crl = sk_X509_CRL_value(crls, i);
1178 X509_STORE_add_crl(st, crl);
1183 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls, int crl_download)
1186 st = SSL_CTX_get_cert_store(ctx);
1187 add_crls_store(st, crls);
1189 store_setup_crl_download(st);
1193 int ssl_load_stores(SSL_CTX *ctx,
1194 const char *vfyCApath, const char *vfyCAfile,
1195 const char *chCApath, const char *chCAfile,
1196 STACK_OF(X509_CRL) *crls, int crl_download)
1198 X509_STORE *vfy = NULL, *ch = NULL;
1200 if (vfyCApath != NULL || vfyCAfile != NULL) {
1201 vfy = X509_STORE_new();
1204 if (!X509_STORE_load_locations(vfy, vfyCAfile, vfyCApath))
1206 add_crls_store(vfy, crls);
1207 SSL_CTX_set1_verify_cert_store(ctx, vfy);
1209 store_setup_crl_download(vfy);
1211 if (chCApath != NULL || chCAfile != NULL) {
1212 ch = X509_STORE_new();
1215 if (!X509_STORE_load_locations(ch, chCAfile, chCApath))
1217 SSL_CTX_set1_chain_cert_store(ctx, ch);
1221 X509_STORE_free(vfy);
1222 X509_STORE_free(ch);
1226 /* Verbose print out of security callback */
1231 int (*old_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1232 void *other, void *ex);
1233 } security_debug_ex;
1235 static STRINT_PAIR callback_types[] = {
1236 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED},
1237 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED},
1238 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK},
1239 #ifndef OPENSSL_NO_DH
1240 {"Temp DH key bits", SSL_SECOP_TMP_DH},
1242 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED},
1243 {"Shared Curve", SSL_SECOP_CURVE_SHARED},
1244 {"Check Curve", SSL_SECOP_CURVE_CHECK},
1245 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED},
1246 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED},
1247 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK},
1248 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK},
1249 {"Certificate chain EE key", SSL_SECOP_EE_KEY},
1250 {"Certificate chain CA key", SSL_SECOP_CA_KEY},
1251 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY},
1252 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY},
1253 {"Certificate chain CA digest", SSL_SECOP_CA_MD},
1254 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD},
1255 {"SSL compression", SSL_SECOP_COMPRESSION},
1256 {"Session ticket", SSL_SECOP_TICKET},
1260 static int security_callback_debug(const SSL *s, const SSL_CTX *ctx,
1261 int op, int bits, int nid,
1262 void *other, void *ex)
1264 security_debug_ex *sdb = ex;
1265 int rv, show_bits = 1, cert_md = 0;
1267 rv = sdb->old_cb(s, ctx, op, bits, nid, other, ex);
1268 if (rv == 1 && sdb->verbose < 2)
1270 BIO_puts(sdb->out, "Security callback: ");
1272 nm = lookup(op, callback_types, NULL);
1274 case SSL_SECOP_TICKET:
1275 case SSL_SECOP_COMPRESSION:
1279 case SSL_SECOP_VERSION:
1280 BIO_printf(sdb->out, "Version=%s", lookup(nid, ssl_versions, "???"));
1284 case SSL_SECOP_CA_MD:
1285 case SSL_SECOP_PEER_CA_MD:
1290 BIO_printf(sdb->out, "%s=", nm);
1292 switch (op & SSL_SECOP_OTHER_TYPE) {
1294 case SSL_SECOP_OTHER_CIPHER:
1295 BIO_puts(sdb->out, SSL_CIPHER_get_name(other));
1298 #ifndef OPENSSL_NO_EC
1299 case SSL_SECOP_OTHER_CURVE:
1302 cname = EC_curve_nid2nist(nid);
1304 cname = OBJ_nid2sn(nid);
1305 BIO_puts(sdb->out, cname);
1309 #ifndef OPENSSL_NO_DH
1310 case SSL_SECOP_OTHER_DH:
1313 BIO_printf(sdb->out, "%d", DH_bits(dh));
1317 case SSL_SECOP_OTHER_CERT:
1320 int sig_nid = X509_get_signature_nid(other);
1321 BIO_puts(sdb->out, OBJ_nid2sn(sig_nid));
1323 EVP_PKEY *pkey = X509_get0_pubkey(other);
1324 const char *algname = "";
1325 EVP_PKEY_asn1_get0_info(NULL, NULL, NULL, NULL,
1326 &algname, EVP_PKEY_get0_asn1(pkey));
1327 BIO_printf(sdb->out, "%s, bits=%d",
1328 algname, EVP_PKEY_bits(pkey));
1332 case SSL_SECOP_OTHER_SIGALG:
1334 const unsigned char *salg = other;
1335 const char *sname = NULL;
1337 case TLSEXT_signature_anonymous:
1338 sname = "anonymous";
1340 case TLSEXT_signature_rsa:
1343 case TLSEXT_signature_dsa:
1346 case TLSEXT_signature_ecdsa:
1351 BIO_puts(sdb->out, OBJ_nid2sn(nid));
1353 BIO_printf(sdb->out, ", algorithm=%s", sname);
1355 BIO_printf(sdb->out, ", algid=%d", salg[1]);
1362 BIO_printf(sdb->out, ", security bits=%d", bits);
1363 BIO_printf(sdb->out, ": %s\n", rv ? "yes" : "no");
1367 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose)
1369 static security_debug_ex sdb;
1372 sdb.verbose = verbose;
1373 sdb.old_cb = SSL_CTX_get_security_callback(ctx);
1374 SSL_CTX_set_security_callback(ctx, security_callback_debug);
1375 SSL_CTX_set0_security_ex_data(ctx, &sdb);
1378 static void keylog_callback(const SSL *ssl, const char *line)
1380 if (bio_keylog == NULL) {
1381 BIO_printf(bio_err, "Keylog callback is invoked without valid file!\n");
1386 * There might be concurrent writers to the keylog file, so we must ensure
1387 * that the given line is written at once.
1389 BIO_printf(bio_keylog, "%s\n", line);
1390 (void)BIO_flush(bio_keylog);
1393 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file)
1395 /* Close any open files */
1396 BIO_free_all(bio_keylog);
1399 if (ctx == NULL || keylog_file == NULL) {
1400 /* Keylogging is disabled, OK. */
1405 * Append rather than write in order to allow concurrent modification.
1406 * Furthermore, this preserves existing keylog files which is useful when
1407 * the tool is run multiple times.
1409 bio_keylog = BIO_new_file(keylog_file, "a");
1410 if (bio_keylog == NULL) {
1411 BIO_printf(bio_err, "Error writing keylog file %s\n", keylog_file);
1415 /* Write a header for seekable, empty files (this excludes pipes). */
1416 if (BIO_tell(bio_keylog) == 0) {
1417 BIO_puts(bio_keylog,
1418 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1419 (void)BIO_flush(bio_keylog);
1421 SSL_CTX_set_keylog_callback(ctx, keylog_callback);