SecurityPkg/RandomNumberGenerator/RngDxe/RdRand.c File Reference


Defines

#define RDRAND_MASK   0x40000000

Functions

EFI_STATUS EFIAPI IsRdRandSupported (VOID)
EFI_STATUS EFIAPI RdRand16 (OUT UINT16 *Rand, IN BOOLEAN NeedRetry)
EFI_STATUS EFIAPI RdRand32 (OUT UINT32 *Rand, IN BOOLEAN NeedRetry)
EFI_STATUS EFIAPI RdRand64 (OUT UINT64 *Rand, IN BOOLEAN NeedRetry)
EFI_STATUS EFIAPI RdRandGetBytes (IN UINTN Length, OUT UINT8 *RandBuffer)
EFI_STATUS EFIAPI RdRandGetSeed128 (OUT UINT8 *SeedBuffer)
EFI_STATUS EFIAPI RdRandGenerateEntropy (IN UINTN Length, OUT UINT8 *Entropy)

Detailed Description

Support routines for RDRAND instruction access.

Copyright (c) 2013, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define RDRAND_MASK   0x40000000

Referenced by IsRdRandSupported().


Function Documentation

EFI_STATUS EFIAPI IsRdRandSupported ( VOID   ) 

Determines whether or not RDRAND instruction is supported by the host hardware.

Return values:
EFI_SUCCESS RDRAND instruction supported.
EFI_UNSUPPORTED RDRAND instruction not supported.

References BOOLEAN(), EFI_STATUS(), RDRAND_MASK, and TRUE.

Referenced by RngDriverEntry().

EFI_STATUS EFIAPI RdRand16 ( OUT UINT16 *  Rand,
IN BOOLEAN  NeedRetry 
)

Calls RDRAND to obtain a 16-bit random number.

Parameters:
[out] Rand Buffer pointer to store the random result.
[in] NeedRetry Determine whether or not to loop retry.
Return values:
EFI_SUCCESS RDRAND call was successful.
EFI_NOT_READY Failed attempts to call RDRAND.

References RdRand16Step(), and RETRY_LIMIT.

EFI_STATUS EFIAPI RdRand32 ( OUT UINT32 *  Rand,
IN BOOLEAN  NeedRetry 
)

Calls RDRAND to obtain a 32-bit random number.

Parameters:
[out] Rand Buffer pointer to store the random result.
[in] NeedRetry Determine whether or not to loop retry.
Return values:
EFI_SUCCESS RDRAND call was successful.
EFI_NOT_READY Failed attempts to call RDRAND.

References RdRand32Step(), and RETRY_LIMIT.

Referenced by RdRandGetWords(), and RdRandWord().

EFI_STATUS EFIAPI RdRand64 ( OUT UINT64 *  Rand,
IN BOOLEAN  NeedRetry 
)

Calls RDRAND to obtain a 64-bit random number.

Parameters:
[out] Rand Buffer pointer to store the random result.
[in] NeedRetry Determine whether or not to loop retry.
Return values:
EFI_SUCCESS RDRAND call was successful.
EFI_NOT_READY Failed attempts to call RDRAND.

References RdRand64Step(), and RETRY_LIMIT.

Referenced by RdRandGetWords(), and RdRandWord().

EFI_STATUS EFIAPI RdRandGenerateEntropy ( IN UINTN  Length,
OUT UINT8 *  Entropy 
)

Generate high-quality entropy source through RDRAND.

Parameters:
[in] Length Size of the buffer, in bytes, to fill with.
[out] Entropy Pointer to the buffer to store the entropy data.
Return values:
EFI_SUCCESS Entropy generation succeeded.
EFI_NOT_READY Failed to request random data.

References EFI_STATUS(), RdRandGetSeed128(), and UINTN().

Referenced by RngGetRNG().

EFI_STATUS EFIAPI RdRandGetBytes ( IN UINTN  Length,
OUT UINT8 *  RandBuffer 
)

Calls RDRAND to fill a buffer of arbitrary size with random bytes.

Parameters:
[in] Length Size of the buffer, in bytes, to fill with.
[out] RandBuffer Pointer to the buffer to store the random result.
Return values:
EFI_SUCCESS Random bytes generation succeeded.
EFI_NOT_READY Failed to request random bytes.

References EFI_STATUS(), RdRandGetWords(), RdRandWord(), TRUE, and UINTN().

Referenced by RdRandGetSeed128(), and RngGetRNG().

EFI_STATUS EFIAPI RdRandGetSeed128 ( OUT UINT8 *  SeedBuffer  ) 

Creates a 128bit random value that is fully forward and backward prediction resistant, suitable for seeding a NIST SP800-90 Compliant, FIPS 1402-2 certifiable SW DRBG. This function takes multiple random numbers through RDRAND without intervening delays to ensure reseeding and performs AES-CBC-MAC over the data to compute the seed value.

Parameters:
[out] SeedBuffer Pointer to a 128bit buffer to store the random seed.
Return values:
EFI_SUCCESS Random seed generation succeeded.
EFI_NOT_READY Failed to request random bytes.

References AesEncrypt(), EFI_STATUS(), and RdRandGetBytes().

Referenced by RdRandGenerateEntropy().


Generated on Thu Sep 24 23:44:24 2015 for SecurityPkg[ALL] by  doxygen 1.5.7.1