Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1 | /** |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 2 | * \file ssl_internal.h |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 3 | * |
| 4 | * \brief Internal functions shared by the SSL modules |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 5 | */ |
| 6 | /* |
Manuel Pégourié-Gonnard | 6fb8187 | 2015-07-27 11:11:48 +0200 | [diff] [blame] | 7 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 8 | * SPDX-License-Identifier: Apache-2.0 |
| 9 | * |
| 10 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 11 | * not use this file except in compliance with the License. |
| 12 | * You may obtain a copy of the License at |
| 13 | * |
| 14 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 15 | * |
| 16 | * Unless required by applicable law or agreed to in writing, software |
| 17 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 18 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 19 | * See the License for the specific language governing permissions and |
| 20 | * limitations under the License. |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 21 | * |
| 22 | * This file is part of mbed TLS (https://tls.mbed.org) |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 23 | */ |
| 24 | #ifndef MBEDTLS_SSL_INTERNAL_H |
| 25 | #define MBEDTLS_SSL_INTERNAL_H |
| 26 | |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 27 | #if !defined(MBEDTLS_CONFIG_FILE) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 28 | #include "mbedtls/config.h" |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 29 | #else |
| 30 | #include MBEDTLS_CONFIG_FILE |
| 31 | #endif |
| 32 | |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 33 | #include "mbedtls/ssl.h" |
| 34 | #include "mbedtls/cipher.h" |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 35 | |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 36 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 37 | #include "psa/crypto.h" |
| 38 | #endif |
| 39 | |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 40 | #if defined(MBEDTLS_MD5_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 41 | #include "mbedtls/md5.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 42 | #endif |
| 43 | |
| 44 | #if defined(MBEDTLS_SHA1_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 45 | #include "mbedtls/sha1.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 46 | #endif |
| 47 | |
| 48 | #if defined(MBEDTLS_SHA256_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 49 | #include "mbedtls/sha256.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 50 | #endif |
| 51 | |
| 52 | #if defined(MBEDTLS_SHA512_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 53 | #include "mbedtls/sha512.h" |
Manuel Pégourié-Gonnard | 56273da | 2015-05-26 12:19:45 +0200 | [diff] [blame] | 54 | #endif |
| 55 | |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 56 | #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 57 | #include "mbedtls/ecjpake.h" |
Manuel Pégourié-Gonnard | 76cfd3f | 2015-09-15 12:10:54 +0200 | [diff] [blame] | 58 | #endif |
| 59 | |
Hanno Becker | df51dbe | 2019-02-18 16:41:55 +0000 | [diff] [blame] | 60 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 61 | #include "psa/crypto.h" |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 62 | #include "mbedtls/psa_util.h" |
Hanno Becker | df51dbe | 2019-02-18 16:41:55 +0000 | [diff] [blame] | 63 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 64 | |
Manuel Pégourié-Gonnard | 0223ab9 | 2015-10-05 11:40:01 +0100 | [diff] [blame] | 65 | #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \ |
| 66 | !defined(inline) && !defined(__cplusplus) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 67 | #define inline __inline |
Manuel Pégourié-Gonnard | 20af64d | 2015-07-07 18:33:39 +0200 | [diff] [blame] | 68 | #endif |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 69 | |
| 70 | /* Determine minimum supported version */ |
| 71 | #define MBEDTLS_SSL_MIN_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3 |
| 72 | |
| 73 | #if defined(MBEDTLS_SSL_PROTO_SSL3) |
| 74 | #define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0 |
| 75 | #else |
| 76 | #if defined(MBEDTLS_SSL_PROTO_TLS1) |
| 77 | #define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1 |
| 78 | #else |
| 79 | #if defined(MBEDTLS_SSL_PROTO_TLS1_1) |
| 80 | #define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2 |
| 81 | #else |
| 82 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
| 83 | #define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3 |
| 84 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 85 | #endif /* MBEDTLS_SSL_PROTO_TLS1_1 */ |
| 86 | #endif /* MBEDTLS_SSL_PROTO_TLS1 */ |
| 87 | #endif /* MBEDTLS_SSL_PROTO_SSL3 */ |
| 88 | |
Ron Eldor | 5e9f14d | 2017-05-28 10:46:38 +0300 | [diff] [blame] | 89 | #define MBEDTLS_SSL_MIN_VALID_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1 |
| 90 | #define MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3 |
| 91 | |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 92 | /* Determine maximum supported version */ |
| 93 | #define MBEDTLS_SSL_MAX_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3 |
| 94 | |
| 95 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
| 96 | #define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3 |
| 97 | #else |
| 98 | #if defined(MBEDTLS_SSL_PROTO_TLS1_1) |
| 99 | #define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2 |
| 100 | #else |
| 101 | #if defined(MBEDTLS_SSL_PROTO_TLS1) |
| 102 | #define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1 |
| 103 | #else |
| 104 | #if defined(MBEDTLS_SSL_PROTO_SSL3) |
| 105 | #define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0 |
| 106 | #endif /* MBEDTLS_SSL_PROTO_SSL3 */ |
| 107 | #endif /* MBEDTLS_SSL_PROTO_TLS1 */ |
| 108 | #endif /* MBEDTLS_SSL_PROTO_TLS1_1 */ |
| 109 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 110 | |
Manuel Pégourié-Gonnard | 862cde5 | 2017-05-17 11:56:15 +0200 | [diff] [blame] | 111 | /* Shorthand for restartable ECC */ |
Manuel Pégourié-Gonnard | 2350b4e | 2017-05-16 09:26:48 +0200 | [diff] [blame] | 112 | #if defined(MBEDTLS_ECP_RESTARTABLE) && \ |
| 113 | defined(MBEDTLS_SSL_CLI_C) && \ |
| 114 | defined(MBEDTLS_SSL_PROTO_TLS1_2) && \ |
| 115 | defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) |
| 116 | #define MBEDTLS_SSL__ECP_RESTARTABLE |
| 117 | #endif |
| 118 | |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 119 | #define MBEDTLS_SSL_INITIAL_HANDSHAKE 0 |
| 120 | #define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */ |
| 121 | #define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */ |
| 122 | #define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */ |
| 123 | |
| 124 | /* |
| 125 | * DTLS retransmission states, see RFC 6347 4.2.4 |
| 126 | * |
| 127 | * The SENDING state is merged in PREPARING for initial sends, |
| 128 | * but is distinct for resends. |
| 129 | * |
| 130 | * Note: initial state is wrong for server, but is not used anyway. |
| 131 | */ |
| 132 | #define MBEDTLS_SSL_RETRANS_PREPARING 0 |
| 133 | #define MBEDTLS_SSL_RETRANS_SENDING 1 |
| 134 | #define MBEDTLS_SSL_RETRANS_WAITING 2 |
| 135 | #define MBEDTLS_SSL_RETRANS_FINISHED 3 |
| 136 | |
| 137 | /* |
| 138 | * Allow extra bytes for record, authentication and encryption overhead: |
| 139 | * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256) |
| 140 | * and allow for a maximum of 1024 of compression expansion if |
| 141 | * enabled. |
| 142 | */ |
| 143 | #if defined(MBEDTLS_ZLIB_SUPPORT) |
| 144 | #define MBEDTLS_SSL_COMPRESSION_ADD 1024 |
| 145 | #else |
| 146 | #define MBEDTLS_SSL_COMPRESSION_ADD 0 |
| 147 | #endif |
| 148 | |
Hanno Becker | 52344c2 | 2018-01-03 15:24:20 +0000 | [diff] [blame] | 149 | #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \ |
| 150 | ( defined(MBEDTLS_CIPHER_MODE_CBC) && \ |
| 151 | ( defined(MBEDTLS_AES_C) || \ |
| 152 | defined(MBEDTLS_CAMELLIA_C) || \ |
Hanno Becker | 34f88af | 2018-07-17 10:19:47 +0100 | [diff] [blame] | 153 | defined(MBEDTLS_ARIA_C) || \ |
| 154 | defined(MBEDTLS_DES_C) ) ) |
Hanno Becker | 52344c2 | 2018-01-03 15:24:20 +0000 | [diff] [blame] | 155 | #define MBEDTLS_SSL_SOME_MODES_USE_MAC |
| 156 | #endif |
| 157 | |
| 158 | #if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 159 | /* Ciphersuites using HMAC */ |
| 160 | #if defined(MBEDTLS_SHA512_C) |
| 161 | #define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */ |
| 162 | #elif defined(MBEDTLS_SHA256_C) |
| 163 | #define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */ |
| 164 | #else |
| 165 | #define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */ |
| 166 | #endif |
Hanno Becker | 52344c2 | 2018-01-03 15:24:20 +0000 | [diff] [blame] | 167 | #else /* MBEDTLS_SSL_SOME_MODES_USE_MAC */ |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 168 | /* AEAD ciphersuites: GCM and CCM use a 128 bits tag */ |
| 169 | #define MBEDTLS_SSL_MAC_ADD 16 |
| 170 | #endif |
| 171 | |
| 172 | #if defined(MBEDTLS_CIPHER_MODE_CBC) |
| 173 | #define MBEDTLS_SSL_PADDING_ADD 256 |
| 174 | #else |
| 175 | #define MBEDTLS_SSL_PADDING_ADD 0 |
| 176 | #endif |
| 177 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 178 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | b1aa1b3 | 2019-05-08 17:37:58 +0100 | [diff] [blame] | 179 | #define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_PADDING_GRANULARITY |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 180 | #else |
| 181 | #define MBEDTLS_SSL_MAX_CID_EXPANSION 0 |
| 182 | #endif |
| 183 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 184 | #define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_SSL_COMPRESSION_ADD + \ |
| 185 | MBEDTLS_MAX_IV_LENGTH + \ |
| 186 | MBEDTLS_SSL_MAC_ADD + \ |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 187 | MBEDTLS_SSL_PADDING_ADD + \ |
| 188 | MBEDTLS_SSL_MAX_CID_EXPANSION \ |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 189 | ) |
| 190 | |
| 191 | #define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \ |
| 192 | ( MBEDTLS_SSL_IN_CONTENT_LEN ) ) |
| 193 | |
| 194 | #define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \ |
| 195 | ( MBEDTLS_SSL_OUT_CONTENT_LEN ) ) |
| 196 | |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 197 | /* The maximum number of buffered handshake messages. */ |
Hanno Becker | d488b9e | 2018-08-16 16:35:37 +0100 | [diff] [blame] | 198 | #define MBEDTLS_SSL_MAX_BUFFERED_HS 4 |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 199 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 200 | /* Maximum length we can advertise as our max content length for |
| 201 | RFC 6066 max_fragment_length extension negotiation purposes |
| 202 | (the lesser of both sizes, if they are unequal.) |
| 203 | */ |
| 204 | #define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \ |
| 205 | (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \ |
| 206 | ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \ |
| 207 | : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \ |
| 208 | ) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 209 | |
| 210 | /* |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 211 | * Check that we obey the standard's message size bounds |
| 212 | */ |
| 213 | |
| 214 | #if MBEDTLS_SSL_MAX_CONTENT_LEN > 16384 |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 215 | #error "Bad configuration - record content too large." |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 216 | #endif |
| 217 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 218 | #if MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN |
| 219 | #error "Bad configuration - incoming record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN." |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 220 | #endif |
| 221 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 222 | #if MBEDTLS_SSL_OUT_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN |
| 223 | #error "Bad configuration - outgoing record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN." |
| 224 | #endif |
| 225 | |
| 226 | #if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048 |
| 227 | #error "Bad configuration - incoming protected record payload too large." |
| 228 | #endif |
| 229 | |
| 230 | #if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048 |
| 231 | #error "Bad configuration - outgoing protected record payload too large." |
| 232 | #endif |
| 233 | |
| 234 | /* Calculate buffer sizes */ |
| 235 | |
Hanno Becker | 25d6d1a | 2017-12-07 08:22:51 +0000 | [diff] [blame] | 236 | /* Note: Even though the TLS record header is only 5 bytes |
| 237 | long, we're internally using 8 bytes to store the |
| 238 | implicit sequence number. */ |
Hanno Becker | d25d444 | 2017-10-04 13:56:42 +0100 | [diff] [blame] | 239 | #define MBEDTLS_SSL_HEADER_LEN 13 |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 240 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 241 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 242 | #define MBEDTLS_SSL_IN_BUFFER_LEN \ |
| 243 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) ) |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 244 | #else |
| 245 | #define MBEDTLS_SSL_IN_BUFFER_LEN \ |
| 246 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \ |
| 247 | + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) ) |
| 248 | #endif |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 249 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 250 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 251 | #define MBEDTLS_SSL_OUT_BUFFER_LEN \ |
| 252 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) ) |
Hanno Becker | 6cbad55 | 2019-05-08 15:40:11 +0100 | [diff] [blame] | 253 | #else |
| 254 | #define MBEDTLS_SSL_OUT_BUFFER_LEN \ |
| 255 | ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \ |
| 256 | + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) ) |
| 257 | #endif |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 258 | |
| 259 | #ifdef MBEDTLS_ZLIB_SUPPORT |
| 260 | /* Compression buffer holds both IN and OUT buffers, so should be size of the larger */ |
| 261 | #define MBEDTLS_SSL_COMPRESS_BUFFER_LEN ( \ |
| 262 | ( MBEDTLS_SSL_IN_BUFFER_LEN > MBEDTLS_SSL_OUT_BUFFER_LEN ) \ |
| 263 | ? MBEDTLS_SSL_IN_BUFFER_LEN \ |
| 264 | : MBEDTLS_SSL_OUT_BUFFER_LEN \ |
| 265 | ) |
| 266 | #endif |
Hanno Becker | a8434e8 | 2017-09-18 10:54:39 +0100 | [diff] [blame] | 267 | |
| 268 | /* |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 269 | * TLS extension flags (for extensions with outgoing ServerHello content |
| 270 | * that need it (e.g. for RENEGOTIATION_INFO the server already knows because |
| 271 | * of state of the renegotiation flag, so no indicator is required) |
| 272 | */ |
| 273 | #define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0) |
Manuel Pégourié-Gonnard | bf57be6 | 2015-09-16 15:04:01 +0200 | [diff] [blame] | 274 | #define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1) |
Manuel Pégourié-Gonnard | 065122c | 2015-05-26 12:31:46 +0200 | [diff] [blame] | 275 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 276 | #ifdef __cplusplus |
| 277 | extern "C" { |
| 278 | #endif |
| 279 | |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 280 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \ |
| 281 | defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) |
| 282 | /* |
| 283 | * Abstraction for a grid of allowed signature-hash-algorithm pairs. |
| 284 | */ |
| 285 | struct mbedtls_ssl_sig_hash_set_t |
| 286 | { |
| 287 | /* At the moment, we only need to remember a single suitable |
| 288 | * hash algorithm per signature algorithm. As long as that's |
| 289 | * the case - and we don't need a general lookup function - |
| 290 | * we can implement the sig-hash-set as a map from signatures |
| 291 | * to hash algorithms. */ |
| 292 | mbedtls_md_type_t rsa; |
| 293 | mbedtls_md_type_t ecdsa; |
| 294 | }; |
| 295 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 && |
| 296 | MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */ |
| 297 | |
Ron Eldor | 51d3ab5 | 2019-05-12 14:54:30 +0300 | [diff] [blame] | 298 | typedef int mbedtls_ssl_tls_prf_cb( const unsigned char *secret, size_t slen, |
| 299 | const char *label, |
| 300 | const unsigned char *random, size_t rlen, |
| 301 | unsigned char *dstbuf, size_t dlen ); |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 302 | /* |
| 303 | * This structure contains the parameters only needed during handshake. |
| 304 | */ |
| 305 | struct mbedtls_ssl_handshake_params |
| 306 | { |
| 307 | /* |
| 308 | * Handshake specific crypto variables |
| 309 | */ |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 310 | |
| 311 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \ |
| 312 | defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) |
| 313 | mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */ |
| 314 | #endif |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 315 | #if defined(MBEDTLS_DHM_C) |
| 316 | mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */ |
| 317 | #endif |
| 318 | #if defined(MBEDTLS_ECDH_C) |
| 319 | mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */ |
Hanno Becker | df51dbe | 2019-02-18 16:41:55 +0000 | [diff] [blame] | 320 | |
| 321 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Gilles Peskine | 4245980 | 2019-12-19 13:31:53 +0100 | [diff] [blame] | 322 | psa_key_type_t ecdh_psa_type; |
| 323 | uint16_t ecdh_bits; |
Hanno Becker | df51dbe | 2019-02-18 16:41:55 +0000 | [diff] [blame] | 324 | psa_key_handle_t ecdh_psa_privkey; |
| 325 | unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH]; |
| 326 | size_t ecdh_psa_peerkey_len; |
| 327 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 328 | #endif /* MBEDTLS_ECDH_C */ |
| 329 | |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 330 | #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
Manuel Pégourié-Gonnard | 76cfd3f | 2015-09-15 12:10:54 +0200 | [diff] [blame] | 331 | mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */ |
Manuel Pégourié-Gonnard | 77c0646 | 2015-09-17 13:59:49 +0200 | [diff] [blame] | 332 | #if defined(MBEDTLS_SSL_CLI_C) |
| 333 | unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */ |
| 334 | size_t ecjpake_cache_len; /*!< Length of cached data */ |
| 335 | #endif |
Hanno Becker | 1aa267c | 2017-04-28 17:08:27 +0100 | [diff] [blame] | 336 | #endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */ |
Manuel Pégourié-Gonnard | f472179 | 2015-09-15 10:53:51 +0200 | [diff] [blame] | 337 | #if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \ |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 338 | defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 339 | const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */ |
| 340 | #endif |
| 341 | #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED) |
Hanno Becker | d9f7d43 | 2018-10-22 15:29:46 +0100 | [diff] [blame] | 342 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Andrzej Kurek | 2349c4d | 2019-01-08 09:36:01 -0500 | [diff] [blame] | 343 | psa_key_handle_t psk_opaque; /*!< Opaque PSK from the callback */ |
Hanno Becker | d9f7d43 | 2018-10-22 15:29:46 +0100 | [diff] [blame] | 344 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 345 | unsigned char *psk; /*!< PSK from the callback */ |
| 346 | size_t psk_len; /*!< Length of PSK from callback */ |
Hanno Becker | d9f7d43 | 2018-10-22 15:29:46 +0100 | [diff] [blame] | 347 | #endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 348 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 349 | mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */ |
| 350 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) |
Manuel Pégourié-Gonnard | cdc26ae | 2015-06-19 12:16:31 +0200 | [diff] [blame] | 351 | int sni_authmode; /*!< authmode from SNI callback */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 352 | mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */ |
| 353 | mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */ |
| 354 | mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */ |
Hanno Becker | 1aa267c | 2017-04-28 17:08:27 +0100 | [diff] [blame] | 355 | #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 356 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Manuel Pégourié-Gonnard | 2350b4e | 2017-05-16 09:26:48 +0200 | [diff] [blame] | 357 | #if defined(MBEDTLS_SSL__ECP_RESTARTABLE) |
Manuel Pégourié-Gonnard | d27d1a5 | 2017-08-15 11:49:08 +0200 | [diff] [blame] | 358 | int ecrs_enabled; /*!< Handshake supports EC restart? */ |
Manuel Pégourié-Gonnard | 6b7301c | 2017-08-15 12:08:45 +0200 | [diff] [blame] | 359 | mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */ |
Manuel Pégourié-Gonnard | 0b23f16 | 2017-08-24 12:08:33 +0200 | [diff] [blame] | 360 | enum { /* this complements ssl->state with info on intra-state operations */ |
| 361 | ssl_ecrs_none = 0, /*!< nothing going on (yet) */ |
| 362 | ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */ |
Manuel Pégourié-Gonnard | c37423f | 2018-10-16 10:28:17 +0200 | [diff] [blame] | 363 | ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */ |
| 364 | ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */ |
Manuel Pégourié-Gonnard | 0b23f16 | 2017-08-24 12:08:33 +0200 | [diff] [blame] | 365 | ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */ |
| 366 | } ecrs_state; /*!< current (or last) operation */ |
Hanno Becker | 3fd3f5e | 2019-02-25 10:08:06 +0000 | [diff] [blame] | 367 | mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */ |
Manuel Pégourié-Gonnard | 0b23f16 | 2017-08-24 12:08:33 +0200 | [diff] [blame] | 368 | size_t ecrs_n; /*!< place for saving a length */ |
Manuel Pégourié-Gonnard | 2350b4e | 2017-05-16 09:26:48 +0200 | [diff] [blame] | 369 | #endif |
Hanno Becker | 7517312 | 2019-02-06 16:18:31 +0000 | [diff] [blame] | 370 | #if defined(MBEDTLS_X509_CRT_PARSE_C) && \ |
| 371 | !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE) |
| 372 | mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */ |
| 373 | #endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 374 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 375 | unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */ |
| 376 | unsigned int in_msg_seq; /*!< Incoming handshake sequence number */ |
| 377 | |
| 378 | unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie |
| 379 | Srv: unused */ |
| 380 | unsigned char verify_cookie_len; /*!< Cli: cookie length |
| 381 | Srv: flag for sending a cookie */ |
| 382 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 383 | uint32_t retransmit_timeout; /*!< Current value of timeout */ |
| 384 | unsigned char retransmit_state; /*!< Retransmission state */ |
Manuel Pégourié-Gonnard | 28f4bea | 2017-09-13 14:00:05 +0200 | [diff] [blame] | 385 | mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */ |
| 386 | mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */ |
| 387 | unsigned char *cur_msg_p; /*!< Position in current message */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 388 | unsigned int in_flight_start_seq; /*!< Minimum message sequence in the |
| 389 | flight being received */ |
| 390 | mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for |
| 391 | resending messages */ |
| 392 | unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter |
| 393 | for resending messages */ |
Hanno Becker | 2ed6bcc | 2018-08-15 15:11:57 +0100 | [diff] [blame] | 394 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 395 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | 2f28c10 | 2019-04-25 15:46:59 +0100 | [diff] [blame] | 396 | /* The state of CID configuration in this handshake. */ |
| 397 | |
| 398 | uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension |
Hanno Becker | f1a2808 | 2019-05-15 10:17:48 +0100 | [diff] [blame] | 399 | * has been negotiated. Possible values are |
Hanno Becker | 2f28c10 | 2019-04-25 15:46:59 +0100 | [diff] [blame] | 400 | * #MBEDTLS_SSL_CID_ENABLED and |
| 401 | * #MBEDTLS_SSL_CID_DISABLED. */ |
| 402 | unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */ |
| 403 | uint8_t peer_cid_len; /*!< The length of |
| 404 | * \c peer_cid. */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 405 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | 2f28c10 | 2019-04-25 15:46:59 +0100 | [diff] [blame] | 406 | |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 407 | struct |
| 408 | { |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 409 | size_t total_bytes_buffered; /*!< Cumulative size of heap allocated |
| 410 | * buffers used for message buffering. */ |
| 411 | |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 412 | uint8_t seen_ccs; /*!< Indicates if a CCS message has |
Hanno Becker | 2ed6bcc | 2018-08-15 15:11:57 +0100 | [diff] [blame] | 413 | * been seen in the current flight. */ |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 414 | |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 415 | struct mbedtls_ssl_hs_buffer |
| 416 | { |
Hanno Becker | 98081a0 | 2018-08-22 13:32:50 +0100 | [diff] [blame] | 417 | unsigned is_valid : 1; |
| 418 | unsigned is_fragmented : 1; |
| 419 | unsigned is_complete : 1; |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 420 | unsigned char *data; |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 421 | size_t data_len; |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 422 | } hs[MBEDTLS_SSL_MAX_BUFFERED_HS]; |
| 423 | |
Hanno Becker | 5f066e7 | 2018-08-16 14:56:31 +0100 | [diff] [blame] | 424 | struct |
| 425 | { |
| 426 | unsigned char *data; |
| 427 | size_t len; |
| 428 | unsigned epoch; |
| 429 | } future_record; |
| 430 | |
Hanno Becker | d7f8ae2 | 2018-08-16 09:45:56 +0100 | [diff] [blame] | 431 | } buffering; |
Hanno Becker | 3546201 | 2018-08-22 10:25:40 +0100 | [diff] [blame] | 432 | |
Manuel Pégourié-Gonnard | f47a4af | 2018-08-22 10:38:52 +0200 | [diff] [blame] | 433 | uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */ |
Hanno Becker | 1aa267c | 2017-04-28 17:08:27 +0100 | [diff] [blame] | 434 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 435 | |
| 436 | /* |
| 437 | * Checksum contexts |
| 438 | */ |
| 439 | #if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \ |
| 440 | defined(MBEDTLS_SSL_PROTO_TLS1_1) |
| 441 | mbedtls_md5_context fin_md5; |
| 442 | mbedtls_sha1_context fin_sha1; |
| 443 | #endif |
| 444 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
| 445 | #if defined(MBEDTLS_SHA256_C) |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 446 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 447 | psa_hash_operation_t fin_sha256_psa; |
| 448 | #else |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 449 | mbedtls_sha256_context fin_sha256; |
| 450 | #endif |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 451 | #endif |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 452 | #if defined(MBEDTLS_SHA512_C) |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 453 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Andrzej Kurek | 972fba5 | 2019-01-30 03:29:12 -0500 | [diff] [blame] | 454 | psa_hash_operation_t fin_sha384_psa; |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 455 | #else |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 456 | mbedtls_sha512_context fin_sha512; |
| 457 | #endif |
Andrzej Kurek | eb34224 | 2019-01-29 09:14:33 -0500 | [diff] [blame] | 458 | #endif |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 459 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 460 | |
| 461 | void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t); |
Manuel Pégourié-Gonnard | de718b9 | 2019-05-03 11:43:28 +0200 | [diff] [blame] | 462 | void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *); |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 463 | void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int); |
Ron Eldor | 51d3ab5 | 2019-05-12 14:54:30 +0300 | [diff] [blame] | 464 | mbedtls_ssl_tls_prf_cb *tls_prf; |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 465 | |
Hanno Becker | e694c3e | 2017-12-27 21:34:08 +0000 | [diff] [blame] | 466 | mbedtls_ssl_ciphersuite_t const *ciphersuite_info; |
| 467 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 468 | size_t pmslen; /*!< premaster length */ |
| 469 | |
| 470 | unsigned char randbytes[64]; /*!< random bytes */ |
| 471 | unsigned char premaster[MBEDTLS_PREMASTER_SIZE]; |
| 472 | /*!< premaster secret */ |
| 473 | |
| 474 | int resume; /*!< session resume indicator*/ |
| 475 | int max_major_ver; /*!< max. major version client*/ |
| 476 | int max_minor_ver; /*!< max. minor version client*/ |
| 477 | int cli_exts; /*!< client extension presence*/ |
| 478 | |
| 479 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) |
| 480 | int new_session_ticket; /*!< use NewSessionTicket? */ |
| 481 | #endif /* MBEDTLS_SSL_SESSION_TICKETS */ |
| 482 | #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) |
| 483 | int extended_ms; /*!< use Extended Master Secret? */ |
| 484 | #endif |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 485 | |
| 486 | #if defined(MBEDTLS_SSL_ASYNC_PRIVATE) |
Gilles Peskine | 7830073 | 2018-04-26 13:03:29 +0200 | [diff] [blame] | 487 | unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */ |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 488 | #endif /* MBEDTLS_SSL_ASYNC_PRIVATE */ |
| 489 | |
| 490 | #if defined(MBEDTLS_SSL_ASYNC_PRIVATE) |
| 491 | /** Asynchronous operation context. This field is meant for use by the |
| 492 | * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start, |
| 493 | * mbedtls_ssl_config::f_async_decrypt_start, |
| 494 | * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel). |
| 495 | * The library does not use it internally. */ |
| 496 | void *user_async_ctx; |
| 497 | #endif /* MBEDTLS_SSL_ASYNC_PRIVATE */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 498 | }; |
| 499 | |
Hanno Becker | 0271f96 | 2018-08-16 13:23:47 +0100 | [diff] [blame] | 500 | typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer; |
| 501 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 502 | /* |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 503 | * Representation of decryption/encryption transformations on records |
| 504 | * |
| 505 | * There are the following general types of record transformations: |
| 506 | * - Stream transformations (TLS versions <= 1.2 only) |
| 507 | * Transformation adding a MAC and applying a stream-cipher |
| 508 | * to the authenticated message. |
| 509 | * - CBC block cipher transformations ([D]TLS versions <= 1.2 only) |
| 510 | * In addition to the distinction of the order of encryption and |
| 511 | * authentication, there's a fundamental difference between the |
| 512 | * handling in SSL3 & TLS 1.0 and TLS 1.1 and TLS 1.2: For SSL3 |
| 513 | * and TLS 1.0, the final IV after processing a record is used |
| 514 | * as the IV for the next record. No explicit IV is contained |
| 515 | * in an encrypted record. The IV for the first record is extracted |
| 516 | * at key extraction time. In contrast, for TLS 1.1 and 1.2, no |
| 517 | * IV is generated at key extraction time, but every encrypted |
| 518 | * record is explicitly prefixed by the IV with which it was encrypted. |
| 519 | * - AEAD transformations ([D]TLS versions >= 1.2 only) |
| 520 | * These come in two fundamentally different versions, the first one |
| 521 | * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second |
| 522 | * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3. |
| 523 | * In the first transformation, the IV to be used for a record is obtained |
| 524 | * as the concatenation of an explicit, static 4-byte IV and the 8-byte |
| 525 | * record sequence number, and explicitly prepending this sequence number |
| 526 | * to the encrypted record. In contrast, in the second transformation |
| 527 | * the IV is obtained by XOR'ing a static IV obtained at key extraction |
| 528 | * time with the 8-byte record sequence number, without prepending the |
| 529 | * latter to the encrypted record. |
| 530 | * |
| 531 | * In addition to type and version, the following parameters are relevant: |
| 532 | * - The symmetric cipher algorithm to be used. |
| 533 | * - The (static) encryption/decryption keys for the cipher. |
| 534 | * - For stream/CBC, the type of message digest to be used. |
| 535 | * - For stream/CBC, (static) encryption/decryption keys for the digest. |
Hanno Becker | 0db7e0c | 2018-10-18 15:39:53 +0100 | [diff] [blame] | 536 | * - For AEAD transformations, the size (potentially 0) of an explicit, |
| 537 | * random initialization vector placed in encrypted records. |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 538 | * - For some transformations (currently AEAD and CBC in SSL3 and TLS 1.0) |
| 539 | * an implicit IV. It may be static (e.g. AEAD) or dynamic (e.g. CBC) |
| 540 | * and (if present) is combined with the explicit IV in a transformation- |
| 541 | * dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3). |
| 542 | * - For stream/CBC, a flag determining the order of encryption and MAC. |
| 543 | * - The details of the transformation depend on the SSL/TLS version. |
| 544 | * - The length of the authentication tag. |
| 545 | * |
Hanno Becker | 0db7e0c | 2018-10-18 15:39:53 +0100 | [diff] [blame] | 546 | * Note: Except for CBC in SSL3 and TLS 1.0, these parameters are |
| 547 | * constant across multiple encryption/decryption operations. |
| 548 | * For CBC, the implicit IV needs to be updated after each |
| 549 | * operation. |
| 550 | * |
Hanno Becker | d362dc5 | 2018-01-03 15:23:11 +0000 | [diff] [blame] | 551 | * The struct below refines this abstract view as follows: |
| 552 | * - The cipher underlying the transformation is managed in |
| 553 | * cipher contexts cipher_ctx_{enc/dec}, which must have the |
| 554 | * same cipher type. The mode of these cipher contexts determines |
| 555 | * the type of the transformation in the sense above: e.g., if |
| 556 | * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM |
| 557 | * then the transformation has type CBC resp. AEAD. |
| 558 | * - The cipher keys are never stored explicitly but |
| 559 | * are maintained within cipher_ctx_{enc/dec}. |
| 560 | * - For stream/CBC transformations, the message digest contexts |
| 561 | * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts |
| 562 | * are unused for AEAD transformations. |
| 563 | * - For stream/CBC transformations and versions > SSL3, the |
| 564 | * MAC keys are not stored explicitly but maintained within |
| 565 | * md_ctx_{enc/dec}. |
| 566 | * - For stream/CBC transformations and version SSL3, the MAC |
| 567 | * keys are stored explicitly in mac_enc, mac_dec and have |
| 568 | * a fixed size of 20 bytes. These fields are unused for |
| 569 | * AEAD transformations or transformations >= TLS 1.0. |
| 570 | * - For transformations using an implicit IV maintained within |
| 571 | * the transformation context, its contents are stored within |
| 572 | * iv_{enc/dec}. |
| 573 | * - The value of ivlen indicates the length of the IV. |
| 574 | * This is redundant in case of stream/CBC transformations |
| 575 | * which always use 0 resp. the cipher's block length as the |
| 576 | * IV length, but is needed for AEAD ciphers and may be |
| 577 | * different from the underlying cipher's block length |
| 578 | * in this case. |
| 579 | * - The field fixed_ivlen is nonzero for AEAD transformations only |
| 580 | * and indicates the length of the static part of the IV which is |
| 581 | * constant throughout the communication, and which is stored in |
| 582 | * the first fixed_ivlen bytes of the iv_{enc/dec} arrays. |
| 583 | * Note: For CBC in SSL3 and TLS 1.0, the fields iv_{enc/dec} |
| 584 | * still store IV's for continued use across multiple transformations, |
| 585 | * so it is not true that fixed_ivlen == 0 means that iv_{enc/dec} are |
| 586 | * not being used! |
| 587 | * - minor_ver denotes the SSL/TLS version |
| 588 | * - For stream/CBC transformations, maclen denotes the length of the |
| 589 | * authentication tag, while taglen is unused and 0. |
| 590 | * - For AEAD transformations, taglen denotes the length of the |
| 591 | * authentication tag, while maclen is unused and 0. |
| 592 | * - For CBC transformations, encrypt_then_mac determines the |
| 593 | * order of encryption and authentication. This field is unused |
| 594 | * in other transformations. |
| 595 | * |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 596 | */ |
| 597 | struct mbedtls_ssl_transform |
| 598 | { |
| 599 | /* |
| 600 | * Session specific crypto layer |
| 601 | */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 602 | size_t minlen; /*!< min. ciphertext length */ |
| 603 | size_t ivlen; /*!< IV length */ |
| 604 | size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */ |
Hanno Becker | e694c3e | 2017-12-27 21:34:08 +0000 | [diff] [blame] | 605 | size_t maclen; /*!< MAC(CBC) len */ |
| 606 | size_t taglen; /*!< TAG(AEAD) len */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 607 | |
| 608 | unsigned char iv_enc[16]; /*!< IV (encryption) */ |
| 609 | unsigned char iv_dec[16]; /*!< IV (decryption) */ |
| 610 | |
Hanno Becker | d56ed24 | 2018-01-03 15:32:51 +0000 | [diff] [blame] | 611 | #if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC) |
| 612 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 613 | #if defined(MBEDTLS_SSL_PROTO_SSL3) |
| 614 | /* Needed only for SSL v3.0 secret */ |
| 615 | unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */ |
| 616 | unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */ |
| 617 | #endif /* MBEDTLS_SSL_PROTO_SSL3 */ |
| 618 | |
| 619 | mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */ |
| 620 | mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */ |
| 621 | |
Hanno Becker | 9eddaeb | 2017-12-27 21:37:21 +0000 | [diff] [blame] | 622 | #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) |
| 623 | int encrypt_then_mac; /*!< flag for EtM activation */ |
| 624 | #endif |
| 625 | |
Hanno Becker | d56ed24 | 2018-01-03 15:32:51 +0000 | [diff] [blame] | 626 | #endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */ |
| 627 | |
| 628 | mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */ |
| 629 | mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */ |
Hanno Becker | 9eddaeb | 2017-12-27 21:37:21 +0000 | [diff] [blame] | 630 | int minor_ver; |
| 631 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 632 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | 1327fa7 | 2019-04-25 15:54:02 +0100 | [diff] [blame] | 633 | uint8_t in_cid_len; |
| 634 | uint8_t out_cid_len; |
| 635 | unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; |
| 636 | unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 637 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | 1327fa7 | 2019-04-25 15:54:02 +0100 | [diff] [blame] | 638 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 639 | /* |
| 640 | * Session specific compression layer |
| 641 | */ |
| 642 | #if defined(MBEDTLS_ZLIB_SUPPORT) |
| 643 | z_stream ctx_deflate; /*!< compression context */ |
| 644 | z_stream ctx_inflate; /*!< decompression context */ |
| 645 | #endif |
Manuel Pégourié-Gonnard | 96fb0ee | 2019-07-09 12:54:17 +0200 | [diff] [blame] | 646 | |
| 647 | #if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION) |
| 648 | /* We need the Hello random bytes in order to re-derive keys from the |
| 649 | * Master Secret and other session info, see ssl_populate_transform() */ |
| 650 | unsigned char randbytes[64]; /*!< ServerHello.random+ClientHello.random */ |
| 651 | #endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 652 | }; |
| 653 | |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 654 | /* |
Manuel Pégourié-Gonnard | 1aaf669 | 2019-07-10 14:14:05 +0200 | [diff] [blame] | 655 | * Return 1 if the transform uses an AEAD cipher, 0 otherwise. |
| 656 | * Equivalently, return 0 if a separate MAC is used, 1 otherwise. |
| 657 | */ |
| 658 | static inline int mbedtls_ssl_transform_uses_aead( |
| 659 | const mbedtls_ssl_transform *transform ) |
| 660 | { |
| 661 | #if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC) |
| 662 | return( transform->maclen == 0 && transform->taglen != 0 ); |
| 663 | #else |
| 664 | (void) transform; |
| 665 | return( 1 ); |
| 666 | #endif |
| 667 | } |
| 668 | |
| 669 | /* |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 670 | * Internal representation of record frames |
| 671 | * |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 672 | * Instances come in two flavors: |
| 673 | * (1) Encrypted |
| 674 | * These always have data_offset = 0 |
| 675 | * (2) Unencrypted |
Hanno Becker | cd430bc | 2019-04-04 16:29:48 +0100 | [diff] [blame] | 676 | * These have data_offset set to the amount of |
| 677 | * pre-expansion during record protection. Concretely, |
| 678 | * this is the length of the fixed part of the explicit IV |
| 679 | * used for encryption, or 0 if no explicit IV is used |
| 680 | * (e.g. for CBC in TLS 1.0, or stream ciphers). |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 681 | * |
| 682 | * The reason for the data_offset in the unencrypted case |
| 683 | * is to allow for in-place conversion of an unencrypted to |
| 684 | * an encrypted record. If the offset wasn't included, the |
| 685 | * encrypted content would need to be shifted afterwards to |
| 686 | * make space for the fixed IV. |
| 687 | * |
| 688 | */ |
Hanno Becker | f2ed448 | 2019-04-29 13:45:54 +0100 | [diff] [blame] | 689 | #if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX |
Hanno Becker | 75f080f | 2019-04-30 15:01:51 +0100 | [diff] [blame] | 690 | #define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX |
Hanno Becker | f2ed448 | 2019-04-29 13:45:54 +0100 | [diff] [blame] | 691 | #else |
Hanno Becker | 75f080f | 2019-04-30 15:01:51 +0100 | [diff] [blame] | 692 | #define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX |
Hanno Becker | f2ed448 | 2019-04-29 13:45:54 +0100 | [diff] [blame] | 693 | #endif |
| 694 | |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 695 | typedef struct |
| 696 | { |
Hanno Becker | d840cea | 2019-07-11 09:24:36 +0100 | [diff] [blame] | 697 | uint8_t ctr[8]; /* In TLS: The implicit record sequence number. |
| 698 | * In DTLS: The 2-byte epoch followed by |
| 699 | * the 6-byte sequence number. |
| 700 | * This is stored as a raw big endian byte array |
| 701 | * as opposed to a uint64_t because we rarely |
| 702 | * need to perform arithmetic on this, but do |
| 703 | * need it as a Byte array for the purpose of |
| 704 | * MAC computations. */ |
| 705 | uint8_t type; /* The record content type. */ |
| 706 | uint8_t ver[2]; /* SSL/TLS version as present on the wire. |
| 707 | * Convert to internal presentation of versions |
| 708 | * using mbedtls_ssl_read_version() and |
| 709 | * mbedtls_ssl_write_version(). |
| 710 | * Keep wire-format for MAC computations. */ |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 711 | |
Hanno Becker | d840cea | 2019-07-11 09:24:36 +0100 | [diff] [blame] | 712 | unsigned char *buf; /* Memory buffer enclosing the record content */ |
| 713 | size_t buf_len; /* Buffer length */ |
| 714 | size_t data_offset; /* Offset of record content */ |
| 715 | size_t data_len; /* Length of record content */ |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 716 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 717 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | d840cea | 2019-07-11 09:24:36 +0100 | [diff] [blame] | 718 | uint8_t cid_len; /* Length of the CID (0 if not present) */ |
| 719 | unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 720 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | 12a3a86 | 2018-01-05 15:42:50 +0000 | [diff] [blame] | 721 | } mbedtls_record; |
| 722 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 723 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 724 | /* |
| 725 | * List of certificate + private key pairs |
| 726 | */ |
| 727 | struct mbedtls_ssl_key_cert |
| 728 | { |
| 729 | mbedtls_x509_crt *cert; /*!< cert */ |
| 730 | mbedtls_pk_context *key; /*!< private key */ |
| 731 | mbedtls_ssl_key_cert *next; /*!< next key/cert pair */ |
| 732 | }; |
| 733 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
| 734 | |
| 735 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 736 | /* |
| 737 | * List of handshake messages kept around for resending |
| 738 | */ |
| 739 | struct mbedtls_ssl_flight_item |
| 740 | { |
| 741 | unsigned char *p; /*!< message, including handshake headers */ |
| 742 | size_t len; /*!< length of p */ |
| 743 | unsigned char type; /*!< type of the message: handshake or CCS */ |
| 744 | mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */ |
| 745 | }; |
| 746 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 747 | |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 748 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \ |
| 749 | defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) |
| 750 | |
| 751 | /* Find an entry in a signature-hash set matching a given hash algorithm. */ |
| 752 | mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set, |
| 753 | mbedtls_pk_type_t sig_alg ); |
| 754 | /* Add a signature-hash-pair to a signature-hash set */ |
| 755 | void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set, |
| 756 | mbedtls_pk_type_t sig_alg, |
| 757 | mbedtls_md_type_t md_alg ); |
| 758 | /* Allow exactly one hash algorithm for each signature. */ |
| 759 | void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set, |
| 760 | mbedtls_md_type_t md_alg ); |
| 761 | |
| 762 | /* Setup an empty signature-hash set */ |
| 763 | static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set ) |
| 764 | { |
| 765 | mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE ); |
| 766 | } |
| 767 | |
| 768 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2) && |
| 769 | MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */ |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 770 | |
| 771 | /** |
| 772 | * \brief Free referenced items in an SSL transform context and clear |
| 773 | * memory |
| 774 | * |
| 775 | * \param transform SSL transform context |
| 776 | */ |
| 777 | void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform ); |
| 778 | |
| 779 | /** |
| 780 | * \brief Free referenced items in an SSL handshake context and clear |
| 781 | * memory |
| 782 | * |
Gilles Peskine | 9b562d5 | 2018-04-25 20:32:43 +0200 | [diff] [blame] | 783 | * \param ssl SSL context |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 784 | */ |
Gilles Peskine | 9b562d5 | 2018-04-25 20:32:43 +0200 | [diff] [blame] | 785 | void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 786 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 787 | int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl ); |
| 788 | int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl ); |
| 789 | void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl ); |
| 790 | |
| 791 | int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl ); |
| 792 | |
| 793 | void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl ); |
| 794 | int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl ); |
| 795 | |
Simon Butcher | 9900014 | 2016-10-13 17:21:01 +0100 | [diff] [blame] | 796 | int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl ); |
| 797 | int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl ); |
| 798 | void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl ); |
| 799 | |
Hanno Becker | 4a810fb | 2017-05-24 16:27:30 +0100 | [diff] [blame] | 800 | /** |
| 801 | * \brief Update record layer |
| 802 | * |
| 803 | * This function roughly separates the implementation |
| 804 | * of the logic of (D)TLS from the implementation |
| 805 | * of the secure transport. |
| 806 | * |
Hanno Becker | 3a0aad1 | 2018-08-20 09:44:02 +0100 | [diff] [blame] | 807 | * \param ssl The SSL context to use. |
| 808 | * \param update_hs_digest This indicates if the handshake digest |
| 809 | * should be automatically updated in case |
| 810 | * a handshake message is found. |
Hanno Becker | 4a810fb | 2017-05-24 16:27:30 +0100 | [diff] [blame] | 811 | * |
| 812 | * \return 0 or non-zero error code. |
| 813 | * |
| 814 | * \note A clarification on what is called 'record layer' here |
| 815 | * is in order, as many sensible definitions are possible: |
| 816 | * |
| 817 | * The record layer takes as input an untrusted underlying |
| 818 | * transport (stream or datagram) and transforms it into |
| 819 | * a serially multiplexed, secure transport, which |
| 820 | * conceptually provides the following: |
| 821 | * |
| 822 | * (1) Three datagram based, content-agnostic transports |
| 823 | * for handshake, alert and CCS messages. |
| 824 | * (2) One stream- or datagram-based transport |
| 825 | * for application data. |
| 826 | * (3) Functionality for changing the underlying transform |
| 827 | * securing the contents. |
| 828 | * |
| 829 | * The interface to this functionality is given as follows: |
| 830 | * |
| 831 | * a Updating |
| 832 | * [Currently implemented by mbedtls_ssl_read_record] |
| 833 | * |
| 834 | * Check if and on which of the four 'ports' data is pending: |
| 835 | * Nothing, a controlling datagram of type (1), or application |
| 836 | * data (2). In any case data is present, internal buffers |
| 837 | * provide access to the data for the user to process it. |
| 838 | * Consumption of type (1) datagrams is done automatically |
| 839 | * on the next update, invalidating that the internal buffers |
| 840 | * for previous datagrams, while consumption of application |
| 841 | * data (2) is user-controlled. |
| 842 | * |
| 843 | * b Reading of application data |
| 844 | * [Currently manual adaption of ssl->in_offt pointer] |
| 845 | * |
| 846 | * As mentioned in the last paragraph, consumption of data |
| 847 | * is different from the automatic consumption of control |
| 848 | * datagrams (1) because application data is treated as a stream. |
| 849 | * |
| 850 | * c Tracking availability of application data |
| 851 | * [Currently manually through decreasing ssl->in_msglen] |
| 852 | * |
| 853 | * For efficiency and to retain datagram semantics for |
| 854 | * application data in case of DTLS, the record layer |
| 855 | * provides functionality for checking how much application |
| 856 | * data is still available in the internal buffer. |
| 857 | * |
| 858 | * d Changing the transformation securing the communication. |
| 859 | * |
| 860 | * Given an opaque implementation of the record layer in the |
| 861 | * above sense, it should be possible to implement the logic |
| 862 | * of (D)TLS on top of it without the need to know anything |
| 863 | * about the record layer's internals. This is done e.g. |
| 864 | * in all the handshake handling functions, and in the |
| 865 | * application data reading function mbedtls_ssl_read. |
| 866 | * |
| 867 | * \note The above tries to give a conceptual picture of the |
| 868 | * record layer, but the current implementation deviates |
| 869 | * from it in some places. For example, our implementation of |
| 870 | * the update functionality through mbedtls_ssl_read_record |
| 871 | * discards datagrams depending on the current state, which |
| 872 | * wouldn't fall under the record layer's responsibility |
| 873 | * following the above definition. |
| 874 | * |
| 875 | */ |
Hanno Becker | 3a0aad1 | 2018-08-20 09:44:02 +0100 | [diff] [blame] | 876 | int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl, |
| 877 | unsigned update_hs_digest ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 878 | int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want ); |
| 879 | |
Manuel Pégourié-Gonnard | 31c1586 | 2017-09-13 09:38:11 +0200 | [diff] [blame] | 880 | int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl ); |
Hanno Becker | 67bc7c3 | 2018-08-06 11:33:50 +0100 | [diff] [blame] | 881 | int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 882 | int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl ); |
| 883 | |
| 884 | int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl ); |
| 885 | int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl ); |
| 886 | |
| 887 | int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl ); |
| 888 | int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl ); |
| 889 | |
| 890 | int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl ); |
| 891 | int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl ); |
| 892 | |
| 893 | void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl, |
| 894 | const mbedtls_ssl_ciphersuite_t *ciphersuite_info ); |
| 895 | |
| 896 | #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED) |
| 897 | int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex ); |
| 898 | #endif |
| 899 | |
| 900 | #if defined(MBEDTLS_PK_C) |
| 901 | unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk ); |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 902 | unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 903 | mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig ); |
| 904 | #endif |
| 905 | |
| 906 | mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash ); |
Manuel Pégourié-Gonnard | 7bfc122 | 2015-06-17 14:34:48 +0200 | [diff] [blame] | 907 | unsigned char mbedtls_ssl_hash_from_md_alg( int md ); |
Simon Butcher | 9900014 | 2016-10-13 17:21:01 +0100 | [diff] [blame] | 908 | int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 909 | |
Manuel Pégourié-Gonnard | b541da6 | 2015-06-17 11:43:30 +0200 | [diff] [blame] | 910 | #if defined(MBEDTLS_ECP_C) |
Manuel Pégourié-Gonnard | 9d412d8 | 2015-06-17 12:10:46 +0200 | [diff] [blame] | 911 | int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 912 | #endif |
| 913 | |
Manuel Pégourié-Gonnard | e5f3072 | 2015-10-22 17:01:15 +0200 | [diff] [blame] | 914 | #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) |
Manuel Pégourié-Gonnard | 7bfc122 | 2015-06-17 14:34:48 +0200 | [diff] [blame] | 915 | int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl, |
| 916 | mbedtls_md_type_t md ); |
| 917 | #endif |
| 918 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 919 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 920 | static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl ) |
| 921 | { |
| 922 | mbedtls_ssl_key_cert *key_cert; |
| 923 | |
| 924 | if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL ) |
| 925 | key_cert = ssl->handshake->key_cert; |
| 926 | else |
| 927 | key_cert = ssl->conf->key_cert; |
| 928 | |
| 929 | return( key_cert == NULL ? NULL : key_cert->key ); |
| 930 | } |
| 931 | |
| 932 | static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl ) |
| 933 | { |
| 934 | mbedtls_ssl_key_cert *key_cert; |
| 935 | |
| 936 | if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL ) |
| 937 | key_cert = ssl->handshake->key_cert; |
| 938 | else |
| 939 | key_cert = ssl->conf->key_cert; |
| 940 | |
| 941 | return( key_cert == NULL ? NULL : key_cert->cert ); |
| 942 | } |
| 943 | |
| 944 | /* |
| 945 | * Check usage of a certificate wrt extensions: |
| 946 | * keyUsage, extendedKeyUsage (later), and nSCertType (later). |
| 947 | * |
| 948 | * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we |
| 949 | * check a cert we received from them)! |
| 950 | * |
| 951 | * Return 0 if everything is OK, -1 if not. |
| 952 | */ |
| 953 | int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert, |
| 954 | const mbedtls_ssl_ciphersuite_t *ciphersuite, |
| 955 | int cert_endpoint, |
| 956 | uint32_t *flags ); |
| 957 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
| 958 | |
| 959 | void mbedtls_ssl_write_version( int major, int minor, int transport, |
| 960 | unsigned char ver[2] ); |
| 961 | void mbedtls_ssl_read_version( int *major, int *minor, int transport, |
| 962 | const unsigned char ver[2] ); |
| 963 | |
Hanno Becker | 5903de4 | 2019-05-03 14:46:38 +0100 | [diff] [blame] | 964 | static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl ) |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 965 | { |
Hanno Becker | 47be768 | 2019-07-12 09:55:46 +0100 | [diff] [blame] | 966 | #if !defined(MBEDTLS_SSL_PROTO_DTLS) |
| 967 | ((void) ssl); |
| 968 | #endif |
| 969 | |
| 970 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 971 | if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) |
| 972 | { |
| 973 | return( 13 ); |
| 974 | } |
| 975 | else |
| 976 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 977 | { |
| 978 | return( 5 ); |
| 979 | } |
Hanno Becker | 5903de4 | 2019-05-03 14:46:38 +0100 | [diff] [blame] | 980 | } |
| 981 | |
| 982 | static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl ) |
| 983 | { |
Hanno Becker | 3b154c1 | 2019-05-03 15:05:27 +0100 | [diff] [blame] | 984 | return( (size_t) ( ssl->out_iv - ssl->out_hdr ) ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 985 | } |
| 986 | |
| 987 | static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl ) |
| 988 | { |
| 989 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 990 | if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) |
| 991 | return( 12 ); |
| 992 | #else |
| 993 | ((void) ssl); |
| 994 | #endif |
| 995 | return( 4 ); |
| 996 | } |
| 997 | |
| 998 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 999 | void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl ); |
| 1000 | void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl ); |
| 1001 | int mbedtls_ssl_resend( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | 87a346f | 2017-09-13 12:45:21 +0200 | [diff] [blame] | 1002 | int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1003 | #endif |
| 1004 | |
| 1005 | /* Visible for testing purposes only */ |
| 1006 | #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) |
Hanno Becker | 0183d69 | 2019-07-12 08:50:37 +0100 | [diff] [blame] | 1007 | int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1008 | void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl ); |
| 1009 | #endif |
| 1010 | |
Hanno Becker | 52055ae | 2019-02-06 14:30:46 +0000 | [diff] [blame] | 1011 | int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst, |
| 1012 | const mbedtls_ssl_session *src ); |
| 1013 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1014 | /* constant-time buffer comparison */ |
| 1015 | static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n ) |
| 1016 | { |
| 1017 | size_t i; |
Hanno Becker | 59e6963 | 2017-06-26 13:26:58 +0100 | [diff] [blame] | 1018 | volatile const unsigned char *A = (volatile const unsigned char *) a; |
| 1019 | volatile const unsigned char *B = (volatile const unsigned char *) b; |
| 1020 | volatile unsigned char diff = 0; |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1021 | |
| 1022 | for( i = 0; i < n; i++ ) |
Azim Khan | 45b79cf | 2018-05-23 16:55:16 +0100 | [diff] [blame] | 1023 | { |
| 1024 | /* Read volatile data in order before computing diff. |
| 1025 | * This avoids IAR compiler warning: |
| 1026 | * 'the order of volatile accesses is undefined ..' */ |
| 1027 | unsigned char x = A[i], y = B[i]; |
| 1028 | diff |= x ^ y; |
| 1029 | } |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1030 | |
| 1031 | return( diff ); |
| 1032 | } |
| 1033 | |
Andres Amaya Garcia | 46f5a3e | 2017-07-20 16:17:51 +0100 | [diff] [blame] | 1034 | #if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \ |
| 1035 | defined(MBEDTLS_SSL_PROTO_TLS1_1) |
| 1036 | int mbedtls_ssl_get_key_exchange_md_ssl_tls( mbedtls_ssl_context *ssl, |
| 1037 | unsigned char *output, |
| 1038 | unsigned char *data, size_t data_len ); |
| 1039 | #endif /* MBEDTLS_SSL_PROTO_SSL3 || MBEDTLS_SSL_PROTO_TLS1 || \ |
| 1040 | MBEDTLS_SSL_PROTO_TLS1_1 */ |
| 1041 | |
| 1042 | #if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \ |
| 1043 | defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Andrzej Kurek | 814feff | 2019-01-14 04:35:19 -0500 | [diff] [blame] | 1044 | /* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */ |
Andres Amaya Garcia | 46f5a3e | 2017-07-20 16:17:51 +0100 | [diff] [blame] | 1045 | int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl, |
Gilles Peskine | ca1d742 | 2018-04-24 11:53:22 +0200 | [diff] [blame] | 1046 | unsigned char *hash, size_t *hashlen, |
| 1047 | unsigned char *data, size_t data_len, |
| 1048 | mbedtls_md_type_t md_alg ); |
Andres Amaya Garcia | 46f5a3e | 2017-07-20 16:17:51 +0100 | [diff] [blame] | 1049 | #endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \ |
| 1050 | MBEDTLS_SSL_PROTO_TLS1_2 */ |
| 1051 | |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1052 | #ifdef __cplusplus |
| 1053 | } |
| 1054 | #endif |
| 1055 | |
Hanno Becker | a18d132 | 2018-01-03 14:27:32 +0000 | [diff] [blame] | 1056 | void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform ); |
| 1057 | int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl, |
| 1058 | mbedtls_ssl_transform *transform, |
| 1059 | mbedtls_record *rec, |
| 1060 | int (*f_rng)(void *, unsigned char *, size_t), |
| 1061 | void *p_rng ); |
Hanno Becker | 605949f | 2019-07-12 08:23:59 +0100 | [diff] [blame] | 1062 | int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl, |
Hanno Becker | a18d132 | 2018-01-03 14:27:32 +0000 | [diff] [blame] | 1063 | mbedtls_ssl_transform *transform, |
| 1064 | mbedtls_record *rec ); |
| 1065 | |
Hanno Becker | 0f57a65 | 2020-02-05 10:37:26 +0000 | [diff] [blame^] | 1066 | |
| 1067 | void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs ); |
Manuel Pégourié-Gonnard | 5e94dde | 2015-05-26 11:57:05 +0200 | [diff] [blame] | 1068 | #endif /* ssl_internal.h */ |