diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_PKEY_fromdata.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_PKEY_fromdata.3 | 177 |
1 files changed, 59 insertions, 118 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_PKEY_fromdata.3 b/secure/lib/libcrypto/man/man3/EVP_PKEY_fromdata.3 index f08f0ec2f8ec..e4dba0798235 100644 --- a/secure/lib/libcrypto/man/man3/EVP_PKEY_fromdata.3 +++ b/secure/lib/libcrypto/man/man3/EVP_PKEY_fromdata.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,78 +52,18 @@ . \} .\} .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_PKEY_FROMDATA 3ossl" -.TH EVP_PKEY_FROMDATA 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EVP_PKEY_FROMDATA 3ossl 2025-07-01 3.5.1 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_PKEY_fromdata_init, EVP_PKEY_fromdata, EVP_PKEY_fromdata_settable \&\- functions to create keys and key parameters from user data -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/evp.h> @@ -149,18 +73,18 @@ EVP_PKEY_fromdata_init, EVP_PKEY_fromdata, EVP_PKEY_fromdata_settable \& OSSL_PARAM params[]); \& const OSSL_PARAM *EVP_PKEY_fromdata_settable(EVP_PKEY_CTX *ctx, int selection); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" The functions described here are used to create new keys from user -provided key data, such as \fIn\fR, \fIe\fR and \fId\fR for a minimal \s-1RSA\s0 +provided key data, such as \fIn\fR, \fIe\fR and \fId\fR for a minimal RSA keypair. .PP -These functions use an \fB\s-1EVP_PKEY_CTX\s0\fR context, which should primarily +These functions use an \fBEVP_PKEY_CTX\fR context, which should primarily be created with \fBEVP_PKEY_CTX_new_from_name\fR\|(3) or \&\fBEVP_PKEY_CTX_new_id\fR\|(3). .PP The exact key data that the user can pass depends on the key type. -These are passed as an \s-1\fBOSSL_PARAM\s0\fR\|(3) array. +These are passed as an \fBOSSL_PARAM\fR\|(3) array. .PP \&\fBEVP_PKEY_fromdata_init()\fR initializes a public key algorithm context for creating a key or key parameters from user data. @@ -168,39 +92,43 @@ for creating a key or key parameters from user data. \&\fBEVP_PKEY_fromdata()\fR creates the structure to store a key or key parameters, given data from \fIparams\fR, \fIselection\fR and a context that's been initialized with \fBEVP_PKEY_fromdata_init()\fR. The result is written to \fI*ppkey\fR. -\&\fIselection\fR is described in \*(L"Selections\*(R". -The parameters that can be used for various types of key are as described by the -diverse \*(L"Common parameters\*(R" sections of the -\&\fB\s-1EVP_PKEY\-RSA\s0\fR(7), -\&\fB\s-1EVP_PKEY\-DSA\s0\fR(7), -\&\fB\s-1EVP_PKEY\-DH\s0\fR(7), -\&\fB\s-1EVP_PKEY\-EC\s0\fR(7), -\&\fB\s-1EVP_PKEY\-ED448\s0\fR(7), -\&\fB\s-1EVP_PKEY\-X25519\s0\fR(7), -\&\fB\s-1EVP_PKEY\-X448\s0\fR(7), -and \fB\s-1EVP_PKEY\-ED25519\s0\fR(7) pages. +\&\fIselection\fR is described in "Selections". +The parameters that can be used for various types of key are as described by +the various "Common parameters" sections of the +\&\fBEVP_PKEY\-RSA\fR(7), +\&\fBEVP_PKEY\-DSA\fR(7), +\&\fBEVP_PKEY\-DH\fR(7), +\&\fBEVP_PKEY\-EC\fR(7), +\&\fBEVP_PKEY\-ED448\fR(7), +\&\fBEVP_PKEY\-X25519\fR(7), +\&\fBEVP_PKEY\-X448\fR(7), +\&\fBEVP_PKEY\-ED25519\fR(7), +\&\fBEVP_PKEY\-ML\-DSA\|(7)\fR +and +\&\fBEVP_PKEY\-ML\-KEM\|(7)\fR +pages. .PP -\&\fBEVP_PKEY_fromdata_settable()\fR gets a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array that describes +\&\fBEVP_PKEY_fromdata_settable()\fR gets a constant \fBOSSL_PARAM\fR\|(3) array that describes the settable parameters that can be used with \fBEVP_PKEY_fromdata()\fR. -\&\fIselection\fR is described in \*(L"Selections\*(R". +\&\fIselection\fR is described in "Selections". .PP Parameters in the \fIparams\fR array that are not among the settable parameters for the given \fIselection\fR are ignored. -.SS "Selections" +.SS Selections .IX Subsection "Selections" The following constants can be used for \fIselection\fR: -.IP "\fB\s-1EVP_PKEY_KEY_PARAMETERS\s0\fR" 4 +.IP \fBEVP_PKEY_KEY_PARAMETERS\fR 4 .IX Item "EVP_PKEY_KEY_PARAMETERS" Only key parameters will be selected. -.IP "\fB\s-1EVP_PKEY_PUBLIC_KEY\s0\fR" 4 +.IP \fBEVP_PKEY_PUBLIC_KEY\fR 4 .IX Item "EVP_PKEY_PUBLIC_KEY" Only public key components will be selected. This includes optional key parameters. -.IP "\fB\s-1EVP_PKEY_KEYPAIR\s0\fR" 4 +.IP \fBEVP_PKEY_KEYPAIR\fR 4 .IX Item "EVP_PKEY_KEYPAIR" Any keypair components will be selected. This includes the private key, public key and key parameters. -.SH "NOTES" +.SH NOTES .IX Header "NOTES" These functions only work with key management methods coming from a provider. This is the mirror function to \fBEVP_PKEY_todata\fR\|(3). @@ -209,13 +137,13 @@ This is the mirror function to \fBEVP_PKEY_todata\fR\|(3). \&\fBEVP_PKEY_fromdata_init()\fR and \fBEVP_PKEY_fromdata()\fR 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 "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" These examples are very terse for the sake of staying on topic, which is the \fBEVP_PKEY_fromdata()\fR set of functions. In real applications, BIGNUMs would be handled and converted to byte arrays with \&\fBBN_bn2nativepad()\fR, but that's off topic here. -.SS "Creating an \s-1RSA\s0 keypair using raw key data" +.SS "Creating an RSA keypair using raw key data" .IX Subsection "Creating an RSA keypair using raw key data" .Vb 1 \& #include <openssl/evp.h> @@ -249,7 +177,7 @@ BIGNUMs would be handled and converted to byte arrays with \& /* Do what you want with |pkey| */ \& } .Ve -.SS "Creating an \s-1ECC\s0 keypair using raw key data" +.SS "Creating an ECC keypair using raw key data" .IX Subsection "Creating an ECC keypair using raw key data" .Vb 3 \& #include <openssl/evp.h> @@ -367,24 +295,37 @@ BIGNUMs would be handled and converted to byte arrays with \& } .Ve .PP -The descriptor \s-1\fBOSSL_PARAM\s0\fR\|(3) returned by +The descriptor \fBOSSL_PARAM\fR\|(3) returned by \&\fBEVP_PKEY_fromdata_settable()\fR may also be used programmatically, for example with \fBOSSL_PARAM_allocate_from_text\fR\|(3). .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fBEVP_PKEY_CTX_new\fR\|(3), \fBprovider\fR\|(7), \fBEVP_PKEY_gettable_params\fR\|(3), -\&\s-1\fBOSSL_PARAM\s0\fR\|(3), \fBEVP_PKEY_todata\fR\|(3), -\&\s-1\fBEVP_PKEY\-RSA\s0\fR\|(7), \s-1\fBEVP_PKEY\-DSA\s0\fR\|(7), \s-1\fBEVP_PKEY\-DH\s0\fR\|(7), \s-1\fBEVP_PKEY\-EC\s0\fR\|(7), -\&\s-1\fBEVP_PKEY\-ED448\s0\fR\|(7), \s-1\fBEVP_PKEY\-X25519\s0\fR\|(7), \s-1\fBEVP_PKEY\-X448\s0\fR\|(7), -\&\s-1\fBEVP_PKEY\-ED25519\s0\fR\|(7) -.SH "HISTORY" +\&\fBEVP_PKEY_CTX_new\fR\|(3), +\&\fBEVP_PKEY_todata\fR\|(3), +\&\fBEVP_PKEY_gettable_params\fR\|(3), +\&\fBOSSL_PARAM\fR\|(3), +\&\fBprovider\fR\|(7), +\&\fBEVP_PKEY\-RSA\fR\|(7), +\&\fBEVP_PKEY\-EC\fR\|(7), +\&\fBEVP_PKEY\-ED25519\fR\|(7), +\&\fBEVP_PKEY\-ED448\fR\|(7), +\&\fBEVP_PKEY\-DSA\fR\|(7), +\&\fBEVP_PKEY\-DH\fR\|(7), +\&\fBEVP_PKEY\-X25519\fR\|(7), +\&\fBEVP_PKEY\-X448\fR\|(7), +\&\fBEVP_PKEY\-ML\-DSA\fR\|(7), +\&\fBEVP_PKEY\-ML\-KEM\fR\|(7), +\&\fBEVP_PKEY\-SLH\-DSA\fR\|(7). +.SH HISTORY .IX Header "HISTORY" These functions were added in OpenSSL 3.0. -.SH "COPYRIGHT" +.PP +Support for \fBML-DSA\fR, \fBML-KEM\fR and \fBSLH-DSA\fR was added in OpenSSL 3.5. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2019\-2022 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2019\-2025 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>. |