diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_PARAM_allocate_from_text.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_PARAM_allocate_from_text.3 | 142 |
1 files changed, 33 insertions, 109 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_PARAM_allocate_from_text.3 b/secure/lib/libcrypto/man/man3/OSSL_PARAM_allocate_from_text.3 index 5e122f3df527..8a730231c54b 100644 --- a/secure/lib/libcrypto/man/man3/OSSL_PARAM_allocate_from_text.3 +++ b/secure/lib/libcrypto/man/man3/OSSL_PARAM_allocate_from_text.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 "OSSL_PARAM_ALLOCATE_FROM_TEXT 3ossl" -.TH OSSL_PARAM_ALLOCATE_FROM_TEXT 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH OSSL_PARAM_ALLOCATE_FROM_TEXT 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 OSSL_PARAM_allocate_from_text \&\- OSSL_PARAM construction utilities -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/params.h> @@ -150,7 +74,7 @@ OSSL_PARAM_allocate_from_text \& size_t value_n, \& int *found); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" With OpenSSL before version 3.0, parameters were passed down to or retrieved from algorithm implementations via control functions. @@ -159,7 +83,7 @@ parameters, for example \fBEVP_PKEY_CTX_ctrl_str\fR\|(3). .PP OpenSSL 3.0 introduces a new mechanism to do the same thing with an array of parameters that contain name, value, value type and value -size (see \s-1\fBOSSL_PARAM\s0\fR\|(3) for more information). +size (see \fBOSSL_PARAM\fR\|(3) for more information). .PP \&\fBOSSL_PARAM_allocate_from_text()\fR uses \fIkey\fR to look up an item in \&\fIparamdefs\fR. If an item was found, it converts \fIvalue\fR to something @@ -173,67 +97,67 @@ to zero. needs to be freed by the caller when it's not useful any more, using \&\fBOPENSSL_free\fR\|(3). .PP -If \fIfound\fR is not \s-1NULL,\s0 \fI*found\fR is set to 1 if \fIkey\fR could be +If \fIfound\fR is not NULL, \fI*found\fR is set to 1 if \fIkey\fR could be located in \fIparamdefs\fR, and to 0 otherwise. .SS "The use of \fIkey\fP and \fIvalue\fP in detail" .IX Subsection "The use of key and value in detail" \&\fBOSSL_PARAM_allocate_from_text()\fR takes note if \fIkey\fR starts with -\&\*(L"hex\*(R", and will only use the rest of \fIkey\fR to look up an item in -\&\fIparamdefs\fR in that case. As an example, if \fIkey\fR is \*(L"hexid\*(R", \*(L"id\*(R" +"hex", and will only use the rest of \fIkey\fR to look up an item in +\&\fIparamdefs\fR in that case. As an example, if \fIkey\fR is "hexid", "id" will be looked up in \fIparamdefs\fR. .PP When an item in \fIparamdefs\fR has been found, \fIvalue\fR is converted depending on that item's \fIdata_type\fR, as follows: -.IP "\fB\s-1OSSL_PARAM_INTEGER\s0\fR and \fB\s-1OSSL_PARAM_UNSIGNED_INTEGER\s0\fR" 4 +.IP "\fBOSSL_PARAM_INTEGER\fR and \fBOSSL_PARAM_UNSIGNED_INTEGER\fR" 4 .IX Item "OSSL_PARAM_INTEGER and OSSL_PARAM_UNSIGNED_INTEGER" -If \fIkey\fR didn't start with \*(L"hex\*(R", \fIvalue\fR is assumed to contain +If \fIkey\fR didn't start with "hex", \fIvalue\fR is assumed to contain \&\fIvalue_n\fR decimal characters, which are decoded, and the resulting bytes become the number stored in the \fIto\->data\fR storage. .Sp -If \fIvalue\fR starts with \*(L"0x\*(R", it is assumed to contain \fIvalue_n\fR +If \fIvalue\fR starts with "0x", it is assumed to contain \fIvalue_n\fR hexadecimal characters. .Sp -If \fIkey\fR started with \*(L"hex\*(R", \fIvalue\fR is assumed to contain -\&\fIvalue_n\fR hexadecimal characters without the \*(L"0x\*(R" prefix. +If \fIkey\fR started with "hex", \fIvalue\fR is assumed to contain +\&\fIvalue_n\fR hexadecimal characters without the "0x" prefix. .Sp If \fIvalue\fR contains characters that couldn't be decoded as hexadecimal or decimal characters, \fBOSSL_PARAM_allocate_from_text()\fR considers that an error. -.IP "\fB\s-1OSSL_PARAM_UTF8_STRING\s0\fR" 4 +.IP \fBOSSL_PARAM_UTF8_STRING\fR 4 .IX Item "OSSL_PARAM_UTF8_STRING" -If \fIkey\fR started with \*(L"hex\*(R", \fBOSSL_PARAM_allocate_from_text()\fR +If \fIkey\fR started with "hex", \fBOSSL_PARAM_allocate_from_text()\fR considers that an error. .Sp Otherwise, \fIvalue\fR is considered a C string and is copied to the \&\fIto\->data\fR storage. -On systems where the native character encoding is \s-1EBCDIC,\s0 the bytes in -\&\fIto\->data\fR are converted to \s-1ASCII.\s0 -.IP "\fB\s-1OSSL_PARAM_OCTET_STRING\s0\fR" 4 +On systems where the native character encoding is EBCDIC, the bytes in +\&\fIto\->data\fR are converted to ASCII. +.IP \fBOSSL_PARAM_OCTET_STRING\fR 4 .IX Item "OSSL_PARAM_OCTET_STRING" -If \fIkey\fR started with \*(L"hex\*(R", \fIvalue\fR is assumed to contain +If \fIkey\fR started with "hex", \fIvalue\fR is assumed to contain \&\fIvalue_n\fR hexadecimal characters, which are decoded, and the resulting bytes are stored in the \fIto\->data\fR storage. If \fIvalue\fR contains characters that couldn't be decoded as hexadecimal or decimal characters, \fBOSSL_PARAM_allocate_from_text()\fR considers that an error. .Sp -If \fIkey\fR didn't start with \*(L"hex\*(R", \fIvalue_n\fR bytes from \fIvalue\fR are +If \fIkey\fR didn't start with "hex", \fIvalue_n\fR bytes from \fIvalue\fR are copied to the \fIto\->data\fR storage. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBOSSL_PARAM_allocate_from_text()\fR returns 1 if \fIkey\fR was found in \&\fIparamdefs\fR and there was no other failure, otherwise 0. -.SH "NOTES" +.SH NOTES .IX Header "NOTES" The parameter descriptor array comes from functions dedicated to return them. -The following \s-1\fBOSSL_PARAM\s0\fR\|(3) attributes are used: -.IP "\fIkey\fR" 4 +The following \fBOSSL_PARAM\fR\|(3) attributes are used: +.IP \fIkey\fR 4 .IX Item "key" .PD 0 -.IP "\fIdata_type\fR" 4 +.IP \fIdata_type\fR 4 .IX Item "data_type" -.IP "\fIdata_size\fR" 4 +.IP \fIdata_size\fR 4 .IX Item "data_size" .PD .PP @@ -241,7 +165,7 @@ All other attributes are ignored. .PP The \fIdata_size\fR attribute can be zero, meaning that the parameter it describes expects arbitrary length data. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" Code that looked like this: .PP @@ -317,12 +241,12 @@ Can be written like this instead: .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\s-1\fBOSSL_PARAM\s0\fR\|(3), \fBOSSL_PARAM_int\fR\|(3) -.SH "COPYRIGHT" +\&\fBOSSL_PARAM\fR\|(3), \fBOSSL_PARAM_int\fR\|(3) +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2019\-2021 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>. |