Blame doc/man3/EVP_PKEY_print_private.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
EVP_PKEY_print_public, EVP_PKEY_print_private, EVP_PKEY_print_params - public key algorithm printing routines
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/evp.h>
Packit c4476c
Packit c4476c
 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
Packit c4476c
                           int indent, ASN1_PCTX *pctx);
Packit c4476c
 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
Packit c4476c
                            int indent, ASN1_PCTX *pctx);
Packit c4476c
 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
Packit c4476c
                           int indent, ASN1_PCTX *pctx);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The functions EVP_PKEY_print_public(), EVP_PKEY_print_private() and
Packit c4476c
EVP_PKEY_print_params() print out the public, private or parameter components
Packit c4476c
of key B<pkey> respectively. The key is sent to BIO B<out> in human readable
Packit c4476c
form. The parameter B<indent> indicated how far the printout should be indented.
Packit c4476c
Packit c4476c
The B<pctx> parameter allows the print output to be finely tuned by using
Packit c4476c
ASN1 printing options. If B<pctx> is set to NULL then default values will
Packit c4476c
be used.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
Currently no public key algorithms include any options in the B<pctx> parameter.
Packit c4476c
Packit c4476c
If the key does not include all the components indicated by the function then
Packit c4476c
only those contained in the key will be printed. For example passing a public
Packit c4476c
key to EVP_PKEY_print_private() will only print the public components.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
These functions all return 1 for success and 0 or a negative value for failure.
Packit c4476c
In particular a return value of -2 indicates the operation is not supported by
Packit c4476c
the public key algorithm.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<EVP_PKEY_CTX_new(3)>,
Packit c4476c
L<EVP_PKEY_keygen(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
These functions were added in OpenSSL 1.0.0.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut