Symbols

Files

Summary Syntax Arguments Related References

SourceVuRaspberry Pi Pico SDK and Examplesmbed TLS Librarymbedtls_pkcs5_pbes2()

mbedtls_pkcs5_pbes2() function

PKCS#5 PBES2 function \warning When decrypting: - if #MBEDTLS_CIPHER_PADDING_PKCS7 is enabled at compile time, this function validates the CBC padding and returns #MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH if the padding is invalid. Note that this can help active adversaries attempting to brute-forcing the password. Note also that there is no guarantee that an invalid password will be detected (the chances of a valid padding with a random password are about 1/255). - if #MBEDTLS_CIPHER_PADDING_PKCS7 is disabled at compile time, this function does not validate the CBC padding.

Syntax

Show:

Summary

Declaration

Definition

from pkcs5.h:81

int mbedtls_pkcs5_pbes2(const mbedtls_asn1_buf *pbe_params, int mode, const unsigned char *pwd, size_t pwdlen, const unsigned char *data, size_t datalen, unsigned char *output);

Implemented in pkcs5.c:109

Arguments

Argument

Description

pbe_params

the ASN.1 algorithm parameters

mode

either #MBEDTLS_PKCS5_DECRYPT or #MBEDTLS_PKCS5_ENCRYPT

pwd

password to use when generating key

pwdlen

length of password

data

data to process

datalen

length of data

output

Output buffer. On success, it contains the encrypted or decrypted data, possibly followed by the CBC padding. On failure, the content is indeterminate. For decryption, there must be enough room for \p datalen bytes. For encryption, there must be enough room for \p datalen + 1 bytes, rounded up to the block size of the block cipher identified by \p pbe_params.

Return value

0 on success, or a MBEDTLS_ERR_XXX code if verification fails.

Notes

When encrypting, #MBEDTLS_CIPHER_PADDING_PKCS7 must be enabled at compile time.

Examples

References

from examples

mbedtls_pkcs5_pbes2() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle

mbedtls_pkcs5_pbes2() function

Syntax

Arguments

Return value

Notes

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle