324 lines
12 KiB
Plaintext
324 lines
12 KiB
Plaintext
|
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
||
|
|
.\"
|
||
|
|
.\" 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 turned on, 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
|
||
|
|
.\"
|
||
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||
|
|
.\" 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_KDF-ARGON2 7ossl"
|
||
|
|
.TH EVP_KDF-ARGON2 7ossl "2024-01-30" "3.2.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"
|
||
|
|
EVP_KDF\-ARGON2 \- The Argon2 EVP KDF implementation
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
Support for computing the \fBargon2\fR password-based \s-1KDF\s0 through the \fB\s-1EVP_KDF\s0\fR
|
||
|
|
\&\s-1API.\s0
|
||
|
|
.PP
|
||
|
|
The \s-1EVP_KDF\-ARGON2\s0 algorithm implements the Argon2 password-based key
|
||
|
|
derivation function, as described in \s-1IETF RFC 9106. \s0 It is memory-hard in
|
||
|
|
the sense that it deliberately requires a significant amount of \s-1RAM\s0 for efficient
|
||
|
|
computation. The intention of this is to render brute forcing of passwords on
|
||
|
|
systems that lack large amounts of main memory (such as GPUs or ASICs)
|
||
|
|
computationally infeasible.
|
||
|
|
.PP
|
||
|
|
Argon2d (Argon2i) uses data-dependent (data-independent) memory access and
|
||
|
|
primary seek to address trade-off (side-channel) attacks.
|
||
|
|
.PP
|
||
|
|
Argon2id is a hybrid construction which, in the first two slices of the first
|
||
|
|
pass, generates reference addresses data-independently as in Argon2i, whereas
|
||
|
|
in later slices and next passes it generates them data-dependently as in
|
||
|
|
Argon2d.
|
||
|
|
.PP
|
||
|
|
Sbox-hardened version Argon2ds is not supported.
|
||
|
|
.PP
|
||
|
|
For more information, please refer to \s-1RFC 9106.\s0
|
||
|
|
.SS "Supported parameters"
|
||
|
|
.IX Subsection "Supported parameters"
|
||
|
|
The supported parameters are:
|
||
|
|
.ie n .IP """pass"" (\fB\s-1OSSL_KDF_PARAM_PASSWORD\s0\fR) <octet string>" 4
|
||
|
|
.el .IP "``pass'' (\fB\s-1OSSL_KDF_PARAM_PASSWORD\s0\fR) <octet string>" 4
|
||
|
|
.IX Item "pass (OSSL_KDF_PARAM_PASSWORD) <octet string>"
|
||
|
|
.PD 0
|
||
|
|
.ie n .IP """salt"" (\fB\s-1OSSL_KDF_PARAM_SALT\s0\fR) <octet string>" 4
|
||
|
|
.el .IP "``salt'' (\fB\s-1OSSL_KDF_PARAM_SALT\s0\fR) <octet string>" 4
|
||
|
|
.IX Item "salt (OSSL_KDF_PARAM_SALT) <octet string>"
|
||
|
|
.ie n .IP """secret"" (\fB\s-1OSSL_KDF_PARAM_SECRET\s0\fR) <octet string>" 4
|
||
|
|
.el .IP "``secret'' (\fB\s-1OSSL_KDF_PARAM_SECRET\s0\fR) <octet string>" 4
|
||
|
|
.IX Item "secret (OSSL_KDF_PARAM_SECRET) <octet string>"
|
||
|
|
.ie n .IP """iter"" (\fB\s-1OSSL_KDF_PARAM_ITER\s0\fR) <unsigned integer>" 4
|
||
|
|
.el .IP "``iter'' (\fB\s-1OSSL_KDF_PARAM_ITER\s0\fR) <unsigned integer>" 4
|
||
|
|
.IX Item "iter (OSSL_KDF_PARAM_ITER) <unsigned integer>"
|
||
|
|
.ie n .IP """size"" (\fB\s-1OSSL_KDF_PARAM_SIZE\s0\fR) <unsigned integer>" 4
|
||
|
|
.el .IP "``size'' (\fB\s-1OSSL_KDF_PARAM_SIZE\s0\fR) <unsigned integer>" 4
|
||
|
|
.IX Item "size (OSSL_KDF_PARAM_SIZE) <unsigned integer>"
|
||
|
|
.PD
|
||
|
|
These parameters work as described in \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1\fIEVP_KDF\s0\fR\|(3).
|
||
|
|
.Sp
|
||
|
|
Note that \s-1RFC 9106\s0 recommends 128 bits salt for most applications, or 64 bits
|
||
|
|
salt in the case of space constraints. At least 128 bits output length is
|
||
|
|
recommended.
|
||
|
|
.Sp
|
||
|
|
Note that secret (or pepper) is an optional secret data used along the
|
||
|
|
password.
|
||
|
|
.ie n .IP """threads"" (\fB\s-1OSSL_KDF_PARAM_THREADS\s0\fR) <unsigned integer>" 4
|
||
|
|
.el .IP "``threads'' (\fB\s-1OSSL_KDF_PARAM_THREADS\s0\fR) <unsigned integer>" 4
|
||
|
|
.IX Item "threads (OSSL_KDF_PARAM_THREADS) <unsigned integer>"
|
||
|
|
The number of threads, bounded above by the number of lanes.
|
||
|
|
.Sp
|
||
|
|
This can only be used with built-in thread support. Threading must be
|
||
|
|
explicitly enabled. See \s-1EXAMPLES\s0 section for more information.
|
||
|
|
.ie n .IP """ad"" (\fB\s-1OSSL_KDF_PARAM_ARGON2_AD\s0\fR) <octet string>" 4
|
||
|
|
.el .IP "``ad'' (\fB\s-1OSSL_KDF_PARAM_ARGON2_AD\s0\fR) <octet string>" 4
|
||
|
|
.IX Item "ad (OSSL_KDF_PARAM_ARGON2_AD) <octet string>"
|
||
|
|
Optional associated data, may be used to \*(L"tag\*(R" a group of keys, or tie them
|
||
|
|
to a particular public key, without having to modify salt.
|
||
|
|
.ie n .IP """lanes"" (\fB\s-1OSSL_KDF_PARAM_ARGON2_LANES\s0\fR) <unsigned integer>" 4
|
||
|
|
.el .IP "``lanes'' (\fB\s-1OSSL_KDF_PARAM_ARGON2_LANES\s0\fR) <unsigned integer>" 4
|
||
|
|
.IX Item "lanes (OSSL_KDF_PARAM_ARGON2_LANES) <unsigned integer>"
|
||
|
|
Argon2 splits the requested memory size into lanes, each of which is designed
|
||
|
|
to be processed in parallel. For example, on a system with p cores, it's
|
||
|
|
recommended to use p lanes.
|
||
|
|
.Sp
|
||
|
|
The number of lanes is used to derive the key. It is possible to specify
|
||
|
|
more lanes than the number of available computational threads. This is
|
||
|
|
especially encouraged if multi-threading is disabled.
|
||
|
|
.ie n .IP """memcost"" (\fB\s-1OSSL_KDF_PARAM_ARGON2_MEMCOST\s0\fR) <unsigned integer>" 4
|
||
|
|
.el .IP "``memcost'' (\fB\s-1OSSL_KDF_PARAM_ARGON2_MEMCOST\s0\fR) <unsigned integer>" 4
|
||
|
|
.IX Item "memcost (OSSL_KDF_PARAM_ARGON2_MEMCOST) <unsigned integer>"
|
||
|
|
Memory cost parameter (the number of 1k memory blocks used).
|
||
|
|
.ie n .IP """version"" (\fB\s-1OSSL_KDF_PARAM_ARGON2_VERSION\s0\fR) <unsigned integer>" 4
|
||
|
|
.el .IP "``version'' (\fB\s-1OSSL_KDF_PARAM_ARGON2_VERSION\s0\fR) <unsigned integer>" 4
|
||
|
|
.IX Item "version (OSSL_KDF_PARAM_ARGON2_VERSION) <unsigned integer>"
|
||
|
|
Argon2 version. Supported values: 0x10, 0x13 (default).
|
||
|
|
.ie n .IP """early_clean"" (\fB\s-1OSSL_KDF_PARAM_EARLY_CLEAN\s0\fR) <unsigned integer>" 4
|
||
|
|
.el .IP "``early_clean'' (\fB\s-1OSSL_KDF_PARAM_EARLY_CLEAN\s0\fR) <unsigned integer>" 4
|
||
|
|
.IX Item "early_clean (OSSL_KDF_PARAM_EARLY_CLEAN) <unsigned integer>"
|
||
|
|
If set (nonzero), password and secret stored in Argon2 context are zeroed
|
||
|
|
early during initial hash computation, as soon as they are not needed.
|
||
|
|
Otherwise, they are zeroed along the rest of Argon2 context data on clear,
|
||
|
|
free, reset.
|
||
|
|
.Sp
|
||
|
|
This can be useful if, for example, multiple keys with different ad value
|
||
|
|
are to be generated from a single password and secret.
|
||
|
|
.SH "EXAMPLES"
|
||
|
|
.IX Header "EXAMPLES"
|
||
|
|
This example uses Argon2d with password \*(L"1234567890\*(R", salt \*(L"saltsalt\*(R",
|
||
|
|
using 2 lanes, 2 threads, and memory cost of 65536:
|
||
|
|
.PP
|
||
|
|
.Vb 5
|
||
|
|
\& #include <string.h> /* strlen */
|
||
|
|
\& #include <openssl/core_names.h> /* OSSL_KDF_* */
|
||
|
|
\& #include <openssl/params.h> /* OSSL_PARAM_* */
|
||
|
|
\& #include <openssl/thread.h> /* OSSL_set_max_threads */
|
||
|
|
\& #include <openssl/kdf.h> /* EVP_KDF_* */
|
||
|
|
\&
|
||
|
|
\& int main(void)
|
||
|
|
\& {
|
||
|
|
\& int retval = 1;
|
||
|
|
\&
|
||
|
|
\& EVP_KDF *kdf = NULL;
|
||
|
|
\& EVP_KDF_CTX *kctx = NULL;
|
||
|
|
\& OSSL_PARAM params[6], *p = params;
|
||
|
|
\&
|
||
|
|
\& /* argon2 params, please refer to RFC9106 for recommended defaults */
|
||
|
|
\& uint32_t lanes = 2, threads = 2, memcost = 65536;
|
||
|
|
\& char pwd[] = "1234567890", salt[] = "saltsalt";
|
||
|
|
\&
|
||
|
|
\& /* derive result */
|
||
|
|
\& size_t outlen = 128;
|
||
|
|
\& unsigned char result[outlen];
|
||
|
|
\&
|
||
|
|
\& /* required if threads > 1 */
|
||
|
|
\& if (OSSL_set_max_threads(NULL, threads) != 1)
|
||
|
|
\& goto fail;
|
||
|
|
\&
|
||
|
|
\& p = params;
|
||
|
|
\& *p++ = OSSL_PARAM_construct_uint32(OSSL_KDF_PARAM_THREADS, &threads);
|
||
|
|
\& *p++ = OSSL_PARAM_construct_uint32(OSSL_KDF_PARAM_ARGON2_LANES,
|
||
|
|
\& &lanes);
|
||
|
|
\& *p++ = OSSL_PARAM_construct_uint32(OSSL_KDF_PARAM_ARGON2_MEMCOST,
|
||
|
|
\& &memcost);
|
||
|
|
\& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT,
|
||
|
|
\& salt,
|
||
|
|
\& strlen((const char *)salt));
|
||
|
|
\& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_PASSWORD,
|
||
|
|
\& pwd,
|
||
|
|
\& strlen((const char *)pwd));
|
||
|
|
\& *p++ = OSSL_PARAM_construct_end();
|
||
|
|
\&
|
||
|
|
\& if ((kdf = EVP_KDF_fetch(NULL, "ARGON2D", NULL)) == NULL)
|
||
|
|
\& goto fail;
|
||
|
|
\& if ((kctx = EVP_KDF_CTX_new(kdf)) == NULL)
|
||
|
|
\& goto fail;
|
||
|
|
\& if (EVP_KDF_derive(kctx, &result[0], outlen, params) != 1)
|
||
|
|
\& goto fail;
|
||
|
|
\&
|
||
|
|
\& printf("Output = %s\en", OPENSSL_buf2hexstr(result, outlen));
|
||
|
|
\& retval = 0;
|
||
|
|
\&
|
||
|
|
\& fail:
|
||
|
|
\& EVP_KDF_free(kdf);
|
||
|
|
\& EVP_KDF_CTX_free(kctx);
|
||
|
|
\& OSSL_set_max_threads(NULL, 0);
|
||
|
|
\&
|
||
|
|
\& return retval;
|
||
|
|
\& }
|
||
|
|
.Ve
|
||
|
|
.SH "NOTES"
|
||
|
|
.IX Header "NOTES"
|
||
|
|
\&\*(L"\s-1ARGON2I\*(R", \*(L"ARGON2D\*(R",\s0 and \*(L"\s-1ARGON2ID\*(R"\s0 are the names for this implementation; it
|
||
|
|
can be used with the \fIEVP_KDF_fetch()\fR function.
|
||
|
|
.SH "CONFORMING TO"
|
||
|
|
.IX Header "CONFORMING TO"
|
||
|
|
\&\s-1RFC 9106\s0 Argon2, see <https://www.rfc\-editor.org/rfc/rfc9106.txt>.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
\&\s-1\fIEVP_KDF\s0\fR\|(3),
|
||
|
|
\&\fIEVP_KDF_CTX_new\fR\|(3),
|
||
|
|
\&\fIEVP_KDF_CTX_free\fR\|(3),
|
||
|
|
\&\fIEVP_KDF_CTX_set_params\fR\|(3),
|
||
|
|
\&\fIEVP_KDF_derive\fR\|(3),
|
||
|
|
\&\*(L"\s-1PARAMETERS\*(R"\s0 in \s-1\fIEVP_KDF\s0\fR\|(3)
|
||
|
|
.SH "HISTORY"
|
||
|
|
.IX Header "HISTORY"
|
||
|
|
This functionality was added to OpenSSL 3.2.
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2022\-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>.
|