2018-02-07 21:05:37 +01:00
|
|
|
/**
|
|
|
|
* \file psa/crypto_struct.h
|
|
|
|
*
|
|
|
|
* \brief PSA cryptography module: Mbed TLS structured type implementations
|
2018-06-28 18:02:53 +02:00
|
|
|
*
|
|
|
|
* \note This file may not be included directly. Applications must
|
|
|
|
* include psa/crypto.h.
|
|
|
|
*
|
|
|
|
* This file contains the definitions of some data structures with
|
|
|
|
* implementation-specific definitions.
|
|
|
|
*
|
|
|
|
* In implementations with isolation between the application and the
|
|
|
|
* cryptography module, it is expected that the front-end and the back-end
|
|
|
|
* would have different versions of this file.
|
2018-02-07 21:05:37 +01:00
|
|
|
*/
|
|
|
|
/*
|
|
|
|
* Copyright (C) 2018, ARM Limited, All Rights Reserved
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
|
|
* not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*
|
|
|
|
* This file is part of mbed TLS (https://tls.mbed.org)
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef PSA_CRYPTO_STRUCT_H
|
|
|
|
#define PSA_CRYPTO_STRUCT_H
|
|
|
|
|
|
|
|
/* Include the Mbed TLS configuration file, the way Mbed TLS does it
|
|
|
|
* in each of its header files. */
|
|
|
|
#if !defined(MBEDTLS_CONFIG_FILE)
|
|
|
|
#include "../mbedtls/config.h"
|
|
|
|
#else
|
|
|
|
#include MBEDTLS_CONFIG_FILE
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include "mbedtls/cipher.h"
|
|
|
|
#include "mbedtls/cmac.h"
|
|
|
|
#include "mbedtls/gcm.h"
|
|
|
|
#include "mbedtls/md.h"
|
|
|
|
#include "mbedtls/md2.h"
|
|
|
|
#include "mbedtls/md4.h"
|
|
|
|
#include "mbedtls/md5.h"
|
|
|
|
#include "mbedtls/ripemd160.h"
|
|
|
|
#include "mbedtls/sha1.h"
|
|
|
|
#include "mbedtls/sha256.h"
|
|
|
|
#include "mbedtls/sha512.h"
|
|
|
|
|
|
|
|
struct psa_hash_operation_s
|
|
|
|
{
|
|
|
|
psa_algorithm_t alg;
|
|
|
|
union
|
|
|
|
{
|
2018-03-22 16:20:19 +01:00
|
|
|
unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
|
2018-02-07 21:05:37 +01:00
|
|
|
#if defined(MBEDTLS_MD2_C)
|
|
|
|
mbedtls_md2_context md2;
|
|
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_MD4_C)
|
|
|
|
mbedtls_md4_context md4;
|
|
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_MD5_C)
|
|
|
|
mbedtls_md5_context md5;
|
|
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_RIPEMD160_C)
|
|
|
|
mbedtls_ripemd160_context ripemd160;
|
|
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_SHA1_C)
|
|
|
|
mbedtls_sha1_context sha1;
|
|
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_SHA256_C)
|
|
|
|
mbedtls_sha256_context sha256;
|
|
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_SHA512_C)
|
|
|
|
mbedtls_sha512_context sha512;
|
|
|
|
#endif
|
|
|
|
} ctx;
|
|
|
|
};
|
|
|
|
|
2019-01-04 12:47:44 +01:00
|
|
|
#define PSA_HASH_OPERATION_INIT {0, {0}}
|
|
|
|
static inline struct psa_hash_operation_s psa_hash_operation_init( void )
|
|
|
|
{
|
|
|
|
const struct psa_hash_operation_s v = PSA_HASH_OPERATION_INIT;
|
|
|
|
return( v );
|
|
|
|
}
|
|
|
|
|
2018-11-16 16:02:56 +01:00
|
|
|
#if defined(MBEDTLS_MD_C)
|
2018-06-18 15:41:12 +02:00
|
|
|
typedef struct
|
|
|
|
{
|
2018-06-04 15:03:32 +02:00
|
|
|
/** The hash context. */
|
|
|
|
struct psa_hash_operation_s hash_ctx;
|
|
|
|
/** The HMAC part of the context. */
|
2018-06-18 22:16:43 +02:00
|
|
|
uint8_t opad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
|
2018-06-04 15:03:32 +02:00
|
|
|
} psa_hmac_internal_data;
|
2018-11-16 16:02:56 +01:00
|
|
|
#endif /* MBEDTLS_MD_C */
|
2018-06-04 15:03:32 +02:00
|
|
|
|
2018-02-07 21:05:37 +01:00
|
|
|
struct psa_mac_operation_s
|
|
|
|
{
|
|
|
|
psa_algorithm_t alg;
|
2018-07-26 14:03:38 +02:00
|
|
|
unsigned int key_set : 1;
|
|
|
|
unsigned int iv_required : 1;
|
|
|
|
unsigned int iv_set : 1;
|
|
|
|
unsigned int has_input : 1;
|
|
|
|
unsigned int is_sign : 1;
|
2018-02-07 21:05:37 +01:00
|
|
|
uint8_t mac_size;
|
|
|
|
union
|
|
|
|
{
|
2018-03-22 16:20:19 +01:00
|
|
|
unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
|
2018-02-07 21:05:37 +01:00
|
|
|
#if defined(MBEDTLS_MD_C)
|
2018-06-04 15:03:32 +02:00
|
|
|
psa_hmac_internal_data hmac;
|
2018-02-07 21:05:37 +01:00
|
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_CMAC_C)
|
|
|
|
mbedtls_cipher_context_t cmac;
|
|
|
|
#endif
|
|
|
|
} ctx;
|
|
|
|
};
|
|
|
|
|
2019-01-04 12:48:03 +01:00
|
|
|
#define PSA_MAC_OPERATION_INIT {0, 0, 0, 0, 0, 0, 0, {0}}
|
|
|
|
static inline struct psa_mac_operation_s psa_mac_operation_init( void )
|
|
|
|
{
|
|
|
|
const struct psa_mac_operation_s v = PSA_MAC_OPERATION_INIT;
|
|
|
|
return( v );
|
|
|
|
}
|
|
|
|
|
2018-03-03 21:27:18 +01:00
|
|
|
struct psa_cipher_operation_s
|
|
|
|
{
|
|
|
|
psa_algorithm_t alg;
|
2018-07-26 14:03:38 +02:00
|
|
|
unsigned int key_set : 1;
|
|
|
|
unsigned int iv_required : 1;
|
|
|
|
unsigned int iv_set : 1;
|
2018-03-03 21:27:18 +01:00
|
|
|
uint8_t iv_size;
|
|
|
|
uint8_t block_size;
|
|
|
|
union
|
|
|
|
{
|
2019-01-04 16:33:37 +01:00
|
|
|
unsigned dummy; /* Enable easier initializing of the union. */
|
2018-03-12 14:59:30 +01:00
|
|
|
mbedtls_cipher_context_t cipher;
|
2018-03-03 21:27:18 +01:00
|
|
|
} ctx;
|
|
|
|
};
|
|
|
|
|
2019-01-04 12:48:27 +01:00
|
|
|
#define PSA_CIPHER_OPERATION_INIT {0, 0, 0, 0, 0, 0, {0}}
|
|
|
|
static inline struct psa_cipher_operation_s psa_cipher_operation_init( void )
|
|
|
|
{
|
|
|
|
const struct psa_cipher_operation_s v = PSA_CIPHER_OPERATION_INIT;
|
|
|
|
return( v );
|
|
|
|
}
|
|
|
|
|
2019-01-14 18:36:12 +01:00
|
|
|
struct psa_aead_operation_s
|
|
|
|
{
|
|
|
|
psa_algorithm_t alg;
|
|
|
|
unsigned int key_set : 1;
|
|
|
|
unsigned int iv_set : 1;
|
|
|
|
uint8_t iv_size;
|
|
|
|
uint8_t block_size;
|
|
|
|
union
|
|
|
|
{
|
|
|
|
unsigned dummy; /* Enable easier initializing of the union. */
|
|
|
|
mbedtls_cipher_context_t cipher;
|
|
|
|
} ctx;
|
|
|
|
};
|
|
|
|
|
|
|
|
#define PSA_AEAD_OPERATION_INIT {0, 0, 0, 0, 0, {0}}
|
|
|
|
static inline struct psa_aead_operation_s psa_aead_operation_init( void )
|
|
|
|
{
|
|
|
|
const struct psa_aead_operation_s v = PSA_AEAD_OPERATION_INIT;
|
|
|
|
return( v );
|
|
|
|
}
|
|
|
|
|
2018-11-16 16:02:56 +01:00
|
|
|
#if defined(MBEDTLS_MD_C)
|
2018-07-12 17:22:21 +02:00
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
uint8_t *info;
|
|
|
|
size_t info_length;
|
|
|
|
psa_hmac_internal_data hmac;
|
|
|
|
uint8_t prk[PSA_HASH_MAX_SIZE];
|
|
|
|
uint8_t output_block[PSA_HASH_MAX_SIZE];
|
|
|
|
#if PSA_HASH_MAX_SIZE > 0xff
|
|
|
|
#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
|
|
|
|
#endif
|
|
|
|
uint8_t offset_in_block;
|
|
|
|
uint8_t block_number;
|
2019-04-12 15:07:32 +02:00
|
|
|
unsigned int state : 2;
|
|
|
|
unsigned int info_set : 1;
|
2019-05-16 16:59:18 +02:00
|
|
|
} psa_hkdf_key_derivation_t;
|
2018-11-16 16:02:56 +01:00
|
|
|
#endif /* MBEDTLS_MD_C */
|
2018-07-12 17:22:21 +02:00
|
|
|
|
2019-06-11 15:07:27 +02:00
|
|
|
/*
|
|
|
|
* If this option is not turned on, then the function `psa_key_derivation()`
|
|
|
|
* is removed. And the new psa_tls12_prf_key_derivation_t context is used along
|
|
|
|
* with the corresponding new API.
|
|
|
|
*
|
|
|
|
* The sole purpose of this option is to make the transition to the new API
|
|
|
|
* smoother. Once the transition is complete it can and should be removed
|
|
|
|
* along with the old API and its implementation.
|
|
|
|
*/
|
|
|
|
#define PSA_PRE_1_0_KEY_DERIVATION
|
|
|
|
|
2018-11-16 16:02:56 +01:00
|
|
|
#if defined(MBEDTLS_MD_C)
|
2019-05-16 16:59:18 +02:00
|
|
|
typedef struct psa_tls12_prf_key_derivation_s
|
2018-10-09 18:33:01 +02:00
|
|
|
{
|
|
|
|
/* The TLS 1.2 PRF uses the key for each HMAC iteration,
|
2019-05-16 17:26:11 +02:00
|
|
|
* hence we must store it for the lifetime of the operation.
|
2018-10-09 18:33:01 +02:00
|
|
|
* This is different from HKDF, where the key is only used
|
|
|
|
* in the extraction phase, but not during expansion. */
|
|
|
|
unsigned char *key;
|
|
|
|
size_t key_len;
|
|
|
|
|
|
|
|
/* `A(i) + seed` in the notation of RFC 5246, Sect. 5 */
|
2018-11-13 21:50:45 +01:00
|
|
|
uint8_t *Ai_with_seed;
|
|
|
|
size_t Ai_with_seed_len;
|
2018-10-09 18:33:01 +02:00
|
|
|
|
|
|
|
/* `HMAC_hash( prk, A(i) + seed )` in the notation of RFC 5246, Sect. 5. */
|
|
|
|
uint8_t output_block[PSA_HASH_MAX_SIZE];
|
|
|
|
|
|
|
|
#if PSA_HASH_MAX_SIZE > 0xff
|
|
|
|
#error "PSA_HASH_MAX_SIZE does not fit in uint8_t"
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Indicates how many bytes in the current HMAC block have
|
|
|
|
* already been read by the user. */
|
|
|
|
uint8_t offset_in_block;
|
|
|
|
|
|
|
|
/* The 1-based number of the block. */
|
|
|
|
uint8_t block_number;
|
|
|
|
|
2019-05-16 16:59:18 +02:00
|
|
|
} psa_tls12_prf_key_derivation_t;
|
2018-11-16 16:02:56 +01:00
|
|
|
#endif /* MBEDTLS_MD_C */
|
2018-10-09 18:33:01 +02:00
|
|
|
|
2019-05-16 16:59:18 +02:00
|
|
|
struct psa_key_derivation_s
|
2018-07-12 17:12:33 +02:00
|
|
|
{
|
|
|
|
psa_algorithm_t alg;
|
|
|
|
size_t capacity;
|
|
|
|
union
|
|
|
|
{
|
|
|
|
struct
|
|
|
|
{
|
|
|
|
uint8_t *data;
|
|
|
|
size_t size;
|
|
|
|
} buffer;
|
2018-07-12 17:22:21 +02:00
|
|
|
#if defined(MBEDTLS_MD_C)
|
2019-05-16 16:59:18 +02:00
|
|
|
psa_hkdf_key_derivation_t hkdf;
|
|
|
|
psa_tls12_prf_key_derivation_t tls12_prf;
|
2018-07-12 17:22:21 +02:00
|
|
|
#endif
|
2018-07-12 17:12:33 +02:00
|
|
|
} ctx;
|
|
|
|
};
|
|
|
|
|
Rename generator functions to psa_key_derivation_xxx
Generators are mostly about key derivation (currently: only about key
derivation). "Generator" is not a commonly used term in cryptography.
So favor "derivation" as terminology. Call a generator a key
derivation operation structure, since it behaves like other multipart
operation structures. Furthermore, the function names are not fully
consistent.
In this commit, I rename the functions to consistently have the prefix
"psa_key_derivation_". I used the following command:
perl -i -pe '%t = (
psa_crypto_generator_t => "psa_key_derivation_operation_t",
psa_crypto_generator_init => "psa_key_derivation_init",
psa_key_derivation_setup => "psa_key_derivation_setup",
psa_key_derivation_input_key => "psa_key_derivation_input_key",
psa_key_derivation_input_bytes => "psa_key_derivation_input_bytes",
psa_key_agreement => "psa_key_derivation_key_agreement",
psa_set_generator_capacity => "psa_key_derivation_set_capacity",
psa_get_generator_capacity => "psa_key_derivation_get_capacity",
psa_generator_read => "psa_key_derivation_output_bytes",
psa_generate_derived_key => "psa_key_derivation_output_key",
psa_generator_abort => "psa_key_derivation_abort",
PSA_CRYPTO_GENERATOR_INIT => "PSA_KEY_DERIVATION_OPERATION_INIT",
PSA_GENERATOR_UNBRIDLED_CAPACITY => "PSA_KEY_DERIVATION_UNLIMITED_CAPACITY",
); s/\b(@{[join("|", keys %t)]})\b/$t{$1}/ge' $(git ls-files)
2019-05-16 15:28:51 +02:00
|
|
|
#define PSA_KEY_DERIVATION_OPERATION_INIT {0, 0, {{0, 0}}}
|
2019-05-16 16:59:18 +02:00
|
|
|
static inline struct psa_key_derivation_s psa_key_derivation_operation_init( void )
|
2018-07-12 17:12:33 +02:00
|
|
|
{
|
2019-05-16 16:59:18 +02:00
|
|
|
const struct psa_key_derivation_s v = PSA_KEY_DERIVATION_OPERATION_INIT;
|
2018-07-12 17:12:33 +02:00
|
|
|
return( v );
|
|
|
|
}
|
|
|
|
|
2018-03-03 21:30:44 +01:00
|
|
|
struct psa_key_policy_s
|
|
|
|
{
|
|
|
|
psa_key_usage_t usage;
|
|
|
|
psa_algorithm_t alg;
|
2019-05-10 19:33:38 +02:00
|
|
|
psa_algorithm_t alg2;
|
2018-03-03 21:30:44 +01:00
|
|
|
};
|
2019-04-19 19:42:26 +02:00
|
|
|
typedef struct psa_key_policy_s psa_key_policy_t;
|
2018-03-03 21:30:44 +01:00
|
|
|
|
2019-05-10 19:33:38 +02:00
|
|
|
#define PSA_KEY_POLICY_INIT {0, 0, 0}
|
2019-01-04 12:47:20 +01:00
|
|
|
static inline struct psa_key_policy_s psa_key_policy_init( void )
|
|
|
|
{
|
|
|
|
const struct psa_key_policy_s v = PSA_KEY_POLICY_INIT;
|
|
|
|
return( v );
|
|
|
|
}
|
|
|
|
|
2019-04-17 15:05:45 +02:00
|
|
|
struct psa_key_attributes_s
|
|
|
|
{
|
|
|
|
psa_key_id_t id;
|
|
|
|
psa_key_lifetime_t lifetime;
|
|
|
|
psa_key_policy_t policy;
|
|
|
|
psa_key_type_t type;
|
|
|
|
size_t bits;
|
2019-04-26 16:06:02 +02:00
|
|
|
void *domain_parameters;
|
|
|
|
size_t domain_parameters_size;
|
2019-04-17 15:05:45 +02:00
|
|
|
};
|
|
|
|
|
2019-05-10 19:33:38 +02:00
|
|
|
#define PSA_KEY_ATTRIBUTES_INIT {0, 0, {0, 0, 0}, 0, 0, NULL, 0}
|
2019-04-17 15:05:45 +02:00
|
|
|
static inline struct psa_key_attributes_s psa_key_attributes_init( void )
|
|
|
|
{
|
|
|
|
const struct psa_key_attributes_s v = PSA_KEY_ATTRIBUTES_INIT;
|
|
|
|
return( v );
|
|
|
|
}
|
|
|
|
|
2019-05-15 16:11:15 +02:00
|
|
|
static inline void psa_set_key_id(psa_key_attributes_t *attributes,
|
|
|
|
psa_key_id_t id)
|
|
|
|
{
|
|
|
|
attributes->id = id;
|
|
|
|
if( attributes->lifetime == PSA_KEY_LIFETIME_VOLATILE )
|
|
|
|
attributes->lifetime = PSA_KEY_LIFETIME_PERSISTENT;
|
|
|
|
}
|
|
|
|
|
2019-04-18 12:53:01 +02:00
|
|
|
static inline psa_key_id_t psa_get_key_id(
|
|
|
|
const psa_key_attributes_t *attributes)
|
|
|
|
{
|
|
|
|
return( attributes->id );
|
|
|
|
}
|
|
|
|
|
2019-05-15 16:11:15 +02:00
|
|
|
static inline void psa_set_key_lifetime(psa_key_attributes_t *attributes,
|
|
|
|
psa_key_lifetime_t lifetime)
|
|
|
|
{
|
|
|
|
attributes->lifetime = lifetime;
|
|
|
|
if( lifetime == PSA_KEY_LIFETIME_VOLATILE )
|
|
|
|
attributes->id = 0;
|
|
|
|
}
|
|
|
|
|
2019-04-18 12:53:01 +02:00
|
|
|
static inline psa_key_lifetime_t psa_get_key_lifetime(
|
|
|
|
const psa_key_attributes_t *attributes)
|
|
|
|
{
|
|
|
|
return( attributes->lifetime );
|
|
|
|
}
|
|
|
|
|
2019-04-17 15:05:45 +02:00
|
|
|
static inline void psa_set_key_usage_flags(psa_key_attributes_t *attributes,
|
|
|
|
psa_key_usage_t usage_flags)
|
|
|
|
{
|
|
|
|
attributes->policy.usage = usage_flags;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline psa_key_usage_t psa_get_key_usage_flags(
|
|
|
|
const psa_key_attributes_t *attributes)
|
|
|
|
{
|
|
|
|
return( attributes->policy.usage );
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void psa_set_key_algorithm(psa_key_attributes_t *attributes,
|
|
|
|
psa_algorithm_t alg)
|
|
|
|
{
|
|
|
|
attributes->policy.alg = alg;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline psa_algorithm_t psa_get_key_algorithm(
|
|
|
|
const psa_key_attributes_t *attributes)
|
|
|
|
{
|
|
|
|
return( attributes->policy.alg );
|
|
|
|
}
|
|
|
|
|
2019-05-16 12:18:32 +02:00
|
|
|
/* This function is declared in crypto_extra.h, which comes after this
|
|
|
|
* header file, but we need the function here, so repeat the declaration. */
|
|
|
|
psa_status_t psa_set_key_domain_parameters(psa_key_attributes_t *attributes,
|
|
|
|
psa_key_type_t type,
|
|
|
|
const uint8_t *data,
|
|
|
|
size_t data_length);
|
|
|
|
|
2019-04-17 15:05:45 +02:00
|
|
|
static inline void psa_set_key_type(psa_key_attributes_t *attributes,
|
|
|
|
psa_key_type_t type)
|
|
|
|
{
|
2019-04-26 16:06:02 +02:00
|
|
|
if( attributes->domain_parameters == NULL )
|
|
|
|
{
|
|
|
|
/* Common case: quick path */
|
|
|
|
attributes->type = type;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* Call the bigger function to free the old domain paramteres.
|
|
|
|
* Ignore any errors which may arise due to type requiring
|
|
|
|
* non-default domain parameters, since this function can't
|
|
|
|
* report errors. */
|
|
|
|
(void) psa_set_key_domain_parameters( attributes, type, NULL, 0 );
|
|
|
|
}
|
2019-04-17 15:05:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline psa_key_type_t psa_get_key_type(
|
|
|
|
const psa_key_attributes_t *attributes)
|
|
|
|
{
|
|
|
|
return( attributes->type );
|
|
|
|
}
|
|
|
|
|
2019-04-26 13:49:28 +02:00
|
|
|
static inline void psa_set_key_bits(psa_key_attributes_t *attributes,
|
|
|
|
size_t bits)
|
|
|
|
{
|
|
|
|
attributes->bits = bits;
|
|
|
|
}
|
|
|
|
|
2019-04-18 12:53:01 +02:00
|
|
|
static inline size_t psa_get_key_bits(
|
|
|
|
const psa_key_attributes_t *attributes)
|
|
|
|
{
|
|
|
|
return( attributes->bits );
|
|
|
|
}
|
|
|
|
|
2018-02-07 21:05:37 +01:00
|
|
|
#endif /* PSA_CRYPTO_STRUCT_H */
|