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