xref: /openbsd-src/lib/libssl/ssl_stat.c (revision 738d3f535ecd13514bfa86321d2bb9916b1a9023)

/* $OpenBSD: ssl_stat.c,v 1.23 2024/10/12 03:54:18 tb Exp $ */
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 *
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 *
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 *
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */
/* ====================================================================
 * Copyright 2005 Nokia. All rights reserved.
 *
 * The portions of the attached software ("Contribution") is developed by
 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
 * license.
 *
 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
 * support (see RFC 4279) to OpenSSL.
 *
 * No patent licenses or other rights except those expressly stated in
 * the OpenSSL open source license shall be deemed granted or received
 * expressly, by implication, estoppel, or otherwise.
 *
 * No assurances are provided by Nokia that the Contribution does not
 * infringe the patent or other intellectual property rights of any third
 * party or that the license provides you with all the necessary rights
 * to make use of the Contribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
 * OTHERWISE.
 */

#include <stdio.h>

#include "ssl_local.h"

const char *
SSL_state_string_long(const SSL *s)
{
	switch (s->s3->hs.state) {
	case SSL_ST_BEFORE:
		return "before SSL initialization";
	case SSL_ST_ACCEPT:
		return "before accept initialization";
	case SSL_ST_CONNECT:
		return "before connect initialization";
	case SSL_ST_OK:
		return "SSL negotiation finished successfully";
	case SSL_ST_RENEGOTIATE:
		return "SSL renegotiate ciphers";
	case SSL_ST_BEFORE|SSL_ST_CONNECT:
		return "before/connect initialization";
	case SSL_ST_OK|SSL_ST_CONNECT:
		return "ok/connect SSL initialization";
	case SSL_ST_BEFORE|SSL_ST_ACCEPT:
		return "before/accept initialization";
	case SSL_ST_OK|SSL_ST_ACCEPT:
		return "ok/accept SSL initialization";

	/* SSLv3 additions */
	case SSL3_ST_CW_CLNT_HELLO_A:
		return "SSLv3 write client hello A";
	case SSL3_ST_CW_CLNT_HELLO_B:
		return "SSLv3 write client hello B";
	case SSL3_ST_CR_SRVR_HELLO_A:
		return "SSLv3 read server hello A";
	case SSL3_ST_CR_SRVR_HELLO_B:
		return "SSLv3 read server hello B";
	case SSL3_ST_CR_CERT_A:
		return "SSLv3 read server certificate A";
	case SSL3_ST_CR_CERT_B:
		return "SSLv3 read server certificate B";
	case SSL3_ST_CR_KEY_EXCH_A:
		return "SSLv3 read server key exchange A";
	case SSL3_ST_CR_KEY_EXCH_B:
		return "SSLv3 read server key exchange B";
	case SSL3_ST_CR_CERT_REQ_A:
		return "SSLv3 read server certificate request A";
	case SSL3_ST_CR_CERT_REQ_B:
		return "SSLv3 read server certificate request B";
	case SSL3_ST_CR_SESSION_TICKET_A:
		return "SSLv3 read server session ticket A";
	case SSL3_ST_CR_SESSION_TICKET_B:
		return "SSLv3 read server session ticket B";
	case SSL3_ST_CR_SRVR_DONE_A:
		return "SSLv3 read server done A";
	case SSL3_ST_CR_SRVR_DONE_B:
		return "SSLv3 read server done B";
	case SSL3_ST_CW_CERT_A:
		return "SSLv3 write client certificate A";
	case SSL3_ST_CW_CERT_B:
		return "SSLv3 write client certificate B";
	case SSL3_ST_CW_CERT_C:
		return "SSLv3 write client certificate C";
	case SSL3_ST_CW_CERT_D:
		return "SSLv3 write client certificate D";
	case SSL3_ST_CW_KEY_EXCH_A:
		return "SSLv3 write client key exchange A";
	case SSL3_ST_CW_KEY_EXCH_B:
		return "SSLv3 write client key exchange B";
	case SSL3_ST_CW_CERT_VRFY_A:
		return "SSLv3 write certificate verify A";
	case SSL3_ST_CW_CERT_VRFY_B:
		return "SSLv3 write certificate verify B";

	case SSL3_ST_CW_CHANGE_A:
	case SSL3_ST_SW_CHANGE_A:
		return "SSLv3 write change cipher spec A";
	case SSL3_ST_CW_CHANGE_B:
	case SSL3_ST_SW_CHANGE_B:
		return "SSLv3 write change cipher spec B";
	case SSL3_ST_CW_FINISHED_A:
	case SSL3_ST_SW_FINISHED_A:
		return "SSLv3 write finished A";
	case SSL3_ST_CW_FINISHED_B:
	case SSL3_ST_SW_FINISHED_B:
		return "SSLv3 write finished B";
	case SSL3_ST_CR_CHANGE_A:
	case SSL3_ST_SR_CHANGE_A:
		return "SSLv3 read change cipher spec A";
	case SSL3_ST_CR_CHANGE_B:
	case SSL3_ST_SR_CHANGE_B:
		return "SSLv3 read change cipher spec B";
	case SSL3_ST_CR_FINISHED_A:
	case SSL3_ST_SR_FINISHED_A:
		return "SSLv3 read finished A";
	case SSL3_ST_CR_FINISHED_B:
	case SSL3_ST_SR_FINISHED_B:
		return "SSLv3 read finished B";

	case SSL3_ST_CW_FLUSH:
	case SSL3_ST_SW_FLUSH:
		return "SSLv3 flush data";

	case SSL3_ST_SR_CLNT_HELLO_A:
		return "SSLv3 read client hello A";
	case SSL3_ST_SR_CLNT_HELLO_B:
		return "SSLv3 read client hello B";
	case SSL3_ST_SR_CLNT_HELLO_C:
		return "SSLv3 read client hello C";
	case SSL3_ST_SW_HELLO_REQ_A:
		return "SSLv3 write hello request A";
	case SSL3_ST_SW_HELLO_REQ_B:
		return "SSLv3 write hello request B";
	case SSL3_ST_SW_HELLO_REQ_C:
		return "SSLv3 write hello request C";
	case SSL3_ST_SW_SRVR_HELLO_A:
		return "SSLv3 write server hello A";
	case SSL3_ST_SW_SRVR_HELLO_B:
		return "SSLv3 write server hello B";
	case SSL3_ST_SW_CERT_A:
		return "SSLv3 write certificate A";
	case SSL3_ST_SW_CERT_B:
		return "SSLv3 write certificate B";
	case SSL3_ST_SW_KEY_EXCH_A:
		return "SSLv3 write key exchange A";
	case SSL3_ST_SW_KEY_EXCH_B:
		return "SSLv3 write key exchange B";
	case SSL3_ST_SW_CERT_REQ_A:
		return "SSLv3 write certificate request A";
	case SSL3_ST_SW_CERT_REQ_B:
		return "SSLv3 write certificate request B";
	case SSL3_ST_SW_SESSION_TICKET_A:
		return "SSLv3 write session ticket A";
	case SSL3_ST_SW_SESSION_TICKET_B:
		return "SSLv3 write session ticket B";
	case SSL3_ST_SW_SRVR_DONE_A:
		return "SSLv3 write server done A";
	case SSL3_ST_SW_SRVR_DONE_B:
		return "SSLv3 write server done B";
	case SSL3_ST_SR_CERT_A:
		return "SSLv3 read client certificate A";
	case SSL3_ST_SR_CERT_B:
		return "SSLv3 read client certificate B";
	case SSL3_ST_SR_KEY_EXCH_A:
		return "SSLv3 read client key exchange A";
	case SSL3_ST_SR_KEY_EXCH_B:
		return "SSLv3 read client key exchange B";
	case SSL3_ST_SR_CERT_VRFY_A:
		return "SSLv3 read certificate verify A";
	case SSL3_ST_SR_CERT_VRFY_B:
		return "SSLv3 read certificate verify B";

	/* DTLS */
	case DTLS1_ST_CR_HELLO_VERIFY_REQUEST_A:
		return "DTLS1 read hello verify request A";
	case DTLS1_ST_CR_HELLO_VERIFY_REQUEST_B:
		return "DTLS1 read hello verify request B";
	case DTLS1_ST_SW_HELLO_VERIFY_REQUEST_A:
		return "DTLS1 write hello verify request A";
	case DTLS1_ST_SW_HELLO_VERIFY_REQUEST_B:
		return "DTLS1 write hello verify request B";

	default:
		return "unknown state";
	}
}
LSSL_ALIAS(SSL_state_string_long);

const char *
SSL_rstate_string_long(const SSL *s)
{
	switch (s->rstate) {
	case SSL_ST_READ_HEADER:
		return "read header";
	case SSL_ST_READ_BODY:
		return "read body";
	case SSL_ST_READ_DONE:
		return "read done";
	default:
		return "unknown";
	}
}
LSSL_ALIAS(SSL_rstate_string_long);

const char *
SSL_state_string(const SSL *s)
{
	switch (s->s3->hs.state) {
	case SSL_ST_BEFORE:
		return "PINIT ";
	case SSL_ST_ACCEPT:
		return "AINIT ";
	case SSL_ST_CONNECT:
		return "CINIT ";
	case SSL_ST_OK:
		return "SSLOK ";

	/* SSLv3 additions */
	case SSL3_ST_SW_FLUSH:
	case SSL3_ST_CW_FLUSH:
		return "3FLUSH";
	case SSL3_ST_CW_CLNT_HELLO_A:
		return "3WCH_A";
	case SSL3_ST_CW_CLNT_HELLO_B:
		return "3WCH_B";
	case SSL3_ST_CR_SRVR_HELLO_A:
		return "3RSH_A";
	case SSL3_ST_CR_SRVR_HELLO_B:
		return "3RSH_B";
	case SSL3_ST_CR_CERT_A:
		return "3RSC_A";
	case SSL3_ST_CR_CERT_B:
		return "3RSC_B";
	case SSL3_ST_CR_KEY_EXCH_A:
		return "3RSKEA";
	case SSL3_ST_CR_KEY_EXCH_B:
		return "3RSKEB";
	case SSL3_ST_CR_CERT_REQ_A:
		return "3RCR_A";
	case SSL3_ST_CR_CERT_REQ_B:
		return "3RCR_B";
	case SSL3_ST_CR_SRVR_DONE_A:
		return "3RSD_A";
	case SSL3_ST_CR_SRVR_DONE_B:
		return "3RSD_B";
	case SSL3_ST_CW_CERT_A:
		return "3WCC_A";
	case SSL3_ST_CW_CERT_B:
		return "3WCC_B";
	case SSL3_ST_CW_CERT_C:
		return "3WCC_C";
	case SSL3_ST_CW_CERT_D:
		return "3WCC_D";
	case SSL3_ST_CW_KEY_EXCH_A:
		return "3WCKEA";
	case SSL3_ST_CW_KEY_EXCH_B:
		return "3WCKEB";
	case SSL3_ST_CW_CERT_VRFY_A:
		return "3WCV_A";
	case SSL3_ST_CW_CERT_VRFY_B:
		return "3WCV_B";

	case SSL3_ST_SW_CHANGE_A:
	case SSL3_ST_CW_CHANGE_A:
		return "3WCCSA";
	case SSL3_ST_SW_CHANGE_B:
	case SSL3_ST_CW_CHANGE_B:
		return "3WCCSB";
	case SSL3_ST_SW_FINISHED_A:
	case SSL3_ST_CW_FINISHED_A:
		return "3WFINA";
	case SSL3_ST_SW_FINISHED_B:
	case SSL3_ST_CW_FINISHED_B:
		return "3WFINB";
	case SSL3_ST_SR_CHANGE_A:
	case SSL3_ST_CR_CHANGE_A:
		return "3RCCSA";
	case SSL3_ST_SR_CHANGE_B:
	case SSL3_ST_CR_CHANGE_B:
		return "3RCCSB";
	case SSL3_ST_SR_FINISHED_A:
	case SSL3_ST_CR_FINISHED_A:
		return "3RFINA";
	case SSL3_ST_SR_FINISHED_B:
	case SSL3_ST_CR_FINISHED_B:
		return "3RFINB";

	case SSL3_ST_SW_HELLO_REQ_A:
		return "3WHR_A";
	case SSL3_ST_SW_HELLO_REQ_B:
		return "3WHR_B";
	case SSL3_ST_SW_HELLO_REQ_C:
		return "3WHR_C";
	case SSL3_ST_SR_CLNT_HELLO_A:
		return "3RCH_A";
	case SSL3_ST_SR_CLNT_HELLO_B:
		return "3RCH_B";
	case SSL3_ST_SR_CLNT_HELLO_C:
		return "3RCH_C";
	case SSL3_ST_SW_SRVR_HELLO_A:
		return "3WSH_A";
	case SSL3_ST_SW_SRVR_HELLO_B:
		return "3WSH_B";
	case SSL3_ST_SW_CERT_A:
		return "3WSC_A";
	case SSL3_ST_SW_CERT_B:
		return "3WSC_B";
	case SSL3_ST_SW_KEY_EXCH_A:
		return "3WSKEA";
	case SSL3_ST_SW_KEY_EXCH_B:
		return "3WSKEB";
	case SSL3_ST_SW_CERT_REQ_A:
		return "3WCR_A";
	case SSL3_ST_SW_CERT_REQ_B:
		return "3WCR_B";
	case SSL3_ST_SW_SRVR_DONE_A:
		return "3WSD_A";
	case SSL3_ST_SW_SRVR_DONE_B:
		return "3WSD_B";
	case SSL3_ST_SR_CERT_A:
		return "3RCC_A";
	case SSL3_ST_SR_CERT_B:
		return "3RCC_B";
	case SSL3_ST_SR_KEY_EXCH_A:
		return "3RCKEA";
	case SSL3_ST_SR_KEY_EXCH_B:
		return "3RCKEB";
	case SSL3_ST_SR_CERT_VRFY_A:
		return "3RCV_A";
	case SSL3_ST_SR_CERT_VRFY_B:
		return "3RCV_B";

	/* DTLS */
	case DTLS1_ST_CR_HELLO_VERIFY_REQUEST_A:
		return "DRCHVA";
	case DTLS1_ST_CR_HELLO_VERIFY_REQUEST_B:
		return "DRCHVB";
	case DTLS1_ST_SW_HELLO_VERIFY_REQUEST_A:
		return "DWCHVA";
	case DTLS1_ST_SW_HELLO_VERIFY_REQUEST_B:
		return "DWCHVB";

	default:
		return "UNKWN ";
	}
}
LSSL_ALIAS(SSL_state_string);

const char *
SSL_alert_type_string_long(int value)
{
	value >>= 8;
	if (value == SSL3_AL_WARNING)
		return "warning";
	else if (value == SSL3_AL_FATAL)
		return "fatal";
	else
		return "unknown";
}
LSSL_ALIAS(SSL_alert_type_string_long);

const char *
SSL_alert_type_string(int value)
{
	value >>= 8;
	if (value == SSL3_AL_WARNING)
		return "W";
	else if (value == SSL3_AL_FATAL)
		return "F";
	else
		return "U";
}
LSSL_ALIAS(SSL_alert_type_string);

const char *
SSL_alert_desc_string(int value)
{
	switch (value & 0xff) {
	case SSL_AD_CLOSE_NOTIFY:
		return "CN";
	case SSL_AD_UNEXPECTED_MESSAGE:
		return "UM";
	case SSL_AD_BAD_RECORD_MAC:
		return "BM";
	case SSL_AD_RECORD_OVERFLOW:
		return "RO";
	case SSL_AD_DECOMPRESSION_FAILURE:
		return "DF";
	case SSL_AD_HANDSHAKE_FAILURE:
		return "HF";
	case SSL_AD_BAD_CERTIFICATE:
		return "BC";
	case SSL_AD_UNSUPPORTED_CERTIFICATE:
		return "UC";
	case SSL_AD_CERTIFICATE_REVOKED:
		return "CR";
	case SSL_AD_CERTIFICATE_EXPIRED:
		return "CE";
	case SSL_AD_CERTIFICATE_UNKNOWN:
		return "CU";
	case SSL_AD_ILLEGAL_PARAMETER:
		return "IP";
	case SSL_AD_UNKNOWN_CA:
		return "CA";
	case SSL_AD_ACCESS_DENIED:
		return "AD";
	case SSL_AD_DECODE_ERROR:
		return "DE";
	case SSL_AD_DECRYPT_ERROR:
		return "CY";
	case SSL_AD_PROTOCOL_VERSION:
		return "PV";
	case SSL_AD_INSUFFICIENT_SECURITY:
		return "IS";
	case SSL_AD_INTERNAL_ERROR:
		return "IE";
	case SSL_AD_INAPPROPRIATE_FALLBACK:
		return "IF";
	case SSL_AD_USER_CANCELLED:
		return "US";
	case SSL_AD_NO_RENEGOTIATION:
		return "NR";
	case SSL_AD_MISSING_EXTENSION:
		return "ME";
	case SSL_AD_UNSUPPORTED_EXTENSION:
		return "UE";
	case SSL_AD_CERTIFICATE_UNOBTAINABLE:
		return "CO";
	case SSL_AD_UNRECOGNIZED_NAME:
		return "UN";
	case SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE:
		return "BR";
	case SSL_AD_BAD_CERTIFICATE_HASH_VALUE:
		return "BH";
	case SSL_AD_UNKNOWN_PSK_IDENTITY:
		return "UP";
	case SSL_AD_CERTIFICATE_REQUIRED:
		return "CQ"; /* XXX */
	case SSL_AD_NO_APPLICATION_PROTOCOL:
		return "AP";
	default:
		return "UK";
	}
}
LSSL_ALIAS(SSL_alert_desc_string);

const char *
SSL_alert_desc_string_long(int value)
{
	switch (value & 0xff) {
	case SSL_AD_CLOSE_NOTIFY:
		return "close notify";
	case SSL_AD_UNEXPECTED_MESSAGE:
		return "unexpected_message";
	case SSL_AD_BAD_RECORD_MAC:
		return "bad record mac";
	case SSL_AD_RECORD_OVERFLOW:
		return "record overflow";
	case SSL_AD_DECOMPRESSION_FAILURE:
		return "decompression failure";
	case SSL_AD_HANDSHAKE_FAILURE:
		return "handshake failure";
	case SSL_AD_BAD_CERTIFICATE:
		return "bad certificate";
	case SSL_AD_UNSUPPORTED_CERTIFICATE:
		return "unsupported certificate";
	case SSL_AD_CERTIFICATE_REVOKED:
		return "certificate revoked";
	case SSL_AD_CERTIFICATE_EXPIRED:
		return "certificate expired";
	case SSL_AD_CERTIFICATE_UNKNOWN:
		return "certificate unknown";
	case SSL_AD_ILLEGAL_PARAMETER:
		return "illegal parameter";
	case SSL_AD_UNKNOWN_CA:
		return "unknown CA";
	case SSL_AD_ACCESS_DENIED:
		return "access denied";
	case SSL_AD_DECODE_ERROR:
		return "decode error";
	case SSL_AD_DECRYPT_ERROR:
		return "decrypt error";
	case SSL_AD_PROTOCOL_VERSION:
		return "protocol version";
	case SSL_AD_INSUFFICIENT_SECURITY:
		return "insufficient security";
	case SSL_AD_INTERNAL_ERROR:
		return "internal error";
	case SSL_AD_INAPPROPRIATE_FALLBACK:
		return "inappropriate fallback";
	case SSL_AD_USER_CANCELLED:
		return "user canceled";
	case SSL_AD_NO_RENEGOTIATION:
		return "no renegotiation";
	case SSL_AD_MISSING_EXTENSION:
		return "missing extension";
	case SSL_AD_UNSUPPORTED_EXTENSION:
		return "unsupported extension";
	case SSL_AD_CERTIFICATE_UNOBTAINABLE:
		return "certificate unobtainable";
	case SSL_AD_UNRECOGNIZED_NAME:
		return "unrecognized name";
	case SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE:
		return "bad certificate status response";
	case SSL_AD_BAD_CERTIFICATE_HASH_VALUE:
		return "bad certificate hash value";
	case SSL_AD_UNKNOWN_PSK_IDENTITY:
		return "unknown PSK identity";
	case SSL_AD_CERTIFICATE_REQUIRED:
		return "certificate required";
	case SSL_AD_NO_APPLICATION_PROTOCOL:
		return "no application protocol";
	default:
		return "unknown";
	}
}
LSSL_ALIAS(SSL_alert_desc_string_long);

const char *
SSL_rstate_string(const SSL *s)
{
	switch (s->rstate) {
	case SSL_ST_READ_HEADER:
		return "RH";
	case SSL_ST_READ_BODY:
		return "RB";
	case SSL_ST_READ_DONE:
		return "RD";
	default:
		return "unknown";
	}
}
LSSL_ALIAS(SSL_rstate_string);