CryptoPkg: Add BigNum API to DXE and protocol
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3828 The implementation provides CryptBn library functions for EFI Driver and EFI BaseCrypt Protocol. Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Xiaoyu Lu <xiaoyu1.lu@intel.com> Cc: Guomin Jiang <guomin.jiang@intel.com> Signed-off-by: Yi Li <yi1.li@intel.com> Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
This commit is contained in:
Yi Li
mergify[bot]
@@ -4061,3 +4061,495 @@ TlsGetCertRevocationList (
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (TlsGetCertRevocationList, (Data, DataSize), EFI_UNSUPPORTED);
|
||||
}
|
||||
|
||||
// =====================================================================================
|
||||
// Big number primitive
|
||||
// =====================================================================================
|
||||
|
||||
/**
|
||||
Allocate new Big Number.
|
||||
|
||||
@retval New BigNum opaque structure or NULL on failure.
|
||||
**/
|
||||
VOID *
|
||||
EFIAPI
|
||||
BigNumInit (
|
||||
VOID
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumInit, (), NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
Allocate new Big Number and assign the provided value to it.
|
||||
|
||||
@param[in] Buf Big endian encoded buffer.
|
||||
@param[in] Len Buffer length.
|
||||
|
||||
@retval New BigNum opaque structure or NULL on failure.
|
||||
**/
|
||||
VOID *
|
||||
EFIAPI
|
||||
BigNumFromBin (
|
||||
IN CONST UINT8 *Buf,
|
||||
IN UINTN Len
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumFromBin, (Buf, Len), NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
Convert the absolute value of Bn into big-endian form and store it at Buf.
|
||||
The Buf array should have at least BigNumBytes() in it.
|
||||
|
||||
@param[in] Bn Big number to convert.
|
||||
@param[out] Buf Output buffer.
|
||||
|
||||
@retval The length of the big-endian number placed at Buf or -1 on error.
|
||||
**/
|
||||
INTN
|
||||
EFIAPI
|
||||
BigNumToBin (
|
||||
IN CONST VOID *Bn,
|
||||
OUT UINT8 *Buf
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumToBin, (Bn, Buf), -1);
|
||||
}
|
||||
|
||||
/**
|
||||
Free the Big Number.
|
||||
|
||||
@param[in] Bn Big number to free.
|
||||
@param[in] Clear TRUE if the buffer should be cleared.
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
BigNumFree (
|
||||
IN VOID *Bn,
|
||||
IN BOOLEAN Clear
|
||||
)
|
||||
{
|
||||
CALL_VOID_CRYPTO_SERVICE (BigNumFree, (Bn, Clear));
|
||||
}
|
||||
|
||||
/**
|
||||
Calculate the sum of two Big Numbers.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnB Big number.
|
||||
@param[out] BnRes The result of BnA + BnB.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumAdd (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnB,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumAdd, (BnA, BnB, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Subtract two Big Numbers.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnB Big number.
|
||||
@param[out] BnRes The result of BnA - BnB.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumSub (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnB,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumSub, (BnA, BnB, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Calculate remainder: BnRes = BnA % BnB
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnB Big number.
|
||||
@param[out] BnRes The result of BnA % BnB.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumMod (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnB,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumMod, (BnA, BnB, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Compute BnA to the BnP-th power modulo BnM.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnP Big number (power).
|
||||
@param[in] BnM Big number (modulo).
|
||||
@param[out] BnRes The result of (BnA ^ BnP) % BnM.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumExpMod (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnP,
|
||||
IN CONST VOID *BnM,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumExpMod, (BnA, BnP, BnM, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Compute BnA inverse modulo BnM.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnM Big number (modulo).
|
||||
@param[out] BnRes The result, such that (BnA * BnRes) % BnM == 1.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumInverseMod (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnM,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumInverseMod, (BnA, BnM, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Divide two Big Numbers.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnB Big number.
|
||||
@param[out] BnRes The result, such that BnA / BnB.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumDiv (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnB,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumDiv, (BnA, BnB, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Multiply two Big Numbers modulo BnM.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnB Big number.
|
||||
@param[in] BnM Big number (modulo).
|
||||
@param[out] BnRes The result, such that (BnA * BnB) % BnM.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumMulMod (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnB,
|
||||
IN CONST VOID *BnM,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumMulMod, (BnA, BnB, BnM, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Compare two Big Numbers.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnB Big number.
|
||||
|
||||
@retval 0 BnA == BnB.
|
||||
@retval 1 BnA > BnB.
|
||||
@retval -1 BnA < BnB.
|
||||
**/
|
||||
INTN
|
||||
EFIAPI
|
||||
BigNumCmp (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnB
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumCmp, (BnA, BnB), 0);
|
||||
}
|
||||
|
||||
/**
|
||||
Get number of bits in Bn.
|
||||
|
||||
@param[in] Bn Big number.
|
||||
|
||||
@retval Number of bits.
|
||||
**/
|
||||
UINTN
|
||||
EFIAPI
|
||||
BigNumBits (
|
||||
IN CONST VOID *Bn
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumBits, (Bn), 0);
|
||||
}
|
||||
|
||||
/**
|
||||
Get number of bytes in Bn.
|
||||
|
||||
@param[in] Bn Big number.
|
||||
|
||||
@retval Number of bytes.
|
||||
**/
|
||||
UINTN
|
||||
EFIAPI
|
||||
BigNumBytes (
|
||||
IN CONST VOID *Bn
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumBytes, (Bn), 0);
|
||||
}
|
||||
|
||||
/**
|
||||
Checks if Big Number equals to the given Num.
|
||||
|
||||
@param[in] Bn Big number.
|
||||
@param[in] Num Number.
|
||||
|
||||
@retval TRUE iff Bn == Num.
|
||||
@retval FALSE otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumIsWord (
|
||||
IN CONST VOID *Bn,
|
||||
IN UINTN Num
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumIsWord, (Bn, Num), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Checks if Big Number is odd.
|
||||
|
||||
@param[in] Bn Big number.
|
||||
|
||||
@retval TRUE Bn is odd (Bn % 2 == 1).
|
||||
@retval FALSE otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumIsOdd (
|
||||
IN CONST VOID *Bn
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumIsOdd, (Bn), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Copy Big number.
|
||||
|
||||
@param[out] BnDst Destination.
|
||||
@param[in] BnSrc Source.
|
||||
|
||||
@retval BnDst on success.
|
||||
@retval NULL otherwise.
|
||||
**/
|
||||
VOID *
|
||||
EFIAPI
|
||||
BigNumCopy (
|
||||
OUT VOID *BnDst,
|
||||
IN CONST VOID *BnSrc
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumCopy, (BnDst, BnSrc), NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
Get constant Big number with value of "1".
|
||||
This may be used to save expensive allocations.
|
||||
|
||||
@retval Big Number with value of 1.
|
||||
**/
|
||||
CONST VOID *
|
||||
EFIAPI
|
||||
BigNumValueOne (
|
||||
VOID
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumValueOne, (), NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
Shift right Big Number.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] Bn Big number.
|
||||
@param[in] N Number of bits to shift.
|
||||
@param[out] BnRes The result.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumRShift (
|
||||
IN CONST VOID *Bn,
|
||||
IN UINTN N,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumRShift, (Bn, N, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Mark Big Number for constant time computations.
|
||||
This function should be called before any constant time computations are
|
||||
performed on the given Big number.
|
||||
|
||||
@param[in] Bn Big number.
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
BigNumConstTime (
|
||||
IN VOID *Bn
|
||||
)
|
||||
{
|
||||
CALL_VOID_CRYPTO_SERVICE (BigNumConstTime, (Bn));
|
||||
}
|
||||
|
||||
/**
|
||||
Calculate square modulo.
|
||||
Please note, all "out" Big number arguments should be properly initialized
|
||||
by calling to BigNumInit() or BigNumFromBin() functions.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnM Big number (modulo).
|
||||
@param[out] BnRes The result, such that (BnA ^ 2) % BnM.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumSqrMod (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnM,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumSqrMod, (BnA, BnM, BnRes), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Create new Big Number computation context. This is an opaque structure
|
||||
which should be passed to any function that requires it. The BN context is
|
||||
needed to optimize calculations and expensive allocations.
|
||||
|
||||
@retval Big Number context struct or NULL on failure.
|
||||
**/
|
||||
VOID *
|
||||
EFIAPI
|
||||
BigNumNewContext (
|
||||
VOID
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumNewContext, (), NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
Free Big Number context that was allocated with BigNumNewContext().
|
||||
|
||||
@param[in] BnCtx Big number context to free.
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
BigNumContextFree (
|
||||
IN VOID *BnCtx
|
||||
)
|
||||
{
|
||||
CALL_VOID_CRYPTO_SERVICE (BigNumContextFree, (BnCtx));
|
||||
}
|
||||
|
||||
/**
|
||||
Set Big Number to a given value.
|
||||
|
||||
@param[in] Bn Big number to set.
|
||||
@param[in] Val Value to set.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumSetUint (
|
||||
IN VOID *Bn,
|
||||
IN UINTN Val
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumSetUint, (Bn, Val), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Add two Big Numbers modulo BnM.
|
||||
|
||||
@param[in] BnA Big number.
|
||||
@param[in] BnB Big number.
|
||||
@param[in] BnM Big number (modulo).
|
||||
@param[out] BnRes The result, such that (BnA + BnB) % BnM.
|
||||
|
||||
@retval TRUE On success.
|
||||
@retval FALSE Otherwise.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
BigNumAddMod (
|
||||
IN CONST VOID *BnA,
|
||||
IN CONST VOID *BnB,
|
||||
IN CONST VOID *BnM,
|
||||
OUT VOID *BnRes
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (BigNumAddMod, (BnA, BnB, BnM, BnRes), FALSE);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user