diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/PKCS12_key_gen_utf8_ex.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/PKCS12_key_gen_utf8_ex.3 | 130 |
1 files changed, 27 insertions, 103 deletions
diff --git a/secure/lib/libcrypto/man/man3/PKCS12_key_gen_utf8_ex.3 b/secure/lib/libcrypto/man/man3/PKCS12_key_gen_utf8_ex.3 index 41f39d36cec7..b0593418c6fb 100644 --- a/secure/lib/libcrypto/man/man3/PKCS12_key_gen_utf8_ex.3 +++ b/secure/lib/libcrypto/man/man3/PKCS12_key_gen_utf8_ex.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,79 +52,19 @@ . \} .\} .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 "PKCS12_KEY_GEN_UTF8_EX 3ossl" -.TH PKCS12_KEY_GEN_UTF8_EX 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH PKCS12_KEY_GEN_UTF8_EX 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 PKCS12_key_gen_asc, PKCS12_key_gen_asc_ex, PKCS12_key_gen_uni, PKCS12_key_gen_uni_ex, PKCS12_key_gen_utf8, PKCS12_key_gen_utf8_ex \- PKCS#12 Password based key derivation -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/pkcs12.h> @@ -167,41 +91,41 @@ PKCS12_key_gen_utf8, PKCS12_key_gen_utf8_ex \- PKCS#12 Password based key deriva \& unsigned char *out, const EVP_MD *md_type, \& OSSL_LIB_CTX *ctx, const char *propq); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -These methods perform a key derivation according to PKCS#12 (\s-1RFC7292\s0) +These methods perform a key derivation according to PKCS#12 (RFC7292) with an input password \fIpass\fR of length \fIpasslen\fR, a salt \fIsalt\fR of length \&\fIsaltlen\fR, an iteration count \fIiter\fR and a digest algorithm \fImd_type\fR. -The \s-1ID\s0 byte \fIid\fR determines how the resulting key is intended to be used: -.IP "\(bu" 4 +The ID byte \fIid\fR determines how the resulting key is intended to be used: +.IP \(bu 4 If ID=1, then the pseudorandom bits being produced are to be used as key material for performing encryption or decryption. -.IP "\(bu" 4 +.IP \(bu 4 If ID=2, then the pseudorandom bits being produced are to be used -as an \s-1IV\s0 (Initial Value) for encryption or decryption. -.IP "\(bu" 4 +as an IV (Initial Value) for encryption or decryption. +.IP \(bu 4 If ID=3, then the pseudorandom bits being produced are to be used as an integrity key for MACing. .PP The intended format of the supplied password is determined by the method chosen: -.IP "\(bu" 4 +.IP \(bu 4 \&\fBPKCS12_key_gen_asc()\fR and \fBPKCS12_key_gen_asc_ex()\fR expect an ASCII-formatted password. -.IP "\(bu" 4 +.IP \(bu 4 \&\fBPKCS12_key_gen_uni()\fR and \fBPKCS12_key_gen_uni_ex()\fR expect a Unicode-formatted password. -.IP "\(bu" 4 -\&\fBPKCS12_key_gen_utf8()\fR and \fBPKCS12_key_gen_utf8_ex()\fR expect a \s-1UTF\-8\s0 encoded password. +.IP \(bu 4 +\&\fBPKCS12_key_gen_utf8()\fR and \fBPKCS12_key_gen_utf8_ex()\fR expect a UTF\-8 encoded password. .PP \&\fIpass\fR is the password used in the derivation of length \fIpasslen\fR. \fIpass\fR -is an optional parameter and can be \s-1NULL.\s0 If \fIpasslen\fR is \-1, then the +is an optional parameter and can be NULL. If \fIpasslen\fR is \-1, then the function will calculate the length of \fIpass\fR using \fBstrlen()\fR. .PP \&\fIsalt\fR is the salt used in the derivation of length \fIsaltlen\fR. If the -\&\fIsalt\fR is \s-1NULL,\s0 then \fIsaltlen\fR must be 0. The function will not +\&\fIsalt\fR is NULL, then \fIsaltlen\fR must be 0. The function will not attempt to calculate the length of the \fIsalt\fR because it is not assumed to -be \s-1NULL\s0 terminated. +be NULL terminated. .PP \&\fIiter\fR is the iteration count and its value should be greater than or -equal to 1. \s-1RFC 2898\s0 suggests an iteration count of at least 1000. Any +equal to 1. RFC 2898 suggests an iteration count of at least 1000. Any \&\fIiter\fR less than 1 is treated as a single iteration. .PP \&\fIdigest\fR is the message digest function used in the derivation. @@ -211,7 +135,7 @@ is specified via \fIn\fR. .PP Functions ending in \fB_ex()\fR allow for a library context \fIctx\fR and property query \&\fIpropq\fR to be used to select algorithm implementations. -.SH "NOTES" +.SH NOTES .IX Header "NOTES" A typical application of this function is to derive keying material for an encryption algorithm from a password in the \fIpass\fR, a salt in \fIsalt\fR, @@ -225,21 +149,21 @@ of candidate passwords. Returns 1 on success or 0 on error. .SH "CONFORMING TO" .IX Header "CONFORMING TO" -\&\s-1IETF RFC 7292\s0 (<https://tools.ietf.org/html/rfc7292>) +IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>) .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBPKCS12_create_ex\fR\|(3), \&\fBPKCS12_pbe_crypt_ex\fR\|(3), \&\fBpassphrase\-encoding\fR\|(7) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" \&\fBPKCS12_key_gen_asc_ex()\fR, \fBPKCS12_key_gen_uni_ex()\fR and \fBPKCS12_key_gen_utf8_ex()\fR were added in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 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>. |