diff options
Diffstat (limited to 'src/lib/libcrypto/doc/EVP_PKEY_print_private.pod')
-rw-r--r-- | src/lib/libcrypto/doc/EVP_PKEY_print_private.pod | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/src/lib/libcrypto/doc/EVP_PKEY_print_private.pod b/src/lib/libcrypto/doc/EVP_PKEY_print_private.pod deleted file mode 100644 index eabbaed264..0000000000 --- a/src/lib/libcrypto/doc/EVP_PKEY_print_private.pod +++ /dev/null | |||
@@ -1,54 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | EVP_PKEY_print_public, EVP_PKEY_print_private, EVP_PKEY_print_params - public | ||
6 | key algorithm printing routines. | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/evp.h> | ||
11 | |||
12 | int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey, | ||
13 | int indent, ASN1_PCTX *pctx); | ||
14 | int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey, | ||
15 | int indent, ASN1_PCTX *pctx); | ||
16 | int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey, | ||
17 | int indent, ASN1_PCTX *pctx); | ||
18 | |||
19 | =head1 DESCRIPTION | ||
20 | |||
21 | The functions EVP_PKEY_print_public(), EVP_PKEY_print_private() and | ||
22 | EVP_PKEY_print_params() print out the public, private or parameter components | ||
23 | of key B<pkey> respectively. The key is sent to BIO B<out> in human readable | ||
24 | form. The parameter B<indent> indicated how far the printout should be indented. | ||
25 | |||
26 | The B<pctx> parameter allows the print output to be finely tuned by using | ||
27 | ASN1 printing options. If B<pctx> is set to NULL then default values will | ||
28 | be used. | ||
29 | |||
30 | =head1 NOTES | ||
31 | |||
32 | Currently no public key algorithms include any options in the B<pctx> parameter | ||
33 | parameter. | ||
34 | |||
35 | If the key does not include all the components indicated by the function then | ||
36 | only those contained in the key will be printed. For example passing a public | ||
37 | key to EVP_PKEY_print_private() will only print the public components. | ||
38 | |||
39 | =head1 RETURN VALUES | ||
40 | |||
41 | These functions all return 1 for success and 0 or a negative value for failure. | ||
42 | In particular a return value of -2 indicates the operation is not supported by | ||
43 | the public key algorithm. | ||
44 | |||
45 | =head1 SEE ALSO | ||
46 | |||
47 | L<EVP_PKEY_CTX_new(3)|EVP_PKEY_CTX_new(3)>, | ||
48 | L<EVP_PKEY_keygen(3)|EVP_PKEY_keygen(3)> | ||
49 | |||
50 | =head1 HISTORY | ||
51 | |||
52 | These functions were first added to OpenSSL 1.0.0. | ||
53 | |||
54 | =cut | ||