summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authortb <>2021-03-29 17:58:29 +0000
committertb <>2021-03-29 17:58:29 +0000
commit4cd8b5cd3e6a96b52e1d8cb53c83ecf94c949ac7 (patch)
tree6cbdfb651dc97822733f2d76b764a1eeb62d70df /src
parent3bfeb436fe7a1999037d9d6a9fb9784e062ea38a (diff)
downloadopenbsd-4cd8b5cd3e6a96b52e1d8cb53c83ecf94c949ac7.tar.gz
openbsd-4cd8b5cd3e6a96b52e1d8cb53c83ecf94c949ac7.tar.bz2
openbsd-4cd8b5cd3e6a96b52e1d8cb53c83ecf94c949ac7.zip
Prepare documenting EVP_PKEY_new_CMAC_key(3)
Based on some text in OpenSSL 1.1.1's EVP_PKEY_new.pod.
Diffstat (limited to 'src')
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_new.356
1 files changed, 54 insertions, 2 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKEY_new.3 b/src/lib/libcrypto/man/EVP_PKEY_new.3
index 00ffbce95d..51f9d9b4b0 100644
--- a/src/lib/libcrypto/man/EVP_PKEY_new.3
+++ b/src/lib/libcrypto/man/EVP_PKEY_new.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EVP_PKEY_new.3,v 1.11 2019/06/07 19:59:11 schwarze Exp $ 1.\" $OpenBSD: EVP_PKEY_new.3,v 1.12 2021/03/29 17:58:29 tb Exp $
2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
3.\" selective merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100 3.\" selective merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100
4.\" 4.\"
@@ -50,13 +50,16 @@
50.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51.\" OF THE POSSIBILITY OF SUCH DAMAGE. 51.\" OF THE POSSIBILITY OF SUCH DAMAGE.
52.\" 52.\"
53.Dd $Mdocdate: June 7 2019 $ 53.Dd $Mdocdate: March 29 2021 $
54.Dt EVP_PKEY_NEW 3 54.Dt EVP_PKEY_NEW 3
55.Os 55.Os
56.Sh NAME 56.Sh NAME
57.Nm EVP_PKEY_new , 57.Nm EVP_PKEY_new ,
58.Nm EVP_PKEY_up_ref , 58.Nm EVP_PKEY_up_ref ,
59.Nm EVP_PKEY_free , 59.Nm EVP_PKEY_free ,
60.ig \" will appear in a library bump before Ox 6.9
61.Nm EVP_PKEY_new_CMAC_key
62..
60.Nm EVP_PKEY_new_mac_key 63.Nm EVP_PKEY_new_mac_key
61.Nd private key allocation functions 64.Nd private key allocation functions
62.Sh SYNOPSIS 65.Sh SYNOPSIS
@@ -71,6 +74,15 @@
71.Fo EVP_PKEY_free 74.Fo EVP_PKEY_free
72.Fa "EVP_PKEY *key" 75.Fa "EVP_PKEY *key"
73.Fc 76.Fc
77.ig
78.Ft EVP_PKEY *
79.Fo EVP_PKEY_new_CMAC_key
80.Fa "ENGINE *e"
81.Fa "const unsigned char *priv"
82.Fa "size_t len"
83.Fa "const EVP_CIPHER *cipher"
84.Fc
85..
74.Ft EVP_PKEY * 86.Ft EVP_PKEY *
75.Fo EVP_PKEY_new_mac_key 87.Fo EVP_PKEY_new_mac_key
76.Fa "int type" 88.Fa "int type"
@@ -107,6 +119,34 @@ If
107is a 119is a
108.Dv NULL 120.Dv NULL
109pointer, no action occurs. 121pointer, no action occurs.
122.ig
123.Pp
124.Fn EVP_PKEY_new_CMAC_key
125allocates a new
126.Vt EVP_PKEY
127for the
128.Dv EVP_PKEY_CMAC
129algorithm type.
130If
131.Fa e
132is
133.Pf non- Dv NULL ,
134then the new
135.Vt EVP_PKEY
136is associated with the engine
137.Fa e .
138.Fa priv
139points to the raw private key data
140of length
141.Fa len
142for this
143.Vt EVP_PKEY .
144.Fa cipher
145specifies a cipher algorithm to be used during creation of the CMAC.
146.Fa cipher
147should be a standard encryption only cipher.
148For example, AEAD and XTS ciphers should not be used.
149..
110.Pp 150.Pp
111.Fn EVP_PKEY_new_mac_key 151.Fn EVP_PKEY_new_mac_key
112allocates a new 152allocates a new
@@ -135,6 +175,9 @@ The public key data will be automatically derived from the given
135private key data (if appropriate for the algorithm type). 175private key data (if appropriate for the algorithm type).
136.Sh RETURN VALUES 176.Sh RETURN VALUES
137.Fn EVP_PKEY_new 177.Fn EVP_PKEY_new
178.ig
179.Fn EVP_PKEY_new_CMAC_key ,
180..
138and 181and
139.Fn EVP_PKEY_new_mac_key 182.Fn EVP_PKEY_new_mac_key
140return either the newly allocated 183return either the newly allocated
@@ -146,6 +189,9 @@ if an error occurred.
146.Fn EVP_PKEY_up_ref 189.Fn EVP_PKEY_up_ref
147returns 1 for success or 0 for failure. 190returns 1 for success or 0 for failure.
148.Sh SEE ALSO 191.Sh SEE ALSO
192.ig
193.Xr CMAC_Init 3 ,
194..
149.Xr d2i_PrivateKey 3 , 195.Xr d2i_PrivateKey 3 ,
150.Xr evp 3 , 196.Xr evp 3 ,
151.Xr EVP_PKEY_asn1_new 3 , 197.Xr EVP_PKEY_asn1_new 3 ,
@@ -161,6 +207,12 @@ and
161.Fn EVP_PKEY_free 207.Fn EVP_PKEY_free
162first appeared in SSLeay 0.6.0 and have been available since 208first appeared in SSLeay 0.6.0 and have been available since
163.Ox 2.4 . 209.Ox 2.4 .
210.ig
211.Pp
212.Fn EVP_PKEY_new_CMAC_key
213first appeared in OpenSSL 1.1.1 and has been available since
214.Ox 6.9 .
215..
164.Pp 216.Pp
165.Fn EVP_PKEY_new_mac_key 217.Fn EVP_PKEY_new_mac_key
166first appeared in OpenSSL 1.0.0 and has been available since 218first appeared in OpenSSL 1.0.0 and has been available since