xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/EVP_KDF-PBKDF1.7 (revision 3117ece4fc4a4ca4489ba793710b60b0d26bab6c)
$NetBSD: EVP_KDF-PBKDF1.7,v 1.5 2024/09/08 13:08:21 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

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'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "EVP_KDF-PBKDF1 7"
EVP_KDF-PBKDF1 7 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
EVP_KDF-PBKDF1 - The PBKDF1 EVP_KDF implementation
DESCRIPTION
Header "DESCRIPTION" Support for computing the PBKDF1 password-based KDF through the EVP_KDF API.

The EVP_KDF-PBKDF1 algorithm implements the PBKDF1 password-based key derivation function, as described in RFC 8018; it derives a key from a password using a salt and iteration count.

Identity
Subsection "Identity" "PBKDF1" is the name for this implementation; it can be used with the EVP_KDF_fetch() function.
"Supported parameters"
Subsection "Supported parameters" The supported parameters are:
"""pass"" (OSSL_KDF_PARAM_PASSWORD) <octet string>" 4
Item """pass"" (OSSL_KDF_PARAM_PASSWORD) <octet string>"

0

"""salt"" (OSSL_KDF_PARAM_SALT) <octet string>" 4
Item """salt"" (OSSL_KDF_PARAM_SALT) <octet string>"
"""iter"" (OSSL_KDF_PARAM_ITER) <unsigned integer>" 4
Item """iter"" (OSSL_KDF_PARAM_ITER) <unsigned integer>"

This parameter has a default value of 0 and should be set.

"""properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" 4
Item """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>"

0

"""digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>" 4
Item """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>"

These parameters work as described in "PARAMETERS" in EVP_KDF\|(3).

NOTES
Header "NOTES" A typical application of this algorithm is to derive keying material for an encryption algorithm from a password in the "pass", a salt in "salt", and an iteration count.

Increasing the "iter" parameter slows down the algorithm which makes it harder for an attacker to perform a brute force attack using a large number of candidate passwords.

No assumption is made regarding the given password; it is simply treated as a byte sequence.

"CONFORMING TO"
Header "CONFORMING TO" RFC 8018
"SEE ALSO"
Header "SEE ALSO" \fBEVP_KDF\|(3), \fBEVP_KDF_CTX_new\|(3), \fBEVP_KDF_CTX_free\|(3), \fBEVP_KDF_CTX_set_params\|(3), \fBEVP_KDF_derive\|(3), "PARAMETERS" in EVP_KDF\|(3)
HISTORY
Header "HISTORY" This functionality was added in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.

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 LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.