2 * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
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
10 /* ====================================================================
11 * Copyright 2005 Nokia. All rights reserved.
13 * The portions of the attached software ("Contribution") is developed by
14 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
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.
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.
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.
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
40 #include <openssl/asn1t.h>
41 #include <openssl/x509.h>
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;
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;
64 #ifndef OPENSSL_NO_SRP
65 ASN1_OCTET_STRING *srp_username;
68 uint32_t max_early_data;
69 ASN1_OCTET_STRING *alpn_selected;
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),
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),
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)
101 IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(SSL_SESSION_ASN1)
103 /* Utility functions for i2d_SSL_SESSION */
105 /* Initialise OCTET STRING from buffer and length */
107 static void ssl_session_oinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
108 unsigned char *data, size_t len)
111 os->length = (int)len;
116 /* Initialise OCTET STRING from string */
117 static void ssl_session_sinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
121 ssl_session_oinit(dest, os, (unsigned char *)data, strlen(data));
126 int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp)
131 ASN1_OCTET_STRING cipher;
132 unsigned char cipher_data[2];
133 ASN1_OCTET_STRING master_key, session_id, sid_ctx;
135 #ifndef OPENSSL_NO_COMP
136 ASN1_OCTET_STRING comp_id;
137 unsigned char comp_id_data;
139 ASN1_OCTET_STRING tlsext_hostname, tlsext_tick;
140 #ifndef OPENSSL_NO_SRP
141 ASN1_OCTET_STRING srp_username;
143 #ifndef OPENSSL_NO_PSK
144 ASN1_OCTET_STRING psk_identity, psk_identity_hint;
146 ASN1_OCTET_STRING alpn_selected;
150 if ((in == NULL) || ((in->cipher == NULL) && (in->cipher_id == 0)))
153 memset(&as, 0, sizeof(as));
155 as.version = SSL_SESSION_ASN1_VERSION;
156 as.ssl_version = in->ssl_version;
158 if (in->cipher == NULL)
162 cipher_data[0] = ((unsigned char)(l >> 8L)) & 0xff;
163 cipher_data[1] = ((unsigned char)(l)) & 0xff;
165 ssl_session_oinit(&as.cipher, &cipher, cipher_data, 2);
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);
174 ssl_session_oinit(&as.master_key, &master_key,
175 in->master_key, in->master_key_length);
177 ssl_session_oinit(&as.session_id, &session_id,
178 in->session_id, in->session_id_length);
180 ssl_session_oinit(&as.session_id_context, &sid_ctx,
181 in->sid_ctx, in->sid_ctx_length);
184 as.timeout = in->timeout;
185 as.verify_result = in->verify_result;
189 ssl_session_sinit(&as.tlsext_hostname, &tlsext_hostname,
192 ssl_session_oinit(&as.tlsext_tick, &tlsext_tick,
193 in->ext.tick, in->ext.ticklen);
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 */
207 as.flags = in->flags;
208 as.max_early_data = in->ext.max_early_data;
210 if (in->ext.alpn_selected == NULL)
211 as.alpn_selected = NULL;
213 ssl_session_oinit(&as.alpn_selected, &alpn_selected,
214 in->ext.alpn_selected, in->ext.alpn_selected_len);
216 return i2d_SSL_SESSION_ASN1(&as, pp);
220 /* Utility functions for d2i_SSL_SESSION */
222 /* OPENSSL_strndup an OCTET STRING */
224 static int ssl_session_strndup(char **pdst, ASN1_OCTET_STRING *src)
230 *pdst = OPENSSL_strndup((char *)src->data, src->length);
236 /* Copy an OCTET STRING, return error if it exceeds maximum length */
238 static int ssl_session_memcpy(unsigned char *dst, size_t *pdstlen,
239 ASN1_OCTET_STRING *src, size_t maxlen)
245 if (src->length < 0 || src->length > (int)maxlen)
247 memcpy(dst, src->data, src->length);
248 *pdstlen = src->length;
252 SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
257 const unsigned char *p = *pp;
258 SSL_SESSION_ASN1 *as = NULL;
259 SSL_SESSION *ret = NULL;
261 as = d2i_SSL_SESSION_ASN1(NULL, &p, length);
262 /* ASN.1 code returns suitable error */
267 ret = SSL_SESSION_new();
274 if (as->version != SSL_SESSION_ASN1_VERSION) {
275 SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_UNKNOWN_SSL_VERSION);
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);
286 ret->ssl_version = (int)as->ssl_version;
288 if (as->cipher->length != 2) {
289 SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_CIPHER_CODE_WRONG_LENGTH);
293 id = 0x03000000L | ((unsigned long)as->cipher->data[0] << 8L)
294 | (unsigned long)as->cipher->data[1];
297 ret->cipher = ssl3_get_cipher_by_id(id);
298 if (ret->cipher == NULL)
301 if (!ssl_session_memcpy(ret->session_id, &ret->session_id_length,
302 as->session_id, SSL3_MAX_SSL_SESSION_ID_LENGTH))
305 if (!ssl_session_memcpy(ret->master_key, &tmpl,
306 as->master_key, TLS13_MAX_RESUMPTION_MASTER_LENGTH))
309 ret->master_key_length = tmpl;
312 ret->time = as->time;
314 ret->time = (unsigned long)time(NULL);
316 if (as->timeout != 0)
317 ret->timeout = as->timeout;
321 X509_free(ret->peer);
322 ret->peer = as->peer;
325 if (!ssl_session_memcpy(ret->sid_ctx, &ret->sid_ctx_length,
326 as->session_id_context, SSL_MAX_SID_CTX_LENGTH))
329 /* NB: this defaults to zero which is X509_V_OK */
330 ret->verify_result = as->verify_result;
332 if (!ssl_session_strndup(&ret->ext.hostname, as->tlsext_hostname))
335 #ifndef OPENSSL_NO_PSK
336 if (!ssl_session_strndup(&ret->psk_identity_hint, as->psk_identity_hint))
338 if (!ssl_session_strndup(&ret->psk_identity, as->psk_identity))
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;
349 ret->ext.tick = NULL;
351 #ifndef OPENSSL_NO_COMP
353 if (as->comp_id->length != 1) {
354 SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_BAD_LENGTH);
357 ret->compress_meth = as->comp_id->data[0];
359 ret->compress_meth = 0;
363 #ifndef OPENSSL_NO_SRP
364 if (!ssl_session_strndup(&ret->srp_username, as->srp_username))
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;
371 if (as->alpn_selected != NULL) {
372 if (!ssl_session_strndup((char **)&ret->ext.alpn_selected,
375 ret->ext.alpn_selected_len = as->alpn_selected->length;
377 ret->ext.alpn_selected = NULL;
378 ret->ext.alpn_selected_len = 0;
381 M_ASN1_free_of(as, SSL_SESSION_ASN1);
383 if ((a != NULL) && (*a == NULL))
389 M_ASN1_free_of(as, SSL_SESSION_ASN1);
390 if ((a == NULL) || (*a != ret))
391 SSL_SESSION_free(ret);