Rename some lowercase API's
[openssl.git] / ssl / ssl_txt.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57 /* ====================================================================
58  * Copyright 2005 Nokia. All rights reserved.
59  *
60  * The portions of the attached software ("Contribution") is developed by
61  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
62  * license.
63  *
64  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
65  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
66  * support (see RFC 4279) to OpenSSL.
67  *
68  * No patent licenses or other rights except those expressly stated in
69  * the OpenSSL open source license shall be deemed granted or received
70  * expressly, by implication, estoppel, or otherwise.
71  *
72  * No assurances are provided by Nokia that the Contribution does not
73  * infringe the patent or other intellectual property rights of any third
74  * party or that the license provides you with all the necessary rights
75  * to make use of the Contribution.
76  *
77  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
78  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
79  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
80  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
81  * OTHERWISE.
82  */
83
84 #include <stdio.h>
85 #include <openssl/buffer.h>
86 #include "ssl_locl.h"
87
88 #ifndef OPENSSL_NO_STDIO
89 int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *x)
90 {
91     BIO *b;
92     int ret;
93
94     if ((b = BIO_new(BIO_s_file())) == NULL) {
95         SSLerr(SSL_F_SSL_SESSION_PRINT_FP, ERR_R_BUF_LIB);
96         return (0);
97     }
98     BIO_set_fp(b, fp, BIO_NOCLOSE);
99     ret = SSL_SESSION_print(b, x);
100     BIO_free(b);
101     return (ret);
102 }
103 #endif
104
105 int SSL_SESSION_print(BIO *bp, const SSL_SESSION *x)
106 {
107     unsigned int i;
108     const char *s;
109
110     if (x == NULL)
111         goto err;
112     if (BIO_puts(bp, "SSL-Session:\n") <= 0)
113         goto err;
114     s = ssl_protocol_to_string(x->ssl_version);
115     if (BIO_printf(bp, "    Protocol  : %s\n", s) <= 0)
116         goto err;
117
118     if (x->cipher == NULL) {
119         if (((x->cipher_id) & 0xff000000) == 0x02000000) {
120             if (BIO_printf
121                 (bp, "    Cipher    : %06lX\n", x->cipher_id & 0xffffff) <= 0)
122                 goto err;
123         } else {
124             if (BIO_printf
125                 (bp, "    Cipher    : %04lX\n", x->cipher_id & 0xffff) <= 0)
126                 goto err;
127         }
128     } else {
129         if (BIO_printf
130             (bp, "    Cipher    : %s\n",
131              ((x->cipher == NULL) ? "unknown" : x->cipher->name)) <= 0)
132             goto err;
133     }
134     if (BIO_puts(bp, "    Session-ID: ") <= 0)
135         goto err;
136     for (i = 0; i < x->session_id_length; i++) {
137         if (BIO_printf(bp, "%02X", x->session_id[i]) <= 0)
138             goto err;
139     }
140     if (BIO_puts(bp, "\n    Session-ID-ctx: ") <= 0)
141         goto err;
142     for (i = 0; i < x->sid_ctx_length; i++) {
143         if (BIO_printf(bp, "%02X", x->sid_ctx[i]) <= 0)
144             goto err;
145     }
146     if (BIO_puts(bp, "\n    Master-Key: ") <= 0)
147         goto err;
148     for (i = 0; i < (unsigned int)x->master_key_length; i++) {
149         if (BIO_printf(bp, "%02X", x->master_key[i]) <= 0)
150             goto err;
151     }
152 #ifndef OPENSSL_NO_PSK
153     if (BIO_puts(bp, "\n    PSK identity: ") <= 0)
154         goto err;
155     if (BIO_printf(bp, "%s", x->psk_identity ? x->psk_identity : "None") <= 0)
156         goto err;
157     if (BIO_puts(bp, "\n    PSK identity hint: ") <= 0)
158         goto err;
159     if (BIO_printf
160         (bp, "%s", x->psk_identity_hint ? x->psk_identity_hint : "None") <= 0)
161         goto err;
162 #endif
163 #ifndef OPENSSL_NO_SRP
164     if (BIO_puts(bp, "\n    SRP username: ") <= 0)
165         goto err;
166     if (BIO_printf(bp, "%s", x->srp_username ? x->srp_username : "None") <= 0)
167         goto err;
168 #endif
169     if (x->tlsext_tick_lifetime_hint) {
170         if (BIO_printf(bp,
171                        "\n    TLS session ticket lifetime hint: %ld (seconds)",
172                        x->tlsext_tick_lifetime_hint) <= 0)
173             goto err;
174     }
175     if (x->tlsext_tick) {
176         if (BIO_puts(bp, "\n    TLS session ticket:\n") <= 0)
177             goto err;
178         if (BIO_dump_indent(bp, (char *)x->tlsext_tick, x->tlsext_ticklen, 4)
179             <= 0)
180             goto err;
181     }
182
183 #ifndef OPENSSL_NO_COMP
184     if (x->compress_meth != 0) {
185         SSL_COMP *comp = NULL;
186
187         if (!ssl_cipher_get_evp(x, NULL, NULL, NULL, NULL, &comp, 0))
188             goto err;
189         if (comp == NULL) {
190             if (BIO_printf(bp, "\n    Compression: %d", x->compress_meth) <=
191                 0)
192                 goto err;
193         } else {
194             if (BIO_printf(bp, "\n    Compression: %d (%s)", comp->id,
195                  comp->name) <= 0)
196                 goto err;
197         }
198     }
199 #endif
200     if (x->time != 0L) {
201         if (BIO_printf(bp, "\n    Start Time: %ld", x->time) <= 0)
202             goto err;
203     }
204     if (x->timeout != 0L) {
205         if (BIO_printf(bp, "\n    Timeout   : %ld (sec)", x->timeout) <= 0)
206             goto err;
207     }
208     if (BIO_puts(bp, "\n") <= 0)
209         goto err;
210
211     if (BIO_puts(bp, "    Verify return code: ") <= 0)
212         goto err;
213     if (BIO_printf(bp, "%ld (%s)\n", x->verify_result,
214                    X509_verify_cert_error_string(x->verify_result)) <= 0)
215         goto err;
216
217     if (BIO_printf(bp, "    Extended master secret: %s\n",
218                    x->flags & SSL_SESS_FLAG_EXTMS ? "yes" : "no") <= 0)
219         goto err;
220
221     return (1);
222  err:
223     return (0);
224 }
225
226 /*
227  * print session id and master key in NSS keylog format (RSA
228  * Session-ID:<session id> Master-Key:<master key>)
229  */
230 int SSL_SESSION_print_keylog(BIO *bp, const SSL_SESSION *x)
231 {
232     unsigned int i;
233
234     if (x == NULL)
235         goto err;
236     if (x->session_id_length == 0 || x->master_key_length == 0)
237         goto err;
238
239     /*
240      * the RSA prefix is required by the format's definition although there's
241      * nothing RSA-specifc in the output, therefore, we don't have to check if
242      * the cipher suite is based on RSA
243      */
244     if (BIO_puts(bp, "RSA ") <= 0)
245         goto err;
246
247     if (BIO_puts(bp, "Session-ID:") <= 0)
248         goto err;
249     for (i = 0; i < x->session_id_length; i++) {
250         if (BIO_printf(bp, "%02X", x->session_id[i]) <= 0)
251             goto err;
252     }
253     if (BIO_puts(bp, " Master-Key:") <= 0)
254         goto err;
255     for (i = 0; i < (unsigned int)x->master_key_length; i++) {
256         if (BIO_printf(bp, "%02X", x->master_key[i]) <= 0)
257             goto err;
258     }
259     if (BIO_puts(bp, "\n") <= 0)
260         goto err;
261
262     return (1);
263  err:
264     return (0);
265 }