diff options
author | schwarze <> | 2019-03-18 04:01:53 +0000 |
---|---|---|
committer | schwarze <> | 2019-03-18 04:01:53 +0000 |
commit | c83fdaf4a44228dd62baab8c5b94f1b2833790fc (patch) | |
tree | 7d104ae684b03be12406af8d1214766afb4ed2af | |
parent | 24c04e2def7e2b57a9aaa595d26bb601b5a77505 (diff) | |
download | openbsd-c83fdaf4a44228dd62baab8c5b94f1b2833790fc.tar.gz openbsd-c83fdaf4a44228dd62baab8c5b94f1b2833790fc.tar.bz2 openbsd-c83fdaf4a44228dd62baab8c5b94f1b2833790fc.zip |
In evp.h rev. 1.75, tb@ provided EVP_PKEY_get0_hmac(3).
Document it.
Even though OpenSSL muddles the waters by lumping the description
together with the other EVP_PKEY_get0_*() functions, describe it
separately because a char * has no reference count and because
the function fills in an additional length parameter.
-rw-r--r-- | src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3 | 32 |
1 files changed, 29 insertions, 3 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3 b/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3 index 1d79584b25..948bec4fb3 100644 --- a/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3 +++ b/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: EVP_PKEY_set1_RSA.3,v 1.14 2018/05/13 16:44:57 schwarze Exp $ | 1 | .\" $OpenBSD: EVP_PKEY_set1_RSA.3,v 1.15 2019/03/18 04:01:53 schwarze Exp $ |
2 | .\" full merge up to: OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400 | 2 | .\" full merge up to: OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400 |
3 | .\" selective merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 | 3 | .\" selective merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 |
4 | .\" | 4 | .\" |
@@ -49,7 +49,7 @@ | |||
49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
51 | .\" | 51 | .\" |
52 | .Dd $Mdocdate: May 13 2018 $ | 52 | .Dd $Mdocdate: March 18 2019 $ |
53 | .Dt EVP_PKEY_SET1_RSA 3 | 53 | .Dt EVP_PKEY_SET1_RSA 3 |
54 | .Os | 54 | .Os |
55 | .Sh NAME | 55 | .Sh NAME |
@@ -65,6 +65,7 @@ | |||
65 | .Nm EVP_PKEY_get0_DSA , | 65 | .Nm EVP_PKEY_get0_DSA , |
66 | .Nm EVP_PKEY_get0_DH , | 66 | .Nm EVP_PKEY_get0_DH , |
67 | .Nm EVP_PKEY_get0_EC_KEY , | 67 | .Nm EVP_PKEY_get0_EC_KEY , |
68 | .Nm EVP_PKEY_get0_hmac , | ||
68 | .Nm EVP_PKEY_assign_RSA , | 69 | .Nm EVP_PKEY_assign_RSA , |
69 | .Nm EVP_PKEY_assign_DSA , | 70 | .Nm EVP_PKEY_assign_DSA , |
70 | .Nm EVP_PKEY_assign_DH , | 71 | .Nm EVP_PKEY_assign_DH , |
@@ -127,6 +128,11 @@ | |||
127 | .Fo EVP_PKEY_get0_EC_KEY | 128 | .Fo EVP_PKEY_get0_EC_KEY |
128 | .Fa "EVP_PKEY *pkey" | 129 | .Fa "EVP_PKEY *pkey" |
129 | .Fc | 130 | .Fc |
131 | .Ft const unsigned char * | ||
132 | .Fo EVP_PKEY_get0_hmac | ||
133 | .Fa "const EVP_PKEY *pkey" | ||
134 | .Fa "size_t *len" | ||
135 | .Fc | ||
130 | .Ft int | 136 | .Ft int |
131 | .Fo EVP_PKEY_assign_RSA | 137 | .Fo EVP_PKEY_assign_RSA |
132 | .Fa "EVP_PKEY *pkey" | 138 | .Fa "EVP_PKEY *pkey" |
@@ -189,6 +195,21 @@ and | |||
189 | are identical except that they do not increment the reference count. | 195 | are identical except that they do not increment the reference count. |
190 | Consequently, the returned key must not be freed by the caller. | 196 | Consequently, the returned key must not be freed by the caller. |
191 | .Pp | 197 | .Pp |
198 | .Fn EVP_PKEY_get0_hmac | ||
199 | returns an internal pointer to the key referenced in | ||
200 | .Fa pkey | ||
201 | and sets | ||
202 | .Pf * Fa len | ||
203 | to its length in bytes. | ||
204 | The returned pointer must not be freed by the caller. | ||
205 | If | ||
206 | .Fa pkey | ||
207 | is not of the correct type, | ||
208 | .Dv NULL | ||
209 | is returned and the content of | ||
210 | .Pf * Fa len | ||
211 | becomes unspecified. | ||
212 | .Pp | ||
192 | .Fn EVP_PKEY_assign_RSA , | 213 | .Fn EVP_PKEY_assign_RSA , |
193 | .Fn EVP_PKEY_assign_DSA , | 214 | .Fn EVP_PKEY_assign_DSA , |
194 | .Fn EVP_PKEY_assign_DH , | 215 | .Fn EVP_PKEY_assign_DH , |
@@ -268,8 +289,9 @@ return 1 for success or 0 for failure. | |||
268 | .Fn EVP_PKEY_get0_RSA , | 289 | .Fn EVP_PKEY_get0_RSA , |
269 | .Fn EVP_PKEY_get0_DSA , | 290 | .Fn EVP_PKEY_get0_DSA , |
270 | .Fn EVP_PKEY_get0_DH , | 291 | .Fn EVP_PKEY_get0_DH , |
292 | .Fn EVP_PKEY_get0_EC_KEY , | ||
271 | and | 293 | and |
272 | .Fn EVP_PKEY_get0_EC_KEY | 294 | .Fn EVP_PKEY_get0_hmac |
273 | return the referenced key or | 295 | return the referenced key or |
274 | .Dv NULL | 296 | .Dv NULL |
275 | if an error occurred. | 297 | if an error occurred. |
@@ -336,3 +358,7 @@ and | |||
336 | .Fn EVP_PKEY_get0_EC_KEY | 358 | .Fn EVP_PKEY_get0_EC_KEY |
337 | first appeared in OpenSSL 1.1.0 and have been available since | 359 | first appeared in OpenSSL 1.1.0 and have been available since |
338 | .Ox 6.3 . | 360 | .Ox 6.3 . |
361 | .Pp | ||
362 | .Fn EVP_PKEY_get0_hmac | ||
363 | first appeared in OpenSSL 1.1.0 and has been available since | ||
364 | .Ox 6.5 . | ||