]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/crypto/d2i_PKCS8PrivateKey.pod
Add copyright to manpages
[thirdparty/openssl.git] / doc / crypto / d2i_PKCS8PrivateKey.pod
CommitLineData
9de6bb8a
DSH
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/evp.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, 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, 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, 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, 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
9b86974e 38corresponding B<PEM> function as described in the L<pem(3)> manual page.
9de6bb8a
DSH
39
40=head1 NOTES
41
9de6bb8a
DSH
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 which
45work directly on memory: this can be readily worked around by converting the buffers
9b86974e 46to memory BIOs, see L<BIO_s_mem(3)> for details.
9de6bb8a
DSH
47
48=head1 SEE ALSO
49
9b86974e 50L<pem(3)>
9de6bb8a
DSH
51
52=cut
e2f92610
RS
53
54=head1 COPYRIGHT
55
56Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
57
58Licensed under the OpenSSL license (the "License"). You may not use
59this file except in compliance with the License. You can obtain a copy
60in the file LICENSE in the source distribution or at
61L<https://www.openssl.org/source/license.html>.
62
63=cut