1*b0563631STom Van Eyck /* 2*b0563631STom Van Eyck * Context structure declaration of the Mbed TLS software-based PSA drivers 3*b0563631STom Van Eyck * called through the PSA Crypto driver dispatch layer. 4*b0563631STom Van Eyck * This file contains the context structures of key derivation algorithms 5*b0563631STom Van Eyck * which need to rely on other algorithms. 6*b0563631STom Van Eyck * 7*b0563631STom Van Eyck * \note This file may not be included directly. Applications must 8*b0563631STom Van Eyck * include psa/crypto.h. 9*b0563631STom Van Eyck * 10*b0563631STom Van Eyck * \note This header and its content are not part of the Mbed TLS API and 11*b0563631STom Van Eyck * applications must not depend on it. Its main purpose is to define the 12*b0563631STom Van Eyck * multi-part state objects of the Mbed TLS software-based PSA drivers. The 13*b0563631STom Van Eyck * definitions of these objects are then used by crypto_struct.h to define the 14*b0563631STom Van Eyck * implementation-defined types of PSA multi-part state objects. 15*b0563631STom Van Eyck */ 16*b0563631STom Van Eyck /* 17*b0563631STom Van Eyck * Copyright The Mbed TLS Contributors 18*b0563631STom Van Eyck * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 19*b0563631STom Van Eyck */ 20*b0563631STom Van Eyck 21*b0563631STom Van Eyck #ifndef PSA_CRYPTO_BUILTIN_KEY_DERIVATION_H 22*b0563631STom Van Eyck #define PSA_CRYPTO_BUILTIN_KEY_DERIVATION_H 23*b0563631STom Van Eyck #include "mbedtls/private_access.h" 24*b0563631STom Van Eyck 25*b0563631STom Van Eyck #include <psa/crypto_driver_common.h> 26*b0563631STom Van Eyck 27*b0563631STom Van Eyck #if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \ 28*b0563631STom Van Eyck defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \ 29*b0563631STom Van Eyck defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND) 30*b0563631STom Van Eyck typedef struct { 31*b0563631STom Van Eyck uint8_t *MBEDTLS_PRIVATE(info); 32*b0563631STom Van Eyck size_t MBEDTLS_PRIVATE(info_length); 33*b0563631STom Van Eyck #if PSA_HASH_MAX_SIZE > 0xff 34*b0563631STom Van Eyck #error "PSA_HASH_MAX_SIZE does not fit in uint8_t" 35*b0563631STom Van Eyck #endif 36*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(offset_in_block); 37*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(block_number); 38*b0563631STom Van Eyck unsigned int MBEDTLS_PRIVATE(state) : 2; 39*b0563631STom Van Eyck unsigned int MBEDTLS_PRIVATE(info_set) : 1; 40*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE]; 41*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(prk)[PSA_HASH_MAX_SIZE]; 42*b0563631STom Van Eyck struct psa_mac_operation_s MBEDTLS_PRIVATE(hmac); 43*b0563631STom Van Eyck } psa_hkdf_key_derivation_t; 44*b0563631STom Van Eyck #endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF || 45*b0563631STom Van Eyck MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT || 46*b0563631STom Van Eyck MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */ 47*b0563631STom Van Eyck #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) 48*b0563631STom Van Eyck typedef struct { 49*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(data)[PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE]; 50*b0563631STom Van Eyck } psa_tls12_ecjpake_to_pms_t; 51*b0563631STom Van Eyck #endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */ 52*b0563631STom Van Eyck 53*b0563631STom Van Eyck #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \ 54*b0563631STom Van Eyck defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) 55*b0563631STom Van Eyck typedef enum { 56*b0563631STom Van Eyck PSA_TLS12_PRF_STATE_INIT, /* no input provided */ 57*b0563631STom Van Eyck PSA_TLS12_PRF_STATE_SEED_SET, /* seed has been set */ 58*b0563631STom Van Eyck PSA_TLS12_PRF_STATE_OTHER_KEY_SET, /* other key has been set - optional */ 59*b0563631STom Van Eyck PSA_TLS12_PRF_STATE_KEY_SET, /* key has been set */ 60*b0563631STom Van Eyck PSA_TLS12_PRF_STATE_LABEL_SET, /* label has been set */ 61*b0563631STom Van Eyck PSA_TLS12_PRF_STATE_OUTPUT /* output has been started */ 62*b0563631STom Van Eyck } psa_tls12_prf_key_derivation_state_t; 63*b0563631STom Van Eyck 64*b0563631STom Van Eyck typedef struct psa_tls12_prf_key_derivation_s { 65*b0563631STom Van Eyck #if PSA_HASH_MAX_SIZE > 0xff 66*b0563631STom Van Eyck #error "PSA_HASH_MAX_SIZE does not fit in uint8_t" 67*b0563631STom Van Eyck #endif 68*b0563631STom Van Eyck 69*b0563631STom Van Eyck /* Indicates how many bytes in the current HMAC block have 70*b0563631STom Van Eyck * not yet been read by the user. */ 71*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(left_in_block); 72*b0563631STom Van Eyck 73*b0563631STom Van Eyck /* The 1-based number of the block. */ 74*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(block_number); 75*b0563631STom Van Eyck 76*b0563631STom Van Eyck psa_tls12_prf_key_derivation_state_t MBEDTLS_PRIVATE(state); 77*b0563631STom Van Eyck 78*b0563631STom Van Eyck uint8_t *MBEDTLS_PRIVATE(secret); 79*b0563631STom Van Eyck size_t MBEDTLS_PRIVATE(secret_length); 80*b0563631STom Van Eyck uint8_t *MBEDTLS_PRIVATE(seed); 81*b0563631STom Van Eyck size_t MBEDTLS_PRIVATE(seed_length); 82*b0563631STom Van Eyck uint8_t *MBEDTLS_PRIVATE(label); 83*b0563631STom Van Eyck size_t MBEDTLS_PRIVATE(label_length); 84*b0563631STom Van Eyck #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) 85*b0563631STom Van Eyck uint8_t *MBEDTLS_PRIVATE(other_secret); 86*b0563631STom Van Eyck size_t MBEDTLS_PRIVATE(other_secret_length); 87*b0563631STom Van Eyck #endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */ 88*b0563631STom Van Eyck 89*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(Ai)[PSA_HASH_MAX_SIZE]; 90*b0563631STom Van Eyck 91*b0563631STom Van Eyck /* `HMAC_hash( prk, A( i ) + seed )` in the notation of RFC 5246, Sect. 5. */ 92*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE]; 93*b0563631STom Van Eyck } psa_tls12_prf_key_derivation_t; 94*b0563631STom Van Eyck #endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || 95*b0563631STom Van Eyck * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */ 96*b0563631STom Van Eyck #if defined(PSA_HAVE_SOFT_PBKDF2) 97*b0563631STom Van Eyck typedef enum { 98*b0563631STom Van Eyck PSA_PBKDF2_STATE_INIT, /* no input provided */ 99*b0563631STom Van Eyck PSA_PBKDF2_STATE_INPUT_COST_SET, /* input cost has been set */ 100*b0563631STom Van Eyck PSA_PBKDF2_STATE_SALT_SET, /* salt has been set */ 101*b0563631STom Van Eyck PSA_PBKDF2_STATE_PASSWORD_SET, /* password has been set */ 102*b0563631STom Van Eyck PSA_PBKDF2_STATE_OUTPUT /* output has been started */ 103*b0563631STom Van Eyck } psa_pbkdf2_key_derivation_state_t; 104*b0563631STom Van Eyck 105*b0563631STom Van Eyck typedef struct { 106*b0563631STom Van Eyck psa_pbkdf2_key_derivation_state_t MBEDTLS_PRIVATE(state); 107*b0563631STom Van Eyck uint64_t MBEDTLS_PRIVATE(input_cost); 108*b0563631STom Van Eyck uint8_t *MBEDTLS_PRIVATE(salt); 109*b0563631STom Van Eyck size_t MBEDTLS_PRIVATE(salt_length); 110*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(password)[PSA_HMAC_MAX_HASH_BLOCK_SIZE]; 111*b0563631STom Van Eyck size_t MBEDTLS_PRIVATE(password_length); 112*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE]; 113*b0563631STom Van Eyck uint8_t MBEDTLS_PRIVATE(bytes_used); 114*b0563631STom Van Eyck uint32_t MBEDTLS_PRIVATE(block_number); 115*b0563631STom Van Eyck } psa_pbkdf2_key_derivation_t; 116*b0563631STom Van Eyck #endif /* PSA_HAVE_SOFT_PBKDF2 */ 117*b0563631STom Van Eyck 118*b0563631STom Van Eyck #endif /* PSA_CRYPTO_BUILTIN_KEY_DERIVATION_H */ 119