attributes.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2024 TU Dresden
3  * Copyright (C) 2021 HAW Hamburg
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
22 #ifndef PSA_CRYPTO_PSA_KEY_ATTRIBUTES_H
23 #define PSA_CRYPTO_PSA_KEY_ATTRIBUTES_H
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 #include "psa/algorithm.h"
30 #include "bits.h"
31 #include "id.h"
32 #include "lifetime.h"
33 #include "type.h"
34 #include "usage.h"
35 
39 struct psa_key_policy_s {
40  psa_key_usage_t usage;
41  psa_algorithm_t alg;
42 };
43 
47 typedef struct psa_key_policy_s psa_key_policy_t;
48 
52 struct psa_key_attributes_s {
53  psa_key_type_t type;
54  psa_key_bits_t bits;
55  psa_key_lifetime_t lifetime;
56  psa_key_id_t id;
57  psa_key_policy_t policy;
58 };
59 
161 typedef struct psa_key_attributes_s psa_key_attributes_t;
162 
167 #define PSA_KEY_ATTRIBUTES_INIT { 0 }
168 
174 static inline psa_key_attributes_t psa_key_attributes_init(void)
175 {
176  const psa_key_attributes_t v = PSA_KEY_ATTRIBUTES_INIT;
177 
178  return v;
179 }
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 
185 #endif /* PSA_CRYPTO_PSA_KEY_ATTRIBUTES_H */
algorithm.h
Algorithm definitions for the PSA Crypto API.
psa_algorithm_t
uint32_t psa_algorithm_t
Encoding of a cryptographic algorithm.
Definition: algorithm.h:39
psa_key_attributes_init
static psa_key_attributes_t psa_key_attributes_init(void)
Return an initial value for a key attribute object.
Definition: attributes.h:174
PSA_KEY_ATTRIBUTES_INIT
#define PSA_KEY_ATTRIBUTES_INIT
This macro returns a suitable initializer for a key attribute object of type psa_key_attributes_t.
Definition: attributes.h:167
bits.h
Key size definitions for the PSA Crypto API.
psa_key_bits_t
uint16_t psa_key_bits_t
Public interfaces use size_t, but internally we use a smaller type.
Definition: bits.h:34
id.h
Key ID definitions for the PSA Crypto API.
psa_key_id_t
uint32_t psa_key_id_t
Key identifier.
Definition: id.h:37
lifetime.h
Key ilfetime definitions for the PSA Crypto API.
psa_key_lifetime_t
uint32_t psa_key_lifetime_t
Encoding of key lifetimes.
Definition: lifetime.h:67
type.h
Key type definitions for the PSA Crypto API.
psa_key_type_t
uint16_t psa_key_type_t
Encoding of a key type.
Definition: type.h:45
psa_key_attributes_s
Structure storing key attributes.
Definition: attributes.h:52
psa_key_attributes_s::id
psa_key_id_t id
Key identifier.
Definition: attributes.h:56
psa_key_attributes_s::bits
psa_key_bits_t bits
Size of key in bits.
Definition: attributes.h:54
psa_key_attributes_s::policy
psa_key_policy_t policy
Key usage policy.
Definition: attributes.h:57
psa_key_attributes_s::type
psa_key_type_t type
Type of key.
Definition: attributes.h:53
psa_key_attributes_s::lifetime
psa_key_lifetime_t lifetime
Lifetime of key.
Definition: attributes.h:55
psa_key_policy_s
Structure storing the key usage policies.
Definition: attributes.h:39
psa_key_policy_s::usage
psa_key_usage_t usage
Key usage policy.
Definition: attributes.h:40
psa_key_policy_s::alg
psa_algorithm_t alg
Algorithm for key usage.
Definition: attributes.h:41
usage.h
Key usage definitions for the PSA Crypto API.
psa_key_usage_t
uint32_t psa_key_usage_t
Encoding of permitted usage on a key.
Definition: usage.h:34