mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
333553caf2
fix(hal/include): fix header violations in hal component fix(hal/include): Move type definitions from `xx_hal.h` to `xx_types.h` fix(hal/include): Move type definitions from `xx_hal.h` to `xx_types.h` fix(hal/include): Add comment for a far away `#endif` fix(hal/include): change scope for cpp guard ci: Remove components/hal/ comment from public headers check exceptions Add missing include macro sdkconfig.h for header files Add missing include macro stdbool.h for header files Add missing include macro stdint.h for header files Add missing capability guard macro for header files Add missing cpp guard macro for header files Remove some useless include macros Add some missing `inline` attribute for functions defined in header files Remove components/hal/ from public headers check exceptions fix(hal/include): fix invalid licenses fix(hal/include): fix invalid licenses fix(hal/include): add missing soc_caps.h fix(hal): include soc_caps.h before cap macro is used fix(hal): Remove unnecessary target check fix(hal): fix header and macro problems Add missing include macro Remove loop dependency in hal Add comment for far-away endif fix(hal): Add missing soc_caps.h ci: update check_copyright_ignore.txt Change the sequence of `#include` macro, cpp guard macro Change the wrap scope of capacity macro fix(hal): Change position of C++ guard to pass test
81 lines
2.2 KiB
C
81 lines
2.2 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2020-2023 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/*******************************************************************************
|
|
* NOTICE
|
|
* The hal is not public api, don't use it in application code.
|
|
* See readme.md in soc/include/hal/readme.md
|
|
******************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <stdbool.h>
|
|
#include "hal/ds_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Start the whole signing process after the input key is ready.
|
|
*
|
|
* Call this before using any of the functions below. The input key is ready must be ready at this point.
|
|
*/
|
|
void ds_hal_start(void);
|
|
|
|
/**
|
|
* @brief Finish the whole signing process. Call this after the signature is read or in case of an error.
|
|
*/
|
|
void ds_hal_finish(void);
|
|
|
|
/**
|
|
* @brief Write the initialization vector.
|
|
*/
|
|
void ds_hal_configure_iv(const uint32_t *iv);
|
|
|
|
/**
|
|
* @brief Write the message which should be signed.
|
|
*
|
|
* @param msg Pointer to the message.
|
|
* @param size Length of signature result in bytes. It is the RSA signature length in bytes.
|
|
*/
|
|
void ds_hal_write_message(const uint8_t *msg, size_t size);
|
|
|
|
/**
|
|
* @brief Write the encrypted private key parameters.
|
|
*/
|
|
void ds_hal_write_private_key_params(const uint8_t *block);
|
|
|
|
/**
|
|
* @brief Begin signing procedure.
|
|
*/
|
|
void ds_hal_start_sign(void);
|
|
|
|
/**
|
|
* @brief Check whether the hardware is busy with an operation.
|
|
*
|
|
* @return True if the hardware has finished the signing procedure, otherwise false.
|
|
*/
|
|
bool ds_hal_busy(void);
|
|
|
|
/**
|
|
* @brief Check and read the signature from the hardware.
|
|
*
|
|
* @return
|
|
* - DS_SIGNATURE_OK if no issue is detected with the signature.
|
|
* - DS_SIGNATURE_PADDING_FAIL if the padding of the private key parameters is wrong.
|
|
* - DS_SIGNATURE_MD_FAIL if the message digest check failed. This means that the message digest calculated using
|
|
* the private key parameters fails, i.e., the integrity of the private key parameters is not protected.
|
|
* - DS_SIGNATURE_PADDING_AND_MD_FAIL if both padding and message digest check fail.
|
|
*/
|
|
ds_signature_check_t ds_hal_read_result(uint8_t *result, size_t size);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|