type.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef PSA_CRYPTO_PSA_KEY_TYPE_H
#define PSA_CRYPTO_PSA_KEY_TYPE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
typedef uint16_t psa_key_type_t;
 
typedef uint8_t psa_ecc_family_t;
 
typedef uint8_t psa_dh_family_t;
 
#define PSA_KEY_TYPE_NONE ((psa_key_type_t)0x0000)
 
#define PSA_KEY_TYPE_VENDOR_FLAG ((psa_key_type_t)0x8000)
 
#define PSA_KEY_TYPE_CATEGORY_MASK ((psa_key_type_t)0x7000)
 
#define PSA_KEY_TYPE_CATEGORY_RAW ((psa_key_type_t)0x1000)
 
#define PSA_KEY_TYPE_CATEGORY_SYMMETRIC ((psa_key_type_t)0x2000)
 
#define PSA_KEY_TYPE_CATEGORY_PUBLIC_KEY ((psa_key_type_t)0x4000)
 
#define PSA_KEY_TYPE_CATEGORY_KEY_PAIR ((psa_key_type_t)0x7000)
 
#define PSA_KEY_TYPE_CATEGORY_FLAG_PAIR ((psa_key_type_t)0x3000)
 
#define PSA_KEY_TYPE_IS_UNSTRUCTURED(type) \
    (((type) & 0x7000) == 0x1000 || ((type) & 0x7000) == 0x2000)
 
#define PSA_KEY_TYPE_IS_ASYMMETRIC(type) \
    (((type) & 0x4000) == 0x4000)
 
#define PSA_KEY_TYPE_IS_PUBLIC_KEY(type) \
    (((type) & 0x7000) == 0x4000)
 
#define PSA_KEY_TYPE_IS_KEY_PAIR(type) \
    (((type) & 0x7000) == 0x7000)
 
#define PSA_KEY_TYPE_RAW_DATA ((psa_key_type_t)0x1001)
 
#define PSA_KEY_TYPE_HMAC ((psa_key_type_t)0x1100)
 
#define PSA_KEY_TYPE_DERIVE ((psa_key_type_t)0x1200)
 
#define PSA_KEY_TYPE_PASSWORD ((psa_key_type_t)0x1203)
 
#define PSA_KEY_TYPE_PASSWORD_HASH ((psa_key_type_t)0x1205)
 
#define PSA_KEY_TYPE_PEPPER ((psa_key_type_t)0x1206)
 
#define PSA_KEY_TYPE_AES ((psa_key_type_t)0x2400)
 
#define PSA_KEY_TYPE_ARIA ((psa_key_type_t)0x2406)
 
#define PSA_KEY_TYPE_DES ((psa_key_type_t)0x2301)
 
#define PSA_KEY_TYPE_CAMELLIA ((psa_key_type_t)0x2403)
 
#define PSA_KEY_TYPE_SM4 ((psa_key_type_t)0x2405)
 
#define PSA_KEY_TYPE_ARC4 ((psa_key_type_t)0x2002)
 
#define PSA_KEY_TYPE_CHACHA20 ((psa_key_type_t)0x2004)
 
#define PSA_KEY_TYPE_RSA_KEY_PAIR ((psa_key_type_t)0x7001)
 
#define PSA_KEY_TYPE_RSA_PUBLIC_KEY ((psa_key_type_t)0x4001)
 
#define PSA_KEY_TYPE_IS_RSA(type) \
    (PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) == 0x4001)
 
#define PSA_KEY_TYPE_ECC_KEY_PAIR_BASE ((psa_key_type_t)0x7100)
 
#define PSA_KEY_TYPE_ECC_KEY_PAIR(curve)         \
    (PSA_KEY_TYPE_ECC_KEY_PAIR_BASE | (curve))
 
#define PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE ((psa_key_type_t)0x4100)
 
#define PSA_KEY_TYPE_ECC_CURVE_MASK ((psa_key_type_t)0x00ff)
 
#define PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve)              \
    (PSA_KEY_TYPE_ECC_PUBLIC_KEY_BASE | (curve))
 
#define PSA_ECC_FAMILY_SECP_K1 ((psa_ecc_family_t)0x17)
 
#define PSA_ECC_FAMILY_SECP_R1 ((psa_ecc_family_t)0x12)
 
#define PSA_ECC_FAMILY_SECP_R2 ((psa_ecc_family_t)0x1b)
 
#define PSA_ECC_FAMILY_SECT_K1 ((psa_ecc_family_t)0x27)
 
#define PSA_ECC_FAMILY_SECT_R1 ((psa_ecc_family_t)0x22)
 
#define PSA_ECC_FAMILY_SECT_R2 ((psa_ecc_family_t)0x2b)
 
#define PSA_ECC_FAMILY_BRAINPOOL_P_R1 ((psa_ecc_family_t)0x30)
 
#define PSA_ECC_FAMILY_FRP ((psa_ecc_family_t)0x33)
 
#define PSA_ECC_FAMILY_MONTGOMERY ((psa_ecc_family_t)0x41)
 
#define PSA_ECC_FAMILY_TWISTED_EDWARDS ((psa_ecc_family_t)0x42)
 
#define PSA_KEY_TYPE_IS_ECC(type) \
    ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & 0xff00) == 0x4100)
 
#define PSA_KEY_TYPE_IS_ECC_KEY_PAIR(type) \
    (((type) & 0xff00) == 0x7100)
 
#define PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY(type) \
    (((type) & 0xff00) == 0x4100)
 
#define PSA_KEY_TYPE_ECC_GET_FAMILY(type) \
    ((psa_ecc_family_t)((type) & 0x00ff))
 
#define PSA_KEY_TYPE_DH_KEY_PAIR(group) \
    ((psa_key_type_t)(0x7200 | (group)))
 
#define PSA_KEY_TYPE_DH_PUBLIC_KEY(group) \
    ((psa_key_type_t)(0x4200 | (group)))
 
#define PSA_DH_FAMILY_RFC7919 ((psa_dh_family_t)0x03)
 
#define PSA_KEY_TYPE_KEY_PAIR_OF_PUBLIC_KEY(type) \
    ((psa_key_type_t)((type) | 0x3000))
 
#define PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) \
    ((psa_key_type_t)((type) & ~0x3000))
 
#define PSA_KEY_TYPE_IS_DH(type) \
    ((PSA_KEY_TYPE_PUBLIC_KEY_OF_KEY_PAIR(type) & 0xff00) == 0x4200)
 
#define PSA_KEY_TYPE_IS_DH_KEY_PAIR(type) \
    (((type) & 0xff00) == 0x7200)
 
#define PSA_KEY_TYPE_IS_DH_PUBLIC_KEY(type) \
    (((type) & 0xff00) == 0x4200)
 
#define PSA_KEY_TYPE_DH_GET_FAMILY(type) \
    ((psa_dh_family_t)((type) & 0x00ff))
 
#ifdef __cplusplus
}
#endif
 
#endif /* PSA_CRYPTO_PSA_KEY_TYPE_H */