316 lines
13 KiB
Plaintext
316 lines
13 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 "PKCS5_PBE_KEYIVGEN 3ossl"
|
||
|
|
.TH PKCS5_PBE_KEYIVGEN 3ossl "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"
|
||
|
|
PKCS5_PBE_keyivgen, PKCS5_PBE_keyivgen_ex, PKCS5_pbe2_set, PKCS5_pbe2_set_iv,
|
||
|
|
PKCS5_pbe2_set_iv_ex, PKCS5_pbe_set, PKCS5_pbe_set_ex, PKCS5_pbe2_set_scrypt,
|
||
|
|
PKCS5_pbe_set0_algor, PKCS5_pbe_set0_algor_ex,
|
||
|
|
PKCS5_v2_PBE_keyivgen, PKCS5_v2_PBE_keyivgen_ex,
|
||
|
|
PKCS5_v2_scrypt_keyivgen, PKCS5_v2_scrypt_keyivgen_ex,
|
||
|
|
PKCS5_pbkdf2_set, PKCS5_pbkdf2_set_ex, EVP_PBE_scrypt, EVP_PBE_scrypt_ex
|
||
|
|
\&\- PKCS#5 Password based encryption routines
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
.Vb 1
|
||
|
|
\& #include <openssl/evp.h>
|
||
|
|
\&
|
||
|
|
\& int PKCS5_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
|
||
|
|
\& ASN1_TYPE *param, const EVP_CIPHER *cipher,
|
||
|
|
\& const EVP_MD *md, int en_de);
|
||
|
|
\& int PKCS5_PBE_keyivgen_ex(EVP_CIPHER_CTX *cctx, const char *pass, int passlen,
|
||
|
|
\& ASN1_TYPE *param, const EVP_CIPHER *cipher,
|
||
|
|
\& const EVP_MD *md, int en_de, OSSL_LIB_CTX *libctx,
|
||
|
|
\& const char *propq);
|
||
|
|
\& int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
|
||
|
|
\& ASN1_TYPE *param, const EVP_CIPHER *cipher,
|
||
|
|
\& const EVP_MD *md, int en_de);
|
||
|
|
\& int PKCS5_v2_PBE_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
|
||
|
|
\& ASN1_TYPE *param, const EVP_CIPHER *cipher,
|
||
|
|
\& const EVP_MD *md, int en_de,
|
||
|
|
\& OSSL_LIB_CTX *libctx, const char *propq);
|
||
|
|
\& int EVP_PBE_scrypt(const char *pass, size_t passlen,
|
||
|
|
\& const unsigned char *salt, size_t saltlen,
|
||
|
|
\& uint64_t N, uint64_t r, uint64_t p, uint64_t maxmem,
|
||
|
|
\& unsigned char *key, size_t keylen);
|
||
|
|
\& int EVP_PBE_scrypt_ex(const char *pass, size_t passlen,
|
||
|
|
\& const unsigned char *salt, size_t saltlen,
|
||
|
|
\& uint64_t N, uint64_t r, uint64_t p, uint64_t maxmem,
|
||
|
|
\& unsigned char *key, size_t keylen,
|
||
|
|
\& OSSL_LIB_CTX *ctx, const char *propq);
|
||
|
|
\& int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
|
||
|
|
\& int passlen, ASN1_TYPE *param,
|
||
|
|
\& const EVP_CIPHER *c, const EVP_MD *md, int en_de);
|
||
|
|
\& int PKCS5_v2_scrypt_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass,
|
||
|
|
\& int passlen, ASN1_TYPE *param,
|
||
|
|
\& const EVP_CIPHER *c, const EVP_MD *md, int en_de,
|
||
|
|
\& OSSL_LIB_CTX *libctx, const char *propq);
|
||
|
|
\&
|
||
|
|
\& #include <openssl/x509.h>
|
||
|
|
\&
|
||
|
|
\& int PKCS5_pbe_set0_algor(X509_ALGOR *algor, int alg, int iter,
|
||
|
|
\& const unsigned char *salt, int saltlen);
|
||
|
|
\& int PKCS5_pbe_set0_algor_ex(X509_ALGOR *algor, int alg, int iter,
|
||
|
|
\& const unsigned char *salt, int saltlen,
|
||
|
|
\& OSSL_LIB_CTX *libctx);
|
||
|
|
\&
|
||
|
|
\& X509_ALGOR *PKCS5_pbe_set(int alg, int iter,
|
||
|
|
\& const unsigned char *salt, int saltlen);
|
||
|
|
\& X509_ALGOR *PKCS5_pbe_set_ex(int alg, int iter,
|
||
|
|
\& const unsigned char *salt, int saltlen,
|
||
|
|
\& OSSL_LIB_CTX *libctx);
|
||
|
|
\&
|
||
|
|
\& X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
|
||
|
|
\& unsigned char *salt, int saltlen);
|
||
|
|
\& X509_ALGOR *PKCS5_pbe2_set_iv(const EVP_CIPHER *cipher, int iter,
|
||
|
|
\& unsigned char *salt, int saltlen,
|
||
|
|
\& unsigned char *aiv, int prf_nid);
|
||
|
|
\& X509_ALGOR *PKCS5_pbe2_set_iv_ex(const EVP_CIPHER *cipher, int iter,
|
||
|
|
\& unsigned char *salt, int saltlen,
|
||
|
|
\& unsigned char *aiv, int prf_nid,
|
||
|
|
\& OSSL_LIB_CTX *libctx);
|
||
|
|
\& X509_ALGOR *PKCS5_pbe2_set_scrypt(const EVP_CIPHER *cipher,
|
||
|
|
\& const unsigned char *salt, int saltlen,
|
||
|
|
\& unsigned char *aiv, uint64_t N, uint64_t r,
|
||
|
|
\& uint64_t p);
|
||
|
|
\&
|
||
|
|
\& X509_ALGOR *PKCS5_pbkdf2_set(int iter, unsigned char *salt, int saltlen,
|
||
|
|
\& int prf_nid, int keylen);
|
||
|
|
\& X509_ALGOR *PKCS5_pbkdf2_set_ex(int iter, unsigned char *salt, int saltlen,
|
||
|
|
\& int prf_nid, int keylen,
|
||
|
|
\& OSSL_LIB_CTX *libctx);
|
||
|
|
.Ve
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
.SS "Key Derivation"
|
||
|
|
.IX Subsection "Key Derivation"
|
||
|
|
\&\fIPKCS5_PBE_keyivgen()\fR and \fIPKCS5_PBE_keyivgen_ex()\fR take a password \fIpass\fR of
|
||
|
|
length \fIpasslen\fR, parameters \fIparam\fR and a message digest function \fImd_type\fR
|
||
|
|
and performs a key derivation according to PKCS#5 \s-1PBES1.\s0 The resulting key is
|
||
|
|
then used to initialise the cipher context \fIctx\fR with a cipher \fIcipher\fR for
|
||
|
|
encryption (\fIen_de\fR=1) or decryption (\fIen_de\fR=0).
|
||
|
|
.PP
|
||
|
|
\&\fIpass\fR is an optional parameter and can be \s-1NULL.\s0 If \fIpasslen\fR is \-1, then the
|
||
|
|
function will calculate the length of \fIpass\fR using \fIstrlen()\fR.
|
||
|
|
.PP
|
||
|
|
\&\fIPKCS5_v2_PBE_keyivgen()\fR and \fIPKCS5_v2_PBE_keyivgen_ex()\fR are similar to the above
|
||
|
|
but instead use PKCS#5 \s-1PBES2\s0 as the encryption algorithm using the supplied
|
||
|
|
parameters.
|
||
|
|
.PP
|
||
|
|
\&\fIPKCS5_v2_scrypt_keyivgen()\fR and \fIPKCS5_v2_scrypt_keyivgen_ex()\fR use \s-1SCRYPT\s0 as the
|
||
|
|
key derivation part of the encryption algorithm.
|
||
|
|
.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
|
||
|
|
attempt to calculate the length of the \fIsalt\fR because it is not assumed to
|
||
|
|
be \s-1NULL\s0 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
|
||
|
|
\&\fIiter\fR less than 1 is treated as a single iteration.
|
||
|
|
.PP
|
||
|
|
\&\fIdigest\fR is the message digest function used in the derivation.
|
||
|
|
.PP
|
||
|
|
Functions ending in \fI_ex()\fR take optional parameters \fIlibctx\fR and \fIpropq\fR which
|
||
|
|
are used to select appropriate algorithm implementations.
|
||
|
|
.SS "Algorithm Identifier Creation"
|
||
|
|
.IX Subsection "Algorithm Identifier Creation"
|
||
|
|
\&\fIPKCS5_pbe_set()\fR, \fIPKCS5_pbe_set_ex()\fR, \fIPKCS5_pbe2_set()\fR, \fIPKCS5_pbe2_set_iv()\fR,
|
||
|
|
\&\fIPKCS5_pbe2_set_iv_ex()\fR and \fIPKCS5_pbe2_set_scrypt()\fR generate an \fBX509_ALGOR\fR
|
||
|
|
object which represents an AlgorithmIdentifier containing the algorithm \s-1OID\s0 and
|
||
|
|
associated parameters for the \s-1PBE\s0 algorithm.
|
||
|
|
.PP
|
||
|
|
\&\fIPKCS5_pbkdf2_set()\fR and \fIPKCS5_pbkdf2_set_ex()\fR generate an \fBX509_ALGOR\fR
|
||
|
|
object which represents an AlgorithmIdentifier containing the algorithm \s-1OID\s0 and
|
||
|
|
associated parameters for the \s-1PBKDF2\s0 algorithm.
|
||
|
|
.PP
|
||
|
|
\&\fIPKCS5_pbe_set0_algor()\fR and \fIPKCS5_pbe_set0_algor_ex()\fR set the \s-1PBE\s0 algorithm \s-1OID\s0 and
|
||
|
|
parameters into the supplied \fBX509_ALGOR\fR.
|
||
|
|
.PP
|
||
|
|
If \fIsalt\fR is \s-1NULL,\s0 then \fIsaltlen\fR specifies the size in bytes of the random salt to
|
||
|
|
generate. If \fIsaltlen\fR is 0 then a default size is used.
|
||
|
|
For \s-1PBE\s0 related functions such as \fIPKCS5_pbe_set_ex()\fR the default salt length is 8 bytes.
|
||
|
|
For \s-1PBE2\s0 related functions that use \s-1PBKDF2\s0 such as \fIPKCS5_pbkdf2_set()\fR,
|
||
|
|
\&\fIPKCS5_pbe2_set_scrypt()\fR and \fIPKCS5_pbe2_set()\fR the default salt length is 16 bytes.
|
||
|
|
.SH "NOTES"
|
||
|
|
.IX Header "NOTES"
|
||
|
|
The *\fI_keyivgen()\fR functions are typically used in PKCS#12 to encrypt objects.
|
||
|
|
.PP
|
||
|
|
These functions make no assumption regarding the given password.
|
||
|
|
It will simply be treated as a byte sequence.
|
||
|
|
.SH "RETURN VALUES"
|
||
|
|
.IX Header "RETURN VALUES"
|
||
|
|
\&\fIPKCS5_PBE_keyivgen()\fR, \fIPKCS5_v2_PBE_keyivgen()\fR,
|
||
|
|
\&\fIPKCS5_v2_PBE_keyivgen_ex()\fR, \fIPKCS5_v2_scrypt_keyivgen()\fR,
|
||
|
|
\&\fIPKCS5_v2_scrypt_keyivgen_ex()\fR, \fIPKCS5_pbe_set0_algor()\fR and
|
||
|
|
\&\fIPKCS5_pbe_set0_algor_ex()\fR return 1 for success and 0 if an error occurs.
|
||
|
|
.PP
|
||
|
|
\&\fIPKCS5_pbe_set()\fR, \fIPKCS5_pbe_set_ex()\fR, \fIPKCS5_pbe2_set()\fR, \fIPKCS5_pbe2_set_iv()\fR,
|
||
|
|
\&\fIPKCS5_pbe2_set_iv_ex()\fR, \fIPKCS5_pbe2_set_scrypt()\fR,
|
||
|
|
\&\fIPKCS5_pbkdf2_set()\fR and \fIPKCS5_pbkdf2_set_ex()\fR return an \fBX509_ALGOR\fR object or
|
||
|
|
\&\s-1NULL\s0 if an error occurs.
|
||
|
|
.SH "CONFORMING TO"
|
||
|
|
.IX Header "CONFORMING TO"
|
||
|
|
\&\s-1IETF RFC 8018 \s0(<https://tools.ietf.org/html/rfc8018>)
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
\&\fIEVP_PBE_CipherInit_ex\fR\|(3),
|
||
|
|
\&\fIPKCS12_pbe_crypt_ex\fR\|(3),
|
||
|
|
\&\fIpassphrase\-encoding\fR\|(7)
|
||
|
|
.SH "HISTORY"
|
||
|
|
.IX Header "HISTORY"
|
||
|
|
\&\fIPKCS5_v2_PBE_keyivgen_ex()\fR, \fIEVP_PBE_scrypt_ex()\fR, \fIPKCS5_v2_scrypt_keyivgen_ex()\fR,
|
||
|
|
\&\fIPKCS5_pbe_set0_algor_ex()\fR, \fIPKCS5_pbe_set_ex()\fR, \fIPKCS5_pbe2_set_iv_ex()\fR and
|
||
|
|
\&\fIPKCS5_pbkdf2_set_ex()\fR were added in OpenSSL 3.0.
|
||
|
|
.PP
|
||
|
|
From OpenSSL 3.0 the \s-1PBKDF1\s0 algorithm used in \fIPKCS5_PBE_keyivgen()\fR and
|
||
|
|
\&\fIPKCS5_PBE_keyivgen_ex()\fR has been moved to the legacy provider as an \s-1EVP_KDF.\s0
|
||
|
|
.PP
|
||
|
|
In OpenSSL 3.2 the default salt length changed from 8 bytes to 16 bytes for \s-1PBE2\s0
|
||
|
|
related functions such as \fIPKCS5_pbe2_set()\fR.
|
||
|
|
This is required for \s-1PBKDF2 FIPS\s0 compliance.
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2021\-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>.
|