Don't add write errors into bytecounts
[openssl.git] / ssl / ssl_asn1.c
1 /* ssl/ssl_asn1.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright 2005 Nokia. All rights reserved.
60  *
61  * The portions of the attached software ("Contribution") is developed by
62  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
63  * license.
64  *
65  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
66  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
67  * support (see RFC 4279) to OpenSSL.
68  *
69  * No patent licenses or other rights except those expressly stated in
70  * the OpenSSL open source license shall be deemed granted or received
71  * expressly, by implication, estoppel, or otherwise.
72  *
73  * No assurances are provided by Nokia that the Contribution does not
74  * infringe the patent or other intellectual property rights of any third
75  * party or that the license provides you with all the necessary rights
76  * to make use of the Contribution.
77  *
78  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
79  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
80  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
81  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
82  * OTHERWISE.
83  */
84
85 #include <stdio.h>
86 #include <stdlib.h>
87 #include "ssl_locl.h"
88 #include <openssl/asn1t.h>
89 #include <openssl/x509.h>
90
91 typedef struct {
92     long version;
93     long ssl_version;
94     ASN1_OCTET_STRING *cipher;
95     ASN1_OCTET_STRING *comp_id;
96     ASN1_OCTET_STRING *master_key;
97     ASN1_OCTET_STRING *session_id;
98     ASN1_OCTET_STRING *key_arg;
99     long time;
100     long timeout;
101     X509 *peer;
102     ASN1_OCTET_STRING *session_id_context;
103     long verify_result;
104 #ifndef OPENSSL_NO_TLSEXT
105     ASN1_OCTET_STRING *tlsext_hostname;
106     long tlsext_tick_lifetime_hint;
107     ASN1_OCTET_STRING *tlsext_tick;
108 #endif
109 #ifndef OPENSSL_NO_PSK
110     ASN1_OCTET_STRING *psk_identity_hint;
111     ASN1_OCTET_STRING *psk_identity;
112 #endif
113 #ifndef OPENSSL_NO_SRP
114     ASN1_OCTET_STRING *srp_username;
115 #endif
116     long flags;
117 } SSL_SESSION_ASN1;
118
119 ASN1_SEQUENCE(SSL_SESSION_ASN1) = {
120     ASN1_SIMPLE(SSL_SESSION_ASN1, version, LONG),
121     ASN1_SIMPLE(SSL_SESSION_ASN1, ssl_version, LONG),
122     ASN1_SIMPLE(SSL_SESSION_ASN1, cipher, ASN1_OCTET_STRING),
123     ASN1_SIMPLE(SSL_SESSION_ASN1, session_id, ASN1_OCTET_STRING),
124     ASN1_SIMPLE(SSL_SESSION_ASN1, master_key, ASN1_OCTET_STRING),
125     ASN1_IMP_OPT(SSL_SESSION_ASN1, key_arg, ASN1_OCTET_STRING, 0),
126     ASN1_EXP_OPT(SSL_SESSION_ASN1, time, ZLONG, 1),
127     ASN1_EXP_OPT(SSL_SESSION_ASN1, timeout, ZLONG, 2),
128     ASN1_EXP_OPT(SSL_SESSION_ASN1, peer, X509, 3),
129     ASN1_EXP_OPT(SSL_SESSION_ASN1, session_id_context, ASN1_OCTET_STRING, 4),
130     ASN1_EXP_OPT(SSL_SESSION_ASN1, verify_result, ZLONG, 5),
131 #ifndef OPENSSL_NO_TLSEXT
132     ASN1_EXP_OPT(SSL_SESSION_ASN1, tlsext_hostname, ASN1_OCTET_STRING, 6),
133 #endif
134 #ifndef OPENSSL_NO_PSK
135     ASN1_EXP_OPT(SSL_SESSION_ASN1, psk_identity_hint, ASN1_OCTET_STRING, 7),
136     ASN1_EXP_OPT(SSL_SESSION_ASN1, psk_identity, ASN1_OCTET_STRING, 8),
137 #endif
138 #ifndef OPENSSL_NO_TLSEXT
139     ASN1_EXP_OPT(SSL_SESSION_ASN1, tlsext_tick_lifetime_hint, ZLONG, 9),
140     ASN1_EXP_OPT(SSL_SESSION_ASN1, tlsext_tick, ASN1_OCTET_STRING, 10),
141 #endif
142     ASN1_EXP_OPT(SSL_SESSION_ASN1, comp_id, ASN1_OCTET_STRING, 11),
143 #ifndef OPENSSL_NO_SRP
144     ASN1_EXP_OPT(SSL_SESSION_ASN1, srp_username, ASN1_OCTET_STRING, 12),
145 #endif
146     ASN1_EXP_OPT(SSL_SESSION_ASN1, flags, ZLONG, 13)
147 } ASN1_SEQUENCE_END(SSL_SESSION_ASN1)
148
149 IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(SSL_SESSION_ASN1)
150
151 /* Utility functions for i2d_SSL_SESSION */
152
153 /* Initialise OCTET STRING from buffer and length */
154
155 static void ssl_session_oinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
156                               unsigned char *data, size_t len)
157 {
158     os->data = data;
159     os->length = len;
160     os->flags = 0;
161     *dest = os;
162 }
163
164 /* Initialise OCTET STRING from string */
165 static void ssl_session_sinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
166                               char *data)
167 {
168     if (data != NULL)
169         ssl_session_oinit(dest, os, (unsigned char *)data, strlen(data));
170     else
171         *dest = NULL;
172 }
173
174 int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp)
175 {
176
177     SSL_SESSION_ASN1 as;
178
179     ASN1_OCTET_STRING cipher;
180     unsigned char cipher_data[2];
181     ASN1_OCTET_STRING master_key, session_id, sid_ctx;
182
183 #ifndef OPENSSL_NO_COMP
184     ASN1_OCTET_STRING comp_id;
185     unsigned char comp_id_data;
186 #endif
187
188 #ifndef OPENSSL_NO_TLSEXT
189     ASN1_OCTET_STRING tlsext_hostname, tlsext_tick;
190 #endif
191
192 #ifndef OPENSSL_NO_SRP
193     ASN1_OCTET_STRING srp_username;
194 #endif
195
196 #ifndef OPENSSL_NO_PSK
197     ASN1_OCTET_STRING psk_identity, psk_identity_hint;
198 #endif
199
200     long l;
201
202     if ((in == NULL) || ((in->cipher == NULL) && (in->cipher_id == 0)))
203         return 0;
204
205     memset(&as, 0, sizeof(as));
206
207     as.version = SSL_SESSION_ASN1_VERSION;
208     as.ssl_version = in->ssl_version;
209
210     if (in->cipher == NULL)
211         l = in->cipher_id;
212     else
213         l = in->cipher->id;
214     cipher_data[0] = ((unsigned char)(l >> 8L)) & 0xff;
215     cipher_data[1] = ((unsigned char)(l)) & 0xff;
216
217     ssl_session_oinit(&as.cipher, &cipher, cipher_data, 2);
218
219 #ifndef OPENSSL_NO_COMP
220     if (in->compress_meth) {
221         comp_id_data = (unsigned char)in->compress_meth;
222         ssl_session_oinit(&as.comp_id, &comp_id, &comp_id_data, 1);
223     }
224 #endif
225
226     ssl_session_oinit(&as.master_key, &master_key,
227                       in->master_key, in->master_key_length);
228
229     ssl_session_oinit(&as.session_id, &session_id,
230                       in->session_id, in->session_id_length);
231
232     ssl_session_oinit(&as.session_id_context, &sid_ctx,
233                       in->sid_ctx, in->sid_ctx_length);
234
235     as.time = in->time;
236     as.timeout = in->timeout;
237     as.verify_result = in->verify_result;
238
239     as.peer = in->peer;
240
241 #ifndef OPENSSL_NO_TLSEXT
242     ssl_session_sinit(&as.tlsext_hostname, &tlsext_hostname,
243                       in->tlsext_hostname);
244     if (in->tlsext_tick) {
245         ssl_session_oinit(&as.tlsext_tick, &tlsext_tick,
246                           in->tlsext_tick, in->tlsext_ticklen);
247     }
248     if (in->tlsext_tick_lifetime_hint > 0)
249         as.tlsext_tick_lifetime_hint = in->tlsext_tick_lifetime_hint;
250 #endif                          /* OPENSSL_NO_TLSEXT */
251 #ifndef OPENSSL_NO_PSK
252     ssl_session_sinit(&as.psk_identity_hint, &psk_identity_hint,
253                       in->psk_identity_hint);
254     ssl_session_sinit(&as.psk_identity, &psk_identity, in->psk_identity);
255 #endif                          /* OPENSSL_NO_PSK */
256 #ifndef OPENSSL_NO_SRP
257     ssl_session_sinit(&as.srp_username, &srp_username, in->srp_username);
258 #endif                          /* OPENSSL_NO_SRP */
259
260     as.flags = in->flags;
261
262     return i2d_SSL_SESSION_ASN1(&as, pp);
263
264 }
265
266 /* Utility functions for d2i_SSL_SESSION */
267
268 /* BUF_strndup an OCTET STRING */
269
270 static int ssl_session_strndup(char **pdst, ASN1_OCTET_STRING *src)
271 {
272     OPENSSL_free(*pdst);
273     *pdst = NULL;
274     if (src == NULL)
275         return 1;
276     *pdst = BUF_strndup((char *)src->data, src->length);
277     if (*pdst == NULL)
278         return 0;
279     return 1;
280 }
281
282 /* Copy an OCTET STRING, return error if it exceeds maximum length */
283
284 static int ssl_session_memcpy(unsigned char *dst, unsigned int *pdstlen,
285                               ASN1_OCTET_STRING *src, int maxlen)
286 {
287     if (src == NULL) {
288         *pdstlen = 0;
289         return 1;
290     }
291     if (src->length > maxlen)
292         return 0;
293     memcpy(dst, src->data, src->length);
294     *pdstlen = src->length;
295     return 1;
296 }
297
298 SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
299                              long length)
300 {
301     long id;
302     unsigned int tmpl;
303     const unsigned char *p = *pp;
304     SSL_SESSION_ASN1 *as = NULL;
305     SSL_SESSION *ret = NULL;
306
307     as = d2i_SSL_SESSION_ASN1(NULL, &p, length);
308     /* ASN.1 code returns suitable error */
309     if (as == NULL)
310         goto err;
311
312     if (!a || !*a) {
313         ret = SSL_SESSION_new();
314         if (ret == NULL)
315             goto err;
316     } else {
317         ret = *a;
318     }
319
320     if (as->version != SSL_SESSION_ASN1_VERSION) {
321         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_UNKNOWN_SSL_VERSION);
322         goto err;
323     }
324
325     if ((as->ssl_version >> 8) != SSL3_VERSION_MAJOR
326         && (as->ssl_version >> 8) != DTLS1_VERSION_MAJOR
327         && as->ssl_version != DTLS1_BAD_VER) {
328         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
329         goto err;
330     }
331
332     ret->ssl_version = (int)as->ssl_version;
333
334     if (as->cipher->length != 2) {
335         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_CIPHER_CODE_WRONG_LENGTH);
336         goto err;
337     }
338
339     p = as->cipher->data;
340     id = 0x03000000L | ((unsigned long)p[0] << 8L) | (unsigned long)p[1];
341
342     ret->cipher = NULL;
343     ret->cipher_id = id;
344
345     if (!ssl_session_memcpy(ret->session_id, &ret->session_id_length,
346                             as->session_id, SSL3_MAX_SSL_SESSION_ID_LENGTH))
347         goto err;
348
349     if (!ssl_session_memcpy(ret->master_key, &tmpl,
350                             as->master_key, SSL_MAX_MASTER_KEY_LENGTH))
351         goto err;
352
353     ret->master_key_length = tmpl;
354
355     if (as->time != 0)
356         ret->time = as->time;
357     else
358         ret->time = (unsigned long)time(NULL);
359
360     if (as->timeout != 0)
361         ret->timeout = as->timeout;
362     else
363         ret->timeout = 3;
364
365     X509_free(ret->peer);
366     ret->peer = as->peer;
367     as->peer = NULL;
368
369     if (!ssl_session_memcpy(ret->sid_ctx, &ret->sid_ctx_length,
370                             as->session_id_context, SSL_MAX_SID_CTX_LENGTH))
371         goto err;
372
373     /* NB: this defaults to zero which is X509_V_OK */
374     ret->verify_result = as->verify_result;
375
376 #ifndef OPENSSL_NO_TLSEXT
377     if (!ssl_session_strndup(&ret->tlsext_hostname, as->tlsext_hostname))
378         goto err;
379 #endif                          /* OPENSSL_NO_TLSEXT */
380
381 #ifndef OPENSSL_NO_PSK
382     if (!ssl_session_strndup(&ret->psk_identity_hint, as->psk_identity_hint))
383         goto err;
384     if (!ssl_session_strndup(&ret->psk_identity, as->psk_identity))
385         goto err;
386 #endif
387
388 #ifndef OPENSSL_NO_TLSEXT
389     ret->tlsext_tick_lifetime_hint = as->tlsext_tick_lifetime_hint;
390     if (as->tlsext_tick) {
391         ret->tlsext_tick = as->tlsext_tick->data;
392         ret->tlsext_ticklen = as->tlsext_tick->length;
393         as->tlsext_tick->data = NULL;
394     } else {
395         ret->tlsext_tick = NULL;
396     }
397 #endif                          /* OPENSSL_NO_TLSEXT */
398 #ifndef OPENSSL_NO_COMP
399     if (as->comp_id) {
400         if (as->comp_id->length != 1) {
401             SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_BAD_LENGTH);
402             goto err;
403         }
404         ret->compress_meth = as->comp_id->data[0];
405     } else {
406         ret->compress_meth = 0;
407     }
408 #endif
409
410 #ifndef OPENSSL_NO_SRP
411     if (!ssl_session_strndup(&ret->srp_username, as->srp_username))
412         goto err;
413 #endif                          /* OPENSSL_NO_SRP */
414     /* Flags defaults to zero which is fine */
415     ret->flags = as->flags;
416
417     M_ASN1_free_of(as, SSL_SESSION_ASN1);
418
419     if ((a != NULL) && (*a == NULL))
420         *a = ret;
421     *pp = p;
422     return ret;
423
424     err:
425     M_ASN1_free_of(as, SSL_SESSION_ASN1);
426     if ((a == NULL) || (*a != ret))
427         SSL_SESSION_free(ret);
428     return NULL;
429 }