/*
 * Copyright (C) 2024 - 2026, Stephan Mueller <smueller@chronox.de>
 *
 * License: see LICENSE file in root directory
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
 * WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */

#ifndef LC_ASCON_KECCAK_H
#define LC_ASCON_KECCAK_H

#include "lc_export.h"
#include "lc_ascon_aead.h"
#include "lc_sha3.h"

#ifdef __cplusplus
extern "C" {
#endif

/// \cond DO_NOT_DOCUMENT

/*
 * Alignment:
 * - hash alignment to adjust lc_ascon_cryptor
 * - hash for SHA-3 alignment
 */
#define LC_AK_STATE_SIZE                                                       \
	(LC_SHA3_STATE_SIZE + LC_ASCON_ALIGNMENT + LC_HASH_COMMON_ALIGNMENT)
#define LC_AK_CTX_SIZE                                                         \
	(sizeof(struct lc_aead_ctx) + sizeof(struct lc_ascon_cryptor) +        \
	 LC_AK_STATE_SIZE)
/// \endcond

/* Ascon-Keccak-based AEAD-algorithm */
extern LC_DLL_IMPORT const struct lc_aead *lc_ascon_keccak_aead;

/**
 * @brief Allocate Ascon Keccak cryptor context on heap
 *
 * This allocation ensures the tag length to be 128 bits.
 *
 * \note This is defined for lc_sha3_512 and lc_sha3_256.
 *
 * @param [in] hash Hash implementation of type struct hash used for the
 *		    Ascon-Keccak algorithm
 * @param [out] ctx Allocated Ascon-Keccak cryptor context
 *
 * @return 0 on success, < 0 on error
 */
int lc_ak_alloc(const struct lc_hash *hash, struct lc_aead_ctx **ctx);

/**
 * @brief Allocate Ascon Keccak cryptor context on heap
 *
 * This allocation ensures the tag length requested by the caller.
 *
 * \note This is defined for lc_sha3_512 and lc_sha3_256.
 *
 * @param [in] hash Hash implementation of type struct hash used for the
 *		    Ascon-Keccak algorithm
 * @param [in] taglen Length of the tag in bytes (between 16 and key size)
 * @param [out] ctx Allocated Ascon-Keccak cryptor context
 *
 * @return 0 on success, < 0 on error
 */
int lc_ak_alloc_taglen(const struct lc_hash *hash, uint8_t taglen,
		       struct lc_aead_ctx **ctx);

/**
 * @brief Allocate stack memory for the Ascon-Keccak cryptor context using
 *        a 128 bit tag
 *
 * \note This is defined for lc_sha3_512 and lc_sha3_256.
 *
 * @param [in] name Name of the stack variable
 * @param [in] hash Hash implementation of type struct hash used for the
 *		    Ascon-Keccak algorithm
 */
#define LC_AK_CTX_ON_STACK(name, hash)                                         \
	_Pragma("GCC diagnostic push") _Pragma(                                \
		"GCC diagnostic ignored \"-Wdeclaration-after-statement\"")    \
		_Pragma("GCC diagnostic ignored \"-Wcast-align\"")             \
			LC_ALIGNED_BUFFER(name##_ctx_buf, LC_AK_CTX_SIZE,      \
					  LC_ASCON_ALIGNMENT);                 \
	struct lc_aead_ctx *name = (struct lc_aead_ctx *)name##_ctx_buf;       \
	LC_ASCON_SET_CTX(name, hash, lc_ascon_keccak_aead);                    \
	struct lc_ascon_cryptor *__name_ascon_crypto = name->aead_state;       \
	__name_ascon_crypto->statesize = LC_SHA3_STATE_SIZE;                   \
	__name_ascon_crypto->taglen = 16;                                      \
	_Pragma("GCC diagnostic pop")

/**
 * @brief Allocate stack memory for the Ascon-Keccak cryptor context using
 *        a configured taglen
 *
 * \note This is defined for lc_sha3_512 and lc_sha3_256.
 *
 * @param [in] name Name of the stack variable
 * @param [in] hash Hash implementation of type struct hash used for the
 *		    Ascon-Keccak algorithm
 * @param [in] tagsize Length of the tag in bytes (between 16 and key size)
 */
#define LC_AK_CTX_ON_STACK_TAGLEN(name, hash, tagsize)                         \
	_Pragma("GCC diagnostic push") _Pragma(                                \
		"GCC diagnostic ignored \"-Wdeclaration-after-statement\"")    \
		_Pragma("GCC diagnostic ignored \"-Wcast-align\"")             \
			LC_ALIGNED_BUFFER(name##_ctx_buf, LC_AK_CTX_SIZE,      \
					  LC_ASCON_ALIGNMENT);                 \
	struct lc_aead_ctx *name = (struct lc_aead_ctx *)name##_ctx_buf;       \
	LC_ASCON_SET_CTX(name, hash, lc_ascon_keccak_aead);                    \
	struct lc_ascon_cryptor *__name_ascon_crypto = name->aead_state;       \
	__name_ascon_crypto->statesize = LC_SHA3_STATE_SIZE;                   \
	__name_ascon_crypto->taglen = tagsize;                                 \
	_Pragma("GCC diagnostic pop")

#ifdef __cplusplus
}
#endif

#endif /* LC_ASCON_KECCAK_H */