aead-metadata.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Southern Storm Software, Pty Ltd.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef LWCRYPTO_AEAD_METADATA_H
#define LWCRYPTO_AEAD_METADATA_H

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef int (*aead_cipher_encrypt_t)
    (unsigned char *c, size_t *clen,
     const unsigned char *m, size_t mlen,
     const unsigned char *ad, size_t adlen,
     const unsigned char *npub,
     const unsigned char *k);

typedef int (*aead_cipher_decrypt_t)
    (unsigned char *m, size_t *mlen,
     const unsigned char *c, size_t clen,
     const unsigned char *ad, size_t adlen,
     const unsigned char *npub,
     const unsigned char *k);

typedef int (*aead_cipher_pk_init_t)
    (unsigned char *pk, const unsigned char *k);

typedef int (*aead_hash_t)
    (unsigned char *out, const unsigned char *in, size_t inlen);

typedef void (*aead_hash_init_t)(void *state);

typedef void (*aead_hash_update_t)
    (void *state, const unsigned char *in, size_t inlen);

typedef void (*aead_hash_finalize_t)(void *state, unsigned char *out);

typedef void (*aead_xof_absorb_t)
    (void *state, const unsigned char *in, size_t inlen);

typedef void (*aead_xof_squeeze_t)
    (void *state, unsigned char *out, size_t outlen);

#define AEAD_FLAG_NONE              0x0000

#define AEAD_FLAG_LITTLE_ENDIAN     0x0001

#define AEAD_FLAG_SC_PROTECT_KEY    0x0002

#define AEAD_FLAG_SC_PROTECT_ALL    0x0004

#define AEAD_FLAG_SLOW              0x0008

#define AEAD_FLAG_MASKED            0x0010

typedef struct
{
    const char *name;               
    unsigned key_len;               
    unsigned nonce_len;             
    unsigned tag_len;               
    unsigned flags;                 
    aead_cipher_encrypt_t encrypt;  
    aead_cipher_decrypt_t decrypt;  
    unsigned pk_state_len;          
    aead_cipher_pk_init_t pk_init;  
} aead_cipher_t;

typedef struct
{
    const char *name;           
    size_t state_size;          
    unsigned hash_len;          
    unsigned flags;             
    aead_hash_t hash;           
    aead_hash_init_t init;      
    aead_hash_update_t update;  
    aead_hash_finalize_t finalize; 
    aead_xof_absorb_t absorb;   
    aead_xof_squeeze_t squeeze; 
} aead_hash_algorithm_t;

/*------------------------ AES-GCM ------------------------*/

extern aead_cipher_t const aesgcm128_cipher;

extern aead_cipher_t const aesgcm192_cipher;

extern aead_cipher_t const aesgcm256_cipher;

/*------------------------- ASCON -------------------------*/

extern aead_cipher_t const ascon128_cipher;

extern aead_cipher_t const ascon128a_cipher;

extern aead_cipher_t const ascon80pq_cipher;

extern aead_hash_algorithm_t const ascon_hash_algorithm;

extern aead_hash_algorithm_t const ascon_hasha_algorithm;

extern aead_hash_algorithm_t const ascon_xof_algorithm;

extern aead_hash_algorithm_t const ascon_xofa_algorithm;

extern aead_cipher_t const ascon128_masked_cipher;

extern aead_cipher_t const ascon128a_masked_cipher;

extern aead_cipher_t const ascon80pq_masked_cipher;

extern aead_cipher_t const ascon128_siv_cipher;

extern aead_cipher_t const ascon128a_siv_cipher;

extern aead_cipher_t const ascon80pq_siv_cipher;

/*----------------------- Elephant ------------------------*/

extern aead_cipher_t const delirium_cipher;

extern aead_cipher_t const dumbo_cipher;

extern aead_cipher_t const jumbo_cipher;

/*----------------------- GIFT-COFB -----------------------*/

extern aead_cipher_t const gift_cofb_cipher;

extern aead_cipher_t const gift_cofb_masked_cipher;

/*--------------------- Grain128-AEAD ---------------------*/

extern aead_cipher_t const grain128_aead_cipher;

/*-------------------------- ISAP -------------------------*/

extern aead_cipher_t const isap_keccak_128a_cipher;

extern aead_cipher_t const isap_ascon_128a_cipher;

extern aead_cipher_t const isap_keccak_128_cipher;

extern aead_cipher_t const isap_ascon_128_cipher;

extern aead_cipher_t const isap_keccak_128a_pk_cipher;

extern aead_cipher_t const isap_ascon_128a_pk_cipher;

extern aead_cipher_t const isap_keccak_128_pk_cipher;

extern aead_cipher_t const isap_ascon_128_pk_cipher;

/*--------------------- PHOTON-Beetle ---------------------*/

extern aead_cipher_t const photon_beetle_128_cipher;

extern aead_cipher_t const photon_beetle_32_cipher;

extern aead_hash_algorithm_t const photon_beetle_hash_algorithm;

/*------------------------ Romulus ------------------------*/

extern aead_cipher_t const romulus_n_cipher;

extern aead_cipher_t const romulus_m_cipher;

extern aead_cipher_t const romulus_t_cipher;

extern aead_hash_algorithm_t const romulus_hash_algorithm;

extern aead_hash_algorithm_t const romulus_xof_algorithm;

/*------------------------ SPARKLE ------------------------*/

extern aead_cipher_t const schwaemm_256_128_cipher;

extern aead_cipher_t const schwaemm_192_192_cipher;

extern aead_cipher_t const schwaemm_128_128_cipher;

extern aead_cipher_t const schwaemm_256_256_cipher;

extern aead_hash_algorithm_t const esch_256_hash_algorithm;

extern aead_hash_algorithm_t const esch_384_hash_algorithm;

extern aead_hash_algorithm_t const esch_256_xof_algorithm;

extern aead_hash_algorithm_t const esch_384_xof_algorithm;

/*----------------------- TinyJAMBU -----------------------*/

extern aead_cipher_t const tiny_jambu_128_cipher;

extern aead_cipher_t const tiny_jambu_192_cipher;

extern aead_cipher_t const tiny_jambu_256_cipher;

extern aead_cipher_t const tiny_jambu_128_masked_cipher;

extern aead_cipher_t const tiny_jambu_192_masked_cipher;

extern aead_cipher_t const tiny_jambu_256_masked_cipher;

/*------------------------ Xoodyak ------------------------*/

extern aead_cipher_t const xoodyak_cipher;

extern aead_hash_algorithm_t const xoodyak_hash_algorithm;

extern aead_cipher_t const xoodyak_masked_cipher;

#ifdef __cplusplus
}
#endif

#endif