RIOT/sys/include/psa_crypto/psa/algorithm.h

/*
 * Copyright (C) 2024 TU Dresden
 * Copyright (C) 2021 HAW Hamburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @ingroup     sys_psa_crypto
 * @{
 *
 * @file        algorithm.h
 * @brief       Algorithm definitions for the PSA Crypto API
 *
 * @author      Armin Wolf <wolf.armin@mailbox.tu-dresden.de>
 * @author      Lena Boeckmann <lena.boeckmann@haw-hamburg.de>
 *
 */

#ifndef PSA_CRYPTO_PSA_ALGORITHM_H
#define PSA_CRYPTO_PSA_ALGORITHM_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

/**
 * @brief   Encoding of a cryptographic algorithm.
 *
 * @details For algorithms that can be applied to multiple key types, this identifier does not
 *          encode the key type. For example, for symmetric ciphers based on a block cipher,
 *          @ref psa_algorithm_t encodes the block cipher mode and the padding mode while the
 *          block cipher itself is encoded via @ref psa_key_type_t.
 */
typedef uint32_t psa_algorithm_t;

/**
 * @brief   An invalid algorithm identifier value.
 *
 * @details Zero is not the encoding of any algorithm.
 */
#define PSA_ALG_NONE ((psa_algorithm_t)0)

/**
 * @brief   PSA algorithm category mask.
 */
#define PSA_ALG_CATEGORY_MASK ((psa_algorithm_t)0x7f000000)

#ifdef __cplusplus
}
#endif

#endif /* PSA_CRYPTO_PSA_ALGORITHM_H */
/** @} */