Convert existing usage of assert() to ossl_assert() in libssl
[openssl.git] / ssl / ssl_asn1.c
1 /*
2  * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 /* ====================================================================
11  * Copyright 2005 Nokia. All rights reserved.
12  *
13  * The portions of the attached software ("Contribution") is developed by
14  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
15  * license.
16  *
17  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
18  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
19  * support (see RFC 4279) to OpenSSL.
20  *
21  * No patent licenses or other rights except those expressly stated in
22  * the OpenSSL open source license shall be deemed granted or received
23  * expressly, by implication, estoppel, or otherwise.
24  *
25  * No assurances are provided by Nokia that the Contribution does not
26  * infringe the patent or other intellectual property rights of any third
27  * party or that the license provides you with all the necessary rights
28  * to make use of the Contribution.
29  *
30  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
31  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
32  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
33  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
34  * OTHERWISE.
35  */
36
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include "ssl_locl.h"
40 #include <openssl/asn1t.h>
41 #include <openssl/x509.h>
42
43 typedef struct {
44     uint32_t version;
45     int32_t ssl_version;
46     ASN1_OCTET_STRING *cipher;
47     ASN1_OCTET_STRING *comp_id;
48     ASN1_OCTET_STRING *master_key;
49     ASN1_OCTET_STRING *session_id;
50     ASN1_OCTET_STRING *key_arg;
51     int64_t time;
52     int64_t timeout;
53     X509 *peer;
54     ASN1_OCTET_STRING *session_id_context;
55     int32_t verify_result;
56     ASN1_OCTET_STRING *tlsext_hostname;
57     uint64_t tlsext_tick_lifetime_hint;
58     uint32_t tlsext_tick_age_add;
59     ASN1_OCTET_STRING *tlsext_tick;
60 #ifndef OPENSSL_NO_PSK
61     ASN1_OCTET_STRING *psk_identity_hint;
62     ASN1_OCTET_STRING *psk_identity;
63 #endif
64 #ifndef OPENSSL_NO_SRP
65     ASN1_OCTET_STRING *srp_username;
66 #endif
67     uint64_t flags;
68     uint32_t max_early_data;
69     ASN1_OCTET_STRING *alpn_selected;
70 } SSL_SESSION_ASN1;
71
72 ASN1_SEQUENCE(SSL_SESSION_ASN1) = {
73     ASN1_EMBED(SSL_SESSION_ASN1, version, UINT32),
74     ASN1_EMBED(SSL_SESSION_ASN1, ssl_version, INT32),
75     ASN1_SIMPLE(SSL_SESSION_ASN1, cipher, ASN1_OCTET_STRING),
76     ASN1_SIMPLE(SSL_SESSION_ASN1, session_id, ASN1_OCTET_STRING),
77     ASN1_SIMPLE(SSL_SESSION_ASN1, master_key, ASN1_OCTET_STRING),
78     ASN1_IMP_OPT(SSL_SESSION_ASN1, key_arg, ASN1_OCTET_STRING, 0),
79     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, time, ZINT64, 1),
80     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, timeout, ZINT64, 2),
81     ASN1_EXP_OPT(SSL_SESSION_ASN1, peer, X509, 3),
82     ASN1_EXP_OPT(SSL_SESSION_ASN1, session_id_context, ASN1_OCTET_STRING, 4),
83     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, verify_result, ZINT32, 5),
84     ASN1_EXP_OPT(SSL_SESSION_ASN1, tlsext_hostname, ASN1_OCTET_STRING, 6),
85 #ifndef OPENSSL_NO_PSK
86     ASN1_EXP_OPT(SSL_SESSION_ASN1, psk_identity_hint, ASN1_OCTET_STRING, 7),
87     ASN1_EXP_OPT(SSL_SESSION_ASN1, psk_identity, ASN1_OCTET_STRING, 8),
88 #endif
89     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, tlsext_tick_lifetime_hint, ZUINT64, 9),
90     ASN1_EXP_OPT(SSL_SESSION_ASN1, tlsext_tick, ASN1_OCTET_STRING, 10),
91     ASN1_EXP_OPT(SSL_SESSION_ASN1, comp_id, ASN1_OCTET_STRING, 11),
92 #ifndef OPENSSL_NO_SRP
93     ASN1_EXP_OPT(SSL_SESSION_ASN1, srp_username, ASN1_OCTET_STRING, 12),
94 #endif
95     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, flags, ZUINT64, 13),
96     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, tlsext_tick_age_add, ZUINT32, 14),
97     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, max_early_data, ZUINT32, 15),
98     ASN1_EXP_OPT(SSL_SESSION_ASN1, alpn_selected, ASN1_OCTET_STRING, 16)
99 } static_ASN1_SEQUENCE_END(SSL_SESSION_ASN1)
100
101 IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(SSL_SESSION_ASN1)
102
103 /* Utility functions for i2d_SSL_SESSION */
104
105 /* Initialise OCTET STRING from buffer and length */
106
107 static void ssl_session_oinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
108                               unsigned char *data, size_t len)
109 {
110     os->data = data;
111     os->length = (int)len;
112     os->flags = 0;
113     *dest = os;
114 }
115
116 /* Initialise OCTET STRING from string */
117 static void ssl_session_sinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
118                               char *data)
119 {
120     if (data != NULL)
121         ssl_session_oinit(dest, os, (unsigned char *)data, strlen(data));
122     else
123         *dest = NULL;
124 }
125
126 int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp)
127 {
128
129     SSL_SESSION_ASN1 as;
130
131     ASN1_OCTET_STRING cipher;
132     unsigned char cipher_data[2];
133     ASN1_OCTET_STRING master_key, session_id, sid_ctx;
134
135 #ifndef OPENSSL_NO_COMP
136     ASN1_OCTET_STRING comp_id;
137     unsigned char comp_id_data;
138 #endif
139     ASN1_OCTET_STRING tlsext_hostname, tlsext_tick;
140 #ifndef OPENSSL_NO_SRP
141     ASN1_OCTET_STRING srp_username;
142 #endif
143 #ifndef OPENSSL_NO_PSK
144     ASN1_OCTET_STRING psk_identity, psk_identity_hint;
145 #endif
146     ASN1_OCTET_STRING alpn_selected;
147
148     long l;
149
150     if ((in == NULL) || ((in->cipher == NULL) && (in->cipher_id == 0)))
151         return 0;
152
153     memset(&as, 0, sizeof(as));
154
155     as.version = SSL_SESSION_ASN1_VERSION;
156     as.ssl_version = in->ssl_version;
157
158     if (in->cipher == NULL)
159         l = in->cipher_id;
160     else
161         l = in->cipher->id;
162     cipher_data[0] = ((unsigned char)(l >> 8L)) & 0xff;
163     cipher_data[1] = ((unsigned char)(l)) & 0xff;
164
165     ssl_session_oinit(&as.cipher, &cipher, cipher_data, 2);
166
167 #ifndef OPENSSL_NO_COMP
168     if (in->compress_meth) {
169         comp_id_data = (unsigned char)in->compress_meth;
170         ssl_session_oinit(&as.comp_id, &comp_id, &comp_id_data, 1);
171     }
172 #endif
173
174     ssl_session_oinit(&as.master_key, &master_key,
175                       in->master_key, in->master_key_length);
176
177     ssl_session_oinit(&as.session_id, &session_id,
178                       in->session_id, in->session_id_length);
179
180     ssl_session_oinit(&as.session_id_context, &sid_ctx,
181                       in->sid_ctx, in->sid_ctx_length);
182
183     as.time = in->time;
184     as.timeout = in->timeout;
185     as.verify_result = in->verify_result;
186
187     as.peer = in->peer;
188
189     ssl_session_sinit(&as.tlsext_hostname, &tlsext_hostname,
190                       in->ext.hostname);
191     if (in->ext.tick) {
192         ssl_session_oinit(&as.tlsext_tick, &tlsext_tick,
193                           in->ext.tick, in->ext.ticklen);
194     }
195     if (in->ext.tick_lifetime_hint > 0)
196         as.tlsext_tick_lifetime_hint = in->ext.tick_lifetime_hint;
197     as.tlsext_tick_age_add = in->ext.tick_age_add;
198 #ifndef OPENSSL_NO_PSK
199     ssl_session_sinit(&as.psk_identity_hint, &psk_identity_hint,
200                       in->psk_identity_hint);
201     ssl_session_sinit(&as.psk_identity, &psk_identity, in->psk_identity);
202 #endif                          /* OPENSSL_NO_PSK */
203 #ifndef OPENSSL_NO_SRP
204     ssl_session_sinit(&as.srp_username, &srp_username, in->srp_username);
205 #endif                          /* OPENSSL_NO_SRP */
206
207     as.flags = in->flags;
208     as.max_early_data = in->ext.max_early_data;
209
210     if (in->ext.alpn_selected == NULL)
211         as.alpn_selected = NULL;
212     else
213         ssl_session_oinit(&as.alpn_selected, &alpn_selected,
214                           in->ext.alpn_selected, in->ext.alpn_selected_len);
215
216     return i2d_SSL_SESSION_ASN1(&as, pp);
217
218 }
219
220 /* Utility functions for d2i_SSL_SESSION */
221
222 /* OPENSSL_strndup an OCTET STRING */
223
224 static int ssl_session_strndup(char **pdst, ASN1_OCTET_STRING *src)
225 {
226     OPENSSL_free(*pdst);
227     *pdst = NULL;
228     if (src == NULL)
229         return 1;
230     *pdst = OPENSSL_strndup((char *)src->data, src->length);
231     if (*pdst == NULL)
232         return 0;
233     return 1;
234 }
235
236 /* Copy an OCTET STRING, return error if it exceeds maximum length */
237
238 static int ssl_session_memcpy(unsigned char *dst, size_t *pdstlen,
239                               ASN1_OCTET_STRING *src, size_t maxlen)
240 {
241     if (src == NULL) {
242         *pdstlen = 0;
243         return 1;
244     }
245     if (src->length < 0 || src->length > (int)maxlen)
246         return 0;
247     memcpy(dst, src->data, src->length);
248     *pdstlen = src->length;
249     return 1;
250 }
251
252 SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
253                              long length)
254 {
255     long id;
256     size_t tmpl;
257     const unsigned char *p = *pp;
258     SSL_SESSION_ASN1 *as = NULL;
259     SSL_SESSION *ret = NULL;
260
261     as = d2i_SSL_SESSION_ASN1(NULL, &p, length);
262     /* ASN.1 code returns suitable error */
263     if (as == NULL)
264         goto err;
265
266     if (!a || !*a) {
267         ret = SSL_SESSION_new();
268         if (ret == NULL)
269             goto err;
270     } else {
271         ret = *a;
272     }
273
274     if (as->version != SSL_SESSION_ASN1_VERSION) {
275         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_UNKNOWN_SSL_VERSION);
276         goto err;
277     }
278
279     if ((as->ssl_version >> 8) != SSL3_VERSION_MAJOR
280         && (as->ssl_version >> 8) != DTLS1_VERSION_MAJOR
281         && as->ssl_version != DTLS1_BAD_VER) {
282         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
283         goto err;
284     }
285
286     ret->ssl_version = (int)as->ssl_version;
287
288     if (as->cipher->length != 2) {
289         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_CIPHER_CODE_WRONG_LENGTH);
290         goto err;
291     }
292
293     id = 0x03000000L | ((unsigned long)as->cipher->data[0] << 8L)
294                      | (unsigned long)as->cipher->data[1];
295
296     ret->cipher_id = id;
297     ret->cipher = ssl3_get_cipher_by_id(id);
298     if (ret->cipher == NULL)
299         goto err;
300
301     if (!ssl_session_memcpy(ret->session_id, &ret->session_id_length,
302                             as->session_id, SSL3_MAX_SSL_SESSION_ID_LENGTH))
303         goto err;
304
305     if (!ssl_session_memcpy(ret->master_key, &tmpl,
306                             as->master_key, TLS13_MAX_RESUMPTION_MASTER_LENGTH))
307         goto err;
308
309     ret->master_key_length = tmpl;
310
311     if (as->time != 0)
312         ret->time = as->time;
313     else
314         ret->time = (unsigned long)time(NULL);
315
316     if (as->timeout != 0)
317         ret->timeout = as->timeout;
318     else
319         ret->timeout = 3;
320
321     X509_free(ret->peer);
322     ret->peer = as->peer;
323     as->peer = NULL;
324
325     if (!ssl_session_memcpy(ret->sid_ctx, &ret->sid_ctx_length,
326                             as->session_id_context, SSL_MAX_SID_CTX_LENGTH))
327         goto err;
328
329     /* NB: this defaults to zero which is X509_V_OK */
330     ret->verify_result = as->verify_result;
331
332     if (!ssl_session_strndup(&ret->ext.hostname, as->tlsext_hostname))
333         goto err;
334
335 #ifndef OPENSSL_NO_PSK
336     if (!ssl_session_strndup(&ret->psk_identity_hint, as->psk_identity_hint))
337         goto err;
338     if (!ssl_session_strndup(&ret->psk_identity, as->psk_identity))
339         goto err;
340 #endif
341
342     ret->ext.tick_lifetime_hint = as->tlsext_tick_lifetime_hint;
343     ret->ext.tick_age_add = as->tlsext_tick_age_add;
344     if (as->tlsext_tick) {
345         ret->ext.tick = as->tlsext_tick->data;
346         ret->ext.ticklen = as->tlsext_tick->length;
347         as->tlsext_tick->data = NULL;
348     } else {
349         ret->ext.tick = NULL;
350     }
351 #ifndef OPENSSL_NO_COMP
352     if (as->comp_id) {
353         if (as->comp_id->length != 1) {
354             SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_BAD_LENGTH);
355             goto err;
356         }
357         ret->compress_meth = as->comp_id->data[0];
358     } else {
359         ret->compress_meth = 0;
360     }
361 #endif
362
363 #ifndef OPENSSL_NO_SRP
364     if (!ssl_session_strndup(&ret->srp_username, as->srp_username))
365         goto err;
366 #endif                          /* OPENSSL_NO_SRP */
367     /* Flags defaults to zero which is fine */
368     ret->flags = as->flags;
369     ret->ext.max_early_data = as->max_early_data;
370
371     if (as->alpn_selected != NULL) {
372         if (!ssl_session_strndup((char **)&ret->ext.alpn_selected,
373                                  as->alpn_selected))
374             goto err;
375         ret->ext.alpn_selected_len = as->alpn_selected->length;
376     } else {
377         ret->ext.alpn_selected = NULL;
378         ret->ext.alpn_selected_len = 0;
379     }
380
381     M_ASN1_free_of(as, SSL_SESSION_ASN1);
382
383     if ((a != NULL) && (*a == NULL))
384         *a = ret;
385     *pp = p;
386     return ret;
387
388  err:
389     M_ASN1_free_of(as, SSL_SESSION_ASN1);
390     if ((a == NULL) || (*a != ret))
391         SSL_SESSION_free(ret);
392     return NULL;
393 }