107 lines
2.9 KiB
C
107 lines
2.9 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#pragma once
|
|
|
|
#include <esp_err.h>
|
|
|
|
#if 0 //High level layout for state machine
|
|
|
|
// *INDENT-OFF*
|
|
@startuml
|
|
[*] --> READ_MAGIC
|
|
READ_MAGIC --> READ_MAGIC : READ LEN < 4
|
|
READ_MAGIC --> DECODE_MAGIC : READ LEN = 4
|
|
|
|
DECODE_MAGIC --> READ_GCM : MAGIC VERIFIED
|
|
DECODE_MAGIC --> ESP_FAIL : MAGIC VERIFICATION FAILED
|
|
PROCESS_BINARY --> ESP_FAIL : DECRYPTION FAILED
|
|
|
|
READ_GCM --> READ_GCM : READ_LEN < 384
|
|
READ_GCM --> DECRYPT_GCM : READ_LEN = 384
|
|
DECRYPT_GCM --> ESP_FAIL : DECRYPTION FAILED
|
|
DECRYPT_GCM --> READ_IV : DECRYPTION SUCCESSFUL
|
|
READ_IV --> READ_IV : READ LEN < 16
|
|
READ_IV --> READ_BIN_SIZE
|
|
READ_BIN_SIZE --> READ_BIN_SIZE : READ LEN < 5
|
|
READ_BIN_SIZE --> READ_AUTH
|
|
READ_AUTH --> READ_AUTH : READ LEN < 16
|
|
READ_AUTH --> PROCESS_BINARY
|
|
PROCESS_BINARY --> PROCESS_BINARY : READ LEN < BIN_SIZE
|
|
|
|
PROCESS_BINARY --> ESP_OK : READ LEN = BIN_SIZE
|
|
ESP_OK --> [*]
|
|
ESP_FAIL --> [*]
|
|
@enduml
|
|
// *INDENT-OFF*
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef void *esp_decrypt_handle_t;
|
|
|
|
typedef struct {
|
|
const char *rsa_pub_key; /*!< 3072 bit RSA key in PEM format */
|
|
size_t rsa_pub_key_len; /*!< Length of the buffer pointed to by rsa_pub_key*/
|
|
} esp_decrypt_cfg_t;
|
|
|
|
typedef struct {
|
|
char *data_in; /*!< Pointer to data to be decrypted */
|
|
size_t data_in_len; /*!< Input data length */
|
|
char *data_out; /*!< Pointer to decrypted data */
|
|
size_t data_out_len; /*!< Output data length */
|
|
} pre_enc_decrypt_arg_t;
|
|
|
|
|
|
/**
|
|
* @brief This function returns esp_decrypt_handle_t handle.
|
|
*
|
|
* @param[in] cfg pointer to esp_decrypt_cfg_t structure
|
|
*
|
|
* @return
|
|
* - NULL On failure
|
|
* - esp_decrypt_handle_t handle
|
|
*/
|
|
esp_decrypt_handle_t esp_encrypted_img_decrypt_start(const esp_decrypt_cfg_t *cfg);
|
|
|
|
|
|
/**
|
|
* @brief This function performs decryption on input data.
|
|
*
|
|
* This function must be called only if esp_encrypted_img_decrypt_start() returns successfully.
|
|
* This function must be called in a loop since since input data might not contain whole binary at once.
|
|
* This function must be called till it return ESP_OK.
|
|
*
|
|
* @note args->data_out must be freed after use provided args->data_out_len is greater than 0
|
|
*
|
|
* @param[in] ctx pointer to esp_decrypt_handle_t
|
|
* @param[in/out] args pointer to pre_enc_decrypt_arg_t
|
|
*
|
|
* @return
|
|
* - ESP_FAIL On failure
|
|
* - ESP_ERR_DECRYPT_IN_PROGRESS Decryption is in process
|
|
* - ESP_OK Success
|
|
*/
|
|
esp_err_t esp_encrypted_img_decrypt_data(esp_decrypt_handle_t *ctx, pre_enc_decrypt_arg_t *args);
|
|
|
|
|
|
/**
|
|
* @brief Clean-up decryption process.
|
|
*
|
|
* @param[in] ctx pointer to esp_decrypt_handle_t structure
|
|
*
|
|
* @return
|
|
* - ESP_FAIL On failure
|
|
* - ESP_OK
|
|
*/
|
|
esp_err_t esp_encrypted_img_decrypt_end(esp_decrypt_handle_t *ctx);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|