CryptPkcs5Pbkdf2.c File Reference

#include "InternalCryptLib.h"
#include <mbedtls/pkcs5.h>

Go to the source code of this file.

Functions
BOOLEAN EFIAPI	Pkcs5HashPassword (IN UINTN PasswordLength, IN CONST CHAR8 *Password, IN UINTN SaltLength, IN CONST UINT8 *Salt, IN UINTN IterationCount, IN UINTN DigestSize, IN UINTN KeyLength, OUT UINT8 *OutKey)

Detailed Description

PBKDF2 Key Derivation Function Wrapper Implementation over MbedTLS.

Copyright (c) 2024, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CryptPkcs5Pbkdf2.c.

Function Documentation

Pkcs5HashPassword()

BOOLEAN EFIAPI Pkcs5HashPassword	(	IN UINTN	PasswordLength,
		IN CONST CHAR8 *	Password,
		IN UINTN	SaltLength,
		IN CONST UINT8 *	Salt,
		IN UINTN	IterationCount,
		IN UINTN	DigestSize,
		IN UINTN	KeyLength,
		OUT UINT8 *	OutKey
	)

Derives a key from a password using a salt and iteration count, based on PKCS#5 v2.0 password based encryption key derivation function PBKDF2, as specified in RFC 2898.

If Password or Salt or OutKey is NULL, then return FALSE. If the hash algorithm could not be determined, then return FALSE.

Parameters

[in]	PasswordLength	Length of input password in bytes.
[in]	Password	Pointer to the array for the password.
[in]	SaltLength	Size of the Salt in bytes.
[in]	Salt	Pointer to the Salt.
[in]	IterationCount	Number of iterations to perform. Its value should be greater than or equal to 1.
[in]	DigestSize	Size of the message digest to be used (eg. SHA256_DIGEST_SIZE). NOTE: DigestSize will be used to determine the hash algorithm. Only SHA1_DIGEST_SIZE or SHA256_DIGEST_SIZE is supported.
[in]	KeyLength	Size of the derived key buffer in bytes.
[out]	OutKey	Pointer to the output derived key buffer.

Return values

TRUE	A key was derived successfully.
FALSE	One of the pointers was NULL or one of the sizes was too large.
FALSE	The hash algorithm could not be determined from the digest size.
FALSE	The key derivation operation failed.

Definition at line 39 of file CryptPkcs5Pbkdf2.c.