Fix a copy&paste error in evp_extra_test
[openssl.git] / crypto / pem / pem_pkey.c
1 /*
2  * Copyright 1995-2020 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 STORE deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
12
13 #include <stdio.h>
14 #include "internal/cryptlib.h"
15 #include <openssl/buffer.h>
16 #include <openssl/objects.h>
17 #include <openssl/evp.h>
18 #include <openssl/x509.h>
19 #include <openssl/pkcs12.h>
20 #include <openssl/pem.h>
21 #include <openssl/engine.h>
22 #include <openssl/dh.h>
23 #include <openssl/store.h>
24 #include <openssl/ui.h>
25 #include "crypto/store.h"
26 #include "crypto/asn1.h"
27 #include "crypto/evp.h"
28 #include "pem_local.h"
29
30 int pem_check_suffix(const char *pem_str, const char *suffix);
31
32 static EVP_PKEY *pem_read_bio_key(BIO *bp, EVP_PKEY **x,
33                                   pem_password_cb *cb, void *u,
34                                   OSSL_LIB_CTX *libctx, const char *propq,
35                                   int expected_store_info_type,
36                                   int try_secure)
37 {
38     EVP_PKEY *ret = NULL;
39     OSSL_STORE_CTX *ctx = NULL;
40     OSSL_STORE_INFO *info = NULL;
41     const UI_METHOD *ui_method = NULL;
42     UI_METHOD *allocated_ui_method = NULL;
43
44     if (expected_store_info_type != OSSL_STORE_INFO_PKEY
45         && expected_store_info_type != OSSL_STORE_INFO_PUBKEY
46         && expected_store_info_type != OSSL_STORE_INFO_PARAMS) {
47         ERR_raise(ERR_LIB_PEM, ERR_R_PASSED_INVALID_ARGUMENT);
48         return NULL;
49     }
50
51     if (cb == NULL)
52         cb = PEM_def_callback;
53     ui_method = allocated_ui_method = UI_UTIL_wrap_read_pem_callback(cb, 0);
54     if (ui_method == NULL)
55         return NULL;
56
57     if ((ctx = OSSL_STORE_attach(bp, "file", libctx, propq, ui_method, u,
58                                  NULL, NULL)) == NULL)
59         goto err;
60 #ifndef OPENSSL_NO_SECURE_HEAP
61 # ifndef OPENSSL_NO_DEPRECATED_3_0
62     if (try_secure) {
63         int on = 1;
64         if (!OSSL_STORE_ctrl(ctx, OSSL_STORE_C_USE_SECMEM, &on))
65             goto err;
66     }
67 # endif
68 #endif
69
70     if (!OSSL_STORE_expect(ctx, expected_store_info_type))
71         goto err;
72
73     while (!OSSL_STORE_eof(ctx)
74            && (info = OSSL_STORE_load(ctx)) != NULL) {
75         if (OSSL_STORE_INFO_get_type(info) == expected_store_info_type) {
76             switch (expected_store_info_type) {
77             case OSSL_STORE_INFO_PKEY:
78                 ret = OSSL_STORE_INFO_get1_PKEY(info);
79                 break;
80             case OSSL_STORE_INFO_PUBKEY:
81                 ret = OSSL_STORE_INFO_get1_PUBKEY(info);
82                 break;
83             case OSSL_STORE_INFO_PARAMS:
84                 ret = OSSL_STORE_INFO_get1_PARAMS(info);
85                 break;
86             }
87         }
88         OSSL_STORE_INFO_free(info);
89         info = NULL;
90     }
91
92     if (ret != NULL && x != NULL)
93         *x = ret;
94
95  err:
96     OSSL_STORE_close(ctx);
97     UI_destroy_method(allocated_ui_method);
98     OSSL_STORE_INFO_free(info);
99     return ret;
100 }
101
102 EVP_PKEY *PEM_read_bio_PUBKEY_ex(BIO *bp, EVP_PKEY **x,
103                                  pem_password_cb *cb, void *u,
104                                  OSSL_LIB_CTX *libctx, const char *propq)
105 {
106     return pem_read_bio_key(bp, x, cb, u, libctx, propq,
107                             OSSL_STORE_INFO_PUBKEY, 0);
108 }
109
110 EVP_PKEY *PEM_read_bio_PUBKEY(BIO *bp, EVP_PKEY **x, pem_password_cb *cb,
111                               void *u)
112 {
113     return PEM_read_bio_PUBKEY_ex(bp, x, cb, u, NULL, NULL);
114 }
115
116 #ifndef OPENSSL_NO_STDIO
117 EVP_PKEY *PEM_read_PUBKEY_ex(FILE *fp, EVP_PKEY **x,
118                              pem_password_cb *cb, void *u,
119                              OSSL_LIB_CTX *libctx, const char *propq)
120 {
121     BIO *b;
122     EVP_PKEY *ret;
123
124     if ((b = BIO_new(BIO_s_file())) == NULL) {
125         ERR_raise(ERR_LIB_PEM, ERR_R_BUF_LIB);
126         return 0;
127     }
128     BIO_set_fp(b, fp, BIO_NOCLOSE);
129     ret = PEM_read_bio_PUBKEY_ex(b, x, cb, u, libctx, propq);
130     BIO_free(b);
131     return ret;
132 }
133
134 EVP_PKEY *PEM_read_PUBKEY(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u)
135 {
136     return PEM_read_PUBKEY_ex(fp, x, cb, u, NULL, NULL);
137 }
138 #endif
139
140 EVP_PKEY *PEM_read_bio_PrivateKey_ex(BIO *bp, EVP_PKEY **x,
141                                      pem_password_cb *cb, void *u,
142                                      OSSL_LIB_CTX *libctx, const char *propq)
143 {
144     return pem_read_bio_key(bp, x, cb, u, libctx, propq,
145                             OSSL_STORE_INFO_PKEY, 1);
146 }
147
148 EVP_PKEY *PEM_read_bio_PrivateKey(BIO *bp, EVP_PKEY **x, pem_password_cb *cb,
149                                   void *u)
150 {
151     return PEM_read_bio_PrivateKey_ex(bp, x, cb, u, NULL, NULL);
152 }
153
154 PEM_write_cb_ex_fnsig(PrivateKey, EVP_PKEY, BIO, write_bio)
155 {
156     IMPLEMENT_PEM_provided_write_body_vars(EVP_PKEY, PrivateKey, propq);
157
158     IMPLEMENT_PEM_provided_write_body_pass();
159     IMPLEMENT_PEM_provided_write_body_main(EVP_PKEY, bio);
160
161  legacy:
162     if (x->ameth == NULL || x->ameth->priv_encode != NULL)
163         return PEM_write_bio_PKCS8PrivateKey(out, x, enc,
164                                              (const char *)kstr, klen, cb, u);
165     return PEM_write_bio_PrivateKey_traditional(out, x, enc, kstr, klen, cb, u);
166 }
167
168 PEM_write_cb_fnsig(PrivateKey, EVP_PKEY, BIO, write_bio)
169 {
170     return PEM_write_bio_PrivateKey_ex(out, x, enc, kstr, klen, cb, u,
171                                        NULL, NULL);
172 }
173
174 /*
175  * Note: there is no way to tell a provided pkey encoder to use "traditional"
176  * encoding.  Therefore, if the pkey is provided, we try to take a copy 
177  * TODO: when #legacy keys are gone, this function will not be possible any
178  * more and should be removed.
179  */
180 int PEM_write_bio_PrivateKey_traditional(BIO *bp, const EVP_PKEY *x,
181                                          const EVP_CIPHER *enc,
182                                          const unsigned char *kstr, int klen,
183                                          pem_password_cb *cb, void *u)
184 {
185     char pem_str[80];
186     EVP_PKEY *copy = NULL;
187     int ret;
188
189     if (evp_pkey_is_assigned(x)
190         && evp_pkey_is_provided(x)
191         && evp_pkey_copy_downgraded(&copy, x))
192         x = copy;
193
194     if (x->ameth == NULL || x->ameth->old_priv_encode == NULL) {
195         ERR_raise(ERR_LIB_PEM, PEM_R_UNSUPPORTED_PUBLIC_KEY_TYPE);
196         return 0;
197     }
198     BIO_snprintf(pem_str, 80, "%s PRIVATE KEY", x->ameth->pem_str);
199     ret = PEM_ASN1_write_bio((i2d_of_void *)i2d_PrivateKey,
200                              pem_str, bp, x, enc, kstr, klen, cb, u);
201
202     EVP_PKEY_free(copy);
203     return ret;
204 }
205
206 EVP_PKEY *PEM_read_bio_Parameters_ex(BIO *bp, EVP_PKEY **x,
207                                      OSSL_LIB_CTX *libctx, const char *propq)
208 {
209     return pem_read_bio_key(bp, x, NULL, NULL, libctx, propq,
210                             OSSL_STORE_INFO_PARAMS, 0);
211 }
212
213 EVP_PKEY *PEM_read_bio_Parameters(BIO *bp, EVP_PKEY **x)
214 {
215     return PEM_read_bio_Parameters_ex(bp, x, NULL, NULL);
216 }
217
218 PEM_write_fnsig(Parameters, EVP_PKEY, BIO, write_bio)
219 {
220     char pem_str[80];
221     IMPLEMENT_PEM_provided_write_body_vars(EVP_PKEY, Parameters, NULL);
222
223     IMPLEMENT_PEM_provided_write_body_main(EVP_PKEY, bio);
224
225  legacy:
226     if (!x->ameth || !x->ameth->param_encode)
227         return 0;
228
229     BIO_snprintf(pem_str, 80, "%s PARAMETERS", x->ameth->pem_str);
230     return PEM_ASN1_write_bio((i2d_of_void *)x->ameth->param_encode,
231                               pem_str, out, x, NULL, NULL, 0, 0, NULL);
232 }
233
234 #ifndef OPENSSL_NO_STDIO
235 EVP_PKEY *PEM_read_PrivateKey_ex(FILE *fp, EVP_PKEY **x, pem_password_cb *cb,
236                                  void *u, OSSL_LIB_CTX *libctx,
237                                  const char *propq)
238 {
239     BIO *b;
240     EVP_PKEY *ret;
241
242     if ((b = BIO_new(BIO_s_file())) == NULL) {
243         ERR_raise(ERR_LIB_PEM, ERR_R_BUF_LIB);
244         return 0;
245     }
246     BIO_set_fp(b, fp, BIO_NOCLOSE);
247     ret = PEM_read_bio_PrivateKey_ex(b, x, cb, u, libctx, propq);
248     BIO_free(b);
249     return ret;
250 }
251
252 EVP_PKEY *PEM_read_PrivateKey(FILE *fp, EVP_PKEY **x, pem_password_cb *cb,
253                               void *u)
254 {
255     return PEM_read_PrivateKey_ex(fp, x, cb, u, NULL, NULL);
256 }
257
258 PEM_write_cb_ex_fnsig(PrivateKey, EVP_PKEY, FILE, write)
259 {
260     BIO *b;
261     int ret;
262
263     if ((b = BIO_new_fp(out, BIO_NOCLOSE)) == NULL) {
264         ERR_raise(ERR_LIB_PEM, ERR_R_BUF_LIB);
265         return 0;
266     }
267     ret = PEM_write_bio_PrivateKey_ex(b, x, enc, kstr, klen, cb, u,
268                                       libctx, propq);
269     BIO_free(b);
270     return ret;
271 }
272
273 PEM_write_cb_fnsig(PrivateKey, EVP_PKEY, FILE, write)
274 {
275     return PEM_write_PrivateKey_ex(out, x, enc, kstr, klen, cb, u, NULL, NULL);
276 }
277 #endif