diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl-kdf.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl-kdf.1 | 356 |
1 files changed, 356 insertions, 0 deletions
diff --git a/secure/usr.bin/openssl/man/openssl-kdf.1 b/secure/usr.bin/openssl/man/openssl-kdf.1 new file mode 100644 index 000000000000..f8b57ac9c56c --- /dev/null +++ b/secure/usr.bin/openssl/man/openssl-kdf.1 @@ -0,0 +1,356 @@ +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.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' +.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\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.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 "OPENSSL-KDF 1ossl" +.TH OPENSSL-KDF 1ossl "2023-09-22" "3.0.11" "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" +openssl\-kdf \- perform Key Derivation Function operations +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBopenssl kdf\fR +[\fB\-help\fR] +[\fB\-cipher\fR] +[\fB\-digest\fR] +[\fB\-mac\fR] +[\fB\-kdfopt\fR \fInm\fR:\fIv\fR] +[\fB\-keylen\fR \fInum\fR] +[\fB\-out\fR \fIfilename\fR] +[\fB\-binary\fR] +[\fB\-provider\fR \fIname\fR] +[\fB\-provider\-path\fR \fIpath\fR] +[\fB\-propquery\fR \fIpropq\fR] +\&\fIkdf_name\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The key derivation functions generate a derived key from either a secret or +password. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-help\fR" 4 +.IX Item "-help" +Print a usage message. +.IP "\fB\-keylen\fR \fInum\fR" 4 +.IX Item "-keylen num" +The output size of the derived key. This field is required. +.IP "\fB\-out\fR \fIfilename\fR" 4 +.IX Item "-out filename" +Filename to output to, or standard output by default. +.IP "\fB\-binary\fR" 4 +.IX Item "-binary" +Output the derived key in binary form. Uses hexadecimal text format if not specified. +.IP "\fB\-cipher\fR \fIname\fR" 4 +.IX Item "-cipher name" +Specify the cipher to be used by the \s-1KDF.\s0 +Not all KDFs require a cipher and it is an error to use this option in such +cases. +.IP "\fB\-digest\fR \fIname\fR" 4 +.IX Item "-digest name" +Specify the digest to be used by the \s-1KDF.\s0 +Not all KDFs require a digest and it is an error to use this option in such +cases. +To see the list of supported digests, use \f(CW\*(C`openssl list \-digest\-commands\*(C'\fR. +.IP "\fB\-mac\fR \fIname\fR" 4 +.IX Item "-mac name" +Specify the \s-1MAC\s0 to be used by the \s-1KDF.\s0 +Not all KDFs require a \s-1MAC\s0 and it is an error to use this option in such +cases. +.IP "\fB\-kdfopt\fR \fInm\fR:\fIv\fR" 4 +.IX Item "-kdfopt nm:v" +Passes options to the \s-1KDF\s0 algorithm. +A comprehensive list of parameters can be found in \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1\fBEVP_KDF\s0\fR\|(3). +Common parameter names used by \fBEVP_KDF_CTX_set_params()\fR are: +.RS 4 +.IP "\fBkey:\fR\fIstring\fR" 4 +.IX Item "key:string" +Specifies the secret key as an alphanumeric string (use if the key contains +printable characters only). +The string length must conform to any restrictions of the \s-1KDF\s0 algorithm. +A key must be specified for most \s-1KDF\s0 algorithms. +.IP "\fBhexkey:\fR\fIstring\fR" 4 +.IX Item "hexkey:string" +Alternative to the \fBkey:\fR option where +the secret key is specified in hexadecimal form (two hex digits per byte). +.IP "\fBpass:\fR\fIstring\fR" 4 +.IX Item "pass:string" +Specifies the password as an alphanumeric string (use if the password contains +printable characters only). +The password must be specified for \s-1PBKDF2\s0 and scrypt. +.IP "\fBhexpass:\fR\fIstring\fR" 4 +.IX Item "hexpass:string" +Alternative to the \fBpass:\fR option where +the password is specified in hexadecimal form (two hex digits per byte). +.IP "\fBsalt:\fR\fIstring\fR" 4 +.IX Item "salt:string" +Specifies a non-secret unique cryptographic salt as an alphanumeric string +(use if it contains printable characters only). +The length must conform to any restrictions of the \s-1KDF\s0 algorithm. +A salt parameter is required for several \s-1KDF\s0 algorithms, +such as \s-1\fBEVP_KDF\-PBKDF2\s0\fR\|(7). +.IP "\fBhexsalt:\fR\fIstring\fR" 4 +.IX Item "hexsalt:string" +Alternative to the \fBsalt:\fR option where +the salt is specified in hexadecimal form (two hex digits per byte). +.IP "\fBinfo:\fR\fIstring\fR" 4 +.IX Item "info:string" +Some \s-1KDF\s0 implementations, such as \s-1\fBEVP_KDF\-HKDF\s0\fR\|(7), take an 'info' parameter +for binding the derived key material +to application\- and context-specific information. +Specifies the info, fixed info, other info or shared info argument +as an alphanumeric string (use if it contains printable characters only). +The length must conform to any restrictions of the \s-1KDF\s0 algorithm. +.IP "\fBhexinfo:\fR\fIstring\fR" 4 +.IX Item "hexinfo:string" +Alternative to the \fBinfo:\fR option where +the info is specified in hexadecimal form (two hex digits per byte). +.IP "\fBdigest:\fR\fIstring\fR" 4 +.IX Item "digest:string" +This option is identical to the \fB\-digest\fR option. +.IP "\fBcipher:\fR\fIstring\fR" 4 +.IX Item "cipher:string" +This option is identical to the \fB\-cipher\fR option. +.IP "\fBmac:\fR\fIstring\fR" 4 +.IX Item "mac:string" +This option is identical to the \fB\-mac\fR option. +.RE +.RS 4 +.RE +.IP "\fB\-provider\fR \fIname\fR" 4 +.IX Item "-provider name" +.PD 0 +.IP "\fB\-provider\-path\fR \fIpath\fR" 4 +.IX Item "-provider-path path" +.IP "\fB\-propquery\fR \fIpropq\fR" 4 +.IX Item "-propquery propq" +.PD +See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7). +.IP "\fIkdf_name\fR" 4 +.IX Item "kdf_name" +Specifies the name of a supported \s-1KDF\s0 algorithm which will be used. +The supported algorithms names include \s-1TLS1\-PRF, HKDF, SSKDF, PBKDF2, +SSHKDF, X942KDF\-ASN1, X942KDF\-CONCAT, X963KDF\s0 and \s-1SCRYPT.\s0 +.SH "EXAMPLES" +.IX Header "EXAMPLES" +Use \s-1TLS1\-PRF\s0 to create a hex-encoded derived key from a secret key and seed: +.PP +.Vb 2 +\& openssl kdf \-keylen 16 \-kdfopt digest:SHA2\-256 \-kdfopt key:secret \e +\& \-kdfopt seed:seed TLS1\-PRF +.Ve +.PP +Use \s-1HKDF\s0 to create a hex-encoded derived key from a secret key, salt and info: +.PP +.Vb 2 +\& openssl kdf \-keylen 10 \-kdfopt digest:SHA2\-256 \-kdfopt key:secret \e +\& \-kdfopt salt:salt \-kdfopt info:label HKDF +.Ve +.PP +Use \s-1SSKDF\s0 with \s-1KMAC\s0 to create a hex-encoded derived key from a secret key, salt and info: +.PP +.Vb 3 +\& openssl kdf \-keylen 64 \-kdfopt mac:KMAC\-128 \-kdfopt maclen:20 \e +\& \-kdfopt hexkey:b74a149a161545 \-kdfopt hexinfo:348a37a2 \e +\& \-kdfopt hexsalt:3638271ccd68a2 SSKDF +.Ve +.PP +Use \s-1SSKDF\s0 with \s-1HMAC\s0 to create a hex-encoded derived key from a secret key, salt and info: +.PP +.Vb 3 +\& openssl kdf \-keylen 16 \-kdfopt mac:HMAC \-kdfopt digest:SHA2\-256 \e +\& \-kdfopt hexkey:b74a149a \-kdfopt hexinfo:348a37a2 \e +\& \-kdfopt hexsalt:3638271c SSKDF +.Ve +.PP +Use \s-1SSKDF\s0 with Hash to create a hex-encoded derived key from a secret key, salt and info: +.PP +.Vb 3 +\& openssl kdf \-keylen 14 \-kdfopt digest:SHA2\-256 \e +\& \-kdfopt hexkey:6dbdc23f045488 \e +\& \-kdfopt hexinfo:a1b2c3d4 SSKDF +.Ve +.PP +Use \s-1SSHKDF\s0 to create a hex-encoded derived key from a secret key, hash and session_id: +.PP +.Vb 5 +\& openssl kdf \-keylen 16 \-kdfopt digest:SHA2\-256 \e +\& \-kdfopt hexkey:0102030405 \e +\& \-kdfopt hexxcghash:06090A \e +\& \-kdfopt hexsession_id:01020304 \e +\& \-kdfopt type:A SSHKDF +.Ve +.PP +Use \s-1PBKDF2\s0 to create a hex-encoded derived key from a password and salt: +.PP +.Vb 2 +\& openssl kdf \-keylen 32 \-kdfopt digest:SHA256 \-kdfopt pass:password \e +\& \-kdfopt salt:salt \-kdfopt iter:2 PBKDF2 +.Ve +.PP +Use scrypt to create a hex-encoded derived key from a password and salt: +.PP +.Vb 3 +\& openssl kdf \-keylen 64 \-kdfopt pass:password \-kdfopt salt:NaCl \e +\& \-kdfopt n:1024 \-kdfopt r:8 \-kdfopt p:16 \e +\& \-kdfopt maxmem_bytes:10485760 SCRYPT +.Ve +.SH "NOTES" +.IX Header "NOTES" +The \s-1KDF\s0 mechanisms that are available will depend on the options +used when building OpenSSL. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBopenssl\fR\|(1), +\&\fBopenssl\-pkeyutl\fR\|(1), +\&\s-1\fBEVP_KDF\s0\fR\|(3), +\&\s-1\fBEVP_KDF\-SCRYPT\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-TLS1_PRF\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-PBKDF2\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-HKDF\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-SS\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-SSHKDF\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-X942\-ASN1\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-X942\-CONCAT\s0\fR\|(7), +\&\s-1\fBEVP_KDF\-X963\s0\fR\|(7) +.SH "HISTORY" +.IX Header "HISTORY" +Added in OpenSSL 3.0 +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the Apache License 2.0 (the \*(L"License\*(R"). 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 +<https://www.openssl.org/source/license.html>. |