/*
 * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/*******************************************************************************
 * NOTICE
 * The HAL is not public api, don't use in application code.
 * See readme.md in soc/README.md
 ******************************************************************************/

#pragma once

#include <stdbool.h>
#include <stdint.h>
#include "hal/ecdsa_types.h"
#include "soc/soc_caps.h"

#ifdef __cplusplus
extern "C" {
#endif

/*
 * ECDSA peripheral config structure
 */
typedef struct {
    ecdsa_mode_t mode;              /* Mode of operation */
    ecdsa_curve_t curve;            /* Curve to use for operation */
    ecdsa_sha_mode_t sha_mode;      /* Source of SHA that needs to be signed */
    int efuse_key_blk;              /* Efuse block to use as ECDSA key (The purpose of the efuse block must be ECDSA_KEY) */
    bool use_km_key;                /* Use an ECDSA key from the Key Manager peripheral */
    ecdsa_sign_type_t sign_type;    /* Type of signature generation */
    uint16_t loop_number;           /* Determines the loop number value in deterministic derivation algorithm to derive K.
                                     * When using mbedtls APIs, this member of the config does not need any explicit
                                     * initialisation as it is used and handled internally by the port layer (ECDSA_SIGN_ALT).
                                     */
} ecdsa_hal_config_t;

/**
 * @brief Generate ECDSA signature
 *
 * @param conf Configuration for ECDSA operation, see ``ecdsa_hal_config_t``
 * @param hash Hash that is to be signed
 * @param r_out Buffer that will contain `R` component of ECDSA signature
 * @param s_out Buffer that will contain `S` component of ECDSA signature
 * @param len Length of the r_out and s_out buffer (32 bytes for SECP256R1, 24 for SECP192R1)
 */
void ecdsa_hal_gen_signature(ecdsa_hal_config_t *conf, const uint8_t *hash,
                            uint8_t *r_out, uint8_t *s_out, uint16_t len);

/**
 * @brief Verify given ECDSA signature
 *
 * @param conf Configuration for ECDSA operation, see ``ecdsa_hal_config_t``
 * @param hash Hash that was signed
 * @param r `R` component of ECDSA signature
 * @param s `S` component of ECDSA signature
 * @param pub_x X coordinate of public key
 * @param pub_y Y coordinate of public key
 * @param len Length of r and s buffer (32 bytes for SECP256R1, 24 for SECP192R1)
 *
 * @return - 0, if the signature matches
 *         - -1, if verification fails
 */
int ecdsa_hal_verify_signature(ecdsa_hal_config_t *conf, const uint8_t *hash, const uint8_t *r, const uint8_t *s,
                               const uint8_t *pub_x, const uint8_t *pub_y, uint16_t len);

#ifdef SOC_ECDSA_SUPPORT_EXPORT_PUBKEY
/**
 * @brief Export public key coordinates of an ECDSA private key
 *
 * @param conf Configuration for ECDSA operation, see ``ecdsa_hal_config_t``
 * @param pub_x X coordinate of public key
 * @param pub_y Y coordinate of public key
 * @param len Length of pub_x and pub_y buffers (32 bytes for SECP256R1, 24 for SECP192R1)
 */
void ecdsa_hal_export_pubkey(ecdsa_hal_config_t *conf, uint8_t *pub_x, uint8_t *pub_y, uint16_t len);
#endif /* SOC_ECDSA_SUPPORT_EXPORT_PUBKEY */

/**
 * @brief Check if the ECDSA operation is successful
 *
 * @return - true, if the ECDSA operation is successful
 *         - false, if the ECDSA operation fails
 */
bool ecdsa_hal_get_operation_result(void);

#ifdef SOC_ECDSA_SUPPORT_DETERMINISTIC_MODE
/**
 * @brief Check if the K value derived by the peripheral during deterministic signature generation is valid
 *
 * @return true, if the derived K value is valid
 * @return false, if the derived K value is invalid
 */
bool ecdsa_hal_det_signature_k_check(void);

#endif /* SOC_ECDSA_SUPPORT_DETERMINISTIC_MODE */

#ifdef __cplusplus
}
#endif