Coverage Report

Created: 2025-12-04 06:33

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