[thirdparty/openssl.git] / ssl / ssl_txt.c

/*
 * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
 * Copyright 2005 Nokia. All rights reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <stdio.h>
#include <openssl/buffer.h>
#include "ssl_local.h"

#ifndef OPENSSL_NO_STDIO
int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *x)
{
    BIO *b;
    int ret;

    if ((b = BIO_new(BIO_s_file())) == NULL) {
        ERR_raise(ERR_LIB_SSL, ERR_R_BUF_LIB);
        return 0;
    }
    BIO_set_fp(b, fp, BIO_NOCLOSE);
    ret = SSL_SESSION_print(b, x);
    BIO_free(b);
    return ret;
}
#endif

int SSL_SESSION_print(BIO *bp, const SSL_SESSION *x)
{
    size_t i;
    const char *s;
    int istls13;

    if (x == NULL)
        goto err;
    istls13 = (x->ssl_version == TLS1_3_VERSION);
    if (BIO_puts(bp, "SSL-Session:\n") <= 0)
        goto err;
    s = ssl_protocol_to_string(x->ssl_version);
    if (BIO_printf(bp, "    Protocol  : %s\n", s) <= 0)
        goto err;

    if (x->cipher == NULL) {
        if (((x->cipher_id) & 0xff000000) == 0x02000000) {
            if (BIO_printf(bp, "    Cipher    : %06lX\n",
                           x->cipher_id & 0xffffff) <= 0)
                goto err;
        } else {
            if (BIO_printf(bp, "    Cipher    : %04lX\n",
                           x->cipher_id & 0xffff) <= 0)
                goto err;
        }
    } else {
        if (BIO_printf(bp, "    Cipher    : %s\n",
                       ((x->cipher->name == NULL) ? "unknown"
                                                  : x->cipher->name)) <= 0)
            goto err;
    }
    if (BIO_puts(bp, "    Session-ID: ") <= 0)
        goto err;
    for (i = 0; i < x->session_id_length; i++) {
        if (BIO_printf(bp, "%02X", x->session_id[i]) <= 0)
            goto err;
    }
    if (BIO_puts(bp, "\n    Session-ID-ctx: ") <= 0)
        goto err;
    for (i = 0; i < x->sid_ctx_length; i++) {
        if (BIO_printf(bp, "%02X", x->sid_ctx[i]) <= 0)
            goto err;
    }
    if (istls13) {
        if (BIO_puts(bp, "\n    Resumption PSK: ") <= 0)
            goto err;
    } else if (BIO_puts(bp, "\n    Master-Key: ") <= 0)
        goto err;
    for (i = 0; i < x->master_key_length; i++) {
        if (BIO_printf(bp, "%02X", x->master_key[i]) <= 0)
            goto err;
    }
#ifndef OPENSSL_NO_PSK
    if (BIO_puts(bp, "\n    PSK identity: ") <= 0)
        goto err;
    if (BIO_printf(bp, "%s", x->psk_identity ? x->psk_identity : "None") <= 0)
        goto err;
    if (BIO_puts(bp, "\n    PSK identity hint: ") <= 0)
        goto err;
    if (BIO_printf
        (bp, "%s", x->psk_identity_hint ? x->psk_identity_hint : "None") <= 0)
        goto err;
#endif
#ifndef OPENSSL_NO_SRP
    if (BIO_puts(bp, "\n    SRP username: ") <= 0)
        goto err;
    if (BIO_printf(bp, "%s", x->srp_username ? x->srp_username : "None") <= 0)
        goto err;
#endif
    if (x->ext.tick_lifetime_hint) {
        if (BIO_printf(bp,
                       "\n    TLS session ticket lifetime hint: %ld (seconds)",
                       x->ext.tick_lifetime_hint) <= 0)
            goto err;
    }
    if (x->ext.tick) {
        if (BIO_puts(bp, "\n    TLS session ticket:\n") <= 0)
            goto err;
        if (BIO_dump_indent
            (bp, (const char *)x->ext.tick, (int)x->ext.ticklen, 4)
            <= 0)
            goto err;
    }
#ifndef OPENSSL_NO_COMP
    if (x->compress_meth != 0) {
        SSL_COMP *comp = NULL;

        if (!ssl_cipher_get_evp(NULL, x, NULL, NULL, NULL, NULL, &comp, 0))
            goto err;
        if (comp == NULL) {
            if (BIO_printf(bp, "\n    Compression: %d", x->compress_meth) <= 0)
                goto err;
        } else {
            if (BIO_printf(bp, "\n    Compression: %d (%s)", comp->id,
                           comp->name) <= 0)
                goto err;
        }
    }
#endif
    if (!ossl_time_is_zero(x->time)) {
        if (BIO_printf(bp, "\n    Start Time: %lld",
                       (long long)ossl_time_to_time_t(x->time)) <= 0)
            goto err;
    }
    if (!ossl_time_is_zero(x->timeout)) {
        if (BIO_printf(bp, "\n    Timeout   : %lld (sec)",
                       (long long)ossl_time2seconds(x->timeout)) <= 0)
            goto err;
    }
    if (BIO_puts(bp, "\n") <= 0)
        goto err;

    if (BIO_puts(bp, "    Verify return code: ") <= 0)
        goto err;
    if (BIO_printf(bp, "%ld (%s)\n", x->verify_result,
                   X509_verify_cert_error_string(x->verify_result)) <= 0)
        goto err;

    if (BIO_printf(bp, "    Extended master secret: %s\n",
                   x->flags & SSL_SESS_FLAG_EXTMS ? "yes" : "no") <= 0)
        goto err;

    if (istls13) {
        if (BIO_printf(bp, "    Max Early Data: %u\n",
                       (unsigned int)x->ext.max_early_data) <= 0)
            goto err;
    }

    return 1;
 err:
    return 0;
}

/*
 * print session id and master key in NSS keylog format (RSA
 * Session-ID:<session id> Master-Key:<master key>)
 */
int SSL_SESSION_print_keylog(BIO *bp, const SSL_SESSION *x)
{
    size_t i;

    if (x == NULL)
        goto err;
    if (x->session_id_length == 0 || x->master_key_length == 0)
        goto err;

    /*
     * the RSA prefix is required by the format's definition although there's
     * nothing RSA-specific in the output, therefore, we don't have to check if
     * the cipher suite is based on RSA
     */
    if (BIO_puts(bp, "RSA ") <= 0)
        goto err;

    if (BIO_puts(bp, "Session-ID:") <= 0)
        goto err;
    for (i = 0; i < x->session_id_length; i++) {
        if (BIO_printf(bp, "%02X", x->session_id[i]) <= 0)
            goto err;
    }
    if (BIO_puts(bp, " Master-Key:") <= 0)
        goto err;
    for (i = 0; i < x->master_key_length; i++) {
        if (BIO_printf(bp, "%02X", x->master_key[i]) <= 0)
            goto err;
    }
    if (BIO_puts(bp, "\n") <= 0)
        goto err;

    return 1;
 err:
    return 0;
}
Commit	Line	Data
846e33c7	1	/*
fecb3aae	2	* Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
c80149d9	3	* Copyright 2005 Nokia. All rights reserved.
d02b48c6	4	*
2c18d164	5	* Licensed under the Apache License 2.0 (the "License"). You may not use
846e33c7 RS	6	* this file except in compliance with the License. You can obtain a copy
	7	* in the file LICENSE in the source distribution or at
	8	* https://www.openssl.org/source/license.html
d02b48c6	9	*/
846e33c7	10
d02b48c6	11	#include <stdio.h>
ec577822	12	#include <openssl/buffer.h>
706457b7	13	#include "ssl_local.h"
d02b48c6	14
4b618848	15	#ifndef OPENSSL_NO_STDIO
0821bcd4	16	int SSL_SESSION_print_fp(FILE fp, const SSL_SESSION x)
0f113f3e MC	17	{
	18	BIO *b;
	19	int ret;
d02b48c6	20
9982cbbb	21	if ((b = BIO_new(BIO_s_file())) == NULL) {
6849b73c	22	ERR_raise(ERR_LIB_SSL, ERR_R_BUF_LIB);
26a7d938	23	return 0;
0f113f3e MC	24	}
	25	BIO_set_fp(b, fp, BIO_NOCLOSE);
	26	ret = SSL_SESSION_print(b, x);
	27	BIO_free(b);
26a7d938	28	return ret;
0f113f3e	29	}
d02b48c6 RE	30	#endif
d02b48c6 RE	31
0821bcd4	32	int SSL_SESSION_print(BIO bp, const SSL_SESSION x)
0f113f3e	33	{
ec60ccc1	34	size_t i;
0f113f3e	35	const char *s;
5281bb22	36	int istls13;
d02b48c6	37
0f113f3e MC	38	if (x == NULL)
0f113f3e MC	39	goto err;
5281bb22	40	istls13 = (x->ssl_version == TLS1_3_VERSION);
0f113f3e MC	41	if (BIO_puts(bp, "SSL-Session:\n") <= 0)
0f113f3e MC	42	goto err;
3eb2aff4	43	s = ssl_protocol_to_string(x->ssl_version);
0f113f3e MC	44	if (BIO_printf(bp, " Protocol : %s\n", s) <= 0)
0f113f3e MC	45	goto err;
58964a49	46
0f113f3e MC	47	if (x->cipher == NULL) {
0f113f3e MC	48	if (((x->cipher_id) & 0xff000000) == 0x02000000) {
d61e6040 TK	49	if (BIO_printf(bp, " Cipher : %06lX\n",
d61e6040 TK	50	x->cipher_id & 0xffffff) <= 0)
0f113f3e MC	51	goto err;
0f113f3e MC	52	} else {
d61e6040 TK	53	if (BIO_printf(bp, " Cipher : %04lX\n",
d61e6040 TK	54	x->cipher_id & 0xffff) <= 0)
0f113f3e MC	55	goto err;
	56	}
	57	} else {
d61e6040 TK	58	if (BIO_printf(bp, " Cipher : %s\n",
	59	((x->cipher->name == NULL) ? "unknown"
	60	: x->cipher->name)) <= 0)
0f113f3e MC	61	goto err;
	62	}
	63	if (BIO_puts(bp, " Session-ID: ") <= 0)
	64	goto err;
	65	for (i = 0; i < x->session_id_length; i++) {
	66	if (BIO_printf(bp, "%02X", x->session_id[i]) <= 0)
	67	goto err;
	68	}
	69	if (BIO_puts(bp, "\n Session-ID-ctx: ") <= 0)
	70	goto err;
	71	for (i = 0; i < x->sid_ctx_length; i++) {
	72	if (BIO_printf(bp, "%02X", x->sid_ctx[i]) <= 0)
	73	goto err;
	74	}
32f803d8 MC	75	if (istls13) {
	76	if (BIO_puts(bp, "\n Resumption PSK: ") <= 0)
	77	goto err;
	78	} else if (BIO_puts(bp, "\n Master-Key: ") <= 0)
0f113f3e	79	goto err;
ec60ccc1	80	for (i = 0; i < x->master_key_length; i++) {
0f113f3e MC	81	if (BIO_printf(bp, "%02X", x->master_key[i]) <= 0)
	82	goto err;
	83	}
ddac1974	84	#ifndef OPENSSL_NO_PSK
0f113f3e MC	85	if (BIO_puts(bp, "\n PSK identity: ") <= 0)
	86	goto err;
	87	if (BIO_printf(bp, "%s", x->psk_identity ? x->psk_identity : "None") <= 0)
	88	goto err;
	89	if (BIO_puts(bp, "\n PSK identity hint: ") <= 0)
	90	goto err;
	91	if (BIO_printf
	92	(bp, "%s", x->psk_identity_hint ? x->psk_identity_hint : "None") <= 0)
	93	goto err;
ddac1974	94	#endif
edc032b5	95	#ifndef OPENSSL_NO_SRP
0f113f3e MC	96	if (BIO_puts(bp, "\n SRP username: ") <= 0)
	97	goto err;
	98	if (BIO_printf(bp, "%s", x->srp_username ? x->srp_username : "None") <= 0)
	99	goto err;
edc032b5	100	#endif
aff8c126	101	if (x->ext.tick_lifetime_hint) {
0f113f3e MC	102	if (BIO_printf(bp,
0f113f3e MC	103	"\n TLS session ticket lifetime hint: %ld (seconds)",
aff8c126	104	x->ext.tick_lifetime_hint) <= 0)
0f113f3e MC	105	goto err;
0f113f3e MC	106	}
aff8c126	107	if (x->ext.tick) {
0f113f3e MC	108	if (BIO_puts(bp, "\n TLS session ticket:\n") <= 0)
0f113f3e MC	109	goto err;
a230b26e	110	if (BIO_dump_indent
aff8c126	111	(bp, (const char *)x->ext.tick, (int)x->ext.ticklen, 4)
0f113f3e MC	112	<= 0)
	113	goto err;
	114	}
09b6c2ef	115	#ifndef OPENSSL_NO_COMP
0f113f3e MC	116	if (x->compress_meth != 0) {
0f113f3e MC	117	SSL_COMP *comp = NULL;
413c4f45	118
c8f6c28a	119	if (!ssl_cipher_get_evp(NULL, x, NULL, NULL, NULL, NULL, &comp, 0))
69f68237	120	goto err;
0f113f3e	121	if (comp == NULL) {
a230b26e	122	if (BIO_printf(bp, "\n Compression: %d", x->compress_meth) <= 0)
0f113f3e MC	123	goto err;
0f113f3e MC	124	} else {
9a555706	125	if (BIO_printf(bp, "\n Compression: %d (%s)", comp->id,
a230b26e	126	comp->name) <= 0)
0f113f3e MC	127	goto err;
	128	}
	129	}
09b6c2ef	130	#endif
f0131dc0 P	131	if (!ossl_time_is_zero(x->time)) {
	132	if (BIO_printf(bp, "\n Start Time: %lld",
	133	(long long)ossl_time_to_time_t(x->time)) <= 0)
0f113f3e MC	134	goto err;
0f113f3e MC	135	}
f0131dc0 P	136	if (!ossl_time_is_zero(x->timeout)) {
	137	if (BIO_printf(bp, "\n Timeout : %lld (sec)",
	138	(long long)ossl_time2seconds(x->timeout)) <= 0)
0f113f3e MC	139	goto err;
	140	}
	141	if (BIO_puts(bp, "\n") <= 0)
	142	goto err;
	143
	144	if (BIO_puts(bp, " Verify return code: ") <= 0)
	145	goto err;
	146	if (BIO_printf(bp, "%ld (%s)\n", x->verify_result,
	147	X509_verify_cert_error_string(x->verify_result)) <= 0)
	148	goto err;
25f923dd	149
ddc06b35 DSH	150	if (BIO_printf(bp, " Extended master secret: %s\n",
	151	x->flags & SSL_SESS_FLAG_EXTMS ? "yes" : "no") <= 0)
	152	goto err;
	153
32f803d8 MC	154	if (istls13) {
32f803d8 MC	155	if (BIO_printf(bp, " Max Early Data: %u\n",
1555c86e	156	(unsigned int)x->ext.max_early_data) <= 0)
32f803d8 MC	157	goto err;
	158	}
	159
208fb891	160	return 1;
0f113f3e	161	err:
26a7d938	162	return 0;
0f113f3e	163	}
d02b48c6	164
0f113f3e MC	165	/*
	166	* print session id and master key in NSS keylog format (RSA
	167	* Session-ID:<session id> Master-Key:<master key>)
	168	*/
189ae368	169	int SSL_SESSION_print_keylog(BIO bp, const SSL_SESSION x)
0f113f3e	170	{
ec60ccc1	171	size_t i;
189ae368	172
0f113f3e MC	173	if (x == NULL)
	174	goto err;
	175	if (x->session_id_length == 0 \|\| x->master_key_length == 0)
	176	goto err;
189ae368	177
0f113f3e MC	178	/*
0f113f3e MC	179	* the RSA prefix is required by the format's definition although there's
8483a003	180	* nothing RSA-specific in the output, therefore, we don't have to check if
0f113f3e MC	181	* the cipher suite is based on RSA
	182	*/
	183	if (BIO_puts(bp, "RSA ") <= 0)
	184	goto err;
189ae368	185
0f113f3e MC	186	if (BIO_puts(bp, "Session-ID:") <= 0)
	187	goto err;
	188	for (i = 0; i < x->session_id_length; i++) {
	189	if (BIO_printf(bp, "%02X", x->session_id[i]) <= 0)
	190	goto err;
	191	}
	192	if (BIO_puts(bp, " Master-Key:") <= 0)
	193	goto err;
ec60ccc1	194	for (i = 0; i < x->master_key_length; i++) {
0f113f3e MC	195	if (BIO_printf(bp, "%02X", x->master_key[i]) <= 0)
	196	goto err;
	197	}
	198	if (BIO_puts(bp, "\n") <= 0)
	199	goto err;
189ae368	200
208fb891	201	return 1;
0f113f3e	202	err:
26a7d938	203	return 0;
0f113f3e	204	}