Blame doc/man3/d2i_PKCS8PrivateKey_bio.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
d2i_PKCS8PrivateKey_bio, d2i_PKCS8PrivateKey_fp,
Packit Service 084de1
i2d_PKCS8PrivateKey_bio, i2d_PKCS8PrivateKey_fp,
Packit Service 084de1
i2d_PKCS8PrivateKey_nid_bio, i2d_PKCS8PrivateKey_nid_fp - PKCS#8 format private key functions
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/evp.h>
Packit Service 084de1
Packit Service 084de1
 EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb, void *u);
Packit Service 084de1
 EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u);
Packit Service 084de1
Packit Service 084de1
 int i2d_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
Packit Service 084de1
                             char *kstr, int klen,
Packit Service 084de1
                             pem_password_cb *cb, void *u);
Packit Service 084de1
Packit Service 084de1
 int i2d_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
Packit Service 084de1
                            char *kstr, int klen,
Packit Service 084de1
                            pem_password_cb *cb, void *u);
Packit Service 084de1
Packit Service 084de1
 int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, EVP_PKEY *x, int nid,
Packit Service 084de1
                                 char *kstr, int klen,
Packit Service 084de1
                                 pem_password_cb *cb, void *u);
Packit Service 084de1
Packit Service 084de1
 int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, EVP_PKEY *x, int nid,
Packit Service 084de1
                                char *kstr, int klen,
Packit Service 084de1
                                pem_password_cb *cb, void *u);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
The PKCS#8 functions encode and decode private keys in PKCS#8 format using both
Packit Service 084de1
PKCS#5 v1.5 and PKCS#5 v2.0 password based encryption algorithms.
Packit Service 084de1
Packit Service 084de1
Other than the use of DER as opposed to PEM these functions are identical to the
Packit Service 084de1
corresponding B<PEM> function as described in L<PEM_read_PrivateKey(3)>.
Packit Service 084de1
Packit Service 084de1
=head1 NOTES
Packit Service 084de1
Packit Service 084de1
These functions are currently the only way to store encrypted private keys using DER format.
Packit Service 084de1
Packit Service 084de1
Currently all the functions use BIOs or FILE pointers, there are no functions which
Packit Service 084de1
work directly on memory: this can be readily worked around by converting the buffers
Packit Service 084de1
to memory BIOs, see L<BIO_s_mem(3)> for details.
Packit Service 084de1
Packit Service 084de1
These functions make no assumption regarding the pass phrase received from the
Packit Service 084de1
password callback.
Packit Service 084de1
It will simply be treated as a byte sequence.
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
d2i_PKCS8PrivateKey_bio() and d2i_PKCS8PrivateKey_fp() return a valid B<EVP_PKEY>
Packit Service 084de1
structure or NULL if an error occurred.
Packit Service 084de1
Packit Service 084de1
i2d_PKCS8PrivateKey_bio(), i2d_PKCS8PrivateKey_fp(), i2d_PKCS8PrivateKey_nid_bio()
Packit Service 084de1
and i2d_PKCS8PrivateKey_nid_fp() return 1 on success or 0 on error.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<PEM_read_PrivateKey(3)>,
Packit Service 084de1
L<passphrase-encoding(7)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut