m5531_crypto_hash.c

Go to the documentation of this file.

/**
 * @file m5531_crypto_hash.c
 * @brief M5531 hash hardware accelerator
 *
 * @section License
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Copyright (C) 2010-2026 Oryx Embedded SARL. All rights reserved.
 *
 * This file is part of CycloneCRYPTO Open.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * @author Oryx Embedded SARL (www.oryx-embedded.com)
 * @version 2.6.4
 **/
 
//Switch to the appropriate trace level
#define TRACE_LEVEL CRYPTO_TRACE_LEVEL
 
//Dependencies
#include "NuMicro.h"
#include "core/crypto.h"
#include "hardware/m5531/m5531_crypto.h"
#include "hardware/m5531/m5531_crypto_hash.h"
#include "hash/hash_algorithms.h"
#include "xof/keccak.h"
#include "debug.h"
 
//Check crypto library configuration
#if (M5531_CRYPTO_HASH_SUPPORT == ENABLED)
 
 
/**
 * @brief Update hash value
 * @param[in] opmode Hash algorithm
 * @param[in] data Pointer to the input buffer
 * @param[in] length Length of the input buffer
 * @param[in,out] h Intermediate hash value
 * @param[in] hLen Length of the intermediate hash value, in words
 **/
 
void hashProcessData(uint32_t opmode, const uint8_t *data,
   size_t length, uint32_t *h, size_t hLen)
{
   uint_t i;
 
   //Acquire exclusive access to the CRYPTO module
   osAcquireMutex(&m5531CryptoMutex);
 
   //Reset CRYPTO controller
   SYS_ResetModule(SYS_CRYPTO0RST);
 
   //Select the relevant hash algorithm
   CRYPTO->HMAC_CTL = CRYPTO_HMAC_CTL_INSWAP_Msk | CRYPTO_HMAC_CTL_OUTSWAP_Msk |
      CRYPTO_HMAC_CTL_DMACSCAD_Msk | opmode;
 
   //SHA-1, SHA-224, SHA-256 or SM3 algorithm?
   if(opmode == CRYPTO_HMAC_CTL_OPMODE_SHA1 || opmode == CRYPTO_HMAC_CTL_OPMODE_SHA224 ||
      opmode == CRYPTO_HMAC_CTL_OPMODE_SHA256 || opmode == CRYPTO_HMAC_CTL_SM3EN_Msk)
   {
      //Restore initial hash value
      for(i = 0; i < hLen; i++)
      {
         CRYPTO->HMAC_FDBCK[2 * i] = h[i];
      }
   }
   else
   {
      //Restore initial hash value
      for(i = 0; i < hLen; i++)
      {
         CRYPTO->HMAC_FDBCK[i] = h[i];
      }
   }
 
   //Start SHA engine
   CRYPTO->HMAC_CTL |= CRYPTO_HMAC_CTL_START_Msk;
 
   //Process input data
   for(i = 0; i < length; i += 4)
   {
      //Wait for the DATINREQ bit to be set
      while((CRYPTO->HMAC_STS & CRYPTO_HMAC_STS_DATINREQ_Msk) == 0)
      {
      }
 
      //Write one word of data
      CRYPTO->HMAC_DATIN = __UNALIGNED_UINT32_READ(data + i);
   }
 
   //Wait for the processing to complete
   while((CRYPTO->HMAC_STS & CRYPTO_HMAC_STS_DATINREQ_Msk) == 0)
   {
   }
 
   //SHA-1, SHA-224, SHA-256 or SM3 algorithm?
   if(opmode == CRYPTO_HMAC_CTL_OPMODE_SHA1 || opmode == CRYPTO_HMAC_CTL_OPMODE_SHA224 ||
      opmode == CRYPTO_HMAC_CTL_OPMODE_SHA256 || opmode == CRYPTO_HMAC_CTL_SM3EN_Msk)
   {
      //Save intermediate hash value
      for(i = 0; i < hLen; i++)
      {
         h[i] = CRYPTO->HMAC_FDBCK[2 * i];
      }
   }
   else
   {
      //Save intermediate hash value
      for(i = 0; i < hLen; i++)
      {
         h[i] = CRYPTO->HMAC_FDBCK[i];
      }
   }
 
   //Stop SHA engine
   CRYPTO->HMAC_CTL |= CRYPTO_HMAC_CTL_STOP_Msk;
 
   //Release exclusive access to the CRYPTO module
   osReleaseMutex(&m5531CryptoMutex);
}
 
 
#if (SHA1_SUPPORT == ENABLED)
 
/**
 * @brief Update the SHA-1 context with a portion of the message being hashed
 * @param[in] context Pointer to the SHA-1 context
 * @param[in] data Pointer to the buffer being hashed
 * @param[in] length Length of the buffer
 **/
 
void sha1Update(Sha1Context *context, const void *data, size_t length)
{
   size_t n;
 
   //Process the incoming data
   while(length > 0)
   {
      //Check whether some data is pending in the buffer
      if(context->size == 0 && length >= 64)
      {
         //The length must be a multiple of 64 bytes
         n = length - (length % 64);
 
         //Update hash value
         hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA1, data, n, context->h,
            SHA1_DIGEST_SIZE / 4);
 
         //Update the SHA-1 context
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
      }
      else
      {
         //The buffer can hold at most 64 bytes
         n = MIN(length, 64 - context->size);
 
         //Copy the data to the buffer
         osMemcpy(context->buffer + context->size, data, n);
 
         //Update the SHA-1 context
         context->size += n;
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
 
         //Check whether the buffer is full
         if(context->size == 64)
         {
            //Update hash value
            hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA1, context->buffer,
               context->size, context->h, SHA1_DIGEST_SIZE / 4);
 
            //Empty the buffer
            context->size = 0;
         }
      }
   }
}
 
 
/**
 * @brief Process message in 16-word blocks
 * @param[in] context Pointer to the SHA-1 context
 **/
 
void sha1ProcessBlock(Sha1Context *context)
{
   //Update hash value
   hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA1, context->buffer, 64,
      context->h, SHA1_DIGEST_SIZE / 4);
}
 
#endif
#if (SHA256_SUPPORT == ENABLED)
 
/**
 * @brief Update the SHA-256 context with a portion of the message being hashed
 * @param[in] context Pointer to the SHA-256 context
 * @param[in] data Pointer to the buffer being hashed
 * @param[in] length Length of the buffer
 **/
 
void sha256Update(Sha256Context *context, const void *data, size_t length)
{
   size_t n;
 
   //Process the incoming data
   while(length > 0)
   {
      //Check whether some data is pending in the buffer
      if(context->size == 0 && length >= 64)
      {
         //The length must be a multiple of 64 bytes
         n = length - (length % 64);
 
         //Update hash value
         hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA256, data, n, context->h,
            SHA256_DIGEST_SIZE / 4);
 
         //Update the SHA-256 context
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
      }
      else
      {
         //The buffer can hold at most 64 bytes
         n = MIN(length, 64 - context->size);
 
         //Copy the data to the buffer
         osMemcpy(context->buffer + context->size, data, n);
 
         //Update the SHA-256 context
         context->size += n;
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
 
         //Check whether the buffer is full
         if(context->size == 64)
         {
            //Update hash value
            hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA256, context->buffer,
               context->size, context->h, SHA256_DIGEST_SIZE / 4);
 
            //Empty the buffer
            context->size = 0;
         }
      }
   }
}
 
 
/**
 * @brief Process message in 16-word blocks
 * @param[in] context Pointer to the SHA-256 context
 **/
 
void sha256ProcessBlock(Sha256Context *context)
{
   //Update hash value
   hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA256, context->buffer, 64,
      context->h, SHA256_DIGEST_SIZE / 4);
}
 
#endif
#if (SHA512_SUPPORT == ENABLED)
 
/**
 * @brief Update the SHA-512 context with a portion of the message being hashed
 * @param[in] context Pointer to the SHA-512 context
 * @param[in] data Pointer to the buffer being hashed
 * @param[in] length Length of the buffer
 **/
 
void sha512Update(Sha512Context *context, const void *data, size_t length)
{
   size_t n;
 
   //Process the incoming data
   while(length > 0)
   {
      //Check whether some data is pending in the buffer
      if(context->size == 0 && length >= 128)
      {
         //The length must be a multiple of 128 bytes
         n = length - (length % 128);
 
         //Update hash value
         hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA512, data, n,
            (uint32_t *) context->h, SHA512_DIGEST_SIZE / 4);
 
         //Update the SHA-512 context
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
      }
      else
      {
         //The buffer can hold at most 128 bytes
         n = MIN(length, 128 - context->size);
 
         //Copy the data to the buffer
         osMemcpy(context->buffer + context->size, data, n);
 
         //Update the SHA-512 context
         context->size += n;
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
 
         //Check whether the buffer is full
         if(context->size == 128)
         {
            //Update hash value
            hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA512, context->buffer,
               context->size, (uint32_t *) context->h, SHA512_DIGEST_SIZE / 4);
 
            //Empty the buffer
            context->size = 0;
         }
      }
   }
}
 
 
/**
 * @brief Process message in 16-word blocks
 * @param[in] context Pointer to the SHA-512 context
 **/
 
void sha512ProcessBlock(Sha512Context *context)
{
   //Update hash value
   hashProcessData(CRYPTO_HMAC_CTL_OPMODE_SHA512, context->buffer, 128,
      (uint32_t *) context->h, SHA512_DIGEST_SIZE / 4);
}
 
#endif
#if (SM3_SUPPORT == ENABLED)
 
/**
 * @brief Update the SM3 context with a portion of the message being hashed
 * @param[in] context Pointer to the SM3 context
 * @param[in] data Pointer to the buffer being hashed
 * @param[in] length Length of the buffer
 **/
 
void sm3Update(Sm3Context *context, const void *data, size_t length)
{
   size_t n;
 
   //Process the incoming data
   while(length > 0)
   {
      //Check whether some data is pending in the buffer
      if(context->size == 0 && length >= 64)
      {
         //The length must be a multiple of 64 bytes
         n = length - (length % 64);
 
         //Update hash value
         hashProcessData(CRYPTO_HMAC_CTL_SM3EN_Msk, data, n, context->h,
            SM3_DIGEST_SIZE / 4);
 
         //Update the SM3 context
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
      }
      else
      {
         //The buffer can hold at most 64 bytes
         n = MIN(length, 64 - context->size);
 
         //Copy the data to the buffer
         osMemcpy(context->buffer + context->size, data, n);
 
         //Update the SM3 context
         context->size += n;
         context->totalSize += n;
         //Advance the data pointer
         data = (uint8_t *) data + n;
         //Remaining bytes to process
         length -= n;
 
         //Check whether the buffer is full
         if(context->size == 64)
         {
            //Update hash value
            hashProcessData(CRYPTO_HMAC_CTL_SM3EN_Msk, context->buffer,
               context->size, context->h, SM3_DIGEST_SIZE / 4);
 
            //Empty the buffer
            context->size = 0;
         }
      }
   }
}
 
 
/**
 * @brief Process message in 16-word blocks
 * @param[in] context Pointer to the SM3 context
 **/
 
void sm3ProcessBlock(Sm3Context *context)
{
   //Update hash value
   hashProcessData(CRYPTO_HMAC_CTL_SM3EN_Msk, context->buffer, 64,
      context->h, SM3_DIGEST_SIZE / 4);
}
 
#endif
#if (KECCAK_SUPPORT == ENABLED)
 
/**
 * @brief Update state array
 * @param[in] data Pointer to the input buffer
 * @param[in] length Length of the input buffer
 * @param[in] blockSize Block size
 * @param[in,out] a State array
 **/
 
void keccakProcessData(const uint8_t *data, size_t length, size_t blockSize,
   uint32_t *a)
{
   uint_t i;
   uint32_t opmode;
 
   //Check block size
   if(blockSize == 72)
   {
      opmode = CRYPTO_HMAC_CTL_OPMODE_SHA3_512;
   }
   else if(blockSize == 104)
   {
      opmode = CRYPTO_HMAC_CTL_OPMODE_SHA3_384;
   }
   else if(blockSize == 136)
   {
      opmode = CRYPTO_HMAC_CTL_OPMODE_SHA3_256;
   }
   else
   {
      opmode = CRYPTO_HMAC_CTL_OPMODE_SHA3_224;
   }
 
   //Acquire exclusive access to the CRYPTO module
   osAcquireMutex(&m5531CryptoMutex);
 
   //Reset CRYPTO controller
   SYS_ResetModule(SYS_CRYPTO0RST);
 
   //Select the relevant hash algorithm
   CRYPTO->HMAC_CTL = CRYPTO_HMAC_CTL_INSWAP_Msk | CRYPTO_HMAC_CTL_OUTSWAP_Msk |
      CRYPTO_HMAC_CTL_SHA3EN_Msk | CRYPTO_HMAC_CTL_DMACSCAD_Msk | opmode;
 
   //Restore state array
   for(i = 0; i < 16; i++)
   {
      CRYPTO->HMAC_FDBCK[i] = reverseInt32(a[49 - i]);
   }
 
   for(i = 0; i < 34; i++)
   {
      CRYPTO->HMAC_FDBCK[54 + i] = reverseInt32(a[33 - i]);
   }
 
   //Start SHA engine
   CRYPTO->HMAC_CTL |= CRYPTO_HMAC_CTL_START_Msk;
 
   //Valid buffer?
   if(data != NULL)
   {
      //Process input data
      for(i = 0; i < length; i += 4)
      {
         //Wait for the DATINREQ bit to be set
         while((CRYPTO->HMAC_STS & CRYPTO_HMAC_STS_DATINREQ_Msk) == 0)
         {
         }
 
         //Write one word of data
         CRYPTO->HMAC_DATIN = __UNALIGNED_UINT32_READ(data + i);
      }
   }
   else
   {
      //Process input data
      for(i = 0; i < length; i += 4)
      {
         //Wait for the DATINREQ bit to be set
         while((CRYPTO->HMAC_STS & CRYPTO_HMAC_STS_DATINREQ_Msk) == 0)
         {
         }
 
         //Write one word of data
         CRYPTO->HMAC_DATIN = 0;
      }
   }
 
   //Wait for the processing to complete
   while((CRYPTO->HMAC_STS & CRYPTO_HMAC_STS_DATINREQ_Msk) == 0)
   {
   }
 
   //Save state array
   for(i = 0; i < 34; i++)
   {
      a[i] = reverseInt32(CRYPTO->HMAC_FDBCK[87 - i]);
   }
 
   for(i = 0; i < 16; i++)
   {
      a[34 + i] = reverseInt32(CRYPTO->HMAC_FDBCK[15 - i]);
   }
 
   //Stop SHA engine
   CRYPTO->HMAC_CTL |= CRYPTO_HMAC_CTL_STOP_Msk;
 
   //Release exclusive access to the CRYPTO module
   osReleaseMutex(&m5531CryptoMutex);
}
 
 
/**
 * @brief Absorb data
 * @param[in] context Pointer to the Keccak context
 * @param[in] input Pointer to the buffer being hashed
 * @param[in] length Length of the buffer
 **/
 
void keccakAbsorb(KeccakContext *context, const void *input, size_t length)
{
   size_t n;
 
   //Process the incoming data
   while(length > 0)
   {
      //Check whether some data is pending in the buffer
      if(context->length == 0 && length >= context->blockSize)
      {
         //The length must be a multiple of the block size
         n = length - (length % context->blockSize);
 
         //Absorb the current block
         keccakProcessData(input, n, context->blockSize,
            (uint32_t *) context->a);
 
         //Advance the data pointer
         input = (uint8_t *) input + n;
         //Remaining bytes to process
         length -= n;
      }
      else
      {
         //The buffer can hold at most one block
         n = MIN(length, context->blockSize - context->length);
 
         //Copy the data to the buffer
         osMemcpy(context->buffer + context->length, input, n);
         //Update the length of the buffer
         context->length += n;
 
         //Advance the data pointer
         input = (uint8_t *) input + n;
         //Remaining bytes to process
         length -= n;
 
         //Check whether the buffer is full
         if(context->length == context->blockSize)
         {
            //Absorb the current block
            keccakProcessData(context->buffer, context->length,
               context->blockSize, (uint32_t *) context->a);
 
            //Empty the buffer
            context->length = 0;
         }
      }
   }
}
 
 
/**
 * @brief Block permutation
 * @param[in] context Pointer to the Keccak context
 **/
 
void keccakPermutBlock(KeccakContext *context)
{
   //Perform block permutation
   keccakProcessData(NULL, context->blockSize, context->blockSize,
      (uint32_t *) context->a);
}
 
#endif
#endif