diff options
Diffstat (limited to '')
| -rw-r--r-- | src/lib/libcrypto/man/EVP_PKEY_print_private.3 | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKEY_print_private.3 b/src/lib/libcrypto/man/EVP_PKEY_print_private.3 new file mode 100644 index 0000000000..d1f627c6a0 --- /dev/null +++ b/src/lib/libcrypto/man/EVP_PKEY_print_private.3 | |||
| @@ -0,0 +1,76 @@ | |||
| 1 | .Dd $Mdocdate: November 3 2016 $ | ||
| 2 | .Dt EVP_PKEY_PRINT_PRIVATE 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm EVP_PKEY_print_public , | ||
| 6 | .Nm EVP_PKEY_print_private , | ||
| 7 | .Nm EVP_PKEY_print_params | ||
| 8 | .Nd public key algorithm printing routines | ||
| 9 | .Sh SYNOPSIS | ||
| 10 | .In openssl/evp.h | ||
| 11 | .Ft int | ||
| 12 | .Fo EVP_PKEY_print_public | ||
| 13 | .Fa "BIO *out" | ||
| 14 | .Fa "const EVP_PKEY *pkey" | ||
| 15 | .Fa "int indent" | ||
| 16 | .Fa "ASN1_PCTX *pctx" | ||
| 17 | .Fc | ||
| 18 | .Ft int | ||
| 19 | .Fo EVP_PKEY_print_private | ||
| 20 | .Fa "BIO *out" | ||
| 21 | .Fa "const EVP_PKEY *pkey" | ||
| 22 | .Fa "int indent" | ||
| 23 | .Fa "ASN1_PCTX *pctx" | ||
| 24 | .Fc | ||
| 25 | .Ft int | ||
| 26 | .Fo EVP_PKEY_print_params | ||
| 27 | .Fa "BIO *out" | ||
| 28 | .Fa "const EVP_PKEY *pkey" | ||
| 29 | .Fa "int indent" | ||
| 30 | .Fa "ASN1_PCTX *pctx" | ||
| 31 | .Fc | ||
| 32 | .Sh DESCRIPTION | ||
| 33 | The functions | ||
| 34 | .Fn EVP_PKEY_print_public , | ||
| 35 | .Fn EVP_PKEY_print_private , | ||
| 36 | and | ||
| 37 | .Fn EVP_PKEY_print_params | ||
| 38 | print out the public, private or parameter components of key | ||
| 39 | .Fa pkey , | ||
| 40 | respectively. | ||
| 41 | The key is sent to | ||
| 42 | .Vt BIO | ||
| 43 | .Fa out | ||
| 44 | in human readable form. | ||
| 45 | The parameter | ||
| 46 | .Fa indent | ||
| 47 | indicates how far the printout should be indented. | ||
| 48 | .Pp | ||
| 49 | The | ||
| 50 | .Fa pctx | ||
| 51 | parameter allows the print output to be finely tuned by using ASN1 | ||
| 52 | printing options. | ||
| 53 | If | ||
| 54 | .Fa pctx | ||
| 55 | is set to | ||
| 56 | .Dv NULL , | ||
| 57 | then default values will be used. | ||
| 58 | Currently, no public key algorithms include any options in the | ||
| 59 | .Fa pctx | ||
| 60 | parameter. | ||
| 61 | .Pp | ||
| 62 | If the key does not include all the components indicated by the function, | ||
| 63 | then only those contained in the key will be printed. | ||
| 64 | For example, passing a public key to | ||
| 65 | .Fn EVP_PKEY_print_private | ||
| 66 | will only print the public components. | ||
| 67 | .Sh RETURN VALUES | ||
| 68 | These functions all return 1 for success and 0 or a negative value for | ||
| 69 | failure. | ||
| 70 | In particular, a return value of -2 indicates the operation is not | ||
| 71 | supported by the public key algorithm. | ||
| 72 | .Sh SEE ALSO | ||
| 73 | .Xr EVP_PKEY_CTX_new 3 , | ||
| 74 | .Xr EVP_PKEY_keygen 3 | ||
| 75 | .Sh HISTORY | ||
| 76 | These functions were first added to OpenSSL 1.0.0. | ||