ra8_rsip_keys.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_rsip_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =============================================================================
 * Wrapped-key handle type (opaque to callers)
 * =============================================================================
 */

typedef struct {
  uint32_t alg;                                        
  uint32_t body_words;                                 
  uint32_t body[k_ra8_rsip_handle_words_rsa4096_priv]; 
} ra8_rsip_key_handle_t;
 
/* =============================================================================
 * Key install -- plaintext (development) flow
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_rsip_aes128_install_plain(const uint8_t*         key,
                                                      ra8_rsip_key_handle_t* out);

[[nodiscard]] ra8_err_t ra8_rsip_aes192_install_plain(const uint8_t*         key,
                                                      ra8_rsip_key_handle_t* out);

[[nodiscard]] ra8_err_t ra8_rsip_aes256_install_plain(const uint8_t*         key,
                                                      ra8_rsip_key_handle_t* out);

[[nodiscard]] ra8_err_t ra8_rsip_chacha20_install_plain(const uint8_t*         key,
                                                        ra8_rsip_key_handle_t* out);

[[nodiscard]] ra8_err_t ra8_rsip_hmac_install_plain(ra8_rsip_oem_cmd_t     alg,
                                                    const uint8_t*         key,
                                                    uint32_t               key_len,
                                                    ra8_rsip_key_handle_t* out);
 
/* =============================================================================
 * Key install -- OEM (provisioning) flow
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_rsip_oem_install(ra8_rsip_oem_cmd_t     cmd,
                                             const uint8_t*         iv,
                                             const uint8_t*         oem_blob,
                                             uint32_t               blob_len,
                                             ra8_rsip_key_handle_t* out);
 
/* =============================================================================
 * AES symmetric cipher -- ECB / CBC / CTR / XTS / CMAC / GMAC
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_rsip_aes_cipher(const ra8_rsip_key_handle_t* key,
                                            ra8_rsip_aes_mode_t          mode,
                                            ra8_rsip_aes_dir_t           dir,
                                            const uint8_t*               iv,
                                            const uint8_t*               in,
                                            uint8_t*                     out,
                                            uint32_t                     len);
 
/* =============================================================================
 * AES authenticated modes -- GCM / CCM
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_rsip_aes_gcm(const ra8_rsip_key_handle_t* key,
                                         ra8_rsip_aes_dir_t           dir,
                                         const uint8_t*               iv,
                                         const uint8_t*               aad,
                                         uint32_t                     aad_len,
                                         const uint8_t*               in,
                                         uint8_t*                     out,
                                         uint32_t                     in_len,
                                         uint8_t*                     tag);

[[nodiscard]] ra8_err_t ra8_rsip_aes_ccm(const ra8_rsip_key_handle_t* key,
                                         ra8_rsip_aes_dir_t           dir,
                                         const uint8_t*               iv,
                                         const uint8_t*               aad,
                                         uint32_t                     aad_len,
                                         const uint8_t*               in,
                                         uint8_t*                     out,
                                         uint32_t                     in_len,
                                         uint8_t*                     tag);
 
/* =============================================================================
 * ChaCha20 + Poly1305
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_rsip_chacha20(const ra8_rsip_key_handle_t* key,
                                          ra8_rsip_aes_dir_t           dir,
                                          const uint8_t*               nonce,
                                          uint32_t                     counter,
                                          const uint8_t*               in,
                                          uint8_t*                     out,
                                          uint32_t                     len);

[[nodiscard]] ra8_err_t ra8_rsip_chacha20_poly1305(const ra8_rsip_key_handle_t* key,
                                                   ra8_rsip_aes_dir_t           dir,
                                                   const uint8_t*               nonce,
                                                   const uint8_t*               aad,
                                                   uint32_t                     aad_len,
                                                   const uint8_t*               in,
                                                   uint8_t*                     out,
                                                   uint32_t                     in_len,
                                                   uint8_t*                     tag);

[[nodiscard]] ra8_err_t
ra8_rsip_poly1305(const uint8_t* one_time_key, const uint8_t* msg, uint32_t msg_len, uint8_t* tag);
 
/* =============================================================================
 * Hash family -- generic SHA-2 / SHA-3 / SHAKE
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_rsip_hash(ra8_rsip_hash_alg_t alg,
                                      const uint8_t*      msg,
                                      uint32_t            msg_len,
                                      uint8_t*            digest,
                                      uint32_t            digest_len);

[[nodiscard]] ra8_err_t ra8_rsip_hmac(const ra8_rsip_key_handle_t* key,
                                      const uint8_t*               msg,
                                      uint32_t                     msg_len,
                                      uint8_t*                     mac,
                                      uint32_t                     mac_len);
 
/* =============================================================================
 * Asymmetric crypto -- RSA + ECDSA + ECDH
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_rsip_rsa_sign(const ra8_rsip_key_handle_t* key,
                                          ra8_rsip_rsa_size_t          size,
                                          const uint8_t*               digest,
                                          uint32_t                     digest_len,
                                          uint8_t*                     signature);

[[nodiscard]] ra8_err_t ra8_rsip_rsa_verify(const ra8_rsip_key_handle_t* key,
                                            ra8_rsip_rsa_size_t          size,
                                            const uint8_t*               digest,
                                            uint32_t                     digest_len,
                                            const uint8_t*               signature);

[[nodiscard]] ra8_err_t ra8_rsip_rsa_encrypt(const ra8_rsip_key_handle_t* key,
                                             ra8_rsip_rsa_size_t          size,
                                             ra8_rsip_rsa_pad_t           pad,
                                             const uint8_t*               plaintext,
                                             uint32_t                     plaintext_len,
                                             uint8_t*                     ciphertext);

[[nodiscard]] ra8_err_t ra8_rsip_rsa_decrypt(const ra8_rsip_key_handle_t* key,
                                             ra8_rsip_rsa_size_t          size,
                                             ra8_rsip_rsa_pad_t           pad,
                                             const uint8_t*               ciphertext,
                                             uint8_t*                     plaintext,
                                             uint32_t                     plaintext_cap,
                                             uint32_t*                    recovered_len);

[[nodiscard]] ra8_err_t ra8_rsip_ecdsa_sign(const ra8_rsip_key_handle_t* key,
                                            ra8_rsip_curve_t             curve,
                                            const uint8_t*               digest,
                                            uint32_t                     digest_len,
                                            uint8_t*                     signature);

[[nodiscard]] ra8_err_t ra8_rsip_ecdsa_verify(const ra8_rsip_key_handle_t* key,
                                              ra8_rsip_curve_t             curve,
                                              const uint8_t*               digest,
                                              uint32_t                     digest_len,
                                              const uint8_t*               signature);

[[nodiscard]] ra8_err_t ra8_rsip_eddsa_sign(const ra8_rsip_key_handle_t* key,
                                            const uint8_t*               msg,
                                            uint32_t                     msg_len,
                                            uint8_t*                     signature);

[[nodiscard]] ra8_err_t ra8_rsip_eddsa_verify(const ra8_rsip_key_handle_t* key,
                                              const uint8_t*               msg,
                                              uint32_t                     msg_len,
                                              const uint8_t*               signature);

[[nodiscard]] ra8_err_t ra8_rsip_ecdh_compute(const ra8_rsip_key_handle_t* key,
                                              ra8_rsip_curve_t             curve,
                                              const uint8_t*               peer_x,
                                              const uint8_t*               peer_y,
                                              ra8_rsip_key_handle_t*       out);
 
#ifdef __cplusplus
}
#endif