Coverage Report

Created: 2025-06-13 06:56

/src/openssl/crypto/asn1/d2i_pr.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1995-2025 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (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
/* We need to use some engine deprecated APIs */
11
#define OPENSSL_SUPPRESS_DEPRECATED
12
13
#include <stdio.h>
14
#include "internal/cryptlib.h"
15
#include <openssl/bn.h>
16
#include <openssl/evp.h>
17
#include <openssl/objects.h>
18
#include <openssl/decoder.h>
19
#include <openssl/engine.h>
20
#include <openssl/x509.h>
21
#include <openssl/asn1.h>
22
#include "crypto/asn1.h"
23
#include "crypto/evp.h"
24
#include "crypto/x509.h"
25
#include "internal/asn1.h"
26
#include "internal/sizes.h"
27
28
static EVP_PKEY *
29
d2i_PrivateKey_decoder(int keytype, EVP_PKEY **a, const unsigned char **pp,
30
                       long length, OSSL_LIB_CTX *libctx, const char *propq)
31
0
{
32
0
    OSSL_DECODER_CTX *dctx = NULL;
33
0
    size_t len = length;
34
0
    EVP_PKEY *pkey = NULL, *bak_a = NULL;
35
0
    EVP_PKEY **ppkey = &pkey;
36
0
    const char *key_name = NULL;
37
0
    char keytypebuf[OSSL_MAX_NAME_SIZE];
38
0
    int ret;
39
0
    const unsigned char *p = *pp;
40
0
    const char *structure;
41
0
    PKCS8_PRIV_KEY_INFO *p8info;
42
0
    const ASN1_OBJECT *algoid;
43
44
0
    if (keytype != EVP_PKEY_NONE) {
45
0
        key_name = evp_pkey_type2name(keytype);
46
0
        if (key_name == NULL)
47
0
            return NULL;
48
0
    }
49
50
    /* This is just a probe. It might fail, so we ignore errors */
51
0
    ERR_set_mark();
52
0
    p8info = d2i_PKCS8_PRIV_KEY_INFO(NULL, pp, len);
53
0
    ERR_pop_to_mark();
54
0
    if (p8info != NULL) {
55
0
        int64_t v;
56
57
        /* ascertain version is 0 or 1 as per RFC5958 */
58
0
        if (!ASN1_INTEGER_get_int64(&v, p8info->version)
59
0
            || (v != 0 && v != 1)) {
60
0
            *pp = p;
61
0
            ERR_raise(ERR_LIB_ASN1, ASN1_R_ASN1_PARSE_ERROR);
62
0
            PKCS8_PRIV_KEY_INFO_free(p8info);
63
0
            return NULL;
64
0
        }
65
0
        if (key_name == NULL
66
0
                && PKCS8_pkey_get0(&algoid, NULL, NULL, NULL, p8info)
67
0
                && OBJ_obj2txt(keytypebuf, sizeof(keytypebuf), algoid, 0))
68
0
            key_name = keytypebuf;
69
0
        structure = "PrivateKeyInfo";
70
0
        PKCS8_PRIV_KEY_INFO_free(p8info);
71
0
    } else {
72
0
        structure = "type-specific";
73
0
    }
74
0
    *pp = p;
75
76
0
    if (a != NULL && (bak_a = *a) != NULL)
77
0
        ppkey = a;
78
0
    dctx = OSSL_DECODER_CTX_new_for_pkey(ppkey, "DER", structure, key_name,
79
0
                                         EVP_PKEY_KEYPAIR, libctx, propq);
80
0
    if (a != NULL)
81
0
        *a = bak_a;
82
0
    if (dctx == NULL)
83
0
        goto err;
84
85
0
    ret = OSSL_DECODER_from_data(dctx, pp, &len);
86
0
    OSSL_DECODER_CTX_free(dctx);
87
0
    if (ret
88
0
        && *ppkey != NULL
89
0
        && evp_keymgmt_util_has(*ppkey, OSSL_KEYMGMT_SELECT_PRIVATE_KEY)) {
90
0
        if (a != NULL)
91
0
            *a = *ppkey;
92
0
        return *ppkey;
93
0
    }
94
95
0
 err:
96
0
    if (ppkey != a)
97
0
        EVP_PKEY_free(*ppkey);
98
0
    return NULL;
99
0
}
100
101
EVP_PKEY *
102
ossl_d2i_PrivateKey_legacy(int keytype, EVP_PKEY **a, const unsigned char **pp,
103
                           long length, OSSL_LIB_CTX *libctx, const char *propq)
104
0
{
105
0
    EVP_PKEY *ret;
106
0
    const unsigned char *p = *pp;
107
108
0
    if (a == NULL || *a == NULL) {
109
0
        if ((ret = EVP_PKEY_new()) == NULL) {
110
0
            ERR_raise(ERR_LIB_ASN1, ERR_R_EVP_LIB);
111
0
            return NULL;
112
0
        }
113
0
    } else {
114
0
        ret = *a;
115
0
#ifndef OPENSSL_NO_ENGINE
116
0
        ENGINE_finish(ret->engine);
117
0
        ret->engine = NULL;
118
0
#endif
119
0
    }
120
121
0
    if (!EVP_PKEY_set_type(ret, keytype)) {
122
0
        ERR_raise(ERR_LIB_ASN1, ASN1_R_UNKNOWN_PUBLIC_KEY_TYPE);
123
0
        goto err;
124
0
    }
125
126
0
    ERR_set_mark();
127
0
    if (!ret->ameth->old_priv_decode ||
128
0
        !ret->ameth->old_priv_decode(ret, &p, length)) {
129
0
        if (ret->ameth->priv_decode != NULL
130
0
                || ret->ameth->priv_decode_ex != NULL) {
131
0
            EVP_PKEY *tmp;
132
0
            PKCS8_PRIV_KEY_INFO *p8 = NULL;
133
0
            p8 = d2i_PKCS8_PRIV_KEY_INFO(NULL, &p, length);
134
0
            if (p8 == NULL) {
135
0
                ERR_clear_last_mark();
136
0
                goto err;
137
0
            }
138
0
            tmp = evp_pkcs82pkey_legacy(p8, libctx, propq);
139
0
            PKCS8_PRIV_KEY_INFO_free(p8);
140
0
            if (tmp == NULL) {
141
0
                ERR_clear_last_mark();
142
0
                goto err;
143
0
            }
144
0
            EVP_PKEY_free(ret);
145
0
            ret = tmp;
146
0
            ERR_pop_to_mark();
147
0
            if (EVP_PKEY_type(keytype) != EVP_PKEY_get_base_id(ret))
148
0
                goto err;
149
0
        } else {
150
0
            ERR_clear_last_mark();
151
0
            ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
152
0
            goto err;
153
0
        }
154
0
    } else {
155
0
      ERR_clear_last_mark();
156
0
    }
157
0
    *pp = p;
158
0
    if (a != NULL)
159
0
        *a = ret;
160
0
    return ret;
161
0
 err:
162
0
    if (a == NULL || *a != ret)
163
0
        EVP_PKEY_free(ret);
164
0
    return NULL;
165
0
}
166
167
EVP_PKEY *d2i_PrivateKey_ex(int keytype, EVP_PKEY **a, const unsigned char **pp,
168
                            long length, OSSL_LIB_CTX *libctx,
169
                            const char *propq)
170
0
{
171
0
    EVP_PKEY *ret;
172
173
0
    ret = d2i_PrivateKey_decoder(keytype, a, pp, length, libctx, propq);
174
    /* try the legacy path if the decoder failed */
175
0
    if (ret == NULL)
176
0
        ret = ossl_d2i_PrivateKey_legacy(keytype, a, pp, length, libctx, propq);
177
0
    return ret;
178
0
}
179
180
EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **a, const unsigned char **pp,
181
                         long length)
182
0
{
183
0
    return d2i_PrivateKey_ex(type, a, pp, length, NULL, NULL);
184
0
}
185
186
static EVP_PKEY *d2i_AutoPrivateKey_legacy(EVP_PKEY **a,
187
                                           const unsigned char **pp,
188
                                           long length,
189
                                           OSSL_LIB_CTX *libctx,
190
                                           const char *propq)
191
0
{
192
0
    STACK_OF(ASN1_TYPE) *inkey;
193
0
    const unsigned char *p;
194
0
    int keytype;
195
196
0
    p = *pp;
197
    /*
198
     * Dirty trick: read in the ASN1 data into a STACK_OF(ASN1_TYPE): by
199
     * analyzing it we can determine the passed structure: this assumes the
200
     * input is surrounded by an ASN1 SEQUENCE.
201
     */
202
0
    inkey = d2i_ASN1_SEQUENCE_ANY(NULL, &p, length);
203
0
    p = *pp;
204
    /*
205
     * Since we only need to discern "traditional format" RSA and DSA keys we
206
     * can just count the elements.
207
     */
208
0
    if (sk_ASN1_TYPE_num(inkey) == 6) {
209
0
        keytype = EVP_PKEY_DSA;
210
0
    } else if (sk_ASN1_TYPE_num(inkey) == 4) {
211
0
        keytype = EVP_PKEY_EC;
212
0
    } else if (sk_ASN1_TYPE_num(inkey) == 3) { /* This seems to be PKCS8, not
213
                                              * traditional format */
214
0
        PKCS8_PRIV_KEY_INFO *p8 = d2i_PKCS8_PRIV_KEY_INFO(NULL, &p, length);
215
0
        EVP_PKEY *ret;
216
217
0
        sk_ASN1_TYPE_pop_free(inkey, ASN1_TYPE_free);
218
0
        if (p8 == NULL) {
219
0
            ERR_raise(ERR_LIB_ASN1, ASN1_R_UNSUPPORTED_PUBLIC_KEY_TYPE);
220
0
            return NULL;
221
0
        }
222
0
        ret = evp_pkcs82pkey_legacy(p8, libctx, propq);
223
0
        PKCS8_PRIV_KEY_INFO_free(p8);
224
0
        if (ret == NULL)
225
0
            return NULL;
226
0
        *pp = p;
227
0
        if (a != NULL) {
228
0
            *a = ret;
229
0
        }
230
0
        return ret;
231
0
    } else {
232
0
        keytype = EVP_PKEY_RSA;
233
0
    }
234
0
    sk_ASN1_TYPE_pop_free(inkey, ASN1_TYPE_free);
235
0
    return ossl_d2i_PrivateKey_legacy(keytype, a, pp, length, libctx, propq);
236
0
}
237
238
/*
239
 * This works like d2i_PrivateKey() except it passes the keytype as
240
 * EVP_PKEY_NONE, which then figures out the type during decoding.
241
 */
242
EVP_PKEY *d2i_AutoPrivateKey_ex(EVP_PKEY **a, const unsigned char **pp,
243
                                long length, OSSL_LIB_CTX *libctx,
244
                                const char *propq)
245
0
{
246
0
    EVP_PKEY *ret;
247
248
0
    ret = d2i_PrivateKey_decoder(EVP_PKEY_NONE, a, pp, length, libctx, propq);
249
    /* try the legacy path if the decoder failed */
250
0
    if (ret == NULL)
251
0
        ret = d2i_AutoPrivateKey_legacy(a, pp, length, libctx, propq);
252
0
    return ret;
253
0
}
254
255
EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp,
256
                             long length)
257
0
{
258
0
    return d2i_AutoPrivateKey_ex(a, pp, length, NULL, NULL);
259
0
}