2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright 2005 Nokia. All rights reserved.
5 * Licensed under the Apache License 2.0 (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
13 #include "ssl_local.h"
14 #include <openssl/asn1t.h>
15 #include <openssl/x509.h>
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
;
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
;
38 #ifndef OPENSSL_NO_SRP
39 ASN1_OCTET_STRING
*srp_username
;
42 uint32_t max_early_data
;
43 ASN1_OCTET_STRING
*alpn_selected
;
44 uint32_t tlsext_max_fragment_len_mode
;
45 ASN1_OCTET_STRING
*ticket_appdata
;
48 ASN1_SEQUENCE(SSL_SESSION_ASN1
) = {
49 ASN1_EMBED(SSL_SESSION_ASN1
, version
, UINT32
),
50 ASN1_EMBED(SSL_SESSION_ASN1
, ssl_version
, INT32
),
51 ASN1_SIMPLE(SSL_SESSION_ASN1
, cipher
, ASN1_OCTET_STRING
),
52 ASN1_SIMPLE(SSL_SESSION_ASN1
, session_id
, ASN1_OCTET_STRING
),
53 ASN1_SIMPLE(SSL_SESSION_ASN1
, master_key
, ASN1_OCTET_STRING
),
54 ASN1_IMP_OPT(SSL_SESSION_ASN1
, key_arg
, ASN1_OCTET_STRING
, 0),
55 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, time
, ZINT64
, 1),
56 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, timeout
, ZINT64
, 2),
57 ASN1_EXP_OPT(SSL_SESSION_ASN1
, peer
, X509
, 3),
58 ASN1_EXP_OPT(SSL_SESSION_ASN1
, session_id_context
, ASN1_OCTET_STRING
, 4),
59 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, verify_result
, ZINT32
, 5),
60 ASN1_EXP_OPT(SSL_SESSION_ASN1
, tlsext_hostname
, ASN1_OCTET_STRING
, 6),
61 #ifndef OPENSSL_NO_PSK
62 ASN1_EXP_OPT(SSL_SESSION_ASN1
, psk_identity_hint
, ASN1_OCTET_STRING
, 7),
63 ASN1_EXP_OPT(SSL_SESSION_ASN1
, psk_identity
, ASN1_OCTET_STRING
, 8),
65 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, tlsext_tick_lifetime_hint
, ZUINT64
, 9),
66 ASN1_EXP_OPT(SSL_SESSION_ASN1
, tlsext_tick
, ASN1_OCTET_STRING
, 10),
67 ASN1_EXP_OPT(SSL_SESSION_ASN1
, comp_id
, ASN1_OCTET_STRING
, 11),
68 #ifndef OPENSSL_NO_SRP
69 ASN1_EXP_OPT(SSL_SESSION_ASN1
, srp_username
, ASN1_OCTET_STRING
, 12),
71 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, flags
, ZUINT64
, 13),
72 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, tlsext_tick_age_add
, ZUINT32
, 14),
73 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, max_early_data
, ZUINT32
, 15),
74 ASN1_EXP_OPT(SSL_SESSION_ASN1
, alpn_selected
, ASN1_OCTET_STRING
, 16),
75 ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1
, tlsext_max_fragment_len_mode
, ZUINT32
, 17),
76 ASN1_EXP_OPT(SSL_SESSION_ASN1
, ticket_appdata
, ASN1_OCTET_STRING
, 18)
77 } static_ASN1_SEQUENCE_END(SSL_SESSION_ASN1
)
79 IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(SSL_SESSION_ASN1
)
81 /* Utility functions for i2d_SSL_SESSION */
83 /* Initialise OCTET STRING from buffer and length */
85 static void ssl_session_oinit(ASN1_OCTET_STRING
**dest
, ASN1_OCTET_STRING
*os
,
86 const unsigned char *data
, size_t len
)
88 os
->data
= (unsigned char *)data
; /* justified cast: data is not modified */
89 os
->length
= (int)len
;
94 /* Initialise OCTET STRING from string */
95 static void ssl_session_sinit(ASN1_OCTET_STRING
**dest
, ASN1_OCTET_STRING
*os
,
99 ssl_session_oinit(dest
, os
, (const unsigned char *)data
, strlen(data
));
104 int i2d_SSL_SESSION(const SSL_SESSION
*in
, unsigned char **pp
)
109 ASN1_OCTET_STRING cipher
;
110 unsigned char cipher_data
[2];
111 ASN1_OCTET_STRING master_key
, session_id
, sid_ctx
;
113 #ifndef OPENSSL_NO_COMP
114 ASN1_OCTET_STRING comp_id
;
115 unsigned char comp_id_data
;
117 ASN1_OCTET_STRING tlsext_hostname
, tlsext_tick
;
118 #ifndef OPENSSL_NO_SRP
119 ASN1_OCTET_STRING srp_username
;
121 #ifndef OPENSSL_NO_PSK
122 ASN1_OCTET_STRING psk_identity
, psk_identity_hint
;
124 ASN1_OCTET_STRING alpn_selected
;
125 ASN1_OCTET_STRING ticket_appdata
;
129 if ((in
== NULL
) || ((in
->cipher
== NULL
) && (in
->cipher_id
== 0)))
132 memset(&as
, 0, sizeof(as
));
134 as
.version
= SSL_SESSION_ASN1_VERSION
;
135 as
.ssl_version
= in
->ssl_version
;
137 if (in
->cipher
== NULL
)
141 cipher_data
[0] = ((unsigned char)(l
>> 8L)) & 0xff;
142 cipher_data
[1] = ((unsigned char)(l
)) & 0xff;
144 ssl_session_oinit(&as
.cipher
, &cipher
, cipher_data
, 2);
146 #ifndef OPENSSL_NO_COMP
147 if (in
->compress_meth
) {
148 comp_id_data
= (unsigned char)in
->compress_meth
;
149 ssl_session_oinit(&as
.comp_id
, &comp_id
, &comp_id_data
, 1);
153 ssl_session_oinit(&as
.master_key
, &master_key
,
154 in
->master_key
, in
->master_key_length
);
156 ssl_session_oinit(&as
.session_id
, &session_id
,
157 in
->session_id
, in
->session_id_length
);
159 ssl_session_oinit(&as
.session_id_context
, &sid_ctx
,
160 in
->sid_ctx
, in
->sid_ctx_length
);
163 as
.timeout
= in
->timeout
;
164 as
.verify_result
= in
->verify_result
;
168 ssl_session_sinit(&as
.tlsext_hostname
, &tlsext_hostname
,
171 ssl_session_oinit(&as
.tlsext_tick
, &tlsext_tick
,
172 in
->ext
.tick
, in
->ext
.ticklen
);
174 if (in
->ext
.tick_lifetime_hint
> 0)
175 as
.tlsext_tick_lifetime_hint
= in
->ext
.tick_lifetime_hint
;
176 as
.tlsext_tick_age_add
= in
->ext
.tick_age_add
;
177 #ifndef OPENSSL_NO_PSK
178 ssl_session_sinit(&as
.psk_identity_hint
, &psk_identity_hint
,
179 in
->psk_identity_hint
);
180 ssl_session_sinit(&as
.psk_identity
, &psk_identity
, in
->psk_identity
);
181 #endif /* OPENSSL_NO_PSK */
182 #ifndef OPENSSL_NO_SRP
183 ssl_session_sinit(&as
.srp_username
, &srp_username
, in
->srp_username
);
184 #endif /* OPENSSL_NO_SRP */
186 as
.flags
= in
->flags
;
187 as
.max_early_data
= in
->ext
.max_early_data
;
189 if (in
->ext
.alpn_selected
== NULL
)
190 as
.alpn_selected
= NULL
;
192 ssl_session_oinit(&as
.alpn_selected
, &alpn_selected
,
193 in
->ext
.alpn_selected
, in
->ext
.alpn_selected_len
);
195 as
.tlsext_max_fragment_len_mode
= in
->ext
.max_fragment_len_mode
;
197 if (in
->ticket_appdata
== NULL
)
198 as
.ticket_appdata
= NULL
;
200 ssl_session_oinit(&as
.ticket_appdata
, &ticket_appdata
,
201 in
->ticket_appdata
, in
->ticket_appdata_len
);
203 return i2d_SSL_SESSION_ASN1(&as
, pp
);
207 /* Utility functions for d2i_SSL_SESSION */
209 /* OPENSSL_strndup an OCTET STRING */
211 static int ssl_session_strndup(char **pdst
, ASN1_OCTET_STRING
*src
)
217 *pdst
= OPENSSL_strndup((char *)src
->data
, src
->length
);
223 /* Copy an OCTET STRING, return error if it exceeds maximum length */
225 static int ssl_session_memcpy(unsigned char *dst
, size_t *pdstlen
,
226 ASN1_OCTET_STRING
*src
, size_t maxlen
)
232 if (src
->length
< 0 || src
->length
> (int)maxlen
)
234 memcpy(dst
, src
->data
, src
->length
);
235 *pdstlen
= src
->length
;
239 SSL_SESSION
*d2i_SSL_SESSION(SSL_SESSION
**a
, const unsigned char **pp
,
244 const unsigned char *p
= *pp
;
245 SSL_SESSION_ASN1
*as
= NULL
;
246 SSL_SESSION
*ret
= NULL
;
248 as
= d2i_SSL_SESSION_ASN1(NULL
, &p
, length
);
249 /* ASN.1 code returns suitable error */
253 if (a
== NULL
|| *a
== NULL
) {
254 ret
= SSL_SESSION_new();
261 if (as
->version
!= SSL_SESSION_ASN1_VERSION
) {
262 ERR_raise(ERR_LIB_SSL
, SSL_R_UNKNOWN_SSL_VERSION
);
266 if ((as
->ssl_version
>> 8) != SSL3_VERSION_MAJOR
267 && (as
->ssl_version
>> 8) != DTLS1_VERSION_MAJOR
268 && as
->ssl_version
!= DTLS1_BAD_VER
) {
269 ERR_raise(ERR_LIB_SSL
, SSL_R_UNSUPPORTED_SSL_VERSION
);
273 ret
->ssl_version
= (int)as
->ssl_version
;
275 if (as
->cipher
->length
!= 2) {
276 ERR_raise(ERR_LIB_SSL
, SSL_R_CIPHER_CODE_WRONG_LENGTH
);
280 id
= 0x03000000L
| ((unsigned long)as
->cipher
->data
[0] << 8L)
281 | (unsigned long)as
->cipher
->data
[1];
284 ret
->cipher
= ssl3_get_cipher_by_id(id
);
285 if (ret
->cipher
== NULL
)
288 if (!ssl_session_memcpy(ret
->session_id
, &ret
->session_id_length
,
289 as
->session_id
, SSL3_MAX_SSL_SESSION_ID_LENGTH
))
292 if (!ssl_session_memcpy(ret
->master_key
, &tmpl
,
293 as
->master_key
, TLS13_MAX_RESUMPTION_PSK_LENGTH
))
296 ret
->master_key_length
= tmpl
;
299 ret
->time
= (long)as
->time
;
301 ret
->time
= (long)time(NULL
);
303 if (as
->timeout
!= 0)
304 ret
->timeout
= (long)as
->timeout
;
308 X509_free(ret
->peer
);
309 ret
->peer
= as
->peer
;
312 if (!ssl_session_memcpy(ret
->sid_ctx
, &ret
->sid_ctx_length
,
313 as
->session_id_context
, SSL_MAX_SID_CTX_LENGTH
))
316 /* NB: this defaults to zero which is X509_V_OK */
317 ret
->verify_result
= as
->verify_result
;
319 if (!ssl_session_strndup(&ret
->ext
.hostname
, as
->tlsext_hostname
))
322 #ifndef OPENSSL_NO_PSK
323 if (!ssl_session_strndup(&ret
->psk_identity_hint
, as
->psk_identity_hint
))
325 if (!ssl_session_strndup(&ret
->psk_identity
, as
->psk_identity
))
329 ret
->ext
.tick_lifetime_hint
= (unsigned long)as
->tlsext_tick_lifetime_hint
;
330 ret
->ext
.tick_age_add
= as
->tlsext_tick_age_add
;
331 OPENSSL_free(ret
->ext
.tick
);
332 if (as
->tlsext_tick
!= NULL
) {
333 ret
->ext
.tick
= as
->tlsext_tick
->data
;
334 ret
->ext
.ticklen
= as
->tlsext_tick
->length
;
335 as
->tlsext_tick
->data
= NULL
;
337 ret
->ext
.tick
= NULL
;
339 #ifndef OPENSSL_NO_COMP
341 if (as
->comp_id
->length
!= 1) {
342 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
345 ret
->compress_meth
= as
->comp_id
->data
[0];
347 ret
->compress_meth
= 0;
351 #ifndef OPENSSL_NO_SRP
352 if (!ssl_session_strndup(&ret
->srp_username
, as
->srp_username
))
354 #endif /* OPENSSL_NO_SRP */
355 /* Flags defaults to zero which is fine */
356 ret
->flags
= (int32_t)as
->flags
;
357 ret
->ext
.max_early_data
= as
->max_early_data
;
359 OPENSSL_free(ret
->ext
.alpn_selected
);
360 if (as
->alpn_selected
!= NULL
) {
361 ret
->ext
.alpn_selected
= as
->alpn_selected
->data
;
362 ret
->ext
.alpn_selected_len
= as
->alpn_selected
->length
;
363 as
->alpn_selected
->data
= NULL
;
365 ret
->ext
.alpn_selected
= NULL
;
366 ret
->ext
.alpn_selected_len
= 0;
369 ret
->ext
.max_fragment_len_mode
= as
->tlsext_max_fragment_len_mode
;
371 OPENSSL_free(ret
->ticket_appdata
);
372 if (as
->ticket_appdata
!= NULL
) {
373 ret
->ticket_appdata
= as
->ticket_appdata
->data
;
374 ret
->ticket_appdata_len
= as
->ticket_appdata
->length
;
375 as
->ticket_appdata
->data
= NULL
;
377 ret
->ticket_appdata
= NULL
;
378 ret
->ticket_appdata_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
);