CryptoPkg/BaseCryptLib: Retire the TDES algorithm

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1898

TDES is not secure any longer.
Remove the Tdes support from edk2.
Change the Tdes field name in EDKII_CRYPTO_PROTOCOL to indicate the
function is unsupported any longer.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Xiaoyu Lu <xiaoyux.lu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>

1 files changed, 15 insertions, 154 deletions

diff --git a/CryptoPkg/Private/Protocol/Crypto.h b/CryptoPkg/Private/Protocol/Crypto.h
index f36c5c1aff..a30660c192 100644
--- a/CryptoPkg/Private/Protocol/Crypto.h
+++ b/CryptoPkg/Private/Protocol/Crypto.h
@@ -2396,155 +2396,45 @@ BOOLEAN
 //=====================================================================================

 

 /**

-  Retrieves the size, in bytes, of the context buffer required for TDES operations.

-

-  If this interface is not supported, then return zero.

-

-  @return  The size, in bytes, of the context buffer required for TDES operations.

-  @retval  0   This interface is not supported.

+  TDES is deprecated and unsupported any longer.

+  Keep the function field for binary compability.

 

 **/

 typedef

 UINTN

-(EFIAPI *EDKII_CRYPTO_TDES_GET_CONTEXT_SIZE) (

+(EFIAPI *DEPRECATED_EDKII_CRYPTO_TDES_GET_CONTEXT_SIZE) (

   VOID

   );

 

-/**

-  Initializes user-supplied memory as TDES context for subsequent use.

-

-  This function initializes user-supplied memory pointed by TdesContext as TDES context.

-  In addition, it sets up all TDES key materials for subsequent encryption and decryption

-  operations.

-  There are 3 key options as follows:

-  KeyLength = 64,  Keying option 1: K1 == K2 == K3 (Backward compatibility with DES)

-  KeyLength = 128, Keying option 2: K1 != K2 and K3 = K1 (Less Security)

-  KeyLength = 192  Keying option 3: K1 != K2 != K3 (Strongest)

-

-  If TdesContext is NULL, then return FALSE.

-  If Key is NULL, then return FALSE.

-  If KeyLength is not valid, then return FALSE.

-  If this interface is not supported, then return FALSE.

-

-  @param[out]  TdesContext  Pointer to TDES context being initialized.

-  @param[in]   Key          Pointer to the user-supplied TDES key.

-  @param[in]   KeyLength    Length of TDES key in bits.

-

-  @retval TRUE   TDES context initialization succeeded.

-  @retval FALSE  TDES context initialization failed.

-  @retval FALSE  This interface is not supported.

-

-**/

 typedef

 BOOLEAN

-(EFIAPI *EDKII_CRYPTO_TDES_INIT) (

+(EFIAPI *DEPRECATED_EDKII_CRYPTO_TDES_INIT) (

   OUT  VOID         *TdesContext,

   IN   CONST UINT8  *Key,

   IN   UINTN        KeyLength

   );

 

-/**

-  Performs TDES encryption on a data buffer of the specified size in ECB mode.

-

-  This function performs TDES encryption on data buffer pointed by Input, of specified

-  size of InputSize, in ECB mode.

-  InputSize must be multiple of block size (8 bytes). This function does not perform

-  padding. Caller must perform padding, if necessary, to ensure valid input data size.

-  TdesContext should be already correctly initialized by TdesInit(). Behavior with

-  invalid TDES context is undefined.

-

-  If TdesContext is NULL, then return FALSE.

-  If Input is NULL, then return FALSE.

-  If InputSize is not multiple of block size (8 bytes), then return FALSE.

-  If Output is NULL, then return FALSE.

-  If this interface is not supported, then return FALSE.

-

-  @param[in]   TdesContext  Pointer to the TDES context.

-  @param[in]   Input        Pointer to the buffer containing the data to be encrypted.

-  @param[in]   InputSize    Size of the Input buffer in bytes.

-  @param[out]  Output       Pointer to a buffer that receives the TDES encryption output.

-

-  @retval TRUE   TDES encryption succeeded.

-  @retval FALSE  TDES encryption failed.

-  @retval FALSE  This interface is not supported.

-

-**/

 typedef

 BOOLEAN

-(EFIAPI *EDKII_CRYPTO_TDES_ECB_ENCRYPT) (

+(EFIAPI *DEPRECATED_EDKII_CRYPTO_TDES_ECB_ENCRYPT) (

   IN   VOID         *TdesContext,

   IN   CONST UINT8  *Input,

   IN   UINTN        InputSize,

   OUT  UINT8        *Output

   );

 

-/**

-  Performs TDES decryption on a data buffer of the specified size in ECB mode.

-

-  This function performs TDES decryption on data buffer pointed by Input, of specified

-  size of InputSize, in ECB mode.

-  InputSize must be multiple of block size (8 bytes). This function does not perform

-  padding. Caller must perform padding, if necessary, to ensure valid input data size.

-  TdesContext should be already correctly initialized by TdesInit(). Behavior with

-  invalid TDES context is undefined.

-

-  If TdesContext is NULL, then return FALSE.

-  If Input is NULL, then return FALSE.

-  If InputSize is not multiple of block size (8 bytes), then return FALSE.

-  If Output is NULL, then return FALSE.

-  If this interface is not supported, then return FALSE.

-

-  @param[in]   TdesContext  Pointer to the TDES context.

-  @param[in]   Input        Pointer to the buffer containing the data to be decrypted.

-  @param[in]   InputSize    Size of the Input buffer in bytes.

-  @param[out]  Output       Pointer to a buffer that receives the TDES decryption output.

-

-  @retval TRUE   TDES decryption succeeded.

-  @retval FALSE  TDES decryption failed.

-  @retval FALSE  This interface is not supported.

-

-**/

 typedef

 BOOLEAN

-(EFIAPI *EDKII_CRYPTO_TDES_ECB_DECRYPT) (

+(EFIAPI *DEPRECATED_EDKII_CRYPTO_TDES_ECB_DECRYPT) (

   IN   VOID         *TdesContext,

   IN   CONST UINT8  *Input,

   IN   UINTN        InputSize,

   OUT  UINT8        *Output

   );

 

-/**

-  Performs TDES encryption on a data buffer of the specified size in CBC mode.

-

-  This function performs TDES encryption on data buffer pointed by Input, of specified

-  size of InputSize, in CBC mode.

-  InputSize must be multiple of block size (8 bytes). This function does not perform

-  padding. Caller must perform padding, if necessary, to ensure valid input data size.

-  Initialization vector should be one block size (8 bytes).

-  TdesContext should be already correctly initialized by TdesInit(). Behavior with

-  invalid TDES context is undefined.

-

-  If TdesContext is NULL, then return FALSE.

-  If Input is NULL, then return FALSE.

-  If InputSize is not multiple of block size (8 bytes), then return FALSE.

-  If Ivec is NULL, then return FALSE.

-  If Output is NULL, then return FALSE.

-  If this interface is not supported, then return FALSE.

-

-  @param[in]   TdesContext  Pointer to the TDES context.

-  @param[in]   Input        Pointer to the buffer containing the data to be encrypted.

-  @param[in]   InputSize    Size of the Input buffer in bytes.

-  @param[in]   Ivec         Pointer to initialization vector.

-  @param[out]  Output       Pointer to a buffer that receives the TDES encryption output.

-

-  @retval TRUE   TDES encryption succeeded.

-  @retval FALSE  TDES encryption failed.

-  @retval FALSE  This interface is not supported.

-

-**/

 typedef

 BOOLEAN

-(EFIAPI *EDKII_CRYPTO_TDES_CBC_ENCRYPT) (

+(EFIAPI *DEPRECATED_EDKII_CRYPTO_TDES_CBC_ENCRYPT) (

   IN   VOID         *TdesContext,

   IN   CONST UINT8  *Input,

   IN   UINTN        InputSize,

@@ -2552,38 +2442,9 @@ BOOLEAN
   OUT  UINT8        *Output

   );

 

-/**

-  Performs TDES decryption on a data buffer of the specified size in CBC mode.

-

-  This function performs TDES decryption on data buffer pointed by Input, of specified

-  size of InputSize, in CBC mode.

-  InputSize must be multiple of block size (8 bytes). This function does not perform

-  padding. Caller must perform padding, if necessary, to ensure valid input data size.

-  Initialization vector should be one block size (8 bytes).

-  TdesContext should be already correctly initialized by TdesInit(). Behavior with

-  invalid TDES context is undefined.

-

-  If TdesContext is NULL, then return FALSE.

-  If Input is NULL, then return FALSE.

-  If InputSize is not multiple of block size (8 bytes), then return FALSE.

-  If Ivec is NULL, then return FALSE.

-  If Output is NULL, then return FALSE.

-  If this interface is not supported, then return FALSE.

-

-  @param[in]   TdesContext  Pointer to the TDES context.

-  @param[in]   Input        Pointer to the buffer containing the data to be encrypted.

-  @param[in]   InputSize    Size of the Input buffer in bytes.

-  @param[in]   Ivec         Pointer to initialization vector.

-  @param[out]  Output       Pointer to a buffer that receives the TDES encryption output.

-

-  @retval TRUE   TDES decryption succeeded.

-  @retval FALSE  TDES decryption failed.

-  @retval FALSE  This interface is not supported.

-

-**/

 typedef

 BOOLEAN

-(EFIAPI *EDKII_CRYPTO_TDES_CBC_DECRYPT) (

+(EFIAPI *DEPRECATED_EDKII_CRYPTO_TDES_CBC_DECRYPT) (

   IN   VOID         *TdesContext,

   IN   CONST UINT8  *Input,

   IN   UINTN        InputSize,

@@ -3911,13 +3772,13 @@ struct _EDKII_CRYPTO_PROTOCOL {
   EDKII_CRYPTO_X509_FREE                          X509Free;

   EDKII_CRYPTO_X509_STACK_FREE                    X509StackFree;

   EDKII_CRYPTO_X509_GET_TBS_CERT                  X509GetTBSCert;

-  /// TDES

-  EDKII_CRYPTO_TDES_GET_CONTEXT_SIZE              TdesGetContextSize;

-  EDKII_CRYPTO_TDES_INIT                          TdesInit;

-  EDKII_CRYPTO_TDES_ECB_ENCRYPT                   TdesEcbEncrypt;

-  EDKII_CRYPTO_TDES_ECB_DECRYPT                   TdesEcbDecrypt;

-  EDKII_CRYPTO_TDES_CBC_ENCRYPT                   TdesCbcEncrypt;

-  EDKII_CRYPTO_TDES_CBC_DECRYPT                   TdesCbcDecrypt;

+  /// TDES - deprecated and unsupported

+  DEPRECATED_EDKII_CRYPTO_TDES_GET_CONTEXT_SIZE   DeprecatedTdesGetContextSize;

+  DEPRECATED_EDKII_CRYPTO_TDES_INIT               DeprecatedTdesInit;

+  DEPRECATED_EDKII_CRYPTO_TDES_ECB_ENCRYPT        DeprecatedTdesEcbEncrypt;

+  DEPRECATED_EDKII_CRYPTO_TDES_ECB_DECRYPT        DeprecatedTdesEcbDecrypt;

+  DEPRECATED_EDKII_CRYPTO_TDES_CBC_ENCRYPT        DeprecatedTdesCbcEncrypt;

+  DEPRECATED_EDKII_CRYPTO_TDES_CBC_DECRYPT        DeprecatedTdesCbcDecrypt;

   /// AES

   EDKII_CRYPTO_AES_GET_CONTEXT_SIZE               AesGetContextSize;

   EDKII_CRYPTO_AES_INIT                           AesInit;