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