mirror of
https://github.com/espressif/esp-idf.git
synced 2025-11-03 22:08:28 +00:00
114 lines
3.3 KiB
C
114 lines
3.3 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stddef.h>
|
|
|
|
#include "hal/sha_types.h"
|
|
|
|
/** @brief Low-level support functions for the hardware SHA engine
|
|
*
|
|
* @note If you're looking for a SHA API to use, try mbedtls component
|
|
* mbedtls/shaXX.h. That API supports hardware acceleration.
|
|
*
|
|
* The API in this header provides some building blocks for implementing a
|
|
* full SHA API such as the one in mbedtls, and also a basic SHA function esp_sha().
|
|
*
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/** @brief Calculate SHA1 or SHA2 sum of some data, using hardware SHA engine
|
|
*
|
|
* @note For more versatile SHA calculations, where data doesn't need
|
|
* to be passed all at once, try the mbedTLS mbedtls/shaX.h APIs.
|
|
*
|
|
* @note It is not necessary to lock any SHA hardware before calling
|
|
* this function, thread safety is managed internally.
|
|
*
|
|
* @param sha_type SHA algorithm to use.
|
|
*
|
|
* @param input Input data buffer.
|
|
*
|
|
* @param ilen Length of input data in bytes.
|
|
*
|
|
* @param output Buffer for output SHA digest. Output is 20 bytes for
|
|
* sha_type SHA1, 32 bytes for sha_type SHA2_256, 48 bytes for
|
|
* sha_type SHA2_384, 64 bytes for sha_type SHA2_512.
|
|
*/
|
|
void esp_sha(esp_sha_type sha_type, const unsigned char *input, size_t ilen, unsigned char *output);
|
|
|
|
/** @brief Execute SHA block operation
|
|
*
|
|
* @note This is a piece of a SHA algorithm, rather than an entire SHA
|
|
* algorithm.
|
|
*
|
|
* @note Call esp_sha_acquire_hardware() before calling this
|
|
* function.
|
|
*
|
|
* @param sha_type SHA algorithm to use.
|
|
*
|
|
* @param data_block Pointer to the input data. Block size is
|
|
* determined by algorithm (SHA1/SHA2_256 = 64 bytes,
|
|
* SHA2_384/SHA2_512 = 128 bytes)
|
|
*
|
|
* @param is_first_block If this parameter is true, the SHA state will
|
|
* be initialised (with the initial state of the given SHA algorithm)
|
|
* before the block is calculated. If false, the existing state of the
|
|
* SHA engine will be used.
|
|
*
|
|
*/
|
|
void esp_sha_block(esp_sha_type sha_type, const void *data_block, bool is_first_block);
|
|
|
|
/**
|
|
* @brief Read out the current state of the SHA digest
|
|
*
|
|
* @note This is a piece of a SHA algorithm, rather than an entire SHA algorithm.
|
|
*
|
|
* @note Call esp_sha_aquire_hardware() before calling this
|
|
* function.
|
|
*
|
|
* If the SHA suffix padding block has been executed already, the
|
|
* value that is read is the SHA digest.
|
|
* Otherwise, the value that is read is an interim SHA state.
|
|
*
|
|
* @param sha_type SHA algorithm in use.
|
|
* @param digest_state Pointer to a memory buffer to hold the SHA state. Size
|
|
* is 20 bytes (SHA1), 32 bytes (SHA2_256), or 64 bytes (SHA2_384, SHA2_512).
|
|
*/
|
|
void esp_sha_read_digest_state(esp_sha_type sha_type, void *digest_state);
|
|
|
|
/**
|
|
* @brief Set the current state of the SHA digest
|
|
*
|
|
* @note Call esp_sha_aquire_hardware() before calling this
|
|
* function.
|
|
*
|
|
* @param sha_type SHA algorithm in use.
|
|
* @param digest_state Digest state to write to hardware
|
|
*/
|
|
void esp_sha_write_digest_state(esp_sha_type sha_type, void *digest_state);
|
|
|
|
|
|
/**
|
|
* @brief Enables the SHA peripheral and takes the lock.
|
|
*/
|
|
void esp_sha_acquire_hardware(void);
|
|
|
|
/**
|
|
* @brief Disables the SHA peripheral and releases the lock.
|
|
*/
|
|
void esp_sha_release_hardware(void);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|