2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* callback functions used by s_client, s_server, and s_time */
13 #include <string.h> /* for memcpy() and strcmp() */
15 #include <openssl/err.h>
16 #include <openssl/rand.h>
17 #include <openssl/x509.h>
18 #include <openssl/ssl.h>
19 #include <openssl/bn.h>
21 # include <openssl/dh.h>
25 #define COOKIE_SECRET_LENGTH 16
27 VERIFY_CB_ARGS verify_args
= { 0, 0, X509_V_OK
, 0 };
29 #ifndef OPENSSL_NO_SOCK
30 static unsigned char cookie_secret
[COOKIE_SECRET_LENGTH
];
31 static int cookie_initialized
= 0;
33 static BIO
*bio_keylog
= NULL
;
35 static const char *lookup(int val
, const STRINT_PAIR
* list
, const char* def
)
37 for ( ; list
->name
; ++list
)
38 if (list
->retval
== val
)
43 int verify_callback(int ok
, X509_STORE_CTX
*ctx
)
48 err_cert
= X509_STORE_CTX_get_current_cert(ctx
);
49 err
= X509_STORE_CTX_get_error(ctx
);
50 depth
= X509_STORE_CTX_get_error_depth(ctx
);
52 if (!verify_args
.quiet
|| !ok
) {
53 BIO_printf(bio_err
, "depth=%d ", depth
);
54 if (err_cert
!= NULL
) {
55 X509_NAME_print_ex(bio_err
,
56 X509_get_subject_name(err_cert
),
58 BIO_puts(bio_err
, "\n");
60 BIO_puts(bio_err
, "<no cert>\n");
64 BIO_printf(bio_err
, "verify error:num=%d:%s\n", err
,
65 X509_verify_cert_error_string(err
));
66 if (verify_args
.depth
>= depth
) {
67 if (!verify_args
.return_error
)
69 verify_args
.error
= err
;
72 verify_args
.error
= X509_V_ERR_CERT_CHAIN_TOO_LONG
;
76 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
:
77 BIO_puts(bio_err
, "issuer= ");
78 X509_NAME_print_ex(bio_err
, X509_get_issuer_name(err_cert
),
80 BIO_puts(bio_err
, "\n");
82 case X509_V_ERR_CERT_NOT_YET_VALID
:
83 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD
:
84 BIO_printf(bio_err
, "notBefore=");
85 ASN1_TIME_print(bio_err
, X509_get0_notBefore(err_cert
));
86 BIO_printf(bio_err
, "\n");
88 case X509_V_ERR_CERT_HAS_EXPIRED
:
89 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD
:
90 BIO_printf(bio_err
, "notAfter=");
91 ASN1_TIME_print(bio_err
, X509_get0_notAfter(err_cert
));
92 BIO_printf(bio_err
, "\n");
94 case X509_V_ERR_NO_EXPLICIT_POLICY
:
95 if (!verify_args
.quiet
)
99 if (err
== X509_V_OK
&& ok
== 2 && !verify_args
.quiet
)
101 if (ok
&& !verify_args
.quiet
)
102 BIO_printf(bio_err
, "verify return:%d\n", ok
);
106 int set_cert_stuff(SSL_CTX
*ctx
, char *cert_file
, char *key_file
)
108 if (cert_file
!= NULL
) {
109 if (SSL_CTX_use_certificate_file(ctx
, cert_file
,
110 SSL_FILETYPE_PEM
) <= 0) {
111 BIO_printf(bio_err
, "unable to get certificate from '%s'\n",
113 ERR_print_errors(bio_err
);
116 if (key_file
== NULL
)
117 key_file
= cert_file
;
118 if (SSL_CTX_use_PrivateKey_file(ctx
, key_file
, SSL_FILETYPE_PEM
) <= 0) {
119 BIO_printf(bio_err
, "unable to get private key from '%s'\n",
121 ERR_print_errors(bio_err
);
126 * If we are using DSA, we can copy the parameters from the private
131 * Now we know that a key and cert have been set against the SSL
134 if (!SSL_CTX_check_private_key(ctx
)) {
136 "Private key does not match the certificate public key\n");
143 int set_cert_key_stuff(SSL_CTX
*ctx
, X509
*cert
, EVP_PKEY
*key
,
144 STACK_OF(X509
) *chain
, int build_chain
)
146 int chflags
= chain
? SSL_BUILD_CHAIN_FLAG_CHECK
: 0;
149 if (SSL_CTX_use_certificate(ctx
, cert
) <= 0) {
150 BIO_printf(bio_err
, "error setting certificate\n");
151 ERR_print_errors(bio_err
);
155 if (SSL_CTX_use_PrivateKey(ctx
, key
) <= 0) {
156 BIO_printf(bio_err
, "error setting private key\n");
157 ERR_print_errors(bio_err
);
162 * Now we know that a key and cert have been set against the SSL context
164 if (!SSL_CTX_check_private_key(ctx
)) {
166 "Private key does not match the certificate public key\n");
169 if (chain
&& !SSL_CTX_set1_chain(ctx
, chain
)) {
170 BIO_printf(bio_err
, "error setting certificate chain\n");
171 ERR_print_errors(bio_err
);
174 if (build_chain
&& !SSL_CTX_build_cert_chain(ctx
, chflags
)) {
175 BIO_printf(bio_err
, "error building certificate chain\n");
176 ERR_print_errors(bio_err
);
182 static STRINT_PAIR cert_type_list
[] = {
183 {"RSA sign", TLS_CT_RSA_SIGN
},
184 {"DSA sign", TLS_CT_DSS_SIGN
},
185 {"RSA fixed DH", TLS_CT_RSA_FIXED_DH
},
186 {"DSS fixed DH", TLS_CT_DSS_FIXED_DH
},
187 {"ECDSA sign", TLS_CT_ECDSA_SIGN
},
188 {"RSA fixed ECDH", TLS_CT_RSA_FIXED_ECDH
},
189 {"ECDSA fixed ECDH", TLS_CT_ECDSA_FIXED_ECDH
},
190 {"GOST01 Sign", TLS_CT_GOST01_SIGN
},
194 static void ssl_print_client_cert_types(BIO
*bio
, SSL
*s
)
196 const unsigned char *p
;
198 int cert_type_num
= SSL_get0_certificate_types(s
, &p
);
201 BIO_puts(bio
, "Client Certificate Types: ");
202 for (i
= 0; i
< cert_type_num
; i
++) {
203 unsigned char cert_type
= p
[i
];
204 const char *cname
= lookup((int)cert_type
, cert_type_list
, NULL
);
209 BIO_puts(bio
, cname
);
211 BIO_printf(bio
, "UNKNOWN (%d),", cert_type
);
216 static const char *get_sigtype(int nid
)
222 case EVP_PKEY_RSA_PSS
:
237 case NID_id_GostR3410_2001
:
240 case NID_id_GostR3410_2012_256
:
241 return "gost2012_256";
243 case NID_id_GostR3410_2012_512
:
244 return "gost2012_512";
251 static int do_print_sigalgs(BIO
*out
, SSL
*s
, int shared
)
254 client
= SSL_is_server(s
) ? 0 : 1;
256 nsig
= SSL_get_shared_sigalgs(s
, 0, NULL
, NULL
, NULL
, NULL
, NULL
);
258 nsig
= SSL_get_sigalgs(s
, -1, NULL
, NULL
, NULL
, NULL
, NULL
);
263 BIO_puts(out
, "Shared ");
266 BIO_puts(out
, "Requested ");
267 BIO_puts(out
, "Signature Algorithms: ");
268 for (i
= 0; i
< nsig
; i
++) {
269 int hash_nid
, sign_nid
;
270 unsigned char rhash
, rsign
;
271 const char *sstr
= NULL
;
273 SSL_get_shared_sigalgs(s
, i
, &sign_nid
, &hash_nid
, NULL
,
276 SSL_get_sigalgs(s
, i
, &sign_nid
, &hash_nid
, NULL
, &rsign
, &rhash
);
279 sstr
= get_sigtype(sign_nid
);
281 BIO_printf(out
, "%s", sstr
);
283 BIO_printf(out
, "0x%02X", (int)rsign
);
284 if (hash_nid
!= NID_undef
)
285 BIO_printf(out
, "+%s", OBJ_nid2sn(hash_nid
));
286 else if (sstr
== NULL
)
287 BIO_printf(out
, "+0x%02X", (int)rhash
);
293 int ssl_print_sigalgs(BIO
*out
, SSL
*s
)
296 if (!SSL_is_server(s
))
297 ssl_print_client_cert_types(out
, s
);
298 do_print_sigalgs(out
, s
, 0);
299 do_print_sigalgs(out
, s
, 1);
300 if (SSL_get_peer_signature_nid(s
, &nid
) && nid
!= NID_undef
)
301 BIO_printf(out
, "Peer signing digest: %s\n", OBJ_nid2sn(nid
));
302 if (SSL_get_peer_signature_type_nid(s
, &nid
))
303 BIO_printf(out
, "Peer signature type: %s\n", get_sigtype(nid
));
307 #ifndef OPENSSL_NO_EC
308 int ssl_print_point_formats(BIO
*out
, SSL
*s
)
311 const char *pformats
;
312 nformats
= SSL_get0_ec_point_formats(s
, &pformats
);
315 BIO_puts(out
, "Supported Elliptic Curve Point Formats: ");
316 for (i
= 0; i
< nformats
; i
++, pformats
++) {
320 case TLSEXT_ECPOINTFORMAT_uncompressed
:
321 BIO_puts(out
, "uncompressed");
324 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime
:
325 BIO_puts(out
, "ansiX962_compressed_prime");
328 case TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2
:
329 BIO_puts(out
, "ansiX962_compressed_char2");
333 BIO_printf(out
, "unknown(%d)", (int)*pformats
);
342 int ssl_print_groups(BIO
*out
, SSL
*s
, int noshared
)
344 int i
, ngroups
, *groups
, nid
;
347 ngroups
= SSL_get1_groups(s
, NULL
);
350 groups
= app_malloc(ngroups
* sizeof(int), "groups to print");
351 SSL_get1_groups(s
, groups
);
353 BIO_puts(out
, "Supported Elliptic Groups: ");
354 for (i
= 0; i
< ngroups
; i
++) {
358 /* If unrecognised print out hex version */
359 if (nid
& TLSEXT_nid_unknown
) {
360 BIO_printf(out
, "0x%04X", nid
& 0xFFFF);
362 /* TODO(TLS1.3): Get group name here */
363 /* Use NIST name for curve if it exists */
364 gname
= EC_curve_nid2nist(nid
);
366 gname
= OBJ_nid2sn(nid
);
367 BIO_printf(out
, "%s", gname
);
370 OPENSSL_free(groups
);
375 BIO_puts(out
, "\nShared Elliptic groups: ");
376 ngroups
= SSL_get_shared_group(s
, -1);
377 for (i
= 0; i
< ngroups
; i
++) {
380 nid
= SSL_get_shared_group(s
, i
);
381 /* TODO(TLS1.3): Convert for DH groups */
382 gname
= EC_curve_nid2nist(nid
);
384 gname
= OBJ_nid2sn(nid
);
385 BIO_printf(out
, "%s", gname
);
388 BIO_puts(out
, "NONE");
394 int ssl_print_tmp_key(BIO
*out
, SSL
*s
)
397 if (!SSL_get_server_tmp_key(s
, &key
))
399 BIO_puts(out
, "Server Temp Key: ");
400 switch (EVP_PKEY_id(key
)) {
402 BIO_printf(out
, "RSA, %d bits\n", EVP_PKEY_bits(key
));
406 BIO_printf(out
, "DH, %d bits\n", EVP_PKEY_bits(key
));
408 #ifndef OPENSSL_NO_EC
411 EC_KEY
*ec
= EVP_PKEY_get1_EC_KEY(key
);
414 nid
= EC_GROUP_get_curve_name(EC_KEY_get0_group(ec
));
416 cname
= EC_curve_nid2nist(nid
);
418 cname
= OBJ_nid2sn(nid
);
419 BIO_printf(out
, "ECDH, %s, %d bits\n", cname
, EVP_PKEY_bits(key
));
424 BIO_printf(out
, "%s, %d bits\n", OBJ_nid2sn(EVP_PKEY_id(key
)),
431 long bio_dump_callback(BIO
*bio
, int cmd
, const char *argp
,
432 int argi
, long argl
, long ret
)
436 out
= (BIO
*)BIO_get_callback_arg(bio
);
440 if (cmd
== (BIO_CB_READ
| BIO_CB_RETURN
)) {
441 BIO_printf(out
, "read from %p [%p] (%lu bytes => %ld (0x%lX))\n",
442 (void *)bio
, (void *)argp
, (unsigned long)argi
, ret
, ret
);
443 BIO_dump(out
, argp
, (int)ret
);
445 } else if (cmd
== (BIO_CB_WRITE
| BIO_CB_RETURN
)) {
446 BIO_printf(out
, "write to %p [%p] (%lu bytes => %ld (0x%lX))\n",
447 (void *)bio
, (void *)argp
, (unsigned long)argi
, ret
, ret
);
448 BIO_dump(out
, argp
, (int)ret
);
453 void apps_ssl_info_callback(const SSL
*s
, int where
, int ret
)
458 w
= where
& ~SSL_ST_MASK
;
460 if (w
& SSL_ST_CONNECT
)
462 else if (w
& SSL_ST_ACCEPT
)
467 if (where
& SSL_CB_LOOP
) {
468 BIO_printf(bio_err
, "%s:%s\n", str
, SSL_state_string_long(s
));
469 } else if (where
& SSL_CB_ALERT
) {
470 str
= (where
& SSL_CB_READ
) ? "read" : "write";
471 BIO_printf(bio_err
, "SSL3 alert %s:%s:%s\n",
473 SSL_alert_type_string_long(ret
),
474 SSL_alert_desc_string_long(ret
));
475 } else if (where
& SSL_CB_EXIT
) {
477 BIO_printf(bio_err
, "%s:failed in %s\n",
478 str
, SSL_state_string_long(s
));
480 BIO_printf(bio_err
, "%s:error in %s\n",
481 str
, SSL_state_string_long(s
));
485 static STRINT_PAIR ssl_versions
[] = {
486 {"SSL 3.0", SSL3_VERSION
},
487 {"TLS 1.0", TLS1_VERSION
},
488 {"TLS 1.1", TLS1_1_VERSION
},
489 {"TLS 1.2", TLS1_2_VERSION
},
490 {"TLS 1.3", TLS1_3_VERSION
},
491 {"DTLS 1.0", DTLS1_VERSION
},
492 {"DTLS 1.0 (bad)", DTLS1_BAD_VER
},
496 static STRINT_PAIR alert_types
[] = {
497 {" close_notify", 0},
498 {" end_of_early_data", 1},
499 {" unexpected_message", 10},
500 {" bad_record_mac", 20},
501 {" decryption_failed", 21},
502 {" record_overflow", 22},
503 {" decompression_failure", 30},
504 {" handshake_failure", 40},
505 {" bad_certificate", 42},
506 {" unsupported_certificate", 43},
507 {" certificate_revoked", 44},
508 {" certificate_expired", 45},
509 {" certificate_unknown", 46},
510 {" illegal_parameter", 47},
512 {" access_denied", 49},
513 {" decode_error", 50},
514 {" decrypt_error", 51},
515 {" export_restriction", 60},
516 {" protocol_version", 70},
517 {" insufficient_security", 71},
518 {" internal_error", 80},
519 {" inappropriate_fallback", 86},
520 {" user_canceled", 90},
521 {" no_renegotiation", 100},
522 {" missing_extension", 109},
523 {" unsupported_extension", 110},
524 {" certificate_unobtainable", 111},
525 {" unrecognized_name", 112},
526 {" bad_certificate_status_response", 113},
527 {" bad_certificate_hash_value", 114},
528 {" unknown_psk_identity", 115},
529 {" certificate_required", 116},
533 static STRINT_PAIR handshakes
[] = {
534 {", HelloRequest", SSL3_MT_HELLO_REQUEST
},
535 {", ClientHello", SSL3_MT_CLIENT_HELLO
},
536 {", ServerHello", SSL3_MT_SERVER_HELLO
},
537 {", HelloVerifyRequest", DTLS1_MT_HELLO_VERIFY_REQUEST
},
538 {", NewSessionTicket", SSL3_MT_NEWSESSION_TICKET
},
539 {", EndOfEarlyData", SSL3_MT_END_OF_EARLY_DATA
},
540 {", EncryptedExtensions", SSL3_MT_ENCRYPTED_EXTENSIONS
},
541 {", Certificate", SSL3_MT_CERTIFICATE
},
542 {", ServerKeyExchange", SSL3_MT_SERVER_KEY_EXCHANGE
},
543 {", CertificateRequest", SSL3_MT_CERTIFICATE_REQUEST
},
544 {", ServerHelloDone", SSL3_MT_SERVER_DONE
},
545 {", CertificateVerify", SSL3_MT_CERTIFICATE_VERIFY
},
546 {", ClientKeyExchange", SSL3_MT_CLIENT_KEY_EXCHANGE
},
547 {", Finished", SSL3_MT_FINISHED
},
548 {", CertificateUrl", SSL3_MT_CERTIFICATE_URL
},
549 {", CertificateStatus", SSL3_MT_CERTIFICATE_STATUS
},
550 {", SupplementalData", SSL3_MT_SUPPLEMENTAL_DATA
},
551 {", KeyUpdate", SSL3_MT_KEY_UPDATE
},
552 #ifndef OPENSSL_NO_NEXTPROTONEG
553 {", NextProto", SSL3_MT_NEXT_PROTO
},
555 {", MessageHash", SSL3_MT_MESSAGE_HASH
},
559 void msg_cb(int write_p
, int version
, int content_type
, const void *buf
,
560 size_t len
, SSL
*ssl
, void *arg
)
563 const char *str_write_p
= write_p
? ">>>" : "<<<";
564 const char *str_version
= lookup(version
, ssl_versions
, "???");
565 const char *str_content_type
= "", *str_details1
= "", *str_details2
= "";
566 const unsigned char* bp
= buf
;
568 if (version
== SSL3_VERSION
||
569 version
== TLS1_VERSION
||
570 version
== TLS1_1_VERSION
||
571 version
== TLS1_2_VERSION
||
572 version
== TLS1_3_VERSION
||
573 version
== DTLS1_VERSION
|| version
== DTLS1_BAD_VER
) {
574 switch (content_type
) {
576 str_content_type
= ", ChangeCipherSpec";
579 str_content_type
= ", Alert";
580 str_details1
= ", ???";
584 str_details1
= ", warning";
587 str_details1
= ", fatal";
590 str_details2
= lookup((int)bp
[1], alert_types
, " ???");
594 str_content_type
= ", Handshake";
595 str_details1
= "???";
597 str_details1
= lookup((int)bp
[0], handshakes
, "???");
600 str_content_type
= ", ApplicationData";
602 #ifndef OPENSSL_NO_HEARTBEATS
604 str_details1
= ", Heartbeat";
609 str_details1
= ", HeartbeatRequest";
612 str_details1
= ", HeartbeatResponse";
621 BIO_printf(bio
, "%s %s%s [length %04lx]%s%s\n", str_write_p
, str_version
,
622 str_content_type
, (unsigned long)len
, str_details1
,
628 BIO_printf(bio
, " ");
630 for (i
= 0; i
< num
; i
++) {
631 if (i
% 16 == 0 && i
> 0)
632 BIO_printf(bio
, "\n ");
633 BIO_printf(bio
, " %02x", ((const unsigned char *)buf
)[i
]);
636 BIO_printf(bio
, " ...");
637 BIO_printf(bio
, "\n");
639 (void)BIO_flush(bio
);
642 static STRINT_PAIR tlsext_types
[] = {
643 {"server name", TLSEXT_TYPE_server_name
},
644 {"max fragment length", TLSEXT_TYPE_max_fragment_length
},
645 {"client certificate URL", TLSEXT_TYPE_client_certificate_url
},
646 {"trusted CA keys", TLSEXT_TYPE_trusted_ca_keys
},
647 {"truncated HMAC", TLSEXT_TYPE_truncated_hmac
},
648 {"status request", TLSEXT_TYPE_status_request
},
649 {"user mapping", TLSEXT_TYPE_user_mapping
},
650 {"client authz", TLSEXT_TYPE_client_authz
},
651 {"server authz", TLSEXT_TYPE_server_authz
},
652 {"cert type", TLSEXT_TYPE_cert_type
},
653 {"supported_groups", TLSEXT_TYPE_supported_groups
},
654 {"EC point formats", TLSEXT_TYPE_ec_point_formats
},
655 {"SRP", TLSEXT_TYPE_srp
},
656 {"signature algorithms", TLSEXT_TYPE_signature_algorithms
},
657 {"use SRTP", TLSEXT_TYPE_use_srtp
},
658 {"heartbeat", TLSEXT_TYPE_heartbeat
},
659 {"session ticket", TLSEXT_TYPE_session_ticket
},
660 {"renegotiation info", TLSEXT_TYPE_renegotiate
},
661 {"signed certificate timestamps", TLSEXT_TYPE_signed_certificate_timestamp
},
662 {"TLS padding", TLSEXT_TYPE_padding
},
663 #ifdef TLSEXT_TYPE_next_proto_neg
664 {"next protocol", TLSEXT_TYPE_next_proto_neg
},
666 #ifdef TLSEXT_TYPE_encrypt_then_mac
667 {"encrypt-then-mac", TLSEXT_TYPE_encrypt_then_mac
},
669 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
670 {"application layer protocol negotiation",
671 TLSEXT_TYPE_application_layer_protocol_negotiation
},
673 #ifdef TLSEXT_TYPE_extended_master_secret
674 {"extended master secret", TLSEXT_TYPE_extended_master_secret
},
676 {"key share", TLSEXT_TYPE_key_share
},
677 {"supported versions", TLSEXT_TYPE_supported_versions
},
678 {"psk", TLSEXT_TYPE_psk
},
679 {"psk kex modes", TLSEXT_TYPE_psk_kex_modes
},
680 {"certificate authorities", TLSEXT_TYPE_certificate_authorities
},
681 {"post handshake auth", TLSEXT_TYPE_post_handshake_auth
},
685 void tlsext_cb(SSL
*s
, int client_server
, int type
,
686 const unsigned char *data
, int len
, void *arg
)
689 const char *extname
= lookup(type
, tlsext_types
, "unknown");
691 BIO_printf(bio
, "TLS %s extension \"%s\" (id=%d), len=%d\n",
692 client_server
? "server" : "client", extname
, type
, len
);
693 BIO_dump(bio
, (const char *)data
, len
);
694 (void)BIO_flush(bio
);
697 #ifndef OPENSSL_NO_SOCK
698 int generate_cookie_callback(SSL
*ssl
, unsigned char *cookie
,
699 unsigned int *cookie_len
)
701 unsigned char *buffer
;
704 BIO_ADDR
*lpeer
= NULL
, *peer
= NULL
;
706 /* Initialize a random secret */
707 if (!cookie_initialized
) {
708 if (RAND_bytes(cookie_secret
, COOKIE_SECRET_LENGTH
) <= 0) {
709 BIO_printf(bio_err
, "error setting random cookie secret\n");
712 cookie_initialized
= 1;
715 if (SSL_is_dtls(ssl
)) {
716 lpeer
= peer
= BIO_ADDR_new();
718 BIO_printf(bio_err
, "memory full\n");
722 /* Read peer information */
723 (void)BIO_dgram_get_peer(SSL_get_rbio(ssl
), peer
);
728 /* Create buffer with peer's address and port */
729 if (!BIO_ADDR_rawaddress(peer
, NULL
, &length
)) {
730 BIO_printf(bio_err
, "Failed getting peer address\n");
733 OPENSSL_assert(length
!= 0);
734 port
= BIO_ADDR_rawport(peer
);
735 length
+= sizeof(port
);
736 buffer
= app_malloc(length
, "cookie generate buffer");
738 memcpy(buffer
, &port
, sizeof(port
));
739 BIO_ADDR_rawaddress(peer
, buffer
+ sizeof(port
), NULL
);
741 /* Calculate HMAC of buffer using the secret */
742 HMAC(EVP_sha1(), cookie_secret
, COOKIE_SECRET_LENGTH
,
743 buffer
, length
, cookie
, cookie_len
);
745 OPENSSL_free(buffer
);
746 BIO_ADDR_free(lpeer
);
751 int verify_cookie_callback(SSL
*ssl
, const unsigned char *cookie
,
752 unsigned int cookie_len
)
754 unsigned char result
[EVP_MAX_MD_SIZE
];
755 unsigned int resultlength
;
757 /* Note: we check cookie_initialized because if it's not,
758 * it cannot be valid */
759 if (cookie_initialized
760 && generate_cookie_callback(ssl
, result
, &resultlength
)
761 && cookie_len
== resultlength
762 && memcmp(result
, cookie
, resultlength
) == 0)
768 int generate_stateless_cookie_callback(SSL
*ssl
, unsigned char *cookie
,
772 int res
= generate_cookie_callback(ssl
, cookie
, &temp
);
777 int verify_stateless_cookie_callback(SSL
*ssl
, const unsigned char *cookie
,
780 return verify_cookie_callback(ssl
, cookie
, cookie_len
);
786 * Example of extended certificate handling. Where the standard support of
787 * one certificate per algorithm is not sufficient an application can decide
788 * which certificate(s) to use at runtime based on whatever criteria it deems
792 /* Linked list of certificates, keys and chains */
793 struct ssl_excert_st
{
795 const char *certfile
;
798 const char *chainfile
;
801 STACK_OF(X509
) *chain
;
803 struct ssl_excert_st
*next
, *prev
;
806 static STRINT_PAIR chain_flags
[] = {
807 {"Overall Validity", CERT_PKEY_VALID
},
808 {"Sign with EE key", CERT_PKEY_SIGN
},
809 {"EE signature", CERT_PKEY_EE_SIGNATURE
},
810 {"CA signature", CERT_PKEY_CA_SIGNATURE
},
811 {"EE key parameters", CERT_PKEY_EE_PARAM
},
812 {"CA key parameters", CERT_PKEY_CA_PARAM
},
813 {"Explicitly sign with EE key", CERT_PKEY_EXPLICIT_SIGN
},
814 {"Issuer Name", CERT_PKEY_ISSUER_NAME
},
815 {"Certificate Type", CERT_PKEY_CERT_TYPE
},
819 static void print_chain_flags(SSL
*s
, int flags
)
823 for (pp
= chain_flags
; pp
->name
; ++pp
)
824 BIO_printf(bio_err
, "\t%s: %s\n",
826 (flags
& pp
->retval
) ? "OK" : "NOT OK");
827 BIO_printf(bio_err
, "\tSuite B: ");
828 if (SSL_set_cert_flags(s
, 0) & SSL_CERT_FLAG_SUITEB_128_LOS
)
829 BIO_puts(bio_err
, flags
& CERT_PKEY_SUITEB
? "OK\n" : "NOT OK\n");
831 BIO_printf(bio_err
, "not tested\n");
835 * Very basic selection callback: just use any certificate chain reported as
836 * valid. More sophisticated could prioritise according to local policy.
838 static int set_cert_cb(SSL
*ssl
, void *arg
)
841 SSL_EXCERT
*exc
= arg
;
842 #ifdef CERT_CB_TEST_RETRY
843 static int retry_cnt
;
847 "Certificate callback retry test: count %d\n",
852 SSL_certs_clear(ssl
);
858 * Go to end of list and traverse backwards since we prepend newer
859 * entries this retains the original order.
861 while (exc
->next
!= NULL
)
866 while (exc
!= NULL
) {
868 rv
= SSL_check_chain(ssl
, exc
->cert
, exc
->key
, exc
->chain
);
869 BIO_printf(bio_err
, "Checking cert chain %d:\nSubject: ", i
);
870 X509_NAME_print_ex(bio_err
, X509_get_subject_name(exc
->cert
), 0,
872 BIO_puts(bio_err
, "\n");
873 print_chain_flags(ssl
, rv
);
874 if (rv
& CERT_PKEY_VALID
) {
875 if (!SSL_use_certificate(ssl
, exc
->cert
)
876 || !SSL_use_PrivateKey(ssl
, exc
->key
)) {
880 * NB: we wouldn't normally do this as it is not efficient
881 * building chains on each connection better to cache the chain
884 if (exc
->build_chain
) {
885 if (!SSL_build_cert_chain(ssl
, 0))
887 } else if (exc
->chain
!= NULL
) {
888 SSL_set1_chain(ssl
, exc
->chain
);
896 void ssl_ctx_set_excert(SSL_CTX
*ctx
, SSL_EXCERT
*exc
)
898 SSL_CTX_set_cert_cb(ctx
, set_cert_cb
, exc
);
901 static int ssl_excert_prepend(SSL_EXCERT
**pexc
)
903 SSL_EXCERT
*exc
= app_malloc(sizeof(*exc
), "prepend cert");
905 memset(exc
, 0, sizeof(*exc
));
911 exc
->certform
= exc
->next
->certform
;
912 exc
->keyform
= exc
->next
->keyform
;
913 exc
->next
->prev
= exc
;
915 exc
->certform
= FORMAT_PEM
;
916 exc
->keyform
= FORMAT_PEM
;
922 void ssl_excert_free(SSL_EXCERT
*exc
)
929 X509_free(exc
->cert
);
930 EVP_PKEY_free(exc
->key
);
931 sk_X509_pop_free(exc
->chain
, X509_free
);
938 int load_excert(SSL_EXCERT
**pexc
)
940 SSL_EXCERT
*exc
= *pexc
;
943 /* If nothing in list, free and set to NULL */
944 if (exc
->certfile
== NULL
&& exc
->next
== NULL
) {
945 ssl_excert_free(exc
);
949 for (; exc
; exc
= exc
->next
) {
950 if (exc
->certfile
== NULL
) {
951 BIO_printf(bio_err
, "Missing filename\n");
954 exc
->cert
= load_cert(exc
->certfile
, exc
->certform
,
955 "Server Certificate");
956 if (exc
->cert
== NULL
)
958 if (exc
->keyfile
!= NULL
) {
959 exc
->key
= load_key(exc
->keyfile
, exc
->keyform
,
960 0, NULL
, NULL
, "Server Key");
962 exc
->key
= load_key(exc
->certfile
, exc
->certform
,
963 0, NULL
, NULL
, "Server Key");
965 if (exc
->key
== NULL
)
967 if (exc
->chainfile
!= NULL
) {
968 if (!load_certs(exc
->chainfile
, &exc
->chain
, FORMAT_PEM
, NULL
,
976 enum range
{ OPT_X_ENUM
};
978 int args_excert(int opt
, SSL_EXCERT
**pexc
)
980 SSL_EXCERT
*exc
= *pexc
;
982 assert(opt
> OPT_X__FIRST
);
983 assert(opt
< OPT_X__LAST
);
986 if (!ssl_excert_prepend(&exc
)) {
987 BIO_printf(bio_err
, " %s: Error initialising xcert\n",
994 switch ((enum range
)opt
) {
999 if (exc
->certfile
!= NULL
&& !ssl_excert_prepend(&exc
)) {
1000 BIO_printf(bio_err
, "%s: Error adding xcert\n", opt_getprog());
1004 exc
->certfile
= opt_arg();
1007 if (exc
->keyfile
!= NULL
) {
1008 BIO_printf(bio_err
, "%s: Key already specified\n", opt_getprog());
1011 exc
->keyfile
= opt_arg();
1014 if (exc
->chainfile
!= NULL
) {
1015 BIO_printf(bio_err
, "%s: Chain already specified\n",
1019 exc
->chainfile
= opt_arg();
1021 case OPT_X_CHAIN_BUILD
:
1022 exc
->build_chain
= 1;
1024 case OPT_X_CERTFORM
:
1025 if (!opt_format(opt_arg(), OPT_FMT_PEMDER
, &exc
->certform
))
1029 if (!opt_format(opt_arg(), OPT_FMT_PEMDER
, &exc
->keyform
))
1036 ERR_print_errors(bio_err
);
1037 ssl_excert_free(exc
);
1042 static void print_raw_cipherlist(SSL
*s
)
1044 const unsigned char *rlist
;
1045 static const unsigned char scsv_id
[] = { 0, 0xFF };
1046 size_t i
, rlistlen
, num
;
1047 if (!SSL_is_server(s
))
1049 num
= SSL_get0_raw_cipherlist(s
, NULL
);
1050 OPENSSL_assert(num
== 2);
1051 rlistlen
= SSL_get0_raw_cipherlist(s
, &rlist
);
1052 BIO_puts(bio_err
, "Client cipher list: ");
1053 for (i
= 0; i
< rlistlen
; i
+= num
, rlist
+= num
) {
1054 const SSL_CIPHER
*c
= SSL_CIPHER_find(s
, rlist
);
1056 BIO_puts(bio_err
, ":");
1058 BIO_puts(bio_err
, SSL_CIPHER_get_name(c
));
1059 } else if (memcmp(rlist
, scsv_id
, num
) == 0) {
1060 BIO_puts(bio_err
, "SCSV");
1063 BIO_puts(bio_err
, "0x");
1064 for (j
= 0; j
< num
; j
++)
1065 BIO_printf(bio_err
, "%02X", rlist
[j
]);
1068 BIO_puts(bio_err
, "\n");
1072 * Hex encoder for TLSA RRdata, not ':' delimited.
1074 static char *hexencode(const unsigned char *data
, size_t len
)
1076 static const char *hex
= "0123456789abcdef";
1079 size_t outlen
= 2 * len
+ 1;
1080 int ilen
= (int) outlen
;
1082 if (outlen
< len
|| ilen
< 0 || outlen
!= (size_t)ilen
) {
1083 BIO_printf(bio_err
, "%s: %zu-byte buffer too large to hexencode\n",
1084 opt_getprog(), len
);
1087 cp
= out
= app_malloc(ilen
, "TLSA hex data buffer");
1090 *cp
++ = hex
[(*data
>> 4) & 0x0f];
1091 *cp
++ = hex
[*data
++ & 0x0f];
1097 void print_verify_detail(SSL
*s
, BIO
*bio
)
1101 long verify_err
= SSL_get_verify_result(s
);
1103 if (verify_err
== X509_V_OK
) {
1104 const char *peername
= SSL_get0_peername(s
);
1106 BIO_printf(bio
, "Verification: OK\n");
1107 if (peername
!= NULL
)
1108 BIO_printf(bio
, "Verified peername: %s\n", peername
);
1110 const char *reason
= X509_verify_cert_error_string(verify_err
);
1112 BIO_printf(bio
, "Verification error: %s\n", reason
);
1115 if ((mdpth
= SSL_get0_dane_authority(s
, NULL
, &mspki
)) >= 0) {
1116 uint8_t usage
, selector
, mtype
;
1117 const unsigned char *data
= NULL
;
1121 mdpth
= SSL_get0_dane_tlsa(s
, &usage
, &selector
, &mtype
, &data
, &dlen
);
1124 * The TLSA data field can be quite long when it is a certificate,
1125 * public key or even a SHA2-512 digest. Because the initial octets of
1126 * ASN.1 certificates and public keys contain mostly boilerplate OIDs
1127 * and lengths, we show the last 12 bytes of the data instead, as these
1128 * are more likely to distinguish distinct TLSA records.
1130 #define TLSA_TAIL_SIZE 12
1131 if (dlen
> TLSA_TAIL_SIZE
)
1132 hexdata
= hexencode(data
+ dlen
- TLSA_TAIL_SIZE
, TLSA_TAIL_SIZE
);
1134 hexdata
= hexencode(data
, dlen
);
1135 BIO_printf(bio
, "DANE TLSA %d %d %d %s%s %s at depth %d\n",
1136 usage
, selector
, mtype
,
1137 (dlen
> TLSA_TAIL_SIZE
) ? "..." : "", hexdata
,
1138 (mspki
!= NULL
) ? "signed the certificate" :
1139 mdpth
? "matched TA certificate" : "matched EE certificate",
1141 OPENSSL_free(hexdata
);
1145 void print_ssl_summary(SSL
*s
)
1147 const SSL_CIPHER
*c
;
1150 BIO_printf(bio_err
, "Protocol version: %s\n", SSL_get_version(s
));
1151 print_raw_cipherlist(s
);
1152 c
= SSL_get_current_cipher(s
);
1153 BIO_printf(bio_err
, "Ciphersuite: %s\n", SSL_CIPHER_get_name(c
));
1154 do_print_sigalgs(bio_err
, s
, 0);
1155 peer
= SSL_get_peer_certificate(s
);
1159 BIO_puts(bio_err
, "Peer certificate: ");
1160 X509_NAME_print_ex(bio_err
, X509_get_subject_name(peer
),
1162 BIO_puts(bio_err
, "\n");
1163 if (SSL_get_peer_signature_nid(s
, &nid
))
1164 BIO_printf(bio_err
, "Hash used: %s\n", OBJ_nid2sn(nid
));
1165 if (SSL_get_peer_signature_type_nid(s
, &nid
))
1166 BIO_printf(bio_err
, "Signature type: %s\n", get_sigtype(nid
));
1167 print_verify_detail(s
, bio_err
);
1169 BIO_puts(bio_err
, "No peer certificate\n");
1172 #ifndef OPENSSL_NO_EC
1173 ssl_print_point_formats(bio_err
, s
);
1174 if (SSL_is_server(s
))
1175 ssl_print_groups(bio_err
, s
, 1);
1177 ssl_print_tmp_key(bio_err
, s
);
1179 if (!SSL_is_server(s
))
1180 ssl_print_tmp_key(bio_err
, s
);
1184 int config_ctx(SSL_CONF_CTX
*cctx
, STACK_OF(OPENSSL_STRING
) *str
,
1189 SSL_CONF_CTX_set_ssl_ctx(cctx
, ctx
);
1190 for (i
= 0; i
< sk_OPENSSL_STRING_num(str
); i
+= 2) {
1191 const char *flag
= sk_OPENSSL_STRING_value(str
, i
);
1192 const char *arg
= sk_OPENSSL_STRING_value(str
, i
+ 1);
1193 if (SSL_CONF_cmd(cctx
, flag
, arg
) <= 0) {
1195 BIO_printf(bio_err
, "Error with command: \"%s %s\"\n",
1198 BIO_printf(bio_err
, "Error with command: \"%s\"\n", flag
);
1199 ERR_print_errors(bio_err
);
1203 if (!SSL_CONF_CTX_finish(cctx
)) {
1204 BIO_puts(bio_err
, "Error finishing context\n");
1205 ERR_print_errors(bio_err
);
1211 static int add_crls_store(X509_STORE
*st
, STACK_OF(X509_CRL
) *crls
)
1215 for (i
= 0; i
< sk_X509_CRL_num(crls
); i
++) {
1216 crl
= sk_X509_CRL_value(crls
, i
);
1217 X509_STORE_add_crl(st
, crl
);
1222 int ssl_ctx_add_crls(SSL_CTX
*ctx
, STACK_OF(X509_CRL
) *crls
, int crl_download
)
1225 st
= SSL_CTX_get_cert_store(ctx
);
1226 add_crls_store(st
, crls
);
1228 store_setup_crl_download(st
);
1232 int ssl_load_stores(SSL_CTX
*ctx
,
1233 const char *vfyCApath
, const char *vfyCAfile
,
1234 const char *chCApath
, const char *chCAfile
,
1235 STACK_OF(X509_CRL
) *crls
, int crl_download
)
1237 X509_STORE
*vfy
= NULL
, *ch
= NULL
;
1239 if (vfyCApath
!= NULL
|| vfyCAfile
!= NULL
) {
1240 vfy
= X509_STORE_new();
1243 if (!X509_STORE_load_locations(vfy
, vfyCAfile
, vfyCApath
))
1245 add_crls_store(vfy
, crls
);
1246 SSL_CTX_set1_verify_cert_store(ctx
, vfy
);
1248 store_setup_crl_download(vfy
);
1250 if (chCApath
!= NULL
|| chCAfile
!= NULL
) {
1251 ch
= X509_STORE_new();
1254 if (!X509_STORE_load_locations(ch
, chCAfile
, chCApath
))
1256 SSL_CTX_set1_chain_cert_store(ctx
, ch
);
1260 X509_STORE_free(vfy
);
1261 X509_STORE_free(ch
);
1265 /* Verbose print out of security callback */
1270 int (*old_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1271 void *other
, void *ex
);
1272 } security_debug_ex
;
1274 static STRINT_PAIR callback_types
[] = {
1275 {"Supported Ciphersuite", SSL_SECOP_CIPHER_SUPPORTED
},
1276 {"Shared Ciphersuite", SSL_SECOP_CIPHER_SHARED
},
1277 {"Check Ciphersuite", SSL_SECOP_CIPHER_CHECK
},
1278 #ifndef OPENSSL_NO_DH
1279 {"Temp DH key bits", SSL_SECOP_TMP_DH
},
1281 {"Supported Curve", SSL_SECOP_CURVE_SUPPORTED
},
1282 {"Shared Curve", SSL_SECOP_CURVE_SHARED
},
1283 {"Check Curve", SSL_SECOP_CURVE_CHECK
},
1284 {"Supported Signature Algorithm digest", SSL_SECOP_SIGALG_SUPPORTED
},
1285 {"Shared Signature Algorithm digest", SSL_SECOP_SIGALG_SHARED
},
1286 {"Check Signature Algorithm digest", SSL_SECOP_SIGALG_CHECK
},
1287 {"Signature Algorithm mask", SSL_SECOP_SIGALG_MASK
},
1288 {"Certificate chain EE key", SSL_SECOP_EE_KEY
},
1289 {"Certificate chain CA key", SSL_SECOP_CA_KEY
},
1290 {"Peer Chain EE key", SSL_SECOP_PEER_EE_KEY
},
1291 {"Peer Chain CA key", SSL_SECOP_PEER_CA_KEY
},
1292 {"Certificate chain CA digest", SSL_SECOP_CA_MD
},
1293 {"Peer chain CA digest", SSL_SECOP_PEER_CA_MD
},
1294 {"SSL compression", SSL_SECOP_COMPRESSION
},
1295 {"Session ticket", SSL_SECOP_TICKET
},
1299 static int security_callback_debug(const SSL
*s
, const SSL_CTX
*ctx
,
1300 int op
, int bits
, int nid
,
1301 void *other
, void *ex
)
1303 security_debug_ex
*sdb
= ex
;
1304 int rv
, show_bits
= 1, cert_md
= 0;
1306 rv
= sdb
->old_cb(s
, ctx
, op
, bits
, nid
, other
, ex
);
1307 if (rv
== 1 && sdb
->verbose
< 2)
1309 BIO_puts(sdb
->out
, "Security callback: ");
1311 nm
= lookup(op
, callback_types
, NULL
);
1313 case SSL_SECOP_TICKET
:
1314 case SSL_SECOP_COMPRESSION
:
1318 case SSL_SECOP_VERSION
:
1319 BIO_printf(sdb
->out
, "Version=%s", lookup(nid
, ssl_versions
, "???"));
1323 case SSL_SECOP_CA_MD
:
1324 case SSL_SECOP_PEER_CA_MD
:
1329 BIO_printf(sdb
->out
, "%s=", nm
);
1331 switch (op
& SSL_SECOP_OTHER_TYPE
) {
1333 case SSL_SECOP_OTHER_CIPHER
:
1334 BIO_puts(sdb
->out
, SSL_CIPHER_get_name(other
));
1337 #ifndef OPENSSL_NO_EC
1338 case SSL_SECOP_OTHER_CURVE
:
1341 cname
= EC_curve_nid2nist(nid
);
1343 cname
= OBJ_nid2sn(nid
);
1344 BIO_puts(sdb
->out
, cname
);
1348 #ifndef OPENSSL_NO_DH
1349 case SSL_SECOP_OTHER_DH
:
1352 BIO_printf(sdb
->out
, "%d", DH_bits(dh
));
1356 case SSL_SECOP_OTHER_CERT
:
1359 int sig_nid
= X509_get_signature_nid(other
);
1360 BIO_puts(sdb
->out
, OBJ_nid2sn(sig_nid
));
1362 EVP_PKEY
*pkey
= X509_get0_pubkey(other
);
1363 const char *algname
= "";
1364 EVP_PKEY_asn1_get0_info(NULL
, NULL
, NULL
, NULL
,
1365 &algname
, EVP_PKEY_get0_asn1(pkey
));
1366 BIO_printf(sdb
->out
, "%s, bits=%d",
1367 algname
, EVP_PKEY_bits(pkey
));
1371 case SSL_SECOP_OTHER_SIGALG
:
1373 const unsigned char *salg
= other
;
1374 const char *sname
= NULL
;
1376 case TLSEXT_signature_anonymous
:
1377 sname
= "anonymous";
1379 case TLSEXT_signature_rsa
:
1382 case TLSEXT_signature_dsa
:
1385 case TLSEXT_signature_ecdsa
:
1390 BIO_puts(sdb
->out
, OBJ_nid2sn(nid
));
1392 BIO_printf(sdb
->out
, ", algorithm=%s", sname
);
1394 BIO_printf(sdb
->out
, ", algid=%d", salg
[1]);
1401 BIO_printf(sdb
->out
, ", security bits=%d", bits
);
1402 BIO_printf(sdb
->out
, ": %s\n", rv
? "yes" : "no");
1406 void ssl_ctx_security_debug(SSL_CTX
*ctx
, int verbose
)
1408 static security_debug_ex sdb
;
1411 sdb
.verbose
= verbose
;
1412 sdb
.old_cb
= SSL_CTX_get_security_callback(ctx
);
1413 SSL_CTX_set_security_callback(ctx
, security_callback_debug
);
1414 SSL_CTX_set0_security_ex_data(ctx
, &sdb
);
1417 static void keylog_callback(const SSL
*ssl
, const char *line
)
1419 if (bio_keylog
== NULL
) {
1420 BIO_printf(bio_err
, "Keylog callback is invoked without valid file!\n");
1425 * There might be concurrent writers to the keylog file, so we must ensure
1426 * that the given line is written at once.
1428 BIO_printf(bio_keylog
, "%s\n", line
);
1429 (void)BIO_flush(bio_keylog
);
1432 int set_keylog_file(SSL_CTX
*ctx
, const char *keylog_file
)
1434 /* Close any open files */
1435 BIO_free_all(bio_keylog
);
1438 if (ctx
== NULL
|| keylog_file
== NULL
) {
1439 /* Keylogging is disabled, OK. */
1444 * Append rather than write in order to allow concurrent modification.
1445 * Furthermore, this preserves existing keylog files which is useful when
1446 * the tool is run multiple times.
1448 bio_keylog
= BIO_new_file(keylog_file
, "a");
1449 if (bio_keylog
== NULL
) {
1450 BIO_printf(bio_err
, "Error writing keylog file %s\n", keylog_file
);
1454 /* Write a header for seekable, empty files (this excludes pipes). */
1455 if (BIO_tell(bio_keylog
) == 0) {
1456 BIO_puts(bio_keylog
,
1457 "# SSL/TLS secrets log file, generated by OpenSSL\n");
1458 (void)BIO_flush(bio_keylog
);
1460 SSL_CTX_set_keylog_callback(ctx
, keylog_callback
);
1464 void print_ca_names(BIO
*bio
, SSL
*s
)
1466 const char *cs
= SSL_is_server(s
) ? "server" : "client";
1467 const STACK_OF(X509_NAME
) *sk
= SSL_get0_peer_CA_list(s
);
1470 if (sk
== NULL
|| sk_X509_NAME_num(sk
) == 0) {
1471 BIO_printf(bio
, "---\nNo %s certificate CA names sent\n", cs
);
1475 BIO_printf(bio
, "---\nAcceptable %s certificate CA names\n",cs
);
1476 for (i
= 0; i
< sk_X509_NAME_num(sk
); i
++) {
1477 X509_NAME_print_ex(bio
, sk_X509_NAME_value(sk
, i
), 0, get_nameopt());
1478 BIO_write(bio
, "\n", 1);