Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 1 | /* |
| 2 | * TLS 1.3 key schedule |
| 3 | * |
| 4 | * Copyright The Mbed TLS Contributors |
| 5 | * SPDX-License-Identifier: Apache-2.0 |
| 6 | * |
| 7 | * Licensed under the Apache License, Version 2.0 ( the "License" ); you may |
| 8 | * not use this file except in compliance with the License. |
| 9 | * You may obtain a copy of the License at |
| 10 | * |
| 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | * |
| 13 | * Unless required by applicable law or agreed to in writing, software |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 15 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | * See the License for the specific language governing permissions and |
| 17 | * limitations under the License. |
| 18 | */ |
| 19 | |
Hanno Becker | 58c5cea | 2020-09-08 10:31:33 +0100 | [diff] [blame] | 20 | #include "common.h" |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 21 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 22 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 23 | |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 24 | #include <stdint.h> |
| 25 | #include <string.h> |
| 26 | |
Jerry Yu | e3131ef | 2021-09-16 13:14:15 +0800 | [diff] [blame] | 27 | #include "mbedtls/hkdf.h" |
| 28 | #include "mbedtls/debug.h" |
| 29 | #include "mbedtls/error.h" |
Jerry Yu | e110d25 | 2022-05-05 10:19:22 +0800 | [diff] [blame] | 30 | #include "mbedtls/platform.h" |
Jerry Yu | e3131ef | 2021-09-16 13:14:15 +0800 | [diff] [blame] | 31 | |
| 32 | #include "ssl_misc.h" |
| 33 | #include "ssl_tls13_keys.h" |
Gabor Mezei | a3eecd2 | 2022-02-09 16:57:26 +0100 | [diff] [blame] | 34 | #include "ssl_tls13_invasive.h" |
| 35 | |
| 36 | #include "psa/crypto.h" |
Jerry Yu | e3131ef | 2021-09-16 13:14:15 +0800 | [diff] [blame] | 37 | |
Hanno Becker | 1413bd8 | 2020-09-09 12:46:09 +0100 | [diff] [blame] | 38 | #define MBEDTLS_SSL_TLS1_3_LABEL( name, string ) \ |
Hanno Becker | e4435ea | 2020-09-08 10:43:52 +0100 | [diff] [blame] | 39 | .name = string, |
| 40 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 41 | struct mbedtls_ssl_tls13_labels_struct const mbedtls_ssl_tls13_labels = |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 42 | { |
| 43 | /* This seems to work in C, despite the string literal being one |
| 44 | * character too long due to the 0-termination. */ |
Hanno Becker | e4435ea | 2020-09-08 10:43:52 +0100 | [diff] [blame] | 45 | MBEDTLS_SSL_TLS1_3_LABEL_LIST |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 46 | }; |
| 47 | |
Hanno Becker | a3a5a4e | 2020-09-08 11:33:48 +0100 | [diff] [blame] | 48 | #undef MBEDTLS_SSL_TLS1_3_LABEL |
Hanno Becker | e4435ea | 2020-09-08 10:43:52 +0100 | [diff] [blame] | 49 | |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 50 | /* |
| 51 | * This function creates a HkdfLabel structure used in the TLS 1.3 key schedule. |
| 52 | * |
| 53 | * The HkdfLabel is specified in RFC 8446 as follows: |
| 54 | * |
| 55 | * struct HkdfLabel { |
| 56 | * uint16 length; // Length of expanded key material |
| 57 | * opaque label<7..255>; // Always prefixed by "tls13 " |
| 58 | * opaque context<0..255>; // Usually a communication transcript hash |
| 59 | * }; |
| 60 | * |
| 61 | * Parameters: |
| 62 | * - desired_length: Length of expanded key material |
| 63 | * Even though the standard allows expansion to up to |
| 64 | * 2**16 Bytes, TLS 1.3 never uses expansion to more than |
| 65 | * 255 Bytes, so we require `desired_length` to be at most |
| 66 | * 255. This allows us to save a few Bytes of code by |
| 67 | * hardcoding the writing of the high bytes. |
Xiaofei Bai | feecbbb | 2021-11-23 07:24:58 +0000 | [diff] [blame] | 68 | * - (label, label_len): label + label length, without "tls13 " prefix |
| 69 | * The label length MUST be less than or equal to |
| 70 | * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN |
| 71 | * It is the caller's responsibility to ensure this. |
| 72 | * All (label, label length) pairs used in TLS 1.3 |
| 73 | * can be obtained via MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(). |
| 74 | * - (ctx, ctx_len): context + context length |
| 75 | * The context length MUST be less than or equal to |
| 76 | * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN |
| 77 | * It is the caller's responsibility to ensure this. |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 78 | * - dst: Target buffer for HkdfLabel structure, |
| 79 | * This MUST be a writable buffer of size |
| 80 | * at least SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN Bytes. |
Xiaofei Bai | feecbbb | 2021-11-23 07:24:58 +0000 | [diff] [blame] | 81 | * - dst_len: Pointer at which to store the actual length of |
| 82 | * the HkdfLabel structure on success. |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 83 | */ |
| 84 | |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 85 | static const char tls13_label_prefix[6] = "tls13 "; |
Hanno Becker | 2dfe132 | 2020-09-10 09:23:12 +0100 | [diff] [blame] | 86 | |
Hanno Becker | 9cb0a14 | 2020-09-08 10:48:14 +0100 | [diff] [blame] | 87 | #define SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( label_len, context_len ) \ |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 88 | ( 2 /* expansion length */ \ |
| 89 | + 1 /* label length */ \ |
Hanno Becker | 9cb0a14 | 2020-09-08 10:48:14 +0100 | [diff] [blame] | 90 | + label_len \ |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 91 | + 1 /* context length */ \ |
Hanno Becker | 9cb0a14 | 2020-09-08 10:48:14 +0100 | [diff] [blame] | 92 | + context_len ) |
| 93 | |
| 94 | #define SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN \ |
| 95 | SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( \ |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 96 | sizeof(tls13_label_prefix) + \ |
Hanno Becker | 9cb0a14 | 2020-09-08 10:48:14 +0100 | [diff] [blame] | 97 | MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN, \ |
| 98 | MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN ) |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 99 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 100 | static void ssl_tls13_hkdf_encode_label( |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 101 | size_t desired_length, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 102 | const unsigned char *label, size_t label_len, |
| 103 | const unsigned char *ctx, size_t ctx_len, |
| 104 | unsigned char *dst, size_t *dst_len ) |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 105 | { |
Hanno Becker | 2dfe132 | 2020-09-10 09:23:12 +0100 | [diff] [blame] | 106 | size_t total_label_len = |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 107 | sizeof(tls13_label_prefix) + label_len; |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 108 | size_t total_hkdf_lbl_len = |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 109 | SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( total_label_len, ctx_len ); |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 110 | |
| 111 | unsigned char *p = dst; |
| 112 | |
Hanno Becker | 531fe30 | 2020-09-16 09:45:27 +0100 | [diff] [blame] | 113 | /* Add the size of the expanded key material. |
| 114 | * We're hardcoding the high byte to 0 here assuming that we never use |
| 115 | * TLS 1.3 HKDF key expansion to more than 255 Bytes. */ |
| 116 | #if MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN > 255 |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 117 | #error "The implementation of ssl_tls13_hkdf_encode_label() is not fit for the \ |
Hanno Becker | 531fe30 | 2020-09-16 09:45:27 +0100 | [diff] [blame] | 118 | value of MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN" |
| 119 | #endif |
| 120 | |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 121 | *p++ = 0; |
Joe Subbiani | 2194dc4 | 2021-07-14 12:31:31 +0100 | [diff] [blame] | 122 | *p++ = MBEDTLS_BYTE_0( desired_length ); |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 123 | |
| 124 | /* Add label incl. prefix */ |
Joe Subbiani | 2194dc4 | 2021-07-14 12:31:31 +0100 | [diff] [blame] | 125 | *p++ = MBEDTLS_BYTE_0( total_label_len ); |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 126 | memcpy( p, tls13_label_prefix, sizeof(tls13_label_prefix) ); |
| 127 | p += sizeof(tls13_label_prefix); |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 128 | memcpy( p, label, label_len ); |
| 129 | p += label_len; |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 130 | |
| 131 | /* Add context value */ |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 132 | *p++ = MBEDTLS_BYTE_0( ctx_len ); |
| 133 | if( ctx_len != 0 ) |
| 134 | memcpy( p, ctx, ctx_len ); |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 135 | |
| 136 | /* Return total length to the caller. */ |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 137 | *dst_len = total_hkdf_lbl_len; |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 138 | } |
| 139 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 140 | int mbedtls_ssl_tls13_hkdf_expand_label( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 141 | psa_algorithm_t hash_alg, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 142 | const unsigned char *secret, size_t secret_len, |
| 143 | const unsigned char *label, size_t label_len, |
| 144 | const unsigned char *ctx, size_t ctx_len, |
| 145 | unsigned char *buf, size_t buf_len ) |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 146 | { |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 147 | unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ]; |
Przemek Stekiel | 1b0ebdf | 2022-06-23 09:22:49 +0200 | [diff] [blame] | 148 | size_t hkdf_label_len = 0; |
Przemek Stekiel | 38ab400 | 2022-06-23 09:05:40 +0200 | [diff] [blame] | 149 | psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED; |
| 150 | psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED; |
Przemek Stekiel | d5ae365 | 2022-05-13 12:10:08 +0200 | [diff] [blame] | 151 | psa_key_derivation_operation_t operation = |
| 152 | PSA_KEY_DERIVATION_OPERATION_INIT; |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 153 | |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 154 | if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN ) |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 155 | { |
| 156 | /* Should never happen since this is an internal |
| 157 | * function, and we know statically which labels |
| 158 | * are allowed. */ |
| 159 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 160 | } |
| 161 | |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 162 | if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN ) |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 163 | { |
| 164 | /* Should not happen, as above. */ |
| 165 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 166 | } |
| 167 | |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 168 | if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN ) |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 169 | { |
| 170 | /* Should not happen, as above. */ |
| 171 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 172 | } |
| 173 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 174 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Gabor Mezei | 58db653 | 2022-03-21 12:12:37 +0100 | [diff] [blame] | 175 | return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA ); |
| 176 | |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 177 | ssl_tls13_hkdf_encode_label( buf_len, |
| 178 | label, label_len, |
| 179 | ctx, ctx_len, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 180 | hkdf_label, |
| 181 | &hkdf_label_len ); |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 182 | |
Przemek Stekiel | d5ae365 | 2022-05-13 12:10:08 +0200 | [diff] [blame] | 183 | status = psa_key_derivation_setup( &operation, PSA_ALG_HKDF_EXPAND( hash_alg ) ); |
Przemek Stekiel | d5ae365 | 2022-05-13 12:10:08 +0200 | [diff] [blame] | 184 | |
Przemek Stekiel | 38ab400 | 2022-06-23 09:05:40 +0200 | [diff] [blame] | 185 | if( status != PSA_SUCCESS ) |
| 186 | goto cleanup; |
| 187 | |
| 188 | status = psa_key_derivation_input_bytes( &operation, |
| 189 | PSA_KEY_DERIVATION_INPUT_SECRET, |
| 190 | secret, |
| 191 | secret_len ); |
| 192 | |
| 193 | if( status != PSA_SUCCESS ) |
| 194 | goto cleanup; |
| 195 | |
| 196 | status = psa_key_derivation_input_bytes( &operation, |
| 197 | PSA_KEY_DERIVATION_INPUT_INFO, |
| 198 | hkdf_label, |
| 199 | hkdf_label_len ); |
| 200 | |
| 201 | if( status != PSA_SUCCESS ) |
| 202 | goto cleanup; |
| 203 | |
| 204 | status = psa_key_derivation_output_bytes( &operation, |
| 205 | buf, |
| 206 | buf_len ); |
| 207 | |
| 208 | if( status != PSA_SUCCESS ) |
| 209 | goto cleanup; |
| 210 | |
| 211 | cleanup: |
| 212 | abort_status = psa_key_derivation_abort( &operation ); |
| 213 | status = ( status == PSA_SUCCESS ? abort_status : status ); |
Przemek Stekiel | 1b0ebdf | 2022-06-23 09:22:49 +0200 | [diff] [blame] | 214 | mbedtls_platform_zeroize( hkdf_label, hkdf_label_len ); |
Przemek Stekiel | d5ae365 | 2022-05-13 12:10:08 +0200 | [diff] [blame] | 215 | return( psa_ssl_status_to_mbedtls ( status ) ); |
Hanno Becker | be9d664 | 2020-08-21 13:20:06 +0100 | [diff] [blame] | 216 | } |
| 217 | |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 218 | /* |
| 219 | * The traffic keying material is generated from the following inputs: |
| 220 | * |
| 221 | * - One secret value per sender. |
| 222 | * - A purpose value indicating the specific value being generated |
| 223 | * - The desired lengths of key and IV. |
| 224 | * |
| 225 | * The expansion itself is based on HKDF: |
| 226 | * |
| 227 | * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length ) |
| 228 | * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length ) |
| 229 | * |
| 230 | * [sender] denotes the sending side and the Secret value is provided |
| 231 | * by the function caller. Note that we generate server and client side |
| 232 | * keys in a single function call. |
| 233 | */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 234 | int mbedtls_ssl_tls13_make_traffic_keys( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 235 | psa_algorithm_t hash_alg, |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 236 | const unsigned char *client_secret, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 237 | const unsigned char *server_secret, size_t secret_len, |
| 238 | size_t key_len, size_t iv_len, |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 239 | mbedtls_ssl_key_set *keys ) |
| 240 | { |
| 241 | int ret = 0; |
| 242 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 243 | ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 244 | client_secret, secret_len, |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 245 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ), |
| 246 | NULL, 0, |
Hanno Becker | 493ea7f | 2020-09-08 11:01:00 +0100 | [diff] [blame] | 247 | keys->client_write_key, key_len ); |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 248 | if( ret != 0 ) |
| 249 | return( ret ); |
| 250 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 251 | ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 252 | server_secret, secret_len, |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 253 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ), |
| 254 | NULL, 0, |
Hanno Becker | 493ea7f | 2020-09-08 11:01:00 +0100 | [diff] [blame] | 255 | keys->server_write_key, key_len ); |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 256 | if( ret != 0 ) |
| 257 | return( ret ); |
| 258 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 259 | ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 260 | client_secret, secret_len, |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 261 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ), |
| 262 | NULL, 0, |
Hanno Becker | 493ea7f | 2020-09-08 11:01:00 +0100 | [diff] [blame] | 263 | keys->client_write_iv, iv_len ); |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 264 | if( ret != 0 ) |
| 265 | return( ret ); |
| 266 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 267 | ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 268 | server_secret, secret_len, |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 269 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ), |
| 270 | NULL, 0, |
Hanno Becker | 493ea7f | 2020-09-08 11:01:00 +0100 | [diff] [blame] | 271 | keys->server_write_iv, iv_len ); |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 272 | if( ret != 0 ) |
| 273 | return( ret ); |
| 274 | |
Hanno Becker | 493ea7f | 2020-09-08 11:01:00 +0100 | [diff] [blame] | 275 | keys->key_len = key_len; |
| 276 | keys->iv_len = iv_len; |
Hanno Becker | 3385a4d | 2020-08-21 13:03:34 +0100 | [diff] [blame] | 277 | |
| 278 | return( 0 ); |
| 279 | } |
| 280 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 281 | int mbedtls_ssl_tls13_derive_secret( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 282 | psa_algorithm_t hash_alg, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 283 | const unsigned char *secret, size_t secret_len, |
| 284 | const unsigned char *label, size_t label_len, |
| 285 | const unsigned char *ctx, size_t ctx_len, |
Hanno Becker | 0c42fd9 | 2020-09-09 12:58:29 +0100 | [diff] [blame] | 286 | int ctx_hashed, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 287 | unsigned char *dstbuf, size_t dstbuf_len ) |
Hanno Becker | b35d522 | 2020-08-21 13:27:44 +0100 | [diff] [blame] | 288 | { |
| 289 | int ret; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 290 | unsigned char hashed_context[ PSA_HASH_MAX_SIZE ]; |
Hanno Becker | 0c42fd9 | 2020-09-09 12:58:29 +0100 | [diff] [blame] | 291 | if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED ) |
Hanno Becker | b35d522 | 2020-08-21 13:27:44 +0100 | [diff] [blame] | 292 | { |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 293 | psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED; |
| 294 | |
| 295 | status = psa_hash_compute( hash_alg, ctx, ctx_len, hashed_context, |
| 296 | PSA_HASH_LENGTH( hash_alg ), &ctx_len ); |
| 297 | if( status != PSA_SUCCESS ) |
| 298 | { |
| 299 | ret = psa_ssl_status_to_mbedtls( status ); |
| 300 | return ret; |
| 301 | } |
Hanno Becker | b35d522 | 2020-08-21 13:27:44 +0100 | [diff] [blame] | 302 | } |
| 303 | else |
| 304 | { |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 305 | if( ctx_len > sizeof(hashed_context) ) |
Hanno Becker | 97a2156 | 2020-09-09 12:57:16 +0100 | [diff] [blame] | 306 | { |
| 307 | /* This should never happen since this function is internal |
Hanno Becker | 0c42fd9 | 2020-09-09 12:58:29 +0100 | [diff] [blame] | 308 | * and the code sets `ctx_hashed` correctly. |
Hanno Becker | 97a2156 | 2020-09-09 12:57:16 +0100 | [diff] [blame] | 309 | * Let's double-check nonetheless to not run at the risk |
| 310 | * of getting a stack overflow. */ |
Hanno Becker | b35d522 | 2020-08-21 13:27:44 +0100 | [diff] [blame] | 311 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
Hanno Becker | 97a2156 | 2020-09-09 12:57:16 +0100 | [diff] [blame] | 312 | } |
Hanno Becker | b35d522 | 2020-08-21 13:27:44 +0100 | [diff] [blame] | 313 | |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 314 | memcpy( hashed_context, ctx, ctx_len ); |
Hanno Becker | b35d522 | 2020-08-21 13:27:44 +0100 | [diff] [blame] | 315 | } |
| 316 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 317 | return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg, |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 318 | secret, secret_len, |
| 319 | label, label_len, |
| 320 | hashed_context, ctx_len, |
| 321 | dstbuf, dstbuf_len ) ); |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 322 | |
Hanno Becker | b35d522 | 2020-08-21 13:27:44 +0100 | [diff] [blame] | 323 | } |
| 324 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 325 | int mbedtls_ssl_tls13_evolve_secret( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 326 | psa_algorithm_t hash_alg, |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 327 | const unsigned char *secret_old, |
| 328 | const unsigned char *input, size_t input_len, |
| 329 | unsigned char *secret_new ) |
| 330 | { |
| 331 | int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR; |
Przemek Stekiel | 38ab400 | 2022-06-23 09:05:40 +0200 | [diff] [blame] | 332 | psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED; |
| 333 | psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED; |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 334 | size_t hlen, ilen; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 335 | unsigned char tmp_secret[ PSA_MAC_MAX_SIZE ] = { 0 }; |
Jerry Yu | 6eaa41c | 2021-11-22 18:16:45 +0800 | [diff] [blame] | 336 | unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 }; |
Przemek Stekiel | d5ae365 | 2022-05-13 12:10:08 +0200 | [diff] [blame] | 337 | psa_key_derivation_operation_t operation = |
| 338 | PSA_KEY_DERIVATION_OPERATION_INIT; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 339 | |
| 340 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Gabor Mezei | 58db653 | 2022-03-21 12:12:37 +0100 | [diff] [blame] | 341 | return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA ); |
| 342 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 343 | hlen = PSA_HASH_LENGTH( hash_alg ); |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 344 | |
| 345 | /* For non-initial runs, call Derive-Secret( ., "derived", "") |
Hanno Becker | 61baae7 | 2020-09-16 09:24:14 +0100 | [diff] [blame] | 346 | * on the old secret. */ |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 347 | if( secret_old != NULL ) |
| 348 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 349 | ret = mbedtls_ssl_tls13_derive_secret( |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 350 | hash_alg, |
| 351 | secret_old, hlen, |
| 352 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ), |
| 353 | NULL, 0, /* context */ |
| 354 | MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED, |
Hanno Becker | 59b50a1 | 2020-09-09 10:56:56 +0100 | [diff] [blame] | 355 | tmp_secret, hlen ); |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 356 | if( ret != 0 ) |
| 357 | goto cleanup; |
| 358 | } |
| 359 | |
Przemek Stekiel | 38ab400 | 2022-06-23 09:05:40 +0200 | [diff] [blame] | 360 | ret = 0; |
| 361 | |
Jerry Yu | 6cf6b47 | 2022-08-16 14:50:28 +0800 | [diff] [blame] | 362 | if( input != NULL && input_len != 0 ) |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 363 | { |
Hanno Becker | 59b50a1 | 2020-09-09 10:56:56 +0100 | [diff] [blame] | 364 | memcpy( tmp_input, input, input_len ); |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 365 | ilen = input_len; |
| 366 | } |
| 367 | else |
| 368 | { |
| 369 | ilen = hlen; |
| 370 | } |
| 371 | |
Przemek Stekiel | d5ae365 | 2022-05-13 12:10:08 +0200 | [diff] [blame] | 372 | status = psa_key_derivation_setup( &operation, |
| 373 | PSA_ALG_HKDF_EXTRACT( hash_alg ) ); |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 374 | |
Przemek Stekiel | 38ab400 | 2022-06-23 09:05:40 +0200 | [diff] [blame] | 375 | if( status != PSA_SUCCESS ) |
| 376 | goto cleanup; |
| 377 | |
| 378 | status = psa_key_derivation_input_bytes( &operation, |
| 379 | PSA_KEY_DERIVATION_INPUT_SALT, |
| 380 | tmp_secret, |
| 381 | hlen ); |
| 382 | |
| 383 | if( status != PSA_SUCCESS ) |
| 384 | goto cleanup; |
| 385 | |
| 386 | status = psa_key_derivation_input_bytes( &operation, |
| 387 | PSA_KEY_DERIVATION_INPUT_SECRET, |
| 388 | tmp_input, |
| 389 | ilen ); |
| 390 | |
| 391 | if( status != PSA_SUCCESS ) |
| 392 | goto cleanup; |
| 393 | |
| 394 | status = psa_key_derivation_output_bytes( &operation, |
| 395 | secret_new, |
| 396 | PSA_HASH_LENGTH( hash_alg ) ); |
| 397 | |
| 398 | if( status != PSA_SUCCESS ) |
| 399 | goto cleanup; |
| 400 | |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 401 | cleanup: |
Przemek Stekiel | 38ab400 | 2022-06-23 09:05:40 +0200 | [diff] [blame] | 402 | abort_status = psa_key_derivation_abort( &operation ); |
| 403 | status = ( status == PSA_SUCCESS ? abort_status : status ); |
| 404 | ret = ( ret == 0 ? psa_ssl_status_to_mbedtls ( status ) : ret ); |
Hanno Becker | 59b50a1 | 2020-09-09 10:56:56 +0100 | [diff] [blame] | 405 | mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) ); |
| 406 | mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) ); |
Hanno Becker | e9cccb4 | 2020-08-20 13:42:46 +0100 | [diff] [blame] | 407 | return( ret ); |
| 408 | } |
| 409 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 410 | int mbedtls_ssl_tls13_derive_early_secrets( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 411 | psa_algorithm_t hash_alg, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 412 | unsigned char const *early_secret, |
| 413 | unsigned char const *transcript, size_t transcript_len, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 414 | mbedtls_ssl_tls13_early_secrets *derived ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 415 | { |
| 416 | int ret; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 417 | size_t const hash_len = PSA_HASH_LENGTH( hash_alg ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 418 | |
| 419 | /* We should never call this function with an unknown hash, |
| 420 | * but add an assertion anyway. */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 421 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 422 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 423 | |
| 424 | /* |
| 425 | * 0 |
| 426 | * | |
| 427 | * v |
| 428 | * PSK -> HKDF-Extract = Early Secret |
| 429 | * | |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 430 | * +-----> Derive-Secret(., "c e traffic", ClientHello) |
| 431 | * | = client_early_traffic_secret |
| 432 | * | |
| 433 | * +-----> Derive-Secret(., "e exp master", ClientHello) |
| 434 | * | = early_exporter_master_secret |
| 435 | * v |
| 436 | */ |
| 437 | |
| 438 | /* Create client_early_traffic_secret */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 439 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 440 | early_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 441 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ), |
| 442 | transcript, transcript_len, |
| 443 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 444 | derived->client_early_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 445 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 446 | if( ret != 0 ) |
| 447 | return( ret ); |
| 448 | |
| 449 | /* Create early exporter */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 450 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 451 | early_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 452 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ), |
| 453 | transcript, transcript_len, |
| 454 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 455 | derived->early_exporter_master_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 456 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 457 | if( ret != 0 ) |
| 458 | return( ret ); |
| 459 | |
| 460 | return( 0 ); |
| 461 | } |
| 462 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 463 | int mbedtls_ssl_tls13_derive_handshake_secrets( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 464 | psa_algorithm_t hash_alg, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 465 | unsigned char const *handshake_secret, |
| 466 | unsigned char const *transcript, size_t transcript_len, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 467 | mbedtls_ssl_tls13_handshake_secrets *derived ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 468 | { |
| 469 | int ret; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 470 | size_t const hash_len = PSA_HASH_LENGTH( hash_alg ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 471 | |
| 472 | /* We should never call this function with an unknown hash, |
| 473 | * but add an assertion anyway. */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 474 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 475 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 476 | |
| 477 | /* |
| 478 | * |
| 479 | * Handshake Secret |
| 480 | * | |
| 481 | * +-----> Derive-Secret( ., "c hs traffic", |
| 482 | * | ClientHello...ServerHello ) |
| 483 | * | = client_handshake_traffic_secret |
| 484 | * | |
| 485 | * +-----> Derive-Secret( ., "s hs traffic", |
| 486 | * | ClientHello...ServerHello ) |
| 487 | * | = server_handshake_traffic_secret |
| 488 | * |
| 489 | */ |
| 490 | |
| 491 | /* |
| 492 | * Compute client_handshake_traffic_secret with |
| 493 | * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello ) |
| 494 | */ |
| 495 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 496 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 497 | handshake_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 498 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ), |
| 499 | transcript, transcript_len, |
| 500 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 501 | derived->client_handshake_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 502 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 503 | if( ret != 0 ) |
| 504 | return( ret ); |
| 505 | |
| 506 | /* |
| 507 | * Compute server_handshake_traffic_secret with |
| 508 | * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello ) |
| 509 | */ |
| 510 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 511 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 512 | handshake_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 513 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ), |
| 514 | transcript, transcript_len, |
| 515 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 516 | derived->server_handshake_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 517 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 518 | if( ret != 0 ) |
| 519 | return( ret ); |
| 520 | |
| 521 | return( 0 ); |
| 522 | } |
| 523 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 524 | int mbedtls_ssl_tls13_derive_application_secrets( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 525 | psa_algorithm_t hash_alg, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 526 | unsigned char const *application_secret, |
| 527 | unsigned char const *transcript, size_t transcript_len, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 528 | mbedtls_ssl_tls13_application_secrets *derived ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 529 | { |
| 530 | int ret; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 531 | size_t const hash_len = PSA_HASH_LENGTH( hash_alg ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 532 | |
| 533 | /* We should never call this function with an unknown hash, |
| 534 | * but add an assertion anyway. */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 535 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 536 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 537 | |
| 538 | /* Generate {client,server}_application_traffic_secret_0 |
| 539 | * |
| 540 | * Master Secret |
| 541 | * | |
| 542 | * +-----> Derive-Secret( ., "c ap traffic", |
| 543 | * | ClientHello...server Finished ) |
| 544 | * | = client_application_traffic_secret_0 |
| 545 | * | |
| 546 | * +-----> Derive-Secret( ., "s ap traffic", |
| 547 | * | ClientHello...Server Finished ) |
| 548 | * | = server_application_traffic_secret_0 |
| 549 | * | |
| 550 | * +-----> Derive-Secret( ., "exp master", |
| 551 | * | ClientHello...server Finished) |
| 552 | * | = exporter_master_secret |
| 553 | * |
| 554 | */ |
| 555 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 556 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 557 | application_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 558 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ), |
| 559 | transcript, transcript_len, |
| 560 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 561 | derived->client_application_traffic_secret_N, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 562 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 563 | if( ret != 0 ) |
| 564 | return( ret ); |
| 565 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 566 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 567 | application_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 568 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ), |
| 569 | transcript, transcript_len, |
| 570 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 571 | derived->server_application_traffic_secret_N, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 572 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 573 | if( ret != 0 ) |
| 574 | return( ret ); |
| 575 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 576 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 577 | application_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 578 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ), |
| 579 | transcript, transcript_len, |
| 580 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 581 | derived->exporter_master_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 582 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 583 | if( ret != 0 ) |
| 584 | return( ret ); |
| 585 | |
| 586 | return( 0 ); |
| 587 | } |
| 588 | |
| 589 | /* Generate resumption_master_secret for use with the ticket exchange. |
| 590 | * |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 591 | * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets() |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 592 | * because it uses the transcript hash up to and including ClientFinished. */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 593 | int mbedtls_ssl_tls13_derive_resumption_master_secret( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 594 | psa_algorithm_t hash_alg, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 595 | unsigned char const *application_secret, |
| 596 | unsigned char const *transcript, size_t transcript_len, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 597 | mbedtls_ssl_tls13_application_secrets *derived ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 598 | { |
| 599 | int ret; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 600 | size_t const hash_len = PSA_HASH_LENGTH( hash_alg ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 601 | |
| 602 | /* We should never call this function with an unknown hash, |
| 603 | * but add an assertion anyway. */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 604 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 605 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 606 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 607 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 608 | application_secret, hash_len, |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 609 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ), |
| 610 | transcript, transcript_len, |
| 611 | MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, |
| 612 | derived->resumption_master_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 613 | hash_len ); |
Hanno Becker | ef5235b | 2021-05-24 06:39:41 +0100 | [diff] [blame] | 614 | |
| 615 | if( ret != 0 ) |
| 616 | return( ret ); |
| 617 | |
| 618 | return( 0 ); |
| 619 | } |
| 620 | |
XiaokangQian | a4c99f2 | 2021-11-11 06:46:35 +0000 | [diff] [blame] | 621 | int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl ) |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 622 | { |
XiaokangQian | 61bdbbc | 2021-10-28 08:03:38 +0000 | [diff] [blame] | 623 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 624 | mbedtls_ssl_handshake_params *handshake = ssl->handshake; |
Manuel Pégourié-Gonnard | abac037 | 2022-07-18 13:41:11 +0200 | [diff] [blame] | 625 | psa_algorithm_t const hash_alg = mbedtls_hash_info_psa_from_md( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 626 | handshake->ciphersuite_info->mac ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 627 | |
| 628 | /* |
| 629 | * Compute MasterSecret |
| 630 | */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 631 | ret = mbedtls_ssl_tls13_evolve_secret( hash_alg, |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 632 | handshake->tls13_master_secrets.handshake, |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 633 | NULL, 0, |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 634 | handshake->tls13_master_secrets.app ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 635 | if( ret != 0 ) |
| 636 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 637 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 638 | return( ret ); |
| 639 | } |
| 640 | |
| 641 | MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret", |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 642 | handshake->tls13_master_secrets.app, PSA_HASH_LENGTH( hash_alg ) ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 643 | |
| 644 | return( 0 ); |
| 645 | } |
| 646 | |
Manuel Pégourié-Gonnard | a3115dc | 2022-06-17 10:52:54 +0200 | [diff] [blame] | 647 | MBEDTLS_CHECK_RETURN_CRITICAL |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 648 | static int ssl_tls13_calc_finished_core( psa_algorithm_t hash_alg, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 649 | unsigned char const *base_key, |
| 650 | unsigned char const *transcript, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 651 | unsigned char *dst, |
| 652 | size_t *dst_len ) |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 653 | { |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 654 | mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT; |
| 655 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
| 656 | psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED; |
| 657 | size_t hash_len = PSA_HASH_LENGTH( hash_alg ); |
| 658 | unsigned char finished_key[PSA_MAC_MAX_SIZE]; |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 659 | int ret; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 660 | psa_algorithm_t alg; |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 661 | |
| 662 | /* We should never call this function with an unknown hash, |
| 663 | * but add an assertion anyway. */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 664 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 665 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 666 | |
| 667 | /* TLS 1.3 Finished message |
| 668 | * |
| 669 | * struct { |
| 670 | * opaque verify_data[Hash.length]; |
| 671 | * } Finished; |
| 672 | * |
| 673 | * verify_data = |
| 674 | * HMAC( finished_key, |
| 675 | * Hash( Handshake Context + |
| 676 | * Certificate* + |
| 677 | * CertificateVerify* ) |
| 678 | * ) |
| 679 | * |
| 680 | * finished_key = |
| 681 | * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length ) |
| 682 | */ |
| 683 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 684 | ret = mbedtls_ssl_tls13_hkdf_expand_label( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 685 | hash_alg, base_key, hash_len, |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 686 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ), |
| 687 | NULL, 0, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 688 | finished_key, hash_len ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 689 | if( ret != 0 ) |
| 690 | goto exit; |
| 691 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 692 | alg = PSA_ALG_HMAC( hash_alg ); |
| 693 | psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE ); |
| 694 | psa_set_key_algorithm( &attributes, alg ); |
| 695 | psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC ); |
| 696 | |
| 697 | status = psa_import_key( &attributes, finished_key, hash_len, &key ); |
| 698 | if( status != PSA_SUCCESS ) |
| 699 | { |
| 700 | ret = psa_ssl_status_to_mbedtls( status ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 701 | goto exit; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 702 | } |
| 703 | |
| 704 | status = psa_mac_compute( key, alg, transcript, hash_len, |
| 705 | dst, hash_len, dst_len ); |
| 706 | ret = psa_ssl_status_to_mbedtls( status ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 707 | |
| 708 | exit: |
| 709 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 710 | status = psa_destroy_key( key ); |
| 711 | if( ret == 0 ) |
| 712 | ret = psa_ssl_status_to_mbedtls( status ); |
| 713 | |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 714 | mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) ); |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 715 | |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 716 | return( ret ); |
| 717 | } |
| 718 | |
XiaokangQian | c5c39d5 | 2021-11-09 11:55:10 +0000 | [diff] [blame] | 719 | int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl, |
XiaokangQian | aaa0e19 | 2021-11-10 03:07:04 +0000 | [diff] [blame] | 720 | unsigned char* dst, |
| 721 | size_t dst_len, |
| 722 | size_t *actual_len, |
| 723 | int from ) |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 724 | { |
XiaokangQian | a763498 | 2021-10-22 06:32:32 +0000 | [diff] [blame] | 725 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 726 | |
XiaokangQian | aaa0e19 | 2021-11-10 03:07:04 +0000 | [diff] [blame] | 727 | unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 728 | size_t transcript_len; |
| 729 | |
Jerry Yu | 4a2fa5d | 2021-12-10 10:19:34 +0800 | [diff] [blame] | 730 | unsigned char *base_key = NULL; |
Jerry Yu | b737f6a | 2021-12-10 17:55:23 +0800 | [diff] [blame] | 731 | size_t base_key_len = 0; |
Jerry Yu | 9c07473 | 2021-12-10 17:12:43 +0800 | [diff] [blame] | 732 | mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = |
| 733 | &ssl->handshake->tls13_hs_secrets; |
Jerry Yu | a5563f6 | 2021-12-10 18:14:36 +0800 | [diff] [blame] | 734 | |
| 735 | mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 736 | |
Manuel Pégourié-Gonnard | abac037 | 2022-07-18 13:41:11 +0200 | [diff] [blame] | 737 | psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 738 | ssl->handshake->ciphersuite_info->mac ); |
Gabor Mezei | 29e7ca8 | 2022-03-29 17:08:49 +0200 | [diff] [blame] | 739 | size_t const hash_len = PSA_HASH_LENGTH( hash_alg ); |
Jerry Yu | a5563f6 | 2021-12-10 18:14:36 +0800 | [diff] [blame] | 740 | |
| 741 | MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) ); |
| 742 | |
Jerry Yu | b737f6a | 2021-12-10 17:55:23 +0800 | [diff] [blame] | 743 | if( from == MBEDTLS_SSL_IS_CLIENT ) |
| 744 | { |
| 745 | base_key = tls13_hs_secrets->client_handshake_traffic_secret; |
| 746 | base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret ); |
| 747 | } |
| 748 | else |
| 749 | { |
| 750 | base_key = tls13_hs_secrets->server_handshake_traffic_secret; |
| 751 | base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret ); |
| 752 | } |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 753 | |
Gabor Mezei | 29e7ca8 | 2022-03-29 17:08:49 +0200 | [diff] [blame] | 754 | if( dst_len < hash_len ) |
Jerry Yu | 9c07473 | 2021-12-10 17:12:43 +0800 | [diff] [blame] | 755 | { |
| 756 | ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL; |
| 757 | goto exit; |
| 758 | } |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 759 | |
| 760 | ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type, |
| 761 | transcript, sizeof( transcript ), |
| 762 | &transcript_len ); |
| 763 | if( ret != 0 ) |
| 764 | { |
| 765 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret ); |
XiaokangQian | 61bdbbc | 2021-10-28 08:03:38 +0000 | [diff] [blame] | 766 | goto exit; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 767 | } |
| 768 | MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len ); |
| 769 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 770 | ret = ssl_tls13_calc_finished_core( hash_alg, base_key, transcript, dst, actual_len ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 771 | if( ret != 0 ) |
XiaokangQian | 61bdbbc | 2021-10-28 08:03:38 +0000 | [diff] [blame] | 772 | goto exit; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 773 | |
Gabor Mezei | 29e7ca8 | 2022-03-29 17:08:49 +0200 | [diff] [blame] | 774 | MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, hash_len ); |
XiaokangQian | c5c39d5 | 2021-11-09 11:55:10 +0000 | [diff] [blame] | 775 | MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) ); |
XiaokangQian | 61bdbbc | 2021-10-28 08:03:38 +0000 | [diff] [blame] | 776 | |
| 777 | exit: |
Jerry Yu | 4a2fa5d | 2021-12-10 10:19:34 +0800 | [diff] [blame] | 778 | /* Erase handshake secrets */ |
Jerry Yu | b737f6a | 2021-12-10 17:55:23 +0800 | [diff] [blame] | 779 | mbedtls_platform_zeroize( base_key, base_key_len ); |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 780 | mbedtls_platform_zeroize( transcript, sizeof( transcript ) ); |
XiaokangQian | 61bdbbc | 2021-10-28 08:03:38 +0000 | [diff] [blame] | 781 | return( ret ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 782 | } |
| 783 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 784 | int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 785 | const psa_algorithm_t hash_alg, |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 786 | unsigned char const *psk, size_t psk_len, |
| 787 | int psk_type, |
| 788 | unsigned char const *transcript, |
| 789 | unsigned char *result ) |
| 790 | { |
| 791 | int ret = 0; |
Gabor Mezei | ed6d658 | 2022-03-26 17:28:06 +0100 | [diff] [blame] | 792 | unsigned char binder_key[PSA_MAC_MAX_SIZE]; |
| 793 | unsigned char early_secret[PSA_MAC_MAX_SIZE]; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 794 | size_t const hash_len = PSA_HASH_LENGTH( hash_alg ); |
| 795 | size_t actual_len; |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 796 | |
Hanno Becker | 28e5f1e | 2021-05-26 09:29:49 +0100 | [diff] [blame] | 797 | #if !defined(MBEDTLS_DEBUG_C) |
| 798 | ssl = NULL; /* make sure we don't use it except for debug */ |
| 799 | ((void) ssl); |
| 800 | #endif |
| 801 | |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 802 | /* We should never call this function with an unknown hash, |
| 803 | * but add an assertion anyway. */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 804 | if( ! PSA_ALG_IS_HASH( hash_alg ) ) |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 805 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 806 | |
| 807 | /* |
| 808 | * 0 |
| 809 | * | |
| 810 | * v |
| 811 | * PSK -> HKDF-Extract = Early Secret |
| 812 | * | |
| 813 | * +-----> Derive-Secret(., "ext binder" | "res binder", "") |
| 814 | * | = binder_key |
| 815 | * v |
| 816 | */ |
| 817 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 818 | ret = mbedtls_ssl_tls13_evolve_secret( hash_alg, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 819 | NULL, /* Old secret */ |
| 820 | psk, psk_len, /* Input */ |
| 821 | early_secret ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 822 | if( ret != 0 ) |
| 823 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 824 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 825 | goto exit; |
| 826 | } |
| 827 | |
Ronald Cron | 295d93e | 2022-07-19 08:21:29 +0200 | [diff] [blame] | 828 | MBEDTLS_SSL_DEBUG_BUF( 4, "mbedtls_ssl_tls13_create_psk_binder", |
| 829 | early_secret, hash_len ) ; |
| 830 | |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 831 | if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION ) |
| 832 | { |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 833 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 834 | early_secret, hash_len, |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 835 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ), |
| 836 | NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 837 | binder_key, hash_len ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 838 | MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) ); |
| 839 | } |
| 840 | else |
| 841 | { |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 842 | ret = mbedtls_ssl_tls13_derive_secret( hash_alg, |
| 843 | early_secret, hash_len, |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 844 | MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ), |
| 845 | NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 846 | binder_key, hash_len ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 847 | MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) ); |
| 848 | } |
| 849 | |
| 850 | if( ret != 0 ) |
| 851 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 852 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 853 | goto exit; |
| 854 | } |
| 855 | |
| 856 | /* |
| 857 | * The binding_value is computed in the same way as the Finished message |
| 858 | * but with the BaseKey being the binder_key. |
| 859 | */ |
| 860 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 861 | ret = ssl_tls13_calc_finished_core( hash_alg, binder_key, transcript, |
| 862 | result, &actual_len ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 863 | if( ret != 0 ) |
| 864 | goto exit; |
| 865 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 866 | MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, actual_len ); |
Hanno Becker | b7d9bad | 2021-05-24 06:44:14 +0100 | [diff] [blame] | 867 | |
| 868 | exit: |
| 869 | |
| 870 | mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) ); |
| 871 | mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) ); |
| 872 | return( ret ); |
| 873 | } |
| 874 | |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 875 | int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform, |
| 876 | int endpoint, |
| 877 | int ciphersuite, |
| 878 | mbedtls_ssl_key_set const *traffic_keys, |
| 879 | mbedtls_ssl_context *ssl /* DEBUG ONLY */ ) |
| 880 | { |
Przemyslaw Stekiel | 6be9cf5 | 2022-01-19 16:00:22 +0100 | [diff] [blame] | 881 | #if !defined(MBEDTLS_USE_PSA_CRYPTO) |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 882 | int ret; |
| 883 | mbedtls_cipher_info_t const *cipher_info; |
Neil Armstrong | a8093f5 | 2022-05-04 17:44:05 +0200 | [diff] [blame] | 884 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 885 | const mbedtls_ssl_ciphersuite_t *ciphersuite_info; |
| 886 | unsigned char const *key_enc; |
| 887 | unsigned char const *iv_enc; |
| 888 | unsigned char const *key_dec; |
| 889 | unsigned char const *iv_dec; |
| 890 | |
Przemyslaw Stekiel | ae77b0a | 2022-01-12 10:29:03 +0100 | [diff] [blame] | 891 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 892 | psa_key_type_t key_type; |
| 893 | psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT; |
| 894 | psa_algorithm_t alg; |
| 895 | size_t key_bits; |
| 896 | psa_status_t status = PSA_SUCCESS; |
| 897 | #endif |
| 898 | |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 899 | #if !defined(MBEDTLS_DEBUG_C) |
| 900 | ssl = NULL; /* make sure we don't use it except for those cases */ |
| 901 | (void) ssl; |
| 902 | #endif |
| 903 | |
| 904 | ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite ); |
Hanno Becker | 7887a77 | 2021-04-20 05:27:57 +0100 | [diff] [blame] | 905 | if( ciphersuite_info == NULL ) |
| 906 | { |
| 907 | MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found", |
| 908 | ciphersuite ) ); |
| 909 | return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA ); |
| 910 | } |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 911 | |
Neil Armstrong | a8093f5 | 2022-05-04 17:44:05 +0200 | [diff] [blame] | 912 | #if !defined(MBEDTLS_USE_PSA_CRYPTO) |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 913 | cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher ); |
| 914 | if( cipher_info == NULL ) |
| 915 | { |
Hanno Becker | 7887a77 | 2021-04-20 05:27:57 +0100 | [diff] [blame] | 916 | MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found", |
| 917 | ciphersuite_info->cipher ) ); |
Hanno Becker | f62a730 | 2021-04-21 05:21:28 +0100 | [diff] [blame] | 918 | return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA ); |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 919 | } |
| 920 | |
| 921 | /* |
| 922 | * Setup cipher contexts in target transform |
| 923 | */ |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 924 | if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc, |
| 925 | cipher_info ) ) != 0 ) |
| 926 | { |
| 927 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret ); |
| 928 | return( ret ); |
| 929 | } |
| 930 | |
| 931 | if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec, |
| 932 | cipher_info ) ) != 0 ) |
| 933 | { |
| 934 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret ); |
| 935 | return( ret ); |
| 936 | } |
Przemyslaw Stekiel | 6be9cf5 | 2022-01-19 16:00:22 +0100 | [diff] [blame] | 937 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 938 | |
| 939 | #if defined(MBEDTLS_SSL_SRV_C) |
| 940 | if( endpoint == MBEDTLS_SSL_IS_SERVER ) |
| 941 | { |
| 942 | key_enc = traffic_keys->server_write_key; |
| 943 | key_dec = traffic_keys->client_write_key; |
| 944 | iv_enc = traffic_keys->server_write_iv; |
| 945 | iv_dec = traffic_keys->client_write_iv; |
| 946 | } |
| 947 | else |
| 948 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 949 | #if defined(MBEDTLS_SSL_CLI_C) |
| 950 | if( endpoint == MBEDTLS_SSL_IS_CLIENT ) |
| 951 | { |
| 952 | key_enc = traffic_keys->client_write_key; |
| 953 | key_dec = traffic_keys->server_write_key; |
| 954 | iv_enc = traffic_keys->client_write_iv; |
| 955 | iv_dec = traffic_keys->server_write_iv; |
| 956 | } |
| 957 | else |
| 958 | #endif /* MBEDTLS_SSL_CLI_C */ |
| 959 | { |
| 960 | /* should not happen */ |
| 961 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 962 | } |
| 963 | |
| 964 | memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len ); |
| 965 | memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len ); |
| 966 | |
Przemyslaw Stekiel | 6be9cf5 | 2022-01-19 16:00:22 +0100 | [diff] [blame] | 967 | #if !defined(MBEDTLS_USE_PSA_CRYPTO) |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 968 | if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, |
| 969 | key_enc, cipher_info->key_bitlen, |
| 970 | MBEDTLS_ENCRYPT ) ) != 0 ) |
| 971 | { |
| 972 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret ); |
| 973 | return( ret ); |
| 974 | } |
| 975 | |
| 976 | if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, |
| 977 | key_dec, cipher_info->key_bitlen, |
| 978 | MBEDTLS_DECRYPT ) ) != 0 ) |
| 979 | { |
| 980 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret ); |
| 981 | return( ret ); |
| 982 | } |
Przemyslaw Stekiel | 6be9cf5 | 2022-01-19 16:00:22 +0100 | [diff] [blame] | 983 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 984 | |
Przemyslaw Stekiel | dd7b501 | 2022-01-17 15:28:57 +0100 | [diff] [blame] | 985 | /* |
| 986 | * Setup other fields in SSL transform |
| 987 | */ |
| 988 | |
| 989 | if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 ) |
| 990 | transform->taglen = 8; |
| 991 | else |
| 992 | transform->taglen = 16; |
| 993 | |
| 994 | transform->ivlen = traffic_keys->iv_len; |
| 995 | transform->maclen = 0; |
| 996 | transform->fixed_ivlen = transform->ivlen; |
Glenn Strauss | 07c6416 | 2022-03-14 12:34:51 -0400 | [diff] [blame] | 997 | transform->tls_version = MBEDTLS_SSL_VERSION_TLS1_3; |
Przemyslaw Stekiel | dd7b501 | 2022-01-17 15:28:57 +0100 | [diff] [blame] | 998 | |
| 999 | /* We add the true record content type (1 Byte) to the plaintext and |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 1000 | * then pad to the configured granularity. The minimum length of the |
Przemyslaw Stekiel | dd7b501 | 2022-01-17 15:28:57 +0100 | [diff] [blame] | 1001 | * type-extended and padded plaintext is therefore the padding |
| 1002 | * granularity. */ |
| 1003 | transform->minlen = |
| 1004 | transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY; |
| 1005 | |
Przemyslaw Stekiel | ae77b0a | 2022-01-12 10:29:03 +0100 | [diff] [blame] | 1006 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Przemyslaw Stekiel | 6be9cf5 | 2022-01-19 16:00:22 +0100 | [diff] [blame] | 1007 | /* |
| 1008 | * Setup psa keys and alg |
| 1009 | */ |
Neil Armstrong | a8093f5 | 2022-05-04 17:44:05 +0200 | [diff] [blame] | 1010 | if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher, |
Przemyslaw Stekiel | ae77b0a | 2022-01-12 10:29:03 +0100 | [diff] [blame] | 1011 | transform->taglen, |
| 1012 | &alg, |
| 1013 | &key_type, |
| 1014 | &key_bits ) ) != PSA_SUCCESS ) |
| 1015 | { |
Przemyslaw Stekiel | 77aec8d | 2022-01-31 20:22:53 +0100 | [diff] [blame] | 1016 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) ); |
| 1017 | return( psa_ssl_status_to_mbedtls( status ) ); |
Przemyslaw Stekiel | ae77b0a | 2022-01-12 10:29:03 +0100 | [diff] [blame] | 1018 | } |
| 1019 | |
Przemyslaw Stekiel | ae77b0a | 2022-01-12 10:29:03 +0100 | [diff] [blame] | 1020 | transform->psa_alg = alg; |
| 1021 | |
Przemyslaw Stekiel | f9cd608 | 2022-02-01 11:25:55 +0100 | [diff] [blame] | 1022 | if ( alg != MBEDTLS_SSL_NULL_CIPHER ) |
Przemyslaw Stekiel | ae77b0a | 2022-01-12 10:29:03 +0100 | [diff] [blame] | 1023 | { |
Przemyslaw Stekiel | f9cd608 | 2022-02-01 11:25:55 +0100 | [diff] [blame] | 1024 | psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT ); |
| 1025 | psa_set_key_algorithm( &attributes, alg ); |
| 1026 | psa_set_key_type( &attributes, key_type ); |
Przemyslaw Stekiel | fe7397d | 2022-01-17 15:47:07 +0100 | [diff] [blame] | 1027 | |
Przemyslaw Stekiel | f9cd608 | 2022-02-01 11:25:55 +0100 | [diff] [blame] | 1028 | if( ( status = psa_import_key( &attributes, |
| 1029 | key_enc, |
| 1030 | PSA_BITS_TO_BYTES( key_bits ), |
| 1031 | &transform->psa_key_enc ) ) != PSA_SUCCESS ) |
| 1032 | { |
| 1033 | MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) ); |
| 1034 | return( psa_ssl_status_to_mbedtls( status ) ); |
| 1035 | } |
Przemyslaw Stekiel | fe7397d | 2022-01-17 15:47:07 +0100 | [diff] [blame] | 1036 | |
Przemyslaw Stekiel | f9cd608 | 2022-02-01 11:25:55 +0100 | [diff] [blame] | 1037 | psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT ); |
| 1038 | |
| 1039 | if( ( status = psa_import_key( &attributes, |
| 1040 | key_dec, |
| 1041 | PSA_BITS_TO_BYTES( key_bits ), |
| 1042 | &transform->psa_key_dec ) ) != PSA_SUCCESS ) |
| 1043 | { |
| 1044 | MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) ); |
| 1045 | return( psa_ssl_status_to_mbedtls( status ) ); |
| 1046 | } |
Przemyslaw Stekiel | ae77b0a | 2022-01-12 10:29:03 +0100 | [diff] [blame] | 1047 | } |
| 1048 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 1049 | |
Hanno Becker | c94060c | 2021-03-22 07:50:44 +0000 | [diff] [blame] | 1050 | return( 0 ); |
| 1051 | } |
| 1052 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1053 | int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl ) |
Jerry Yu | 89ea321 | 2021-09-09 14:31:24 +0800 | [diff] [blame] | 1054 | { |
Jerry Yu | e3131ef | 2021-09-16 13:14:15 +0800 | [diff] [blame] | 1055 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1056 | psa_algorithm_t hash_alg; |
Jerry Yu | 5ccfcd4 | 2021-10-11 16:39:29 +0800 | [diff] [blame] | 1057 | mbedtls_ssl_handshake_params *handshake = ssl->handshake; |
Ronald Cron | 295d93e | 2022-07-19 08:21:29 +0200 | [diff] [blame] | 1058 | unsigned char *psk = NULL; |
| 1059 | size_t psk_len = 0; |
Jerry Yu | 6ca7c7f | 2021-09-28 18:51:40 +0800 | [diff] [blame] | 1060 | |
Jerry Yu | 5ccfcd4 | 2021-10-11 16:39:29 +0800 | [diff] [blame] | 1061 | if( handshake->ciphersuite_info == NULL ) |
Jerry Yu | 89ea321 | 2021-09-09 14:31:24 +0800 | [diff] [blame] | 1062 | { |
| 1063 | MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) ); |
| 1064 | return( MBEDTLS_ERR_SSL_INTERNAL_ERROR ); |
| 1065 | } |
Jerry Yu | e3131ef | 2021-09-16 13:14:15 +0800 | [diff] [blame] | 1066 | |
Manuel Pégourié-Gonnard | abac037 | 2022-07-18 13:41:11 +0200 | [diff] [blame] | 1067 | hash_alg = mbedtls_hash_info_psa_from_md( handshake->ciphersuite_info->mac ); |
Jerry Yu | 5d01c05 | 2022-08-17 10:18:10 +0800 | [diff] [blame] | 1068 | #if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) |
| 1069 | if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) ) |
Ronald Cron | 295d93e | 2022-07-19 08:21:29 +0200 | [diff] [blame] | 1070 | { |
Jerry Yu | 5d01c05 | 2022-08-17 10:18:10 +0800 | [diff] [blame] | 1071 | ret = mbedtls_ssl_tls13_export_handshake_psk( ssl, &psk, &psk_len ); |
| 1072 | if( ret != 0 ) |
| 1073 | { |
| 1074 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_export_handshake_psk", |
| 1075 | ret ); |
| 1076 | return( ret ); |
| 1077 | } |
Ronald Cron | 295d93e | 2022-07-19 08:21:29 +0200 | [diff] [blame] | 1078 | } |
Jerry Yu | 5d01c05 | 2022-08-17 10:18:10 +0800 | [diff] [blame] | 1079 | #endif |
Ronald Cron | 295d93e | 2022-07-19 08:21:29 +0200 | [diff] [blame] | 1080 | |
| 1081 | ret = mbedtls_ssl_tls13_evolve_secret( hash_alg, NULL, psk, psk_len, |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 1082 | handshake->tls13_master_secrets.early ); |
Ronald Cron | 295d93e | 2022-07-19 08:21:29 +0200 | [diff] [blame] | 1083 | #if defined(MBEDTLS_USE_PSA_CRYPTO) && \ |
| 1084 | defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) |
| 1085 | mbedtls_free( (void*)psk ); |
| 1086 | #endif |
Jerry Yu | 89ea321 | 2021-09-09 14:31:24 +0800 | [diff] [blame] | 1087 | if( ret != 0 ) |
| 1088 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1089 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret ); |
Jerry Yu | 89ea321 | 2021-09-09 14:31:24 +0800 | [diff] [blame] | 1090 | return( ret ); |
| 1091 | } |
| 1092 | |
Ronald Cron | 295d93e | 2022-07-19 08:21:29 +0200 | [diff] [blame] | 1093 | MBEDTLS_SSL_DEBUG_BUF( 4, "mbedtls_ssl_tls13_key_schedule_stage_early", |
| 1094 | handshake->tls13_master_secrets.early, |
| 1095 | PSA_HASH_LENGTH( hash_alg ) ); |
Jerry Yu | 89ea321 | 2021-09-09 14:31:24 +0800 | [diff] [blame] | 1096 | return( 0 ); |
| 1097 | } |
| 1098 | |
Manuel Pégourié-Gonnard | a3115dc | 2022-06-17 10:52:54 +0200 | [diff] [blame] | 1099 | MBEDTLS_CHECK_RETURN_CRITICAL |
Neil Armstrong | b818e16 | 2022-05-17 09:24:52 +0200 | [diff] [blame] | 1100 | static int mbedtls_ssl_tls13_get_cipher_key_info( |
| 1101 | const mbedtls_ssl_ciphersuite_t *ciphersuite_info, |
| 1102 | size_t *key_len, size_t *iv_len ) |
| 1103 | { |
| 1104 | psa_key_type_t key_type; |
| 1105 | psa_algorithm_t alg; |
| 1106 | size_t taglen; |
| 1107 | size_t key_bits; |
| 1108 | psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED; |
| 1109 | |
| 1110 | if( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) |
| 1111 | taglen = 8; |
| 1112 | else |
| 1113 | taglen = 16; |
| 1114 | |
| 1115 | status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher, taglen, |
| 1116 | &alg, &key_type, &key_bits ); |
| 1117 | if( status != PSA_SUCCESS ) |
| 1118 | return psa_ssl_status_to_mbedtls( status ); |
| 1119 | |
| 1120 | *key_len = PSA_BITS_TO_BYTES( key_bits ); |
| 1121 | |
Neil Armstrong | 0fa8ce3 | 2022-05-17 14:42:57 +0200 | [diff] [blame] | 1122 | /* TLS 1.3 only have AEAD ciphers, IV length is unconditionally 12 bytes */ |
| 1123 | *iv_len = 12; |
Neil Armstrong | b818e16 | 2022-05-17 09:24:52 +0200 | [diff] [blame] | 1124 | |
| 1125 | return 0; |
| 1126 | } |
| 1127 | |
Jerry Yu | c068b66 | 2021-10-11 22:30:19 +0800 | [diff] [blame] | 1128 | /* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1129 | * protecting the handshake messages, as described in Section 7 of TLS 1.3. */ |
Jerry Yu | c068b66 | 2021-10-11 22:30:19 +0800 | [diff] [blame] | 1130 | int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl, |
| 1131 | mbedtls_ssl_key_set *traffic_keys ) |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1132 | { |
| 1133 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
| 1134 | |
| 1135 | mbedtls_md_type_t md_type; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1136 | |
| 1137 | psa_algorithm_t hash_alg; |
| 1138 | size_t hash_len; |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1139 | |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1140 | unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1141 | size_t transcript_len; |
| 1142 | |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 1143 | size_t key_len, iv_len; |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1144 | |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1145 | mbedtls_ssl_handshake_params *handshake = ssl->handshake; |
| 1146 | const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info; |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1147 | mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets; |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1148 | |
Jerry Yu | c068b66 | 2021-10-11 22:30:19 +0800 | [diff] [blame] | 1149 | MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1150 | |
Neil Armstrong | b818e16 | 2022-05-17 09:24:52 +0200 | [diff] [blame] | 1151 | ret = mbedtls_ssl_tls13_get_cipher_key_info( ciphersuite_info, |
| 1152 | &key_len, &iv_len ); |
| 1153 | if( ret != 0 ) |
Neil Armstrong | 4f4f271 | 2022-05-05 15:34:39 +0200 | [diff] [blame] | 1154 | { |
Neil Armstrong | b818e16 | 2022-05-17 09:24:52 +0200 | [diff] [blame] | 1155 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_get_cipher_key_info", ret ); |
Neil Armstrong | 4f4f271 | 2022-05-05 15:34:39 +0200 | [diff] [blame] | 1156 | return ret; |
| 1157 | } |
| 1158 | |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1159 | md_type = ciphersuite_info->mac; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1160 | |
Manuel Pégourié-Gonnard | abac037 | 2022-07-18 13:41:11 +0200 | [diff] [blame] | 1161 | hash_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac ); |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1162 | hash_len = PSA_HASH_LENGTH( hash_alg ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1163 | |
| 1164 | ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type, |
| 1165 | transcript, |
| 1166 | sizeof( transcript ), |
| 1167 | &transcript_len ); |
| 1168 | if( ret != 0 ) |
| 1169 | { |
| 1170 | MBEDTLS_SSL_DEBUG_RET( 1, |
| 1171 | "mbedtls_ssl_get_handshake_transcript", |
| 1172 | ret ); |
| 1173 | return( ret ); |
| 1174 | } |
| 1175 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1176 | ret = mbedtls_ssl_tls13_derive_handshake_secrets( hash_alg, |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 1177 | handshake->tls13_master_secrets.handshake, |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1178 | transcript, transcript_len, tls13_hs_secrets ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1179 | if( ret != 0 ) |
| 1180 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1181 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets", |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1182 | ret ); |
| 1183 | return( ret ); |
| 1184 | } |
| 1185 | |
| 1186 | MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret", |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1187 | tls13_hs_secrets->client_handshake_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1188 | hash_len ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1189 | MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret", |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1190 | tls13_hs_secrets->server_handshake_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1191 | hash_len ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1192 | |
| 1193 | /* |
| 1194 | * Export client handshake traffic secret |
| 1195 | */ |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1196 | if( ssl->f_export_keys != NULL ) |
| 1197 | { |
| 1198 | ssl->f_export_keys( ssl->p_export_keys, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1199 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET, |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1200 | tls13_hs_secrets->client_handshake_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1201 | hash_len, |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1202 | handshake->randbytes, |
lhuang04 | a3890a3 | 2022-01-04 09:47:20 -0800 | [diff] [blame] | 1203 | handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN, |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1204 | MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ ); |
| 1205 | |
| 1206 | ssl->f_export_keys( ssl->p_export_keys, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1207 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET, |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1208 | tls13_hs_secrets->server_handshake_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1209 | hash_len, |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1210 | handshake->randbytes, |
lhuang04 | a3890a3 | 2022-01-04 09:47:20 -0800 | [diff] [blame] | 1211 | handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN, |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1212 | MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ ); |
| 1213 | } |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1214 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1215 | ret = mbedtls_ssl_tls13_make_traffic_keys( hash_alg, |
Jerry Yu | 435208a | 2021-10-13 11:22:16 +0800 | [diff] [blame] | 1216 | tls13_hs_secrets->client_handshake_traffic_secret, |
| 1217 | tls13_hs_secrets->server_handshake_traffic_secret, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1218 | hash_len, key_len, iv_len, traffic_keys ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1219 | if( ret != 0 ) |
| 1220 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1221 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1222 | goto exit; |
| 1223 | } |
| 1224 | |
| 1225 | MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key", |
| 1226 | traffic_keys->client_write_key, |
| 1227 | traffic_keys->key_len); |
| 1228 | |
| 1229 | MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key", |
| 1230 | traffic_keys->server_write_key, |
| 1231 | traffic_keys->key_len); |
| 1232 | |
| 1233 | MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv", |
| 1234 | traffic_keys->client_write_iv, |
| 1235 | traffic_keys->iv_len); |
| 1236 | |
| 1237 | MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv", |
| 1238 | traffic_keys->server_write_iv, |
| 1239 | traffic_keys->iv_len); |
| 1240 | |
Jerry Yu | c068b66 | 2021-10-11 22:30:19 +0800 | [diff] [blame] | 1241 | MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) ); |
Jerry Yu | 61e35e0 | 2021-09-16 18:59:08 +0800 | [diff] [blame] | 1242 | |
| 1243 | exit: |
| 1244 | |
| 1245 | return( ret ); |
| 1246 | } |
| 1247 | |
Jerry Yu | f0ac235 | 2021-10-11 17:47:07 +0800 | [diff] [blame] | 1248 | int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl ) |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1249 | { |
Jerry Yu | f0ac235 | 2021-10-11 17:47:07 +0800 | [diff] [blame] | 1250 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
Przemyslaw Stekiel | c0824bf | 2022-02-10 10:37:15 +0100 | [diff] [blame] | 1251 | #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED) && defined(MBEDTLS_ECDH_C) |
| 1252 | psa_status_t status = PSA_ERROR_GENERIC_ERROR; |
| 1253 | #endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED && MBEDTLS_ECDH_C */ |
Jerry Yu | 5ccfcd4 | 2021-10-11 16:39:29 +0800 | [diff] [blame] | 1254 | mbedtls_ssl_handshake_params *handshake = ssl->handshake; |
Manuel Pégourié-Gonnard | abac037 | 2022-07-18 13:41:11 +0200 | [diff] [blame] | 1255 | psa_algorithm_t const hash_alg = mbedtls_hash_info_psa_from_md( |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1256 | handshake->ciphersuite_info->mac ); |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1257 | |
Jerry Yu | f0ac235 | 2021-10-11 17:47:07 +0800 | [diff] [blame] | 1258 | #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED) |
| 1259 | /* |
| 1260 | * Compute ECDHE secret used to compute the handshake secret from which |
| 1261 | * client_handshake_traffic_secret and server_handshake_traffic_secret |
| 1262 | * are derived in the handshake secret derivation stage. |
| 1263 | */ |
Ronald Cron | 7990771 | 2022-07-20 17:05:29 +0200 | [diff] [blame] | 1264 | if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) ) |
Jerry Yu | f0ac235 | 2021-10-11 17:47:07 +0800 | [diff] [blame] | 1265 | { |
| 1266 | if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) ) |
| 1267 | { |
| 1268 | #if defined(MBEDTLS_ECDH_C) |
Przemyslaw Stekiel | c0824bf | 2022-02-10 10:37:15 +0100 | [diff] [blame] | 1269 | /* Compute ECDH shared secret. */ |
| 1270 | status = psa_raw_key_agreement( |
| 1271 | PSA_ALG_ECDH, handshake->ecdh_psa_privkey, |
| 1272 | handshake->ecdh_psa_peerkey, handshake->ecdh_psa_peerkey_len, |
| 1273 | handshake->premaster, sizeof( handshake->premaster ), |
| 1274 | &handshake->pmslen ); |
| 1275 | if( status != PSA_SUCCESS ) |
| 1276 | { |
| 1277 | ret = psa_ssl_status_to_mbedtls( status ); |
| 1278 | MBEDTLS_SSL_DEBUG_RET( 1, "psa_raw_key_agreement", ret ); |
| 1279 | return( ret ); |
| 1280 | } |
| 1281 | |
| 1282 | status = psa_destroy_key( handshake->ecdh_psa_privkey ); |
| 1283 | if( status != PSA_SUCCESS ) |
| 1284 | { |
| 1285 | ret = psa_ssl_status_to_mbedtls( status ); |
| 1286 | MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret ); |
| 1287 | return( ret ); |
| 1288 | } |
| 1289 | |
| 1290 | handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT; |
Jerry Yu | f0ac235 | 2021-10-11 17:47:07 +0800 | [diff] [blame] | 1291 | #endif /* MBEDTLS_ECDH_C */ |
| 1292 | } |
| 1293 | else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) ) |
| 1294 | { |
Jerry Yu | f0ac235 | 2021-10-11 17:47:07 +0800 | [diff] [blame] | 1295 | MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) ); |
| 1296 | return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE ); |
| 1297 | } |
| 1298 | } |
| 1299 | #else |
| 1300 | return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE ); |
| 1301 | #endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */ |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1302 | |
| 1303 | /* |
Jerry Yu | f0ac235 | 2021-10-11 17:47:07 +0800 | [diff] [blame] | 1304 | * Compute the Handshake Secret |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1305 | */ |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1306 | ret = mbedtls_ssl_tls13_evolve_secret( hash_alg, |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 1307 | handshake->tls13_master_secrets.early, |
Przemyslaw Stekiel | c0824bf | 2022-02-10 10:37:15 +0100 | [diff] [blame] | 1308 | handshake->premaster, handshake->pmslen, |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 1309 | handshake->tls13_master_secrets.handshake ); |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1310 | if( ret != 0 ) |
| 1311 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1312 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret ); |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1313 | return( ret ); |
| 1314 | } |
| 1315 | |
| 1316 | MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret", |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1317 | handshake->tls13_master_secrets.handshake, |
| 1318 | PSA_HASH_LENGTH( hash_alg ) ); |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1319 | |
| 1320 | #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED) |
Przemyslaw Stekiel | c0824bf | 2022-02-10 10:37:15 +0100 | [diff] [blame] | 1321 | mbedtls_platform_zeroize( handshake->premaster, sizeof( handshake->premaster ) ); |
Jerry Yu | a0650eb | 2021-09-09 17:14:45 +0800 | [diff] [blame] | 1322 | #endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */ |
| 1323 | return( 0 ); |
| 1324 | } |
| 1325 | |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1326 | /* Generate application traffic keys since any records following a 1-RTT Finished message |
| 1327 | * MUST be encrypted under the application traffic key. |
| 1328 | */ |
XiaokangQian | d0aa3e9 | 2021-11-10 06:17:40 +0000 | [diff] [blame] | 1329 | int mbedtls_ssl_tls13_generate_application_keys( |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1330 | mbedtls_ssl_context *ssl, |
| 1331 | mbedtls_ssl_key_set *traffic_keys ) |
| 1332 | { |
XiaokangQian | a763498 | 2021-10-22 06:32:32 +0000 | [diff] [blame] | 1333 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 1334 | mbedtls_ssl_handshake_params *handshake = ssl->handshake; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1335 | |
| 1336 | /* Address at which to store the application secrets */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1337 | mbedtls_ssl_tls13_application_secrets * const app_secrets = |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1338 | &ssl->session_negotiate->app_secrets; |
| 1339 | |
| 1340 | /* Holding the transcript up to and including the ServerFinished */ |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 1341 | unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1342 | size_t transcript_len; |
| 1343 | |
| 1344 | /* Variables relating to the hash for the chosen ciphersuite. */ |
| 1345 | mbedtls_md_type_t md_type; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1346 | |
| 1347 | psa_algorithm_t hash_alg; |
| 1348 | size_t hash_len; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1349 | |
| 1350 | /* Variables relating to the cipher for the chosen ciphersuite. */ |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 1351 | size_t key_len, iv_len; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1352 | |
| 1353 | MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) ); |
| 1354 | |
| 1355 | /* Extract basic information about hash and ciphersuite */ |
| 1356 | |
Neil Armstrong | b818e16 | 2022-05-17 09:24:52 +0200 | [diff] [blame] | 1357 | ret = mbedtls_ssl_tls13_get_cipher_key_info( handshake->ciphersuite_info, |
| 1358 | &key_len, &iv_len ); |
| 1359 | if( ret != 0 ) |
Neil Armstrong | 4f4f271 | 2022-05-05 15:34:39 +0200 | [diff] [blame] | 1360 | { |
Neil Armstrong | b818e16 | 2022-05-17 09:24:52 +0200 | [diff] [blame] | 1361 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_get_cipher_key_info", ret ); |
Neil Armstrong | 4f4f271 | 2022-05-05 15:34:39 +0200 | [diff] [blame] | 1362 | goto cleanup; |
| 1363 | } |
| 1364 | |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 1365 | md_type = handshake->ciphersuite_info->mac; |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1366 | |
Manuel Pégourié-Gonnard | abac037 | 2022-07-18 13:41:11 +0200 | [diff] [blame] | 1367 | hash_alg = mbedtls_hash_info_psa_from_md( handshake->ciphersuite_info->mac ); |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1368 | hash_len = PSA_HASH_LENGTH( hash_alg ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1369 | |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 1370 | /* Compute current handshake transcript. It's the caller's responsibility |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1371 | * to call this at the right time, that is, after the ServerFinished. */ |
| 1372 | |
| 1373 | ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type, |
| 1374 | transcript, sizeof( transcript ), |
| 1375 | &transcript_len ); |
| 1376 | if( ret != 0 ) |
XiaokangQian | 4cab024 | 2021-10-12 08:43:37 +0000 | [diff] [blame] | 1377 | goto cleanup; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1378 | |
| 1379 | /* Compute application secrets from master secret and transcript hash. */ |
| 1380 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1381 | ret = mbedtls_ssl_tls13_derive_application_secrets( hash_alg, |
Xiaofei Bai | d25fab6 | 2021-12-02 06:36:27 +0000 | [diff] [blame] | 1382 | handshake->tls13_master_secrets.app, |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1383 | transcript, transcript_len, |
| 1384 | app_secrets ); |
| 1385 | if( ret != 0 ) |
| 1386 | { |
| 1387 | MBEDTLS_SSL_DEBUG_RET( 1, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1388 | "mbedtls_ssl_tls13_derive_application_secrets", ret ); |
XiaokangQian | 4cab024 | 2021-10-12 08:43:37 +0000 | [diff] [blame] | 1389 | goto cleanup; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1390 | } |
| 1391 | |
| 1392 | /* Derive first epoch of IV + Key for application traffic. */ |
| 1393 | |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1394 | ret = mbedtls_ssl_tls13_make_traffic_keys( hash_alg, |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1395 | app_secrets->client_application_traffic_secret_N, |
| 1396 | app_secrets->server_application_traffic_secret_N, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1397 | hash_len, key_len, iv_len, traffic_keys ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1398 | if( ret != 0 ) |
| 1399 | { |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1400 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret ); |
XiaokangQian | 4cab024 | 2021-10-12 08:43:37 +0000 | [diff] [blame] | 1401 | goto cleanup; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1402 | } |
| 1403 | |
| 1404 | MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret", |
| 1405 | app_secrets->client_application_traffic_secret_N, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1406 | hash_len ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1407 | |
| 1408 | MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret", |
| 1409 | app_secrets->server_application_traffic_secret_N, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1410 | hash_len ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1411 | |
XiaokangQian | ac0385c | 2021-11-03 06:40:11 +0000 | [diff] [blame] | 1412 | /* |
| 1413 | * Export client/server application traffic secret 0 |
| 1414 | */ |
| 1415 | if( ssl->f_export_keys != NULL ) |
| 1416 | { |
| 1417 | ssl->f_export_keys( ssl->p_export_keys, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1418 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1419 | app_secrets->client_application_traffic_secret_N, hash_len, |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 1420 | handshake->randbytes, |
lhuang04 | a3890a3 | 2022-01-04 09:47:20 -0800 | [diff] [blame] | 1421 | handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN, |
XiaokangQian | b51f884 | 2021-11-04 03:02:47 +0000 | [diff] [blame] | 1422 | MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by |
| 1423 | a new constant for TLS 1.3! */ ); |
XiaokangQian | ac0385c | 2021-11-03 06:40:11 +0000 | [diff] [blame] | 1424 | |
| 1425 | ssl->f_export_keys( ssl->p_export_keys, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1426 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET, |
Gabor Mezei | 07732f7 | 2022-03-26 17:04:19 +0100 | [diff] [blame] | 1427 | app_secrets->server_application_traffic_secret_N, hash_len, |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 1428 | handshake->randbytes, |
lhuang04 | a3890a3 | 2022-01-04 09:47:20 -0800 | [diff] [blame] | 1429 | handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN, |
XiaokangQian | b51f884 | 2021-11-04 03:02:47 +0000 | [diff] [blame] | 1430 | MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by |
| 1431 | a new constant for TLS 1.3! */ ); |
XiaokangQian | ac0385c | 2021-11-03 06:40:11 +0000 | [diff] [blame] | 1432 | } |
| 1433 | |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1434 | MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:", |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 1435 | traffic_keys->client_write_key, key_len ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1436 | MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key", |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 1437 | traffic_keys->server_write_key, key_len ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1438 | MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV", |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 1439 | traffic_keys->client_write_iv, iv_len ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1440 | MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV", |
Xiaofei Bai | b797284 | 2021-11-18 07:29:56 +0000 | [diff] [blame] | 1441 | traffic_keys->server_write_iv, iv_len ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1442 | |
| 1443 | MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) ); |
XiaokangQian | 4cab024 | 2021-10-12 08:43:37 +0000 | [diff] [blame] | 1444 | |
| 1445 | cleanup: |
Jerry Yu | 2c70a39 | 2021-12-08 13:28:49 +0800 | [diff] [blame] | 1446 | /* randbytes is not used again */ |
| 1447 | mbedtls_platform_zeroize( ssl->handshake->randbytes, |
| 1448 | sizeof( ssl->handshake->randbytes ) ); |
Jerry Yu | ef2b98a | 2022-05-06 16:40:05 +0800 | [diff] [blame] | 1449 | |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 1450 | mbedtls_platform_zeroize( transcript, sizeof( transcript ) ); |
XiaokangQian | 4cab024 | 2021-10-12 08:43:37 +0000 | [diff] [blame] | 1451 | return( ret ); |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1452 | } |
| 1453 | |
Jerry Yu | f86eb75 | 2022-05-06 11:16:55 +0800 | [diff] [blame] | 1454 | int mbedtls_ssl_tls13_compute_handshake_transform( mbedtls_ssl_context *ssl ) |
Jerry Yu | e110d25 | 2022-05-05 10:19:22 +0800 | [diff] [blame] | 1455 | { |
Jerry Yu | ef2b98a | 2022-05-06 16:40:05 +0800 | [diff] [blame] | 1456 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
Jerry Yu | e110d25 | 2022-05-05 10:19:22 +0800 | [diff] [blame] | 1457 | mbedtls_ssl_key_set traffic_keys; |
| 1458 | mbedtls_ssl_transform *transform_handshake = NULL; |
| 1459 | mbedtls_ssl_handshake_params *handshake = ssl->handshake; |
| 1460 | |
| 1461 | /* Compute handshake secret */ |
| 1462 | ret = mbedtls_ssl_tls13_key_schedule_stage_handshake( ssl ); |
| 1463 | if( ret != 0 ) |
| 1464 | { |
| 1465 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_master_secret", ret ); |
| 1466 | goto cleanup; |
| 1467 | } |
| 1468 | |
| 1469 | /* Next evolution in key schedule: Establish handshake secret and |
| 1470 | * key material. */ |
| 1471 | ret = mbedtls_ssl_tls13_generate_handshake_keys( ssl, &traffic_keys ); |
| 1472 | if( ret != 0 ) |
| 1473 | { |
| 1474 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_generate_handshake_keys", |
| 1475 | ret ); |
| 1476 | goto cleanup; |
| 1477 | } |
| 1478 | |
| 1479 | transform_handshake = mbedtls_calloc( 1, sizeof( mbedtls_ssl_transform ) ); |
| 1480 | if( transform_handshake == NULL ) |
| 1481 | { |
| 1482 | ret = MBEDTLS_ERR_SSL_ALLOC_FAILED; |
| 1483 | goto cleanup; |
| 1484 | } |
| 1485 | |
Jerry Yu | ef2b98a | 2022-05-06 16:40:05 +0800 | [diff] [blame] | 1486 | ret = mbedtls_ssl_tls13_populate_transform( |
| 1487 | transform_handshake, |
| 1488 | ssl->conf->endpoint, |
| 1489 | ssl->session_negotiate->ciphersuite, |
| 1490 | &traffic_keys, |
| 1491 | ssl ); |
Jerry Yu | e110d25 | 2022-05-05 10:19:22 +0800 | [diff] [blame] | 1492 | if( ret != 0 ) |
| 1493 | { |
| 1494 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_populate_transform", ret ); |
| 1495 | goto cleanup; |
| 1496 | } |
| 1497 | handshake->transform_handshake = transform_handshake; |
| 1498 | |
| 1499 | cleanup: |
| 1500 | mbedtls_platform_zeroize( &traffic_keys, sizeof( traffic_keys ) ); |
| 1501 | if( ret != 0 ) |
Jerry Yu | e110d25 | 2022-05-05 10:19:22 +0800 | [diff] [blame] | 1502 | mbedtls_free( transform_handshake ); |
Jerry Yu | e110d25 | 2022-05-05 10:19:22 +0800 | [diff] [blame] | 1503 | |
| 1504 | return( ret ); |
| 1505 | } |
| 1506 | |
Jerry Yu | ff22698 | 2022-04-16 16:52:57 +0800 | [diff] [blame] | 1507 | int mbedtls_ssl_tls13_generate_resumption_master_secret( |
| 1508 | mbedtls_ssl_context *ssl ) |
| 1509 | { |
| 1510 | /* Erase master secrets */ |
| 1511 | mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets, |
| 1512 | sizeof( ssl->handshake->tls13_master_secrets ) ); |
| 1513 | return( 0 ); |
| 1514 | } |
| 1515 | |
Jerry Yu | fd5ea04 | 2022-05-19 14:29:48 +0800 | [diff] [blame] | 1516 | int mbedtls_ssl_tls13_compute_application_transform( mbedtls_ssl_context *ssl ) |
| 1517 | { |
| 1518 | int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED; |
| 1519 | mbedtls_ssl_key_set traffic_keys; |
| 1520 | mbedtls_ssl_transform *transform_application = NULL; |
| 1521 | |
| 1522 | ret = mbedtls_ssl_tls13_key_schedule_stage_application( ssl ); |
| 1523 | if( ret != 0 ) |
| 1524 | { |
| 1525 | MBEDTLS_SSL_DEBUG_RET( 1, |
| 1526 | "mbedtls_ssl_tls13_key_schedule_stage_application", ret ); |
| 1527 | goto cleanup; |
| 1528 | } |
| 1529 | |
| 1530 | ret = mbedtls_ssl_tls13_generate_application_keys( ssl, &traffic_keys ); |
| 1531 | if( ret != 0 ) |
| 1532 | { |
| 1533 | MBEDTLS_SSL_DEBUG_RET( 1, |
| 1534 | "mbedtls_ssl_tls13_generate_application_keys", ret ); |
| 1535 | goto cleanup; |
| 1536 | } |
| 1537 | |
| 1538 | transform_application = |
| 1539 | mbedtls_calloc( 1, sizeof( mbedtls_ssl_transform ) ); |
| 1540 | if( transform_application == NULL ) |
| 1541 | { |
| 1542 | ret = MBEDTLS_ERR_SSL_ALLOC_FAILED; |
| 1543 | goto cleanup; |
| 1544 | } |
| 1545 | |
| 1546 | ret = mbedtls_ssl_tls13_populate_transform( |
| 1547 | transform_application, |
| 1548 | ssl->conf->endpoint, |
| 1549 | ssl->session_negotiate->ciphersuite, |
| 1550 | &traffic_keys, |
| 1551 | ssl ); |
| 1552 | if( ret != 0 ) |
| 1553 | { |
| 1554 | MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_populate_transform", ret ); |
| 1555 | goto cleanup; |
| 1556 | } |
| 1557 | |
| 1558 | ssl->transform_application = transform_application; |
| 1559 | |
| 1560 | cleanup: |
| 1561 | |
| 1562 | mbedtls_platform_zeroize( &traffic_keys, sizeof( traffic_keys ) ); |
| 1563 | if( ret != 0 ) |
| 1564 | { |
| 1565 | mbedtls_free( transform_application ); |
| 1566 | } |
| 1567 | return( ret ); |
| 1568 | } |
| 1569 | |
Jerry Yu | 01e42d2 | 2022-08-21 12:55:51 +0800 | [diff] [blame^] | 1570 | #if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED) |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1571 | int mbedtls_ssl_tls13_export_handshake_psk( mbedtls_ssl_context *ssl, |
| 1572 | unsigned char **psk, |
| 1573 | size_t *psk_len ) |
| 1574 | { |
Jerry Yu | 01e42d2 | 2022-08-21 12:55:51 +0800 | [diff] [blame^] | 1575 | |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1576 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 1577 | psa_key_attributes_t key_attributes = PSA_KEY_ATTRIBUTES_INIT; |
| 1578 | psa_status_t status; |
| 1579 | |
| 1580 | *psk_len = 0; |
| 1581 | *psk = NULL; |
| 1582 | |
| 1583 | if( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) ) |
Jerry Yu | 01e42d2 | 2022-08-21 12:55:51 +0800 | [diff] [blame^] | 1584 | return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED ); |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1585 | |
| 1586 | status = psa_get_key_attributes( ssl->handshake->psk_opaque, &key_attributes ); |
Jerry Yu | 6cf6b47 | 2022-08-16 14:50:28 +0800 | [diff] [blame] | 1587 | if( status != PSA_SUCCESS ) |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1588 | { |
| 1589 | return( psa_ssl_status_to_mbedtls( status ) ); |
| 1590 | } |
| 1591 | |
| 1592 | *psk_len = PSA_BITS_TO_BYTES( psa_get_key_bits( &key_attributes ) ); |
| 1593 | *psk = mbedtls_calloc( 1, *psk_len ); |
| 1594 | if( *psk == NULL ) |
| 1595 | { |
| 1596 | return( MBEDTLS_ERR_SSL_ALLOC_FAILED ); |
| 1597 | } |
| 1598 | |
| 1599 | status = psa_export_key( ssl->handshake->psk_opaque, |
| 1600 | (uint8_t *)*psk, *psk_len, psk_len ); |
Jerry Yu | 6cf6b47 | 2022-08-16 14:50:28 +0800 | [diff] [blame] | 1601 | if( status != PSA_SUCCESS ) |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1602 | { |
| 1603 | mbedtls_free( (void *)*psk ); |
Jerry Yu | 5d01c05 | 2022-08-17 10:18:10 +0800 | [diff] [blame] | 1604 | *psk = NULL; |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1605 | return( psa_ssl_status_to_mbedtls( status ) ); |
| 1606 | } |
Jerry Yu | 5d01c05 | 2022-08-17 10:18:10 +0800 | [diff] [blame] | 1607 | return( 0 ); |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1608 | #else |
| 1609 | *psk = ssl->handshake->psk; |
| 1610 | *psk_len = ssl->handshake->psk_len; |
Jerry Yu | 5d01c05 | 2022-08-17 10:18:10 +0800 | [diff] [blame] | 1611 | if( *psk == NULL ) |
| 1612 | return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED ); |
| 1613 | return( 0 ); |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1614 | #endif /* !MBEDTLS_USE_PSA_CRYPTO */ |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1615 | } |
Jerry Yu | 01e42d2 | 2022-08-21 12:55:51 +0800 | [diff] [blame^] | 1616 | #endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */ |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1617 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1618 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Jerry Yu | 40f3771 | 2022-07-26 16:58:57 +0800 | [diff] [blame] | 1619 | |