diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_KEYMGMT.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_KEYMGMT.3 | 143 |
1 files changed, 36 insertions, 107 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_KEYMGMT.3 b/secure/lib/libcrypto/man/man3/EVP_KEYMGMT.3 index c841aa611be7..fd2695a7018c 100644 --- a/secure/lib/libcrypto/man/man3/EVP_KEYMGMT.3 +++ b/secure/lib/libcrypto/man/man3/EVP_KEYMGMT.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,75 +52,15 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "EVP_KEYMGMT 3ossl" -.TH EVP_KEYMGMT 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EVP_KEYMGMT 3ossl 2025-09-30 3.5.4 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME EVP_KEYMGMT, EVP_KEYMGMT_fetch, EVP_KEYMGMT_up_ref, @@ -149,9 +73,10 @@ EVP_KEYMGMT_do_all_provided, EVP_KEYMGMT_names_do_all, EVP_KEYMGMT_gettable_params, EVP_KEYMGMT_settable_params, +EVP_KEYMGMT_gen_gettable_params, EVP_KEYMGMT_gen_settable_params \&\- EVP key management routines -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/evp.h> @@ -176,10 +101,11 @@ EVP_KEYMGMT_gen_settable_params \& const OSSL_PARAM *EVP_KEYMGMT_gettable_params(const EVP_KEYMGMT *keymgmt); \& const OSSL_PARAM *EVP_KEYMGMT_settable_params(const EVP_KEYMGMT *keymgmt); \& const OSSL_PARAM *EVP_KEYMGMT_gen_settable_params(const EVP_KEYMGMT *keymgmt); +\& const OSSL_PARAM *EVP_KEYMGMT_gen_gettable_params(const EVP_KEYMGMT *keymgmt); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -\&\fB\s-1EVP_KEYMGMT\s0\fR is a method object that represents key management +\&\fBEVP_KEYMGMT\fR is a method object that represents key management implementations for different cryptographic algorithms. This method object provides functionality to have providers import key material from the outside, as well as export key material to the @@ -189,14 +115,15 @@ public interface, this object is simply passed into other functions when needed. .PP \&\fBEVP_KEYMGMT_fetch()\fR looks for an algorithm within the provider that -has been loaded into the \fB\s-1OSSL_LIB_CTX\s0\fR given by \fIctx\fR, having the +has been loaded into the \fBOSSL_LIB_CTX\fR given by \fIctx\fR, having the name given by \fIalgorithm\fR and the properties given by \fIproperties\fR. .PP \&\fBEVP_KEYMGMT_up_ref()\fR increments the reference count for the given -\&\fB\s-1EVP_KEYMGMT\s0\fR \fIkeymgmt\fR. +\&\fBEVP_KEYMGMT\fR \fIkeymgmt\fR. .PP \&\fBEVP_KEYMGMT_free()\fR decrements the reference count for the given -\&\fB\s-1EVP_KEYMGMT\s0\fR \fIkeymgmt\fR, and when the count reaches zero, frees it. +\&\fBEVP_KEYMGMT\fR \fIkeymgmt\fR, and when the count reaches zero, frees it. +If the argument is NULL, nothing is done. .PP \&\fBEVP_KEYMGMT_get0_provider()\fR returns the provider that has this particular implementation. @@ -223,22 +150,23 @@ of the implementations, calls \fIfn\fR with the implementation method and \&\fIdata\fR as arguments. .PP \&\fBEVP_KEYMGMT_gettable_params()\fR and \fBEVP_KEYMGMT_settable_params()\fR return a -constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array that describes the names and types of key +constant \fBOSSL_PARAM\fR\|(3) array that describes the names and types of key parameters that can be retrieved or set. \&\fBEVP_KEYMGMT_gettable_params()\fR is used by \fBEVP_PKEY_gettable_params\fR\|(3). .PP -\&\fBEVP_KEYMGMT_gen_settable_params()\fR returns a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array that -describes the names and types of key generation parameters that can be set via -\&\fBEVP_PKEY_CTX_set_params\fR\|(3). -.SH "NOTES" +\&\fBEVP_KEYMGMT_gen_gettable_params()\fR and \fBEVP_KEYMGMT_gen_settable_params()\fR return a +constant \fBOSSL_PARAM\fR\|(3) array that describes the names and types of key +generation parameters that can be retrieved or set via +\&\fBEVP_PKEY_CTX_get_params\fR\|(3) or \fBEVP_PKEY_CTX_set_params\fR\|(3) respectively. +.SH NOTES .IX Header "NOTES" \&\fBEVP_KEYMGMT_fetch()\fR may be called implicitly by other fetching functions, using the same library context and properties. -Any other \s-1API\s0 that uses keys will typically do this. +Any other API that uses keys will typically do this. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBEVP_KEYMGMT_fetch()\fR returns a pointer to the key management -implementation represented by an \s-1EVP_KEYMGMT\s0 object, or \s-1NULL\s0 on +implementation represented by an EVP_KEYMGMT object, or NULL on error. .PP \&\fBEVP_KEYMGMT_up_ref()\fR returns 1 on success, or 0 on error. @@ -248,31 +176,32 @@ names. A return value of 0 means that the callback was not called for any names. .PP \&\fBEVP_KEYMGMT_free()\fR doesn't return any value. .PP -\&\fBEVP_KEYMGMT_get0_provider()\fR returns a pointer to a provider object, or \s-1NULL\s0 +\&\fBEVP_KEYMGMT_get0_provider()\fR returns a pointer to a provider object, or NULL on error. .PP \&\fBEVP_KEYMGMT_is_a()\fR returns 1 of \fIkeymgmt\fR was identifiable, otherwise 0. .PP -\&\fBEVP_KEYMGMT_get0_name()\fR returns the algorithm name, or \s-1NULL\s0 on error. +\&\fBEVP_KEYMGMT_get0_name()\fR returns the algorithm name, or NULL on error. .PP -\&\fBEVP_KEYMGMT_get0_description()\fR returns a pointer to a description, or \s-1NULL\s0 if +\&\fBEVP_KEYMGMT_get0_description()\fR returns a pointer to a description, or NULL if there isn't one. .PP -\&\fBEVP_KEYMGMT_gettable_params()\fR, \fBEVP_KEYMGMT_settable_params()\fR and -\&\fBEVP_KEYMGMT_gen_settable_params()\fR return a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array or -\&\s-1NULL\s0 on error. +\&\fBEVP_KEYMGMT_gettable_params()\fR, \fBEVP_KEYMGMT_settable_params()\fR, +\&\fBEVP_KEYMGMT_gen_gettable_params()\fR and \fBEVP_KEYMGMT_gen_settable_params()\fR +return a constant \fBOSSL_PARAM\fR\|(3) array or NULL on error. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fBEVP_MD_fetch\fR\|(3), \s-1\fBOSSL_LIB_CTX\s0\fR\|(3) -.SH "HISTORY" +\&\fBEVP_MD_fetch\fR\|(3), \fBOSSL_LIB_CTX\fR\|(3) +.SH HISTORY .IX Header "HISTORY" -The functions described here were added in OpenSSL 3.0. -.SH "COPYRIGHT" +The function \fBEVP_KEYMGMT_gen_gettable_params()\fR was added in OpenSSL 3.4.0 +All other functions described here were added in OpenSSL 3.0. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2019\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |