lifetime.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_LIFETIME_H
#define PSA_CRYPTO_PSA_KEY_LIFETIME_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
typedef uint32_t psa_key_lifetime_t;
 
typedef uint8_t psa_key_persistence_t;
 
typedef uint32_t psa_key_location_t;
 
#define PSA_KEY_LIFETIME_VOLATILE ((psa_key_lifetime_t)0x00000000)
 
#define PSA_KEY_LIFETIME_PERSISTENT ((psa_key_lifetime_t)0x00000001)
 
#define PSA_KEY_PERSISTENCE_VOLATILE ((psa_key_persistence_t)0x00)
 
#define PSA_KEY_PERSISTENCE_DEFAULT ((psa_key_persistence_t)0x01)
 
#define PSA_KEY_PERSISTENCE_READ_ONLY ((psa_key_persistence_t)0xff)
 
#define PSA_KEY_LOCATION_LOCAL_STORAGE          ((psa_key_location_t)0x000000)
 
#define PSA_KEY_LOCATION_PRIMARY_SECURE_ELEMENT ((psa_key_location_t)0x000001)
 
#define PSA_KEY_LOCATION_VENDOR_FLAG            ((psa_key_location_t)0x800000)
 
#define PSA_KEY_LOCATION_SE_MIN (PSA_KEY_LOCATION_VENDOR_FLAG)
 
#define PSA_KEY_LOCATION_SE_MAX ((psa_key_location_t)0x8000ff)
 
#define PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) \
    ((psa_key_persistence_t)((lifetime) & 0x000000ff))
 
#define PSA_KEY_LIFETIME_GET_LOCATION(lifetime) \
    ((psa_key_location_t)((lifetime) >> 8))
 
#define PSA_KEY_LIFETIME_IS_VOLATILE(lifetime) \
    (PSA_KEY_LIFETIME_GET_PERSISTENCE(lifetime) == PSA_KEY_PERSISTENCE_VOLATILE)
 
#define PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION(persistence, location) \
    ((location) << 8 | (persistence))
 
#ifdef __cplusplus
}
#endif
 
#endif /* PSA_CRYPTO_PSA_KEY_LIFETIME_H */