2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
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
11 #include "internal/cryptlib.h"
12 #include <openssl/core_dispatch.h>
13 #include <openssl/buffer.h>
14 #include <openssl/objects.h>
15 #include <openssl/evp.h>
16 #include <openssl/x509.h>
17 #include <openssl/pkcs12.h>
18 #include <openssl/pem.h>
19 #include <openssl/encoder.h>
21 static int do_pk8pkey(BIO *bp, const EVP_PKEY *x, int isder,
22 int nid, const EVP_CIPHER *enc,
23 const char *kstr, int klen,
24 pem_password_cb *cb, void *u,
25 OSSL_LIB_CTX *libctx, const char *propq);
27 #ifndef OPENSSL_NO_STDIO
28 static int do_pk8pkey_fp(FILE *bp, const EVP_PKEY *x, int isder,
29 int nid, const EVP_CIPHER *enc,
30 const char *kstr, int klen,
31 pem_password_cb *cb, void *u,
32 OSSL_LIB_CTX *libctx, const char *propq);
35 * These functions write a private key in PKCS#8 format: it is a "drop in"
36 * replacement for PEM_write_bio_PrivateKey() and friends. As usual if 'enc'
37 * is NULL then it uses the unencrypted private key form. The 'nid' versions
38 * uses PKCS#5 v1.5 PBE algorithms whereas the others use PKCS#5 v2.0.
41 int PEM_write_bio_PKCS8PrivateKey_nid(BIO *bp, const EVP_PKEY *x, int nid,
42 const char *kstr, int klen,
43 pem_password_cb *cb, void *u)
45 return do_pk8pkey(bp, x, 0, nid, NULL, kstr, klen, cb, u, NULL, NULL);
48 int PEM_write_bio_PKCS8PrivateKey(BIO *bp, const EVP_PKEY *x, const EVP_CIPHER *enc,
49 const char *kstr, int klen,
50 pem_password_cb *cb, void *u)
52 return do_pk8pkey(bp, x, 0, -1, enc, kstr, klen, cb, u, NULL, NULL);
55 int i2d_PKCS8PrivateKey_bio(BIO *bp, const EVP_PKEY *x, const EVP_CIPHER *enc,
56 const char *kstr, int klen,
57 pem_password_cb *cb, void *u)
59 return do_pk8pkey(bp, x, 1, -1, enc, kstr, klen, cb, u, NULL, NULL);
62 int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, const EVP_PKEY *x, int nid,
63 const char *kstr, int klen,
64 pem_password_cb *cb, void *u)
66 return do_pk8pkey(bp, x, 1, nid, NULL, kstr, klen, cb, u, NULL, NULL);
69 static int do_pk8pkey(BIO *bp, const EVP_PKEY *x, int isder, int nid,
70 const EVP_CIPHER *enc, const char *kstr, int klen,
71 pem_password_cb *cb, void *u,
72 OSSL_LIB_CTX *libctx, const char *propq)
75 const char *outtype = isder ? "DER" : "PEM";
76 OSSL_ENCODER_CTX *ctx =
77 OSSL_ENCODER_CTX_new_by_EVP_PKEY(x, outtype, OSSL_KEYMGMT_SELECT_ALL,
84 * If no keystring or callback is set, OpenSSL traditionally uses the
85 * user's cb argument as a password string, or if that's NULL, it falls
86 * back on PEM_def_callback().
88 if (kstr == NULL && cb == NULL) {
93 cb = PEM_def_callback;
97 if (OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0) {
101 if (OSSL_ENCODER_CTX_set_cipher(ctx, EVP_CIPHER_name(enc), NULL)) {
102 const unsigned char *ukstr = (const unsigned char *)kstr;
105 * Try to pass the passphrase if one was given, or the
106 * passphrase callback if one was given. If none of them
107 * are given and that's wrong, we rely on the _to_bio()
108 * call to generate errors.
112 && !OSSL_ENCODER_CTX_set_passphrase(ctx, ukstr, klen))
115 && !OSSL_ENCODER_CTX_set_pem_password_cb(ctx, cb, u))
119 ret = ret && OSSL_ENCODER_to_bio(ctx, bp);
122 PKCS8_PRIV_KEY_INFO *p8inf;
123 char buf[PEM_BUFSIZE];
126 if ((p8inf = EVP_PKEY2PKCS8(x)) == NULL) {
127 PEMerr(PEM_F_DO_PK8PKEY, PEM_R_ERROR_CONVERTING_PRIVATE_KEY);
130 if (enc || (nid != -1)) {
132 klen = cb(buf, PEM_BUFSIZE, 1, u);
134 PEMerr(PEM_F_DO_PK8PKEY, PEM_R_READ_KEY);
140 p8 = PKCS8_encrypt(nid, enc, kstr, klen, NULL, 0, 0, p8inf);
142 OPENSSL_cleanse(buf, klen);
146 ret = i2d_PKCS8_bio(bp, p8);
148 ret = PEM_write_bio_PKCS8(bp, p8);
152 ret = i2d_PKCS8_PRIV_KEY_INFO_bio(bp, p8inf);
154 ret = PEM_write_bio_PKCS8_PRIV_KEY_INFO(bp, p8inf);
157 PKCS8_PRIV_KEY_INFO_free(p8inf);
159 OSSL_ENCODER_CTX_free(ctx);
163 EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb,
166 PKCS8_PRIV_KEY_INFO *p8inf = NULL;
170 char psbuf[PEM_BUFSIZE];
172 p8 = d2i_PKCS8_bio(bp, NULL);
176 klen = cb(psbuf, PEM_BUFSIZE, 0, u);
178 klen = PEM_def_callback(psbuf, PEM_BUFSIZE, 0, u);
180 PEMerr(PEM_F_D2I_PKCS8PRIVATEKEY_BIO, PEM_R_BAD_PASSWORD_READ);
184 p8inf = PKCS8_decrypt(p8, psbuf, klen);
186 OPENSSL_cleanse(psbuf, klen);
189 ret = EVP_PKCS82PKEY(p8inf);
190 PKCS8_PRIV_KEY_INFO_free(p8inf);
200 #ifndef OPENSSL_NO_STDIO
202 int i2d_PKCS8PrivateKey_fp(FILE *fp, const EVP_PKEY *x, const EVP_CIPHER *enc,
203 const char *kstr, int klen,
204 pem_password_cb *cb, void *u)
206 return do_pk8pkey_fp(fp, x, 1, -1, enc, kstr, klen, cb, u, NULL, NULL);
209 int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, const EVP_PKEY *x, int nid,
210 const char *kstr, int klen,
211 pem_password_cb *cb, void *u)
213 return do_pk8pkey_fp(fp, x, 1, nid, NULL, kstr, klen, cb, u, NULL, NULL);
216 int PEM_write_PKCS8PrivateKey_nid(FILE *fp, const EVP_PKEY *x, int nid,
217 const char *kstr, int klen,
218 pem_password_cb *cb, void *u)
220 return do_pk8pkey_fp(fp, x, 0, nid, NULL, kstr, klen, cb, u, NULL, NULL);
223 int PEM_write_PKCS8PrivateKey(FILE *fp, const EVP_PKEY *x, const EVP_CIPHER *enc,
224 const char *kstr, int klen,
225 pem_password_cb *cb, void *u)
227 return do_pk8pkey_fp(fp, x, 0, -1, enc, kstr, klen, cb, u, NULL, NULL);
230 static int do_pk8pkey_fp(FILE *fp, const EVP_PKEY *x, int isder, int nid,
231 const EVP_CIPHER *enc, const char *kstr, int klen,
232 pem_password_cb *cb, void *u,
233 OSSL_LIB_CTX *libctx, const char *propq)
238 if ((bp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
239 PEMerr(PEM_F_DO_PK8PKEY_FP, ERR_R_BUF_LIB);
242 ret = do_pk8pkey(bp, x, isder, nid, enc, kstr, klen, cb, u, libctx, propq);
247 EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb,
253 if ((bp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
254 PEMerr(PEM_F_D2I_PKCS8PRIVATEKEY_FP, ERR_R_BUF_LIB);
257 ret = d2i_PKCS8PrivateKey_bio(bp, x, cb, u);
264 IMPLEMENT_PEM_rw(PKCS8, X509_SIG, PEM_STRING_PKCS8, X509_SIG)
267 IMPLEMENT_PEM_rw(PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO, PEM_STRING_PKCS8INF,