1=pod
2
3=head1 NAME
4
5d2i_PKCS8PrivateKey_bio, d2i_PKCS8PrivateKey_fp,
6i2d_PKCS8PrivateKey_bio, i2d_PKCS8PrivateKey_fp,
7i2d_PKCS8PrivateKey_nid_bio, i2d_PKCS8PrivateKey_nid_fp - PKCS#8 format private key functions
8
9=head1 SYNOPSIS
10
11 #include <openssl/pem.h>
12
13 EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb, void *u);
14 EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u);
15
16 int i2d_PKCS8PrivateKey_bio(BIO *bp, const EVP_PKEY *x, const EVP_CIPHER *enc,
17                             char *kstr, int klen,
18                             pem_password_cb *cb, void *u);
19
20 int i2d_PKCS8PrivateKey_fp(FILE *fp, const EVP_PKEY *x, const EVP_CIPHER *enc,
21                            char *kstr, int klen,
22                            pem_password_cb *cb, void *u);
23
24 int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, const EVP_PKEY *x, int nid,
25                                 char *kstr, int klen,
26                                 pem_password_cb *cb, void *u);
27
28 int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, const EVP_PKEY *x, int nid,
29                                char *kstr, int klen,
30                                pem_password_cb *cb, void *u);
31
32=head1 DESCRIPTION
33
34The PKCS#8 functions encode and decode private keys in PKCS#8 format using both
35PKCS#5 v1.5 and PKCS#5 v2.0 password based encryption algorithms.
36
37Other than the use of DER as opposed to PEM these functions are identical to the
38corresponding B<PEM> function as described in L<PEM_read_PrivateKey(3)>.
39
40=head1 NOTES
41
42These functions are currently the only way to store encrypted private keys using DER format.
43
44Currently all the functions use BIOs or FILE pointers, there are no functions
45which support password-protection and work directly on memory: this can be
46readily worked around by converting the buffers to memory BIOs, see
47L<BIO_s_mem(3)> for details.
48If password-protection is not required, the L<i2d_PKCS8PrivateKey(3)> function
49encodes a private key to an unencrypted DER B<PKCS#8> form.
50
51These functions make no assumption regarding the pass phrase received from the
52password callback.
53It will simply be treated as a byte sequence.
54
55=head1 RETURN VALUES
56
57d2i_PKCS8PrivateKey_bio() and d2i_PKCS8PrivateKey_fp() return a valid B<EVP_PKEY>
58structure or NULL if an error occurred.
59
60i2d_PKCS8PrivateKey_bio(), i2d_PKCS8PrivateKey_fp(), i2d_PKCS8PrivateKey_nid_bio()
61and i2d_PKCS8PrivateKey_nid_fp() return 1 on success or 0 on error.
62
63=head1 SEE ALSO
64
65L<i2d_PKCS8PrivateKey(3)>,
66L<PEM_read_PrivateKey(3)>,
67L<passphrase-encoding(7)>
68
69=head1 HISTORY
70
71L<i2d_PKCS8PrivateKey(3)> was added in OpenSSL 3.6.
72
73=head1 COPYRIGHT
74
75Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
76
77Licensed under the Apache License 2.0 (the "License").  You may not use
78this file except in compliance with the License.  You can obtain a copy
79in the file LICENSE in the source distribution or at
80L<https://www.openssl.org/source/license.html>.
81
82=cut
83