Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1 | /** |
| 2 | * \file ssl.h |
Paul Bakker | e0ccd0a | 2009-01-04 16:27:10 +0000 | [diff] [blame] | 3 | * |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 4 | * \brief SSL/TLS functions. |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 5 | */ |
| 6 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 7 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 8 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 9 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 10 | #ifndef MBEDTLS_SSL_H |
| 11 | #define MBEDTLS_SSL_H |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 12 | #include "mbedtls/platform_util.h" |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 13 | #include "mbedtls/private_access.h" |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 14 | |
Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 15 | #include "mbedtls/build_info.h" |
Manuel Pégourié-Gonnard | 0371704 | 2014-11-04 19:52:10 +0100 | [diff] [blame] | 16 | |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 17 | #include "mbedtls/bignum.h" |
| 18 | #include "mbedtls/ecp.h" |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 19 | |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 20 | #include "mbedtls/ssl_ciphersuites.h" |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 21 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 22 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 23 | #include "mbedtls/x509_crt.h" |
| 24 | #include "mbedtls/x509_crl.h" |
Manuel Pégourié-Gonnard | 834ea85 | 2013-09-23 14:46:13 +0200 | [diff] [blame] | 25 | #endif |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 26 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 27 | #if defined(MBEDTLS_DHM_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 28 | #include "mbedtls/dhm.h" |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 29 | #endif |
XiaokangQian | a763498 | 2021-10-22 06:32:32 +0000 | [diff] [blame] | 30 | |
Andrzej Kurek | 1b75e5f | 2023-04-04 09:55:06 -0400 | [diff] [blame] | 31 | #include "mbedtls/md.h" |
| 32 | |
Valerio Setti | 7aeec54 | 2023-07-05 18:57:21 +0200 | [diff] [blame] | 33 | #if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 34 | #include "mbedtls/ecdh.h" |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 35 | #endif |
| 36 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 37 | #if defined(MBEDTLS_HAVE_TIME) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 38 | #include "mbedtls/platform_time.h" |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 39 | #endif |
| 40 | |
Hanno Becker | 4363313 | 2018-10-22 15:31:03 +0100 | [diff] [blame] | 41 | #include "psa/crypto.h" |
Hanno Becker | 4363313 | 2018-10-22 15:31:03 +0100 | [diff] [blame] | 42 | |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 43 | /* |
| 44 | * SSL Error codes |
| 45 | */ |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 46 | /** A cryptographic operation is in progress. Try again later. */ |
| 47 | #define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 |
| 48 | /** The requested feature is not available. */ |
| 49 | #define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 |
| 50 | /** Bad input parameters to function. */ |
| 51 | #define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 |
| 52 | /** Verification of the message MAC failed. */ |
| 53 | #define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 |
| 54 | /** An invalid SSL record was received. */ |
| 55 | #define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 |
| 56 | /** The connection indicated an EOF. */ |
| 57 | #define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 |
| 58 | /** A message could not be parsed due to a syntactic error. */ |
| 59 | #define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300 |
Dave Rodgman | bb05cd0 | 2021-06-29 10:37:43 +0100 | [diff] [blame] | 60 | /* Error space gap */ |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 61 | /** No RNG was provided to the SSL module. */ |
| 62 | #define MBEDTLS_ERR_SSL_NO_RNG -0x7400 |
| 63 | /** No client certification received from the client, but required by the authentication mode. */ |
| 64 | #define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 |
| 65 | /** Client received an extended server hello containing an unsupported extension */ |
| 66 | #define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500 |
| 67 | /** No ALPN protocols supported that the client advertises */ |
| 68 | #define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580 |
| 69 | /** The own private key or pre-shared key is not set, but needed. */ |
| 70 | #define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 |
| 71 | /** No CA Chain is set, but required to operate. */ |
| 72 | #define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 |
| 73 | /** An unexpected message was received from our peer. */ |
| 74 | #define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 |
| 75 | /** A fatal alert message was received from our peer. */ |
| 76 | #define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 |
| 77 | /** No server could be identified matching the client's SNI. */ |
| 78 | #define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800 |
| 79 | /** The peer notified us that the connection is going to be closed. */ |
| 80 | #define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 |
Hanno Becker | 90d59dd | 2021-06-24 11:17:13 +0100 | [diff] [blame] | 81 | /* Error space gap */ |
Hanno Becker | c3411d4 | 2021-06-24 11:09:00 +0100 | [diff] [blame] | 82 | /* Error space gap */ |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 83 | /** Processing of the Certificate handshake message failed. */ |
| 84 | #define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00 |
Pengyu Lv | 1894653 | 2023-01-12 12:28:09 +0800 | [diff] [blame] | 85 | /* Error space gap */ |
Ronald Cron | da13072 | 2022-11-22 09:08:57 +0100 | [diff] [blame] | 86 | /** |
| 87 | * Received NewSessionTicket Post Handshake Message. |
| 88 | * This error code is experimental and may be changed or removed without notice. |
| 89 | */ |
Jerry Yu | f8a4994 | 2022-07-07 11:32:32 +0000 | [diff] [blame] | 90 | #define MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET -0x7B00 |
Ronald Cron | 4a8c9e2 | 2022-10-26 18:49:09 +0200 | [diff] [blame] | 91 | /** Not possible to read early data */ |
| 92 | #define MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA -0x7B80 |
| 93 | /** Not possible to write early data */ |
| 94 | #define MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA -0x7C00 |
Hanno Becker | b24e74b | 2021-06-24 09:52:01 +0100 | [diff] [blame] | 95 | /* Error space gap */ |
Hanno Becker | d3eec78 | 2021-06-24 10:21:46 +0100 | [diff] [blame] | 96 | /* Error space gap */ |
Hanno Becker | d934a2a | 2021-06-24 10:23:45 +0100 | [diff] [blame] | 97 | /* Error space gap */ |
Hanno Becker | d200296 | 2021-06-24 10:25:40 +0100 | [diff] [blame] | 98 | /* Error space gap */ |
Pengyu Lv | 5038a38 | 2023-03-23 15:49:52 +0800 | [diff] [blame] | 99 | /** Cache entry not found */ |
Pengyu Lv | e3746d7 | 2023-04-10 14:40:03 +0800 | [diff] [blame] | 100 | #define MBEDTLS_ERR_SSL_CACHE_ENTRY_NOT_FOUND -0x7E80 |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 101 | /** Memory allocation failed */ |
| 102 | #define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 |
| 103 | /** Hardware acceleration function returned with error */ |
| 104 | #define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 |
| 105 | /** Hardware acceleration function skipped / left alone data */ |
| 106 | #define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 |
| 107 | /** Handshake protocol not within min/max boundaries */ |
| 108 | #define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80 |
| 109 | /** The handshake negotiation failed. */ |
| 110 | #define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00 |
| 111 | /** Session ticket has expired. */ |
| 112 | #define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 |
| 113 | /** Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */ |
| 114 | #define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 |
| 115 | /** Unknown identity received (eg, PSK identity) */ |
| 116 | #define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 |
| 117 | /** Internal error (eg, unexpected failure in lower-level module) */ |
| 118 | #define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 |
| 119 | /** A counter would wrap (eg, too many messages exchanged). */ |
| 120 | #define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 |
| 121 | /** Unexpected message at ServerHello in renegotiation. */ |
| 122 | #define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 |
| 123 | /** DTLS client must retry for hello verification */ |
| 124 | #define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 |
| 125 | /** A buffer is too small to receive or write a message */ |
| 126 | #define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 |
Dave Rodgman | 096c411 | 2021-06-29 09:52:06 +0100 | [diff] [blame] | 127 | /* Error space gap */ |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 128 | /** No data of requested type currently available on underlying transport. */ |
| 129 | #define MBEDTLS_ERR_SSL_WANT_READ -0x6900 |
| 130 | /** Connection requires a write call. */ |
| 131 | #define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 |
| 132 | /** The operation timed out. */ |
| 133 | #define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 |
| 134 | /** The client initiated a reconnect from the same port. */ |
| 135 | #define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 |
| 136 | /** Record header looks valid but is not expected. */ |
| 137 | #define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 |
| 138 | /** The alert message received indicates a non-fatal error. */ |
| 139 | #define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 |
| 140 | /** A field in a message was incorrect or inconsistent with other fields. */ |
| 141 | #define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600 |
| 142 | /** Internal-only message signaling that further message-processing should be done */ |
| 143 | #define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580 |
| 144 | /** The asynchronous operation is not completed yet. */ |
| 145 | #define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 |
| 146 | /** Internal-only message signaling that a message arrived early. */ |
| 147 | #define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 |
Dave Rodgman | c628fc9 | 2021-06-29 14:32:46 +0100 | [diff] [blame] | 148 | /* Error space gap */ |
| 149 | /* Error space gap */ |
| 150 | /* Error space gap */ |
| 151 | /* Error space gap */ |
| 152 | /* Error space gap */ |
| 153 | /* Error space gap */ |
| 154 | /* Error space gap */ |
| 155 | /* Error space gap */ |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 156 | /** An encrypted DTLS-frame with an unexpected CID was received. */ |
| 157 | #define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000 |
| 158 | /** An operation failed due to an unexpected version or configuration. */ |
| 159 | #define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00 |
| 160 | /** Invalid value in SSL config */ |
| 161 | #define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 162 | |
| 163 | /* |
Jerry Yu | e19e3b9 | 2022-07-08 12:04:51 +0000 | [diff] [blame] | 164 | * Constants from RFC 8446 for TLS 1.3 PSK modes |
| 165 | * |
| 166 | * Those are used in the Pre-Shared Key Exchange Modes extension. |
| 167 | * See Section 4.2.9 in RFC 8446. |
| 168 | */ |
| 169 | #define MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE 0 /* Pure PSK-based exchange */ |
| 170 | #define MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE 1 /* PSK+ECDHE-based exchange */ |
| 171 | |
| 172 | /* |
Jerry Yu | e226cef | 2021-08-27 22:06:20 +0800 | [diff] [blame] | 173 | * TLS 1.3 NamedGroup values |
| 174 | * |
| 175 | * From RF 8446 |
| 176 | * enum { |
| 177 | * // Elliptic Curve Groups (ECDHE) |
| 178 | * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019), |
| 179 | * x25519(0x001D), x448(0x001E), |
| 180 | * // Finite Field Groups (DHE) |
| 181 | * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102), |
| 182 | * ffdhe6144(0x0103), ffdhe8192(0x0104), |
| 183 | * // Reserved Code Points |
| 184 | * ffdhe_private_use(0x01FC..0x01FF), |
| 185 | * ecdhe_private_use(0xFE00..0xFEFF), |
| 186 | * (0xFFFF) |
| 187 | * } NamedGroup; |
| 188 | * |
| 189 | */ |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 190 | |
Jerry Yu | e226cef | 2021-08-27 22:06:20 +0800 | [diff] [blame] | 191 | /* Elliptic Curve Groups (ECDHE) */ |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 192 | #define MBEDTLS_SSL_IANA_TLS_GROUP_NONE 0 |
| 193 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 0x0012 |
| 194 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 0x0013 |
| 195 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 0x0014 |
| 196 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 0x0015 |
| 197 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 0x0016 |
| 198 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 0x0017 |
| 199 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 0x0018 |
| 200 | #define MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 0x0019 |
| 201 | #define MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 0x001A |
| 202 | #define MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 0x001B |
| 203 | #define MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 0x001C |
| 204 | #define MBEDTLS_SSL_IANA_TLS_GROUP_X25519 0x001D |
| 205 | #define MBEDTLS_SSL_IANA_TLS_GROUP_X448 0x001E |
Jerry Yu | e226cef | 2021-08-27 22:06:20 +0800 | [diff] [blame] | 206 | /* Finite Field Groups (DHE) */ |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 207 | #define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 0x0100 |
| 208 | #define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 0x0101 |
| 209 | #define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 0x0102 |
| 210 | #define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 0x0103 |
| 211 | #define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 0x0104 |
Jerry Yu | e226cef | 2021-08-27 22:06:20 +0800 | [diff] [blame] | 212 | |
| 213 | /* |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 214 | * TLS 1.3 Key Exchange Modes |
| 215 | * |
| 216 | * Mbed TLS internal identifiers for use with the SSL configuration API |
| 217 | * mbedtls_ssl_conf_tls13_key_exchange_modes(). |
| 218 | */ |
| 219 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 220 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK (1u << 0) /*!< Pure-PSK TLS 1.3 key exchange, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 221 | * encompassing both externally agreed PSKs |
| 222 | * as well as resumption PSKs. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 223 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL (1u << 1) /*!< Pure-Ephemeral TLS 1.3 key exchanges, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 224 | * including for example ECDHE and DHE |
| 225 | * key exchanges. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 226 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL (1u << 2) /*!< PSK-Ephemeral TLS 1.3 key exchanges, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 227 | * using both a PSK and an ephemeral |
| 228 | * key exchange. */ |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 229 | |
| 230 | /* Convenience macros for sets of key exchanges. */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 231 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 232 | (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \ |
| 233 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \ |
| 234 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL) /*!< All TLS 1.3 key exchanges */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 235 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 236 | (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \ |
| 237 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All PSK-based TLS 1.3 key exchanges */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 238 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 239 | (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL | \ |
| 240 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All ephemeral TLS 1.3 key exchanges */ |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 241 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 242 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE (0) |
Jerry Yu | 77f0148 | 2022-07-11 07:03:24 +0000 | [diff] [blame] | 243 | |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 244 | /* |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 245 | * Various constants |
| 246 | */ |
Mateusz Starzyk | 06b07fb | 2021-02-18 13:55:21 +0100 | [diff] [blame] | 247 | |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 248 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
Jan Bruckner | 25fdc2a | 2022-07-26 10:45:07 +0200 | [diff] [blame] | 249 | /* These are the high and low bytes of ProtocolVersion as defined by: |
Mateusz Starzyk | 06b07fb | 2021-02-18 13:55:21 +0100 | [diff] [blame] | 250 | * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2 |
| 251 | * - RFC 8446: see section 4.2.1 |
| 252 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 253 | #define MBEDTLS_SSL_MAJOR_VERSION_3 3 |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 254 | #define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */ |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 255 | #define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 */ |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 256 | #endif /* MBEDTLS_DEPRECATED_REMOVED */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 257 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 258 | #define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */ |
| 259 | #define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */ |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 260 | |
Simon Butcher | 9f81231 | 2015-09-28 19:22:33 +0100 | [diff] [blame] | 261 | #define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */ |
Ronald Cron | 8216dd3 | 2020-04-23 16:41:44 +0200 | [diff] [blame] | 262 | #define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */ |
| 263 | |
| 264 | #define MBEDTLS_SSL_MAX_ALPN_LIST_LEN 65535 /*!< Maximum size in bytes of list in alpn ext., RFC 7301 */ |
Simon Butcher | 89f7762 | 2015-09-27 22:50:49 +0100 | [diff] [blame] | 265 | |
Manuel Pégourié-Gonnard | 581e6b6 | 2013-07-18 12:32:27 +0200 | [diff] [blame] | 266 | /* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c |
Manuel Pégourié-Gonnard | e048b67 | 2013-07-19 12:47:00 +0200 | [diff] [blame] | 267 | * NONE must be zero so that memset()ing structure to zero works */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 268 | #define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */ |
| 269 | #define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */ |
| 270 | #define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */ |
| 271 | #define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */ |
| 272 | #define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */ |
| 273 | #define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */ |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 274 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 275 | #define MBEDTLS_SSL_IS_CLIENT 0 |
| 276 | #define MBEDTLS_SSL_IS_SERVER 1 |
Manuel Pégourié-Gonnard | 55e4ff2 | 2014-08-19 11:16:35 +0200 | [diff] [blame] | 277 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 278 | #define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0 |
| 279 | #define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1 |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 280 | |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 281 | #define MBEDTLS_SSL_CID_DISABLED 0 |
| 282 | #define MBEDTLS_SSL_CID_ENABLED 1 |
| 283 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 284 | #define MBEDTLS_SSL_ETM_DISABLED 0 |
| 285 | #define MBEDTLS_SSL_ETM_ENABLED 1 |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 286 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 287 | #define MBEDTLS_SSL_COMPRESS_NULL 0 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 288 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 289 | #define MBEDTLS_SSL_VERIFY_NONE 0 |
| 290 | #define MBEDTLS_SSL_VERIFY_OPTIONAL 1 |
| 291 | #define MBEDTLS_SSL_VERIFY_REQUIRED 2 |
Manuel Pégourié-Gonnard | cdc26ae | 2015-06-19 12:16:31 +0200 | [diff] [blame] | 292 | #define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 293 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 294 | #define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0 |
| 295 | #define MBEDTLS_SSL_SECURE_RENEGOTIATION 1 |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 296 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 297 | #define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0 |
| 298 | #define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1 |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 299 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 300 | #define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0 |
| 301 | #define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1 |
Manuel Pégourié-Gonnard | 2739313 | 2014-09-24 14:41:11 +0200 | [diff] [blame] | 302 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 303 | #define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1 |
| 304 | #define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16 |
Manuel Pégourié-Gonnard | a9964db | 2014-07-03 19:29:16 +0200 | [diff] [blame] | 305 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 306 | #define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0 |
| 307 | #define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1 |
| 308 | #define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2 |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 309 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 310 | #define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0 |
| 311 | #define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1 |
| 312 | #define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */ |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 313 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 314 | #define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0 |
| 315 | #define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1 |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 316 | |
Manuel Pégourié-Gonnard | b31c5f6 | 2015-06-17 13:53:47 +0200 | [diff] [blame] | 317 | #define MBEDTLS_SSL_PRESET_DEFAULT 0 |
| 318 | #define MBEDTLS_SSL_PRESET_SUITEB 2 |
| 319 | |
Janos Follath | 088ce43 | 2017-04-10 12:42:31 +0100 | [diff] [blame] | 320 | #define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1 |
| 321 | #define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0 |
| 322 | |
Xiaokang Qian | 54413b1 | 2022-10-20 05:57:03 +0000 | [diff] [blame] | 323 | #define MBEDTLS_SSL_EARLY_DATA_DISABLED 0 |
| 324 | #define MBEDTLS_SSL_EARLY_DATA_ENABLED 1 |
| 325 | |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 326 | #define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0 |
| 327 | #define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1 |
| 328 | |
TRodziewicz | 3946f79 | 2021-06-14 12:11:18 +0200 | [diff] [blame] | 329 | #define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1 |
| 330 | #define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0 |
TRodziewicz | 8476f2f | 2021-06-02 14:34:47 +0200 | [diff] [blame] | 331 | |
Jerry Yu | 0a430c8 | 2022-07-20 11:02:48 +0800 | [diff] [blame] | 332 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) |
Przemyslaw Stekiel | 034492b | 2022-09-14 11:09:20 +0200 | [diff] [blame] | 333 | #if defined(PSA_WANT_ALG_SHA_384) |
Jerry Yu | 0a430c8 | 2022-07-20 11:02:48 +0800 | [diff] [blame] | 334 | #define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 48 |
Przemyslaw Stekiel | 034492b | 2022-09-14 11:09:20 +0200 | [diff] [blame] | 335 | #elif defined(PSA_WANT_ALG_SHA_256) |
Jerry Yu | 0a430c8 | 2022-07-20 11:02:48 +0800 | [diff] [blame] | 336 | #define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 32 |
Przemek Stekiel | a9a8816 | 2022-09-02 13:18:55 +0200 | [diff] [blame] | 337 | #endif |
Jerry Yu | 0a430c8 | 2022-07-20 11:02:48 +0800 | [diff] [blame] | 338 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */ |
Manuel Pégourié-Gonnard | ffa67be | 2014-09-19 11:18:57 +0200 | [diff] [blame] | 339 | /* |
Manuel Pégourié-Gonnard | 0ac247f | 2014-09-30 22:21:31 +0200 | [diff] [blame] | 340 | * Default range for DTLS retransmission timer value, in milliseconds. |
| 341 | * RFC 6347 4.2.4.1 says from 1 second to 60 seconds. |
| 342 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 343 | #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000 |
| 344 | #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000 |
Manuel Pégourié-Gonnard | 0ac247f | 2014-09-30 22:21:31 +0200 | [diff] [blame] | 345 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 346 | /** |
| 347 | * \name SECTION: Module settings |
| 348 | * |
| 349 | * The configuration options you can set for this module are in this section. |
Bence Szépkúti | bb0cfeb | 2021-05-28 09:42:25 +0200 | [diff] [blame] | 350 | * Either change them in mbedtls_config.h or define them on the compiler command line. |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 351 | * \{ |
| 352 | */ |
| 353 | |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 354 | /* |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 355 | * Maximum fragment length in bytes, |
Manuel Pégourié-Gonnard | bb83844 | 2015-08-31 12:46:01 +0200 | [diff] [blame] | 356 | * determines the size of each of the two internal I/O buffers. |
| 357 | * |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 358 | * Note: the RFC defines the default size of SSL / TLS messages. If you |
| 359 | * change the value here, other clients / servers may not be able to |
| 360 | * communicate with you anymore. Only change this value if you control |
Manuel Pégourié-Gonnard | c27807d | 2014-06-30 17:27:49 +0200 | [diff] [blame] | 361 | * both sides of the connection and have it reduced at both sides, or |
| 362 | * if you're using the Max Fragment Length extension and you know all your |
| 363 | * peers are using it too! |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 364 | */ |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 365 | #if !defined(MBEDTLS_SSL_IN_CONTENT_LEN) |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 366 | #define MBEDTLS_SSL_IN_CONTENT_LEN 16384 |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 367 | #endif |
| 368 | |
| 369 | #if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN) |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 370 | #define MBEDTLS_SSL_OUT_CONTENT_LEN 16384 |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 371 | #endif |
| 372 | |
Hanno Becker | 2800751 | 2018-08-28 09:46:44 +0100 | [diff] [blame] | 373 | /* |
| 374 | * Maximum number of heap-allocated bytes for the purpose of |
| 375 | * DTLS handshake message reassembly and future message buffering. |
| 376 | */ |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 377 | #if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING) |
Hanno Becker | 2800751 | 2018-08-28 09:46:44 +0100 | [diff] [blame] | 378 | #define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768 |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 379 | #endif |
| 380 | |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 381 | /* |
| 382 | * Maximum length of CIDs for incoming and outgoing messages. |
| 383 | */ |
| 384 | #if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX) |
Hanno Becker | 08cbc0c | 2019-05-15 10:09:15 +0100 | [diff] [blame] | 385 | #define MBEDTLS_SSL_CID_IN_LEN_MAX 32 |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 386 | #endif |
| 387 | |
| 388 | #if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX) |
| 389 | #define MBEDTLS_SSL_CID_OUT_LEN_MAX 32 |
| 390 | #endif |
| 391 | |
TRodziewicz | e8dd709 | 2021-05-12 14:19:11 +0200 | [diff] [blame] | 392 | #if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) |
| 393 | #define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16 |
Hanno Becker | 1399692 | 2020-05-28 16:15:19 +0100 | [diff] [blame] | 394 | #endif |
| 395 | |
Tom Cosgrove | 3b4471e | 2023-09-14 12:59:50 +0100 | [diff] [blame] | 396 | #if !defined(MBEDTLS_SSL_MAX_EARLY_DATA_SIZE) |
| 397 | #define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024 |
| 398 | #endif |
| 399 | |
Gilles Peskine | d65ea42 | 2023-09-05 21:07:32 +0200 | [diff] [blame] | 400 | #if !defined(MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) |
| 401 | #define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000 |
| 402 | #endif |
| 403 | |
| 404 | #if !defined(MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH) |
| 405 | #define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32 |
| 406 | #endif |
| 407 | |
| 408 | #if !defined(MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS) |
| 409 | #define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1 |
| 410 | #endif |
| 411 | |
Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 412 | /** \} name SECTION: Module settings */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 413 | |
| 414 | /* |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 415 | * Default to standard CID mode |
| 416 | */ |
| 417 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \ |
| 418 | !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT) |
| 419 | #define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0 |
| 420 | #endif |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 421 | |
| 422 | /* |
Manuel Pégourié-Gonnard | 6186019 | 2014-11-04 13:05:42 +0100 | [diff] [blame] | 423 | * Length of the verify data for secure renegotiation |
| 424 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 425 | #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12 |
Manuel Pégourié-Gonnard | 6186019 | 2014-11-04 13:05:42 +0100 | [diff] [blame] | 426 | |
| 427 | /* |
Manuel Pégourié-Gonnard | c27807d | 2014-06-30 17:27:49 +0200 | [diff] [blame] | 428 | * Signaling ciphersuite values (SCSV) |
| 429 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 430 | #define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 431 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 432 | /* |
Paul Bakker | 1ef83d6 | 2012-04-11 12:09:53 +0000 | [diff] [blame] | 433 | * Supported Signature and Hash algorithms (For TLS 1.2) |
Manuel Pégourié-Gonnard | 0b03200 | 2013-08-17 13:01:41 +0200 | [diff] [blame] | 434 | * RFC 5246 section 7.4.1.4.1 |
Paul Bakker | 1ef83d6 | 2012-04-11 12:09:53 +0000 | [diff] [blame] | 435 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 436 | #define MBEDTLS_SSL_HASH_NONE 0 |
| 437 | #define MBEDTLS_SSL_HASH_MD5 1 |
| 438 | #define MBEDTLS_SSL_HASH_SHA1 2 |
| 439 | #define MBEDTLS_SSL_HASH_SHA224 3 |
| 440 | #define MBEDTLS_SSL_HASH_SHA256 4 |
| 441 | #define MBEDTLS_SSL_HASH_SHA384 5 |
| 442 | #define MBEDTLS_SSL_HASH_SHA512 6 |
Paul Bakker | 1ef83d6 | 2012-04-11 12:09:53 +0000 | [diff] [blame] | 443 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 444 | #define MBEDTLS_SSL_SIG_ANON 0 |
| 445 | #define MBEDTLS_SSL_SIG_RSA 1 |
| 446 | #define MBEDTLS_SSL_SIG_ECDSA 3 |
Paul Bakker | 1ef83d6 | 2012-04-11 12:09:53 +0000 | [diff] [blame] | 447 | |
| 448 | /* |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 449 | * TLS 1.3 signature algorithms |
| 450 | * RFC 8446, Section 4.2.2 |
| 451 | */ |
| 452 | |
| 453 | /* RSASSA-PKCS1-v1_5 algorithms */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 454 | #define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256 0x0401 |
| 455 | #define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384 0x0501 |
| 456 | #define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512 0x0601 |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 457 | |
| 458 | /* ECDSA algorithms */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 459 | #define MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256 0x0403 |
| 460 | #define MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384 0x0503 |
| 461 | #define MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512 0x0603 |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 462 | |
| 463 | /* RSASSA-PSS algorithms with public key OID rsaEncryption */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 464 | #define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256 0x0804 |
| 465 | #define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384 0x0805 |
| 466 | #define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512 0x0806 |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 467 | |
| 468 | /* EdDSA algorithms */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 469 | #define MBEDTLS_TLS1_3_SIG_ED25519 0x0807 |
| 470 | #define MBEDTLS_TLS1_3_SIG_ED448 0x0808 |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 471 | |
| 472 | /* RSASSA-PSS algorithms with public key OID RSASSA-PSS */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 473 | #define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA256 0x0809 |
| 474 | #define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA384 0x080A |
| 475 | #define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA512 0x080B |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 476 | |
| 477 | /* LEGACY ALGORITHMS */ |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 478 | #define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA1 0x0201 |
| 479 | #define MBEDTLS_TLS1_3_SIG_ECDSA_SHA1 0x0203 |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 480 | |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 481 | #define MBEDTLS_TLS1_3_SIG_NONE 0x0 |
Hanno Becker | 551265f | 2021-08-10 13:03:48 +0100 | [diff] [blame] | 482 | |
| 483 | /* |
Paul Bakker | 926af75 | 2012-11-23 13:38:07 +0100 | [diff] [blame] | 484 | * Client Certificate Types |
Manuel Pégourié-Gonnard | 0b03200 | 2013-08-17 13:01:41 +0200 | [diff] [blame] | 485 | * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5 |
Paul Bakker | 926af75 | 2012-11-23 13:38:07 +0100 | [diff] [blame] | 486 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 487 | #define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1 |
| 488 | #define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64 |
Paul Bakker | 926af75 | 2012-11-23 13:38:07 +0100 | [diff] [blame] | 489 | |
| 490 | /* |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 491 | * Message, alert and handshake types |
| 492 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 493 | #define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20 |
| 494 | #define MBEDTLS_SSL_MSG_ALERT 21 |
| 495 | #define MBEDTLS_SSL_MSG_HANDSHAKE 22 |
| 496 | #define MBEDTLS_SSL_MSG_APPLICATION_DATA 23 |
Hanno Becker | 8b3eb5a | 2019-04-29 17:31:37 +0100 | [diff] [blame] | 497 | #define MBEDTLS_SSL_MSG_CID 25 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 498 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 499 | #define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1 |
| 500 | #define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2 |
Paul Bakker | 2e11f7d | 2010-07-25 14:24:53 +0000 | [diff] [blame] | 501 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 502 | #define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */ |
| 503 | #define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */ |
| 504 | #define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */ |
| 505 | #define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */ |
| 506 | #define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */ |
| 507 | #define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */ |
| 508 | #define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */ |
| 509 | #define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */ |
| 510 | #define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */ |
| 511 | #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */ |
| 512 | #define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */ |
| 513 | #define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */ |
| 514 | #define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */ |
| 515 | #define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */ |
| 516 | #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */ |
| 517 | #define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */ |
| 518 | #define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */ |
| 519 | #define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */ |
| 520 | #define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */ |
| 521 | #define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */ |
| 522 | #define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */ |
| 523 | #define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */ |
| 524 | #define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */ |
| 525 | #define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */ |
| 526 | #define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */ |
XiaokangQian | 7807f9f | 2022-02-15 10:04:37 +0000 | [diff] [blame] | 527 | #define MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION 109 /* 0x6d -- new in TLS 1.3 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 528 | #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */ |
| 529 | #define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */ |
| 530 | #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */ |
XiaokangQian | 6b916b1 | 2022-04-25 07:29:34 +0000 | [diff] [blame] | 531 | #define MBEDTLS_SSL_ALERT_MSG_CERT_REQUIRED 116 /* 0x74 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 532 | #define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 533 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 534 | #define MBEDTLS_SSL_HS_HELLO_REQUEST 0 |
| 535 | #define MBEDTLS_SSL_HS_CLIENT_HELLO 1 |
| 536 | #define MBEDTLS_SSL_HS_SERVER_HELLO 2 |
| 537 | #define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3 |
| 538 | #define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4 |
Xiaokang Qian | 5b41007 | 2023-01-03 10:31:15 +0000 | [diff] [blame] | 539 | #define MBEDTLS_SSL_HS_END_OF_EARLY_DATA 5 |
| 540 | #define MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS 8 |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 541 | #define MBEDTLS_SSL_HS_CERTIFICATE 11 |
| 542 | #define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12 |
| 543 | #define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13 |
| 544 | #define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14 |
| 545 | #define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15 |
| 546 | #define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16 |
| 547 | #define MBEDTLS_SSL_HS_FINISHED 20 |
XiaokangQian | 647719a | 2021-12-07 09:16:29 +0000 | [diff] [blame] | 548 | #define MBEDTLS_SSL_HS_MESSAGE_HASH 254 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 549 | |
| 550 | /* |
| 551 | * TLS extensions |
| 552 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 553 | #define MBEDTLS_TLS_EXT_SERVERNAME 0 |
| 554 | #define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 555 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 556 | #define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1 |
Manuel Pégourié-Gonnard | 48f8d0d | 2013-07-17 10:25:37 +0200 | [diff] [blame] | 557 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 558 | #define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4 |
Jerry Yu | a2cf7bd | 2021-08-31 16:12:00 +0800 | [diff] [blame] | 559 | #define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */ |
Manuel Pégourié-Gonnard | 57c2852 | 2013-07-19 11:41:43 +0200 | [diff] [blame] | 560 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 561 | #define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10 |
Jerry Yu | a2cf7bd | 2021-08-31 16:12:00 +0800 | [diff] [blame] | 562 | #define MBEDTLS_TLS_EXT_SUPPORTED_GROUPS 10 /* RFC 8422,7919 TLS 1.2 and 1.3 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 563 | #define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11 |
Paul Bakker | c3f177a | 2012-04-11 16:11:49 +0000 | [diff] [blame] | 564 | |
Jerry Yu | b3317e1 | 2021-08-26 14:30:22 +0800 | [diff] [blame] | 565 | #define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */ |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 566 | #define MBEDTLS_TLS_EXT_USE_SRTP 14 |
Jerry Yu | a2cf7bd | 2021-08-31 16:12:00 +0800 | [diff] [blame] | 567 | #define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 568 | #define MBEDTLS_TLS_EXT_ALPN 16 |
Manuel Pégourié-Gonnard | 0b874dc | 2014-04-07 10:57:45 +0200 | [diff] [blame] | 569 | |
Jerry Yu | a2cf7bd | 2021-08-31 16:12:00 +0800 | [diff] [blame] | 570 | #define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */ |
Jerry Yu | 1bc2c1f | 2021-09-01 12:57:29 +0800 | [diff] [blame] | 571 | #define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */ |
| 572 | #define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */ |
| 573 | #define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 574 | #define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */ |
| 575 | #define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */ |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 576 | |
Jan Bruckner | 151f642 | 2023-02-10 12:45:19 +0100 | [diff] [blame] | 577 | #define MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT 28 /* RFC 8449 (implemented for TLS 1.3 only) */ |
| 578 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 579 | #define MBEDTLS_TLS_EXT_SESSION_TICKET 35 |
Manuel Pégourié-Gonnard | 60182ef | 2013-08-02 14:44:54 +0200 | [diff] [blame] | 580 | |
Jerry Yu | b3317e1 | 2021-08-26 14:30:22 +0800 | [diff] [blame] | 581 | #define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */ |
| 582 | #define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */ |
| 583 | #define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */ |
| 584 | #define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */ |
| 585 | #define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */ |
Jerry Yu | 7984d99 | 2021-08-18 10:31:29 +0800 | [diff] [blame] | 586 | |
Jerry Yu | b3317e1 | 2021-08-26 14:30:22 +0800 | [diff] [blame] | 587 | #define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */ |
| 588 | #define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */ |
| 589 | #define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */ |
| 590 | #define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */ |
| 591 | #define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */ |
Jerry Yu | 7984d99 | 2021-08-18 10:31:29 +0800 | [diff] [blame] | 592 | |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 593 | #if MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0 |
| 594 | #define MBEDTLS_TLS_EXT_CID 54 /* RFC 9146 DTLS 1.2 CID */ |
| 595 | #else |
| 596 | #define MBEDTLS_TLS_EXT_CID 254 /* Pre-RFC 9146 DTLS 1.2 CID */ |
Gilles Peskine | 7dd2f50 | 2021-04-24 13:35:41 +0200 | [diff] [blame] | 597 | #endif |
Hanno Becker | 0652bc5 | 2019-04-25 16:24:57 +0100 | [diff] [blame] | 598 | |
Manuel Pégourié-Gonnard | 294139b | 2015-09-15 16:55:05 +0200 | [diff] [blame] | 599 | #define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */ |
| 600 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 601 | #define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01 |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 602 | |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 603 | /* |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 604 | * Size defines |
| 605 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 606 | #if !defined(MBEDTLS_PSK_MAX_LEN) |
Ronald Cron | 1aa6e8d | 2023-02-23 09:46:54 +0100 | [diff] [blame] | 607 | /* |
| 608 | * If the library supports TLS 1.3 tickets and the cipher suite |
| 609 | * TLS1-3-AES-256-GCM-SHA384, set the PSK maximum length to 48 instead of 32. |
| 610 | * That way, the TLS 1.3 client and server are able to resume sessions where |
Ronald Cron | ee54de0 | 2023-02-24 12:06:30 +0100 | [diff] [blame] | 611 | * the cipher suite is TLS1-3-AES-256-GCM-SHA384 (pre-shared keys are 48 |
| 612 | * bytes long in that case). |
Ronald Cron | 1aa6e8d | 2023-02-23 09:46:54 +0100 | [diff] [blame] | 613 | */ |
| 614 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \ |
| 615 | defined(MBEDTLS_SSL_SESSION_TICKETS) && \ |
Valerio Setti | 01c4fa3 | 2023-11-09 10:46:36 +0100 | [diff] [blame] | 616 | defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM) && \ |
Paul Elliott | 6903438 | 2023-03-27 21:24:45 +0100 | [diff] [blame] | 617 | defined(MBEDTLS_MD_CAN_SHA384) |
Ronald Cron | 1aa6e8d | 2023-02-23 09:46:54 +0100 | [diff] [blame] | 618 | #define MBEDTLS_PSK_MAX_LEN 48 /* 384 bits */ |
| 619 | #else |
| 620 | #define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 621 | #endif |
Ronald Cron | 1aa6e8d | 2023-02-23 09:46:54 +0100 | [diff] [blame] | 622 | #endif /* !MBEDTLS_PSK_MAX_LEN */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 623 | |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 624 | /* Dummy type used only for its size */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 625 | union mbedtls_ssl_premaster_secret { |
Gilles Peskine | e8e1e15 | 2023-06-25 21:41:58 +0200 | [diff] [blame] | 626 | unsigned char dummy; /* Make the union non-empty even with SSL disabled */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 627 | #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 628 | unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */ |
| 629 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 630 | #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) |
| 631 | unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */ |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 632 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 633 | #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \ |
| 634 | defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \ |
| 635 | defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \ |
| 636 | defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED) |
| 637 | unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */ |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 638 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 639 | #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) |
| 640 | unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */ |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 641 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 642 | #if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) |
| 643 | unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 644 | + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */ |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 645 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 646 | #if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) |
| 647 | unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */ |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 648 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 649 | #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED) |
| 650 | unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 651 | + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */ |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 652 | #endif |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 653 | #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
| 654 | unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */ |
| 655 | #endif |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 656 | }; |
| 657 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 658 | #define MBEDTLS_PREMASTER_SIZE sizeof(union mbedtls_ssl_premaster_secret) |
Manuel Pégourié-Gonnard | 481fcfd | 2014-07-03 16:12:50 +0200 | [diff] [blame] | 659 | |
Przemyslaw Stekiel | 67ffab5 | 2022-09-14 14:07:01 +0200 | [diff] [blame] | 660 | #define MBEDTLS_TLS1_3_MD_MAX_SIZE PSA_HASH_MAX_SIZE |
Przemyslaw Stekiel | 67ffab5 | 2022-09-14 14:07:01 +0200 | [diff] [blame] | 661 | |
XiaokangQian | c5c39d5 | 2021-11-09 11:55:10 +0000 | [diff] [blame] | 662 | |
Jerry Yu | d96a5c2 | 2021-09-29 17:46:51 +0800 | [diff] [blame] | 663 | /* Length in number of bytes of the TLS sequence number */ |
Jerry Yu | ae0b2e2 | 2021-10-08 15:21:19 +0800 | [diff] [blame] | 664 | #define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN 8 |
Jerry Yu | 957f0fa | 2021-09-24 10:27:07 +0800 | [diff] [blame] | 665 | |
Paul Bakker | 407a0da | 2013-06-27 14:29:21 +0200 | [diff] [blame] | 666 | #ifdef __cplusplus |
| 667 | extern "C" { |
| 668 | #endif |
| 669 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 670 | /* |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 671 | * SSL state machine |
| 672 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 673 | typedef enum { |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 674 | MBEDTLS_SSL_HELLO_REQUEST, |
| 675 | MBEDTLS_SSL_CLIENT_HELLO, |
| 676 | MBEDTLS_SSL_SERVER_HELLO, |
| 677 | MBEDTLS_SSL_SERVER_CERTIFICATE, |
| 678 | MBEDTLS_SSL_SERVER_KEY_EXCHANGE, |
| 679 | MBEDTLS_SSL_CERTIFICATE_REQUEST, |
| 680 | MBEDTLS_SSL_SERVER_HELLO_DONE, |
| 681 | MBEDTLS_SSL_CLIENT_CERTIFICATE, |
| 682 | MBEDTLS_SSL_CLIENT_KEY_EXCHANGE, |
| 683 | MBEDTLS_SSL_CERTIFICATE_VERIFY, |
| 684 | MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC, |
| 685 | MBEDTLS_SSL_CLIENT_FINISHED, |
| 686 | MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC, |
| 687 | MBEDTLS_SSL_SERVER_FINISHED, |
| 688 | MBEDTLS_SSL_FLUSH_BUFFERS, |
| 689 | MBEDTLS_SSL_HANDSHAKE_WRAPUP, |
Jerry Yu | a357cf4 | 2022-07-12 05:36:45 +0000 | [diff] [blame] | 690 | MBEDTLS_SSL_NEW_SESSION_TICKET, |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 691 | MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT, |
XiaokangQian | 7807f9f | 2022-02-15 10:04:37 +0000 | [diff] [blame] | 692 | MBEDTLS_SSL_HELLO_RETRY_REQUEST, |
Jerry Yu | a13c7e7 | 2021-08-17 10:44:40 +0800 | [diff] [blame] | 693 | MBEDTLS_SSL_ENCRYPTED_EXTENSIONS, |
Xiaokang Qian | 125afcb | 2022-10-28 06:04:06 +0000 | [diff] [blame] | 694 | MBEDTLS_SSL_END_OF_EARLY_DATA, |
Jerry Yu | 687101b | 2021-09-14 16:03:56 +0800 | [diff] [blame] | 695 | MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY, |
Ronald Cron | 49ad619 | 2021-11-24 16:25:31 +0100 | [diff] [blame] | 696 | MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED, |
XiaokangQian | 647719a | 2021-12-07 09:16:29 +0000 | [diff] [blame] | 697 | MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO, |
Gabor Mezei | 7b39bf1 | 2022-05-24 16:04:14 +0200 | [diff] [blame] | 698 | MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO, |
Xiaokang Qian | 592021a | 2023-01-04 10:47:05 +0000 | [diff] [blame] | 699 | MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO, |
Gabor Mezei | f7044ea | 2022-06-28 16:01:49 +0200 | [diff] [blame] | 700 | MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST, |
Jerry Yu | 5ed73ff | 2022-10-27 13:08:42 +0800 | [diff] [blame] | 701 | MBEDTLS_SSL_HANDSHAKE_OVER, |
Jerry Yu | a8d3c50 | 2022-10-30 14:51:23 +0800 | [diff] [blame] | 702 | MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET, |
| 703 | MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH, |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 704 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 705 | mbedtls_ssl_states; |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 706 | |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 707 | /** |
| 708 | * \brief Callback type: send data on the network. |
| 709 | * |
| 710 | * \note That callback may be either blocking or non-blocking. |
| 711 | * |
| 712 | * \param ctx Context for the send callback (typically a file descriptor) |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 713 | * \param buf Buffer holding the data to send |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 714 | * \param len Length of the data to send |
| 715 | * |
| 716 | * \return The callback must return the number of bytes sent if any, |
| 717 | * or a non-zero error code. |
| 718 | * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE |
| 719 | * must be returned when the operation would block. |
| 720 | * |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 721 | * \note The callback is allowed to send fewer bytes than requested. |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 722 | * It must always return the number of bytes actually sent. |
| 723 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 724 | typedef int mbedtls_ssl_send_t(void *ctx, |
| 725 | const unsigned char *buf, |
| 726 | size_t len); |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 727 | |
| 728 | /** |
| 729 | * \brief Callback type: receive data from the network. |
| 730 | * |
| 731 | * \note That callback may be either blocking or non-blocking. |
| 732 | * |
| 733 | * \param ctx Context for the receive callback (typically a file |
| 734 | * descriptor) |
| 735 | * \param buf Buffer to write the received data to |
| 736 | * \param len Length of the receive buffer |
| 737 | * |
Hanno Becker | 218dec8 | 2021-07-23 07:23:47 +0100 | [diff] [blame] | 738 | * \returns If data has been received, the positive number of bytes received. |
| 739 | * \returns \c 0 if the connection has been closed. |
| 740 | * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 741 | * must be returned when the operation would block. |
Hanno Becker | 218dec8 | 2021-07-23 07:23:47 +0100 | [diff] [blame] | 742 | * \returns Another negative error code on other kinds of failures. |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 743 | * |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 744 | * \note The callback may receive fewer bytes than the length of the |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 745 | * buffer. It must always return the number of bytes actually |
| 746 | * received and written to the buffer. |
| 747 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 748 | typedef int mbedtls_ssl_recv_t(void *ctx, |
| 749 | unsigned char *buf, |
| 750 | size_t len); |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 751 | |
| 752 | /** |
| 753 | * \brief Callback type: receive data from the network, with timeout |
| 754 | * |
| 755 | * \note That callback must block until data is received, or the |
| 756 | * timeout delay expires, or the operation is interrupted by a |
| 757 | * signal. |
| 758 | * |
| 759 | * \param ctx Context for the receive callback (typically a file descriptor) |
| 760 | * \param buf Buffer to write the received data to |
| 761 | * \param len Length of the receive buffer |
Andrey Starodubtsev | 90cc33a | 2021-08-23 12:14:56 +0300 | [diff] [blame] | 762 | * \param timeout Maximum number of milliseconds to wait for data |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 763 | * 0 means no timeout (potentially waiting forever) |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 764 | * |
| 765 | * \return The callback must return the number of bytes received, |
| 766 | * or a non-zero error code: |
| 767 | * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out, |
| 768 | * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal. |
| 769 | * |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 770 | * \note The callback may receive fewer bytes than the length of the |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 771 | * buffer. It must always return the number of bytes actually |
| 772 | * received and written to the buffer. |
| 773 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 774 | typedef int mbedtls_ssl_recv_timeout_t(void *ctx, |
| 775 | unsigned char *buf, |
| 776 | size_t len, |
| 777 | uint32_t timeout); |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 778 | /** |
| 779 | * \brief Callback type: set a pair of timers/delays to watch |
| 780 | * |
| 781 | * \param ctx Context pointer |
| 782 | * \param int_ms Intermediate delay in milliseconds |
| 783 | * \param fin_ms Final delay in milliseconds |
| 784 | * 0 cancels the current timer. |
| 785 | * |
| 786 | * \note This callback must at least store the necessary information |
| 787 | * for the associated \c mbedtls_ssl_get_timer_t callback to |
| 788 | * return correct information. |
| 789 | * |
Tom Cosgrove | ce7f18c | 2022-07-28 05:50:56 +0100 | [diff] [blame] | 790 | * \note If using an event-driven style of programming, an event must |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 791 | * be generated when the final delay is passed. The event must |
| 792 | * cause a call to \c mbedtls_ssl_handshake() with the proper |
| 793 | * SSL context to be scheduled. Care must be taken to ensure |
| 794 | * that at most one such call happens at a time. |
| 795 | * |
| 796 | * \note Only one timer at a time must be running. Calling this |
| 797 | * function while a timer is running must cancel it. Cancelled |
| 798 | * timers must not generate any event. |
| 799 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 800 | typedef void mbedtls_ssl_set_timer_t(void *ctx, |
| 801 | uint32_t int_ms, |
| 802 | uint32_t fin_ms); |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 803 | |
| 804 | /** |
| 805 | * \brief Callback type: get status of timers/delays |
| 806 | * |
| 807 | * \param ctx Context pointer |
| 808 | * |
| 809 | * \return This callback must return: |
| 810 | * -1 if cancelled (fin_ms == 0), |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 811 | * 0 if none of the delays have passed, |
| 812 | * 1 if only the intermediate delay has passed, |
| 813 | * 2 if the final delay has passed. |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 814 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 815 | typedef int mbedtls_ssl_get_timer_t(void *ctx); |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 816 | |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 817 | /* Defined below */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 818 | typedef struct mbedtls_ssl_session mbedtls_ssl_session; |
| 819 | typedef struct mbedtls_ssl_context mbedtls_ssl_context; |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 820 | typedef struct mbedtls_ssl_config mbedtls_ssl_config; |
| 821 | |
Chris Jones | 3848e31 | 2021-03-11 16:17:59 +0000 | [diff] [blame] | 822 | /* Defined in library/ssl_misc.h */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 823 | typedef struct mbedtls_ssl_transform mbedtls_ssl_transform; |
| 824 | typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params; |
Hanno Becker | 7e5437a | 2017-04-28 17:15:26 +0100 | [diff] [blame] | 825 | typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t; |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 826 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 827 | typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert; |
Manuel Pégourié-Gonnard | 834ea85 | 2013-09-23 14:46:13 +0200 | [diff] [blame] | 828 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 829 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
| 830 | typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item; |
Manuel Pégourié-Gonnard | ffa67be | 2014-09-19 11:18:57 +0200 | [diff] [blame] | 831 | #endif |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 832 | |
Xiaokang Qian | f447e8a | 2022-11-08 07:02:27 +0000 | [diff] [blame] | 833 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) |
Xiaokang Qian | 51c5a8b | 2022-11-16 08:32:51 +0000 | [diff] [blame] | 834 | #define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 835 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK /* 1U << 0 */ |
Xiaokang Qian | 51c5a8b | 2022-11-16 08:32:51 +0000 | [diff] [blame] | 836 | #define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 837 | MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL /* 1U << 2 */ |
| 838 | #define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA (1U << 3) |
Xiaokang Qian | 51c5a8b | 2022-11-16 08:32:51 +0000 | [diff] [blame] | 839 | |
| 840 | #define MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 841 | (MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION | \ |
| 842 | MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION | \ |
| 843 | MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) |
Xiaokang Qian | f447e8a | 2022-11-08 07:02:27 +0000 | [diff] [blame] | 844 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */ |
Xiaokang Qian | 51c5a8b | 2022-11-16 08:32:51 +0000 | [diff] [blame] | 845 | |
Hanno Becker | 0248785 | 2021-05-13 06:26:57 +0100 | [diff] [blame] | 846 | /** |
| 847 | * \brief Callback type: server-side session cache getter |
| 848 | * |
| 849 | * The session cache is logically a key value store, with |
| 850 | * keys being session IDs and values being instances of |
| 851 | * mbedtls_ssl_session. |
| 852 | * |
| 853 | * This callback retrieves an entry in this key-value store. |
| 854 | * |
| 855 | * \param data The address of the session cache structure to query. |
| 856 | * \param session_id The buffer holding the session ID to query. |
| 857 | * \param session_id_len The length of \p session_id in Bytes. |
Hanno Becker | 0d05f40 | 2021-05-14 04:54:01 +0100 | [diff] [blame] | 858 | * \param session The address of the session structure to populate. |
| 859 | * It is initialized with mbdtls_ssl_session_init(), |
| 860 | * and the callback must always leave it in a state |
Hanno Becker | 9caed14 | 2021-05-14 14:57:13 +0100 | [diff] [blame] | 861 | * where it can safely be freed via |
Hanno Becker | 0d05f40 | 2021-05-14 04:54:01 +0100 | [diff] [blame] | 862 | * mbedtls_ssl_session_free() independent of the |
| 863 | * return code of this function. |
Hanno Becker | 0248785 | 2021-05-13 06:26:57 +0100 | [diff] [blame] | 864 | * |
| 865 | * \return \c 0 on success |
| 866 | * \return A non-zero return value on failure. |
Hanno Becker | 0d05f40 | 2021-05-14 04:54:01 +0100 | [diff] [blame] | 867 | * |
Hanno Becker | 0248785 | 2021-05-13 06:26:57 +0100 | [diff] [blame] | 868 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 869 | typedef int mbedtls_ssl_cache_get_t(void *data, |
| 870 | unsigned char const *session_id, |
| 871 | size_t session_id_len, |
| 872 | mbedtls_ssl_session *session); |
Hanno Becker | 0248785 | 2021-05-13 06:26:57 +0100 | [diff] [blame] | 873 | /** |
| 874 | * \brief Callback type: server-side session cache setter |
| 875 | * |
| 876 | * The session cache is logically a key value store, with |
| 877 | * keys being session IDs and values being instances of |
| 878 | * mbedtls_ssl_session. |
| 879 | * |
| 880 | * This callback sets an entry in this key-value store. |
| 881 | * |
| 882 | * \param data The address of the session cache structure to modify. |
| 883 | * \param session_id The buffer holding the session ID to query. |
| 884 | * \param session_id_len The length of \p session_id in Bytes. |
| 885 | * \param session The address of the session to be stored in the |
| 886 | * session cache. |
| 887 | * |
| 888 | * \return \c 0 on success |
| 889 | * \return A non-zero return value on failure. |
| 890 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 891 | typedef int mbedtls_ssl_cache_set_t(void *data, |
| 892 | unsigned char const *session_id, |
| 893 | size_t session_id_len, |
| 894 | const mbedtls_ssl_session *session); |
Hanno Becker | a637ff6 | 2021-04-15 08:42:48 +0100 | [diff] [blame] | 895 | |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 896 | #if defined(MBEDTLS_SSL_ASYNC_PRIVATE) |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 897 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 898 | /** |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 899 | * \brief Callback type: start external signature operation. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 900 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 901 | * This callback is called during an SSL handshake to start |
| 902 | * a signature decryption operation using an |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 903 | * external processor. The parameter \p cert contains |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 904 | * the public key; it is up to the callback function to |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 905 | * determine how to access the associated private key. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 906 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 907 | * This function typically sends or enqueues a request, and |
| 908 | * does not wait for the operation to complete. This allows |
| 909 | * the handshake step to be non-blocking. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 910 | * |
Gilles Peskine | 6a8cb36 | 2018-04-30 11:54:14 +0200 | [diff] [blame] | 911 | * The parameters \p ssl and \p cert are guaranteed to remain |
| 912 | * valid throughout the handshake. On the other hand, this |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 913 | * function must save the contents of \p hash if the value |
| 914 | * is needed for later processing, because the \p hash buffer |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 915 | * is no longer valid after this function returns. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 916 | * |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 917 | * This function may call mbedtls_ssl_set_async_operation_data() |
| 918 | * to store an operation context for later retrieval |
Gilles Peskine | ea5fab8 | 2018-04-30 13:57:45 +0200 | [diff] [blame] | 919 | * by the resume or cancel callback. |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 920 | * |
Gilles Peskine | d326883 | 2018-04-26 06:23:59 +0200 | [diff] [blame] | 921 | * \note For RSA signatures, this function must produce output |
| 922 | * that is consistent with PKCS#1 v1.5 in the same way as |
| 923 | * mbedtls_rsa_pkcs1_sign(). Before the private key operation, |
| 924 | * apply the padding steps described in RFC 8017, section 9.2 |
| 925 | * "EMSA-PKCS1-v1_5" as follows. |
| 926 | * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5 |
| 927 | * encoding, treating \p hash as the DigestInfo to be |
| 928 | * padded. In other words, apply EMSA-PKCS1-v1_5 starting |
| 929 | * from step 3, with `T = hash` and `tLen = hash_len`. |
Gilles Peskine | 6a8cb36 | 2018-04-30 11:54:14 +0200 | [diff] [blame] | 930 | * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5 |
Gilles Peskine | d326883 | 2018-04-26 06:23:59 +0200 | [diff] [blame] | 931 | * encoding, treating \p hash as the hash to be encoded and |
| 932 | * padded. In other words, apply EMSA-PKCS1-v1_5 starting |
| 933 | * from step 2, with `digestAlgorithm` obtained by calling |
| 934 | * mbedtls_oid_get_oid_by_md() on \p md_alg. |
| 935 | * |
Gilles Peskine | 20deb01 | 2018-04-26 17:57:37 +0200 | [diff] [blame] | 936 | * \note For ECDSA signatures, the output format is the DER encoding |
| 937 | * `Ecdsa-Sig-Value` defined in |
| 938 | * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4). |
| 939 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 940 | * \param ssl The SSL connection instance. It should not be |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 941 | * modified other than via |
| 942 | * mbedtls_ssl_set_async_operation_data(). |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 943 | * \param cert Certificate containing the public key. |
Gilles Peskine | 807d74a | 2018-04-30 10:30:49 +0200 | [diff] [blame] | 944 | * In simple cases, this is one of the pointers passed to |
Gilles Peskine | 20deb01 | 2018-04-26 17:57:37 +0200 | [diff] [blame] | 945 | * mbedtls_ssl_conf_own_cert() when configuring the SSL |
Gilles Peskine | 807d74a | 2018-04-30 10:30:49 +0200 | [diff] [blame] | 946 | * connection. However, if other callbacks are used, this |
| 947 | * property may not hold. For example, if an SNI callback |
| 948 | * is registered with mbedtls_ssl_conf_sni(), then |
| 949 | * this callback determines what certificate is used. |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 950 | * \param md_alg Hash algorithm. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 951 | * \param hash Buffer containing the hash. This buffer is |
| 952 | * no longer valid when the function returns. |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 953 | * \param hash_len Size of the \c hash buffer in bytes. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 954 | * |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 955 | * \return 0 if the operation was started successfully and the SSL |
| 956 | * stack should call the resume callback immediately. |
| 957 | * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation |
| 958 | * was started successfully and the SSL stack should return |
| 959 | * immediately without calling the resume callback yet. |
| 960 | * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external |
| 961 | * processor does not support this key. The SSL stack will |
| 962 | * use the private key object instead. |
| 963 | * \return Any other error indicates a fatal failure and is |
Gilles Peskine | ac5e8a3 | 2018-04-26 11:50:07 +0200 | [diff] [blame] | 964 | * propagated up the call chain. The callback should |
| 965 | * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b> |
| 966 | * use \c MBEDTLS_ERR_SSL_xxx error codes except as |
Gilles Peskine | 9ceae8b | 2018-04-30 16:37:03 +0200 | [diff] [blame] | 967 | * directed in the documentation of this callback. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 968 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 969 | typedef int mbedtls_ssl_async_sign_t(mbedtls_ssl_context *ssl, |
| 970 | mbedtls_x509_crt *cert, |
| 971 | mbedtls_md_type_t md_alg, |
| 972 | const unsigned char *hash, |
| 973 | size_t hash_len); |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 974 | |
| 975 | /** |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 976 | * \brief Callback type: start external decryption operation. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 977 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 978 | * This callback is called during an SSL handshake to start |
| 979 | * an RSA decryption operation using an |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 980 | * external processor. The parameter \p cert contains |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 981 | * the public key; it is up to the callback function to |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 982 | * determine how to access the associated private key. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 983 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 984 | * This function typically sends or enqueues a request, and |
| 985 | * does not wait for the operation to complete. This allows |
| 986 | * the handshake step to be non-blocking. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 987 | * |
Gilles Peskine | 6a8cb36 | 2018-04-30 11:54:14 +0200 | [diff] [blame] | 988 | * The parameters \p ssl and \p cert are guaranteed to remain |
| 989 | * valid throughout the handshake. On the other hand, this |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 990 | * function must save the contents of \p input if the value |
| 991 | * is needed for later processing, because the \p input buffer |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 992 | * is no longer valid after this function returns. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 993 | * |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 994 | * This function may call mbedtls_ssl_set_async_operation_data() |
| 995 | * to store an operation context for later retrieval |
Gilles Peskine | ea5fab8 | 2018-04-30 13:57:45 +0200 | [diff] [blame] | 996 | * by the resume or cancel callback. |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 997 | * |
Gilles Peskine | 20deb01 | 2018-04-26 17:57:37 +0200 | [diff] [blame] | 998 | * \warning RSA decryption as used in TLS is subject to a potential |
| 999 | * timing side channel attack first discovered by Bleichenbacher |
| 1000 | * in 1998. This attack can be remotely exploitable |
| 1001 | * in practice. To avoid this attack, you must ensure that |
| 1002 | * if the callback performs an RSA decryption, the time it |
| 1003 | * takes to execute and return the result does not depend |
| 1004 | * on whether the RSA decryption succeeded or reported |
| 1005 | * invalid padding. |
| 1006 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1007 | * \param ssl The SSL connection instance. It should not be |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 1008 | * modified other than via |
| 1009 | * mbedtls_ssl_set_async_operation_data(). |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1010 | * \param cert Certificate containing the public key. |
Gilles Peskine | 807d74a | 2018-04-30 10:30:49 +0200 | [diff] [blame] | 1011 | * In simple cases, this is one of the pointers passed to |
Gilles Peskine | 20deb01 | 2018-04-26 17:57:37 +0200 | [diff] [blame] | 1012 | * mbedtls_ssl_conf_own_cert() when configuring the SSL |
Gilles Peskine | 807d74a | 2018-04-30 10:30:49 +0200 | [diff] [blame] | 1013 | * connection. However, if other callbacks are used, this |
| 1014 | * property may not hold. For example, if an SNI callback |
| 1015 | * is registered with mbedtls_ssl_conf_sni(), then |
| 1016 | * this callback determines what certificate is used. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1017 | * \param input Buffer containing the input ciphertext. This buffer |
| 1018 | * is no longer valid when the function returns. |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 1019 | * \param input_len Size of the \p input buffer in bytes. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1020 | * |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 1021 | * \return 0 if the operation was started successfully and the SSL |
| 1022 | * stack should call the resume callback immediately. |
| 1023 | * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation |
| 1024 | * was started successfully and the SSL stack should return |
| 1025 | * immediately without calling the resume callback yet. |
| 1026 | * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external |
| 1027 | * processor does not support this key. The SSL stack will |
| 1028 | * use the private key object instead. |
| 1029 | * \return Any other error indicates a fatal failure and is |
Gilles Peskine | ac5e8a3 | 2018-04-26 11:50:07 +0200 | [diff] [blame] | 1030 | * propagated up the call chain. The callback should |
| 1031 | * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b> |
| 1032 | * use \c MBEDTLS_ERR_SSL_xxx error codes except as |
Gilles Peskine | 9ceae8b | 2018-04-30 16:37:03 +0200 | [diff] [blame] | 1033 | * directed in the documentation of this callback. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1034 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1035 | typedef int mbedtls_ssl_async_decrypt_t(mbedtls_ssl_context *ssl, |
| 1036 | mbedtls_x509_crt *cert, |
| 1037 | const unsigned char *input, |
| 1038 | size_t input_len); |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1039 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
| 1040 | |
| 1041 | /** |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1042 | * \brief Callback type: resume external operation. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1043 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1044 | * This callback is called during an SSL handshake to resume |
| 1045 | * an external operation started by the |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 1046 | * ::mbedtls_ssl_async_sign_t or |
| 1047 | * ::mbedtls_ssl_async_decrypt_t callback. |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1048 | * |
| 1049 | * This function typically checks the status of a pending |
| 1050 | * request or causes the request queue to make progress, and |
| 1051 | * does not wait for the operation to complete. This allows |
| 1052 | * the handshake step to be non-blocking. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1053 | * |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 1054 | * This function may call mbedtls_ssl_get_async_operation_data() |
| 1055 | * to retrieve an operation context set by the start callback. |
| 1056 | * It may call mbedtls_ssl_set_async_operation_data() to modify |
| 1057 | * this context. |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 1058 | * |
Gilles Peskine | ea5fab8 | 2018-04-30 13:57:45 +0200 | [diff] [blame] | 1059 | * Note that when this function returns a status other than |
| 1060 | * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any |
| 1061 | * resources associated with the operation. |
| 1062 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1063 | * \param ssl The SSL connection instance. It should not be |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 1064 | * modified other than via |
| 1065 | * mbedtls_ssl_set_async_operation_data(). |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1066 | * \param output Buffer containing the output (signature or decrypted |
| 1067 | * data) on success. |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 1068 | * \param output_len On success, number of bytes written to \p output. |
| 1069 | * \param output_size Size of the \p output buffer in bytes. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1070 | * |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 1071 | * \return 0 if output of the operation is available in the |
| 1072 | * \p output buffer. |
| 1073 | * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation |
| 1074 | * is still in progress. Subsequent requests for progress |
| 1075 | * on the SSL connection will call the resume callback |
| 1076 | * again. |
| 1077 | * \return Any other error means that the operation is aborted. |
Gilles Peskine | ac5e8a3 | 2018-04-26 11:50:07 +0200 | [diff] [blame] | 1078 | * The SSL handshake is aborted. The callback should |
| 1079 | * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b> |
| 1080 | * use \c MBEDTLS_ERR_SSL_xxx error codes except as |
Gilles Peskine | 9ceae8b | 2018-04-30 16:37:03 +0200 | [diff] [blame] | 1081 | * directed in the documentation of this callback. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1082 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1083 | typedef int mbedtls_ssl_async_resume_t(mbedtls_ssl_context *ssl, |
| 1084 | unsigned char *output, |
| 1085 | size_t *output_len, |
| 1086 | size_t output_size); |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1087 | |
| 1088 | /** |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1089 | * \brief Callback type: cancel external operation. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1090 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1091 | * This callback is called if an SSL connection is closed |
Gilles Peskine | ea5fab8 | 2018-04-30 13:57:45 +0200 | [diff] [blame] | 1092 | * while an asynchronous operation is in progress. Note that |
| 1093 | * this callback is not called if the |
| 1094 | * ::mbedtls_ssl_async_resume_t callback has run and has |
| 1095 | * returned a value other than |
| 1096 | * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case |
| 1097 | * the asynchronous operation has already completed. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1098 | * |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 1099 | * This function may call mbedtls_ssl_get_async_operation_data() |
| 1100 | * to retrieve an operation context set by the start callback. |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 1101 | * |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 1102 | * \param ssl The SSL connection instance. It should not be |
| 1103 | * modified. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1104 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1105 | typedef void mbedtls_ssl_async_cancel_t(mbedtls_ssl_context *ssl); |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 1106 | #endif /* MBEDTLS_SSL_ASYNC_PRIVATE */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1107 | |
Gilles Peskine | eccd888 | 2020-03-10 12:19:08 +0100 | [diff] [blame] | 1108 | #if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \ |
Hanno Becker | fe4ef0c | 2019-02-26 11:43:09 +0000 | [diff] [blame] | 1109 | !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE) |
Hanno Becker | 9198ad1 | 2019-02-05 17:00:50 +0000 | [diff] [blame] | 1110 | #define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48 |
Manuel Pégourié-Gonnard | 9330242 | 2023-03-21 17:23:08 +0100 | [diff] [blame] | 1111 | #if defined(MBEDTLS_MD_CAN_SHA256) |
Hanno Becker | 9198ad1 | 2019-02-05 17:00:50 +0000 | [diff] [blame] | 1112 | #define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256 |
| 1113 | #define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32 |
Manuel Pégourié-Gonnard | 9330242 | 2023-03-21 17:23:08 +0100 | [diff] [blame] | 1114 | #elif defined(MBEDTLS_MD_CAN_SHA384) |
Hanno Becker | 9198ad1 | 2019-02-05 17:00:50 +0000 | [diff] [blame] | 1115 | #define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384 |
| 1116 | #define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48 |
Manuel Pégourié-Gonnard | 9330242 | 2023-03-21 17:23:08 +0100 | [diff] [blame] | 1117 | #elif defined(MBEDTLS_MD_CAN_SHA1) |
Hanno Becker | 9198ad1 | 2019-02-05 17:00:50 +0000 | [diff] [blame] | 1118 | #define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1 |
| 1119 | #define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20 |
| 1120 | #else |
Hanno Becker | fe4ef0c | 2019-02-26 11:43:09 +0000 | [diff] [blame] | 1121 | /* This is already checked in check_config.h, but be sure. */ |
Hanno Becker | 9198ad1 | 2019-02-05 17:00:50 +0000 | [diff] [blame] | 1122 | #error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT." |
| 1123 | #endif |
Gilles Peskine | eccd888 | 2020-03-10 12:19:08 +0100 | [diff] [blame] | 1124 | #endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED && |
Hanno Becker | fe4ef0c | 2019-02-26 11:43:09 +0000 | [diff] [blame] | 1125 | !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */ |
Hanno Becker | 9198ad1 | 2019-02-05 17:00:50 +0000 | [diff] [blame] | 1126 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1127 | typedef struct { |
| 1128 | unsigned char client_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
| 1129 | unsigned char server_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
| 1130 | unsigned char exporter_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
| 1131 | unsigned char resumption_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE]; |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1132 | } mbedtls_ssl_tls13_application_secrets; |
XiaokangQian | aa5f5c1 | 2021-09-18 06:20:25 +0000 | [diff] [blame] | 1133 | |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1134 | #if defined(MBEDTLS_SSL_DTLS_SRTP) |
Ron Eldor | 3adb992 | 2017-12-21 10:15:08 +0200 | [diff] [blame] | 1135 | |
Johan Pascal | 8526957 | 2020-08-25 10:01:54 +0200 | [diff] [blame] | 1136 | #define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255 |
Johan Pascal | aae4d22 | 2020-09-22 21:21:39 +0200 | [diff] [blame] | 1137 | #define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4 |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1138 | /* |
Johan Pascal | 43f9490 | 2020-09-22 12:25:52 +0200 | [diff] [blame] | 1139 | * For code readability use a typedef for DTLS-SRTP profiles |
Johan Pascal | 76fdf1d | 2020-10-22 23:31:00 +0200 | [diff] [blame] | 1140 | * |
| 1141 | * Use_srtp extension protection profiles values as defined in |
| 1142 | * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml |
| 1143 | * |
| 1144 | * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value |
| 1145 | * must be updated too. |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1146 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1147 | #define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ((uint16_t) 0x0001) |
| 1148 | #define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ((uint16_t) 0x0002) |
| 1149 | #define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ((uint16_t) 0x0005) |
| 1150 | #define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ((uint16_t) 0x0006) |
Johan Pascal | 76fdf1d | 2020-10-22 23:31:00 +0200 | [diff] [blame] | 1151 | /* This one is not iana defined, but for code readability. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1152 | #define MBEDTLS_TLS_SRTP_UNSET ((uint16_t) 0x0000) |
Johan Pascal | 76fdf1d | 2020-10-22 23:31:00 +0200 | [diff] [blame] | 1153 | |
Johan Pascal | 43f9490 | 2020-09-22 12:25:52 +0200 | [diff] [blame] | 1154 | typedef uint16_t mbedtls_ssl_srtp_profile; |
Ron Eldor | 311b95a | 2018-07-08 08:50:31 +0300 | [diff] [blame] | 1155 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1156 | typedef struct mbedtls_dtls_srtp_info_t { |
Johan Pascal | 9bc97ca | 2020-09-21 23:44:45 +0200 | [diff] [blame] | 1157 | /*! The SRTP profile that was negotiated. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1158 | mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile); |
Johan Pascal | f6417ec | 2020-09-22 15:15:19 +0200 | [diff] [blame] | 1159 | /*! The length of mki_value. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1160 | uint16_t MBEDTLS_PRIVATE(mki_len); |
Johan Pascal | 9bc97ca | 2020-09-21 23:44:45 +0200 | [diff] [blame] | 1161 | /*! The mki_value used, with max size of 256 bytes. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1162 | unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH]; |
Ron Eldor | 349877e | 2018-03-29 18:35:09 +0300 | [diff] [blame] | 1163 | } |
| 1164 | mbedtls_dtls_srtp_info; |
Ron Eldor | 3adb992 | 2017-12-21 10:15:08 +0200 | [diff] [blame] | 1165 | |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1166 | #endif /* MBEDTLS_SSL_DTLS_SRTP */ |
| 1167 | |
Glenn Strauss | dff8462 | 2022-03-14 11:12:57 -0400 | [diff] [blame] | 1168 | /** Human-friendly representation of the (D)TLS protocol version. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1169 | typedef enum { |
Glenn Strauss | dff8462 | 2022-03-14 11:12:57 -0400 | [diff] [blame] | 1170 | MBEDTLS_SSL_VERSION_UNKNOWN, /*!< Context not in use or version not yet negotiated. */ |
| 1171 | MBEDTLS_SSL_VERSION_TLS1_2 = 0x0303, /*!< (D)TLS 1.2 */ |
| 1172 | MBEDTLS_SSL_VERSION_TLS1_3 = 0x0304, /*!< (D)TLS 1.3 */ |
| 1173 | } mbedtls_ssl_protocol_version; |
| 1174 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1175 | /* |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 1176 | * This structure is used for storing current session data. |
Manuel Pégourié-Gonnard | 7b3a887 | 2019-05-24 09:48:05 +0200 | [diff] [blame] | 1177 | * |
| 1178 | * Note: when changing this definition, we need to check and update: |
| 1179 | * - in tests/suites/test_suite_ssl.function: |
Manuel Pégourié-Gonnard | 686adb4 | 2019-06-03 09:55:16 +0200 | [diff] [blame] | 1180 | * ssl_populate_session() and ssl_serialize_session_save_load() |
Manuel Pégourié-Gonnard | 7b3a887 | 2019-05-24 09:48:05 +0200 | [diff] [blame] | 1181 | * - in library/ssl_tls.c: |
| 1182 | * mbedtls_ssl_session_init() and mbedtls_ssl_session_free() |
| 1183 | * mbedtls_ssl_session_save() and ssl_session_load() |
| 1184 | * ssl_session_copy() |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1185 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1186 | struct mbedtls_ssl_session { |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1187 | #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) |
| 1188 | unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */ |
| 1189 | #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */ |
| 1190 | |
| 1191 | unsigned char MBEDTLS_PRIVATE(exported); |
| 1192 | |
Ronald Cron | 217d699 | 2022-04-04 10:23:22 +0200 | [diff] [blame] | 1193 | /** TLS version negotiated in the session. Used if and when renegotiating |
| 1194 | * or resuming a session instead of the configured minor TLS version. |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 1195 | */ |
Glenn Strauss | bbdc83b | 2022-04-12 07:31:46 -0400 | [diff] [blame] | 1196 | mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version); |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1197 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1198 | #if defined(MBEDTLS_HAVE_TIME) |
Jerry Yu | 702fc59 | 2023-10-31 14:22:04 +0800 | [diff] [blame] | 1199 | mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< start time of current session */ |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 1200 | #endif |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1201 | int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1202 | size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */ |
| 1203 | unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */ |
| 1204 | unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 1205 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1206 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Hanno Becker | abe6f66 | 2019-02-07 13:29:55 +0000 | [diff] [blame] | 1207 | #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1208 | mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */ |
Hanno Becker | abe6f66 | 2019-02-07 13:29:55 +0000 | [diff] [blame] | 1209 | #else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */ |
Hanno Becker | 9198ad1 | 2019-02-05 17:00:50 +0000 | [diff] [blame] | 1210 | /*! The digest of the peer's end-CRT. This must be kept to detect CRT |
| 1211 | * changes during renegotiation, mitigating the triple handshake attack. */ |
Mateusz Starzyk | 2abe51c | 2021-06-07 11:08:01 +0200 | [diff] [blame] | 1212 | unsigned char *MBEDTLS_PRIVATE(peer_cert_digest); |
| 1213 | size_t MBEDTLS_PRIVATE(peer_cert_digest_len); |
| 1214 | mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type); |
Hanno Becker | abe6f66 | 2019-02-07 13:29:55 +0000 | [diff] [blame] | 1215 | #endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1216 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1217 | uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */ |
Manuel Pégourié-Gonnard | ed4af8b | 2013-07-18 14:07:09 +0200 | [diff] [blame] | 1218 | |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 1219 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1220 | unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */ |
| 1221 | size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */ |
| 1222 | uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */ |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 1223 | #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */ |
Manuel Pégourié-Gonnard | 75d4401 | 2013-08-02 14:44:04 +0200 | [diff] [blame] | 1224 | |
Jerry Yu | a270f67 | 2022-07-07 06:51:06 +0000 | [diff] [blame] | 1225 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) |
Xiaokang Qian | 0340929 | 2022-10-12 02:49:52 +0000 | [diff] [blame] | 1226 | uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */ |
Jerry Yu | a66fece | 2022-07-13 14:30:29 +0800 | [diff] [blame] | 1227 | uint8_t MBEDTLS_PRIVATE(ticket_flags); /*!< Ticket flags */ |
Jerry Yu | a270f67 | 2022-07-07 06:51:06 +0000 | [diff] [blame] | 1228 | uint32_t MBEDTLS_PRIVATE(ticket_age_add); /*!< Randomly generated value used to obscure the age of the ticket */ |
Jerry Yu | 0a430c8 | 2022-07-20 11:02:48 +0800 | [diff] [blame] | 1229 | uint8_t MBEDTLS_PRIVATE(resumption_key_len); /*!< resumption_key length */ |
| 1230 | unsigned char MBEDTLS_PRIVATE(resumption_key)[MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN]; |
Jerry Yu | a270f67 | 2022-07-07 06:51:06 +0000 | [diff] [blame] | 1231 | |
Xiaokang Qian | ed3afcd | 2022-10-12 08:31:11 +0000 | [diff] [blame] | 1232 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && defined(MBEDTLS_SSL_CLI_C) |
| 1233 | char *MBEDTLS_PRIVATE(hostname); /*!< host name binded with tickets */ |
| 1234 | #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION && MBEDTLS_SSL_CLI_C */ |
| 1235 | |
Jerry Yu | 25ba4d4 | 2023-11-10 14:12:20 +0800 | [diff] [blame] | 1236 | #if defined(MBEDTLS_HAVE_TIME) |
| 1237 | #if defined(MBEDTLS_SSL_CLI_C) |
Jerry Yu | cf91351 | 2023-11-14 11:06:52 +0800 | [diff] [blame] | 1238 | mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_reception_time); /*!< time when ticket was received. */ |
Jerry Yu | 25ba4d4 | 2023-11-10 14:12:20 +0800 | [diff] [blame] | 1239 | #endif |
| 1240 | #if defined(MBEDTLS_SSL_SRV_C) |
Jerry Yu | cf91351 | 2023-11-14 11:06:52 +0800 | [diff] [blame] | 1241 | mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_creation_time); /*!< time when ticket was created. */ |
Jerry Yu | 25ba4d4 | 2023-11-10 14:12:20 +0800 | [diff] [blame] | 1242 | #endif |
| 1243 | #endif /* MBEDTLS_HAVE_TIME */ |
Jerry Yu | a270f67 | 2022-07-07 06:51:06 +0000 | [diff] [blame] | 1244 | |
| 1245 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */ |
| 1246 | |
Jerry Yu | 02e3a07 | 2022-12-12 15:13:20 +0800 | [diff] [blame] | 1247 | #if defined(MBEDTLS_SSL_EARLY_DATA) |
Jerry Yu | 6c485da | 2023-11-15 10:18:47 +0800 | [diff] [blame] | 1248 | uint32_t MBEDTLS_PRIVATE(max_early_data_size); /*!< maximum amount of early data in tickets */ |
Jerry Yu | 02e3a07 | 2022-12-12 15:13:20 +0800 | [diff] [blame] | 1249 | #endif |
| 1250 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1251 | #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1252 | int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */ |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 1253 | #endif |
XiaokangQian | 3306284 | 2021-11-11 03:37:45 +0000 | [diff] [blame] | 1254 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1255 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1256 | mbedtls_ssl_tls13_application_secrets MBEDTLS_PRIVATE(app_secrets); |
Xiaokang Qian | baa4764 | 2022-10-12 10:21:27 +0000 | [diff] [blame] | 1257 | #endif |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1258 | }; |
| 1259 | |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 1260 | /* |
| 1261 | * Identifiers for PRFs used in various versions of TLS. |
| 1262 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1263 | typedef enum { |
| 1264 | MBEDTLS_SSL_TLS_PRF_NONE, |
| 1265 | MBEDTLS_SSL_TLS_PRF_SHA384, |
| 1266 | MBEDTLS_SSL_TLS_PRF_SHA256, |
| 1267 | MBEDTLS_SSL_HKDF_EXPAND_SHA384, |
| 1268 | MBEDTLS_SSL_HKDF_EXPAND_SHA256 |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 1269 | } |
| 1270 | mbedtls_tls_prf_types; |
| 1271 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1272 | typedef enum { |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 1273 | MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET = 0, |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1274 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 1275 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET, |
| 1276 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_EARLY_EXPORTER_SECRET, |
| 1277 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET, |
| 1278 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET, |
| 1279 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET, |
| 1280 | MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET, |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1281 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 1282 | } mbedtls_ssl_key_export_type; |
| 1283 | |
| 1284 | /** |
| 1285 | * \brief Callback type: Export key alongside random values for |
| 1286 | * session identification, and PRF for |
| 1287 | * implementation of TLS key exporters. |
| 1288 | * |
Hanno Becker | ddc739c | 2021-05-28 05:10:38 +0100 | [diff] [blame] | 1289 | * \param p_expkey Context for the callback. |
| 1290 | * \param type The type of the key that is being exported. |
| 1291 | * \param secret The address of the buffer holding the secret |
| 1292 | * that's being exporterd. |
| 1293 | * \param secret_len The length of \p secret in bytes. |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 1294 | * \param client_random The client random bytes. |
| 1295 | * \param server_random The server random bytes. |
| 1296 | * \param tls_prf_type The identifier for the PRF used in the handshake |
| 1297 | * to which the key belongs. |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 1298 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1299 | typedef void mbedtls_ssl_export_keys_t(void *p_expkey, |
| 1300 | mbedtls_ssl_key_export_type type, |
| 1301 | const unsigned char *secret, |
| 1302 | size_t secret_len, |
| 1303 | const unsigned char client_random[32], |
| 1304 | const unsigned char server_random[32], |
| 1305 | mbedtls_tls_prf_types tls_prf_type); |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 1306 | |
Glenn Strauss | 236e17e | 2022-03-13 23:39:40 -0400 | [diff] [blame] | 1307 | #if defined(MBEDTLS_SSL_SRV_C) |
| 1308 | /** |
| 1309 | * \brief Callback type: generic handshake callback |
| 1310 | * |
| 1311 | * \note Callbacks may use user_data funcs to set/get app user data. |
| 1312 | * See \c mbedtls_ssl_get_user_data_p() |
| 1313 | * \c mbedtls_ssl_get_user_data_n() |
| 1314 | * \c mbedtls_ssl_conf_get_user_data_p() |
| 1315 | * \c mbedtls_ssl_conf_get_user_data_n() |
| 1316 | * |
| 1317 | * \param ssl \c mbedtls_ssl_context on which the callback is run |
| 1318 | * |
| 1319 | * \return The return value of the callback is 0 if successful, |
| 1320 | * or a specific MBEDTLS_ERR_XXX code, which will cause |
| 1321 | * the handshake to be aborted. |
| 1322 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1323 | typedef int (*mbedtls_ssl_hs_cb_t)(mbedtls_ssl_context *ssl); |
Glenn Strauss | 236e17e | 2022-03-13 23:39:40 -0400 | [diff] [blame] | 1324 | #endif |
| 1325 | |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 1326 | /* A type for storing user data in a library structure. |
| 1327 | * |
| 1328 | * The representation of type may change in future versions of the library. |
| 1329 | * Only the behaviors guaranteed by documented accessor functions are |
| 1330 | * guaranteed to remain stable. |
| 1331 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1332 | typedef union { |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 1333 | uintptr_t n; /* typically a handle to an associated object */ |
| 1334 | void *p; /* typically a pointer to extra data */ |
| 1335 | } mbedtls_ssl_user_data_t; |
| 1336 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1337 | /** |
Manuel Pégourié-Gonnard | 6729e79 | 2015-05-11 09:50:24 +0200 | [diff] [blame] | 1338 | * SSL/TLS configuration to be shared between mbedtls_ssl_context structures. |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1339 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1340 | struct mbedtls_ssl_config { |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1341 | /* Group items mostly by size. This helps to reduce memory wasted to |
| 1342 | * padding. It also helps to keep smaller fields early in the structure, |
| 1343 | * so that elements tend to be in the 128-element direct access window |
| 1344 | * on Arm Thumb, which reduces the code size. */ |
| 1345 | |
Glenn Strauss | bbdc83b | 2022-04-12 07:31:46 -0400 | [diff] [blame] | 1346 | mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(max_tls_version); /*!< max. TLS version used */ |
| 1347 | mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(min_tls_version); /*!< min. TLS version used */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1348 | |
| 1349 | /* |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1350 | * Flags (could be bit-fields to save RAM, but separate bytes make |
| 1351 | * the code smaller on architectures with an instruction for direct |
| 1352 | * byte access). |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1353 | */ |
| 1354 | |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1355 | uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */ |
Gilles Peskine | b3ec69d | 2021-12-08 18:32:12 +0100 | [diff] [blame] | 1356 | uint8_t MBEDTLS_PRIVATE(transport); /*!< 0: stream (TLS), 1: datagram (DTLS) */ |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1357 | uint8_t MBEDTLS_PRIVATE(authmode); /*!< MBEDTLS_SSL_VERIFY_XXX */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1358 | /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */ |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1359 | uint8_t MBEDTLS_PRIVATE(allow_legacy_renegotiation); /*!< MBEDTLS_LEGACY_XXX */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1360 | #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) |
Gilles Peskine | b3ec69d | 2021-12-08 18:32:12 +0100 | [diff] [blame] | 1361 | uint8_t MBEDTLS_PRIVATE(mfl_code); /*!< desired fragment length indicator |
| 1362 | (MBEDTLS_SSL_MAX_FRAG_LEN_XXX) */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1363 | #endif |
| 1364 | #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1365 | uint8_t MBEDTLS_PRIVATE(encrypt_then_mac); /*!< negotiate encrypt-then-mac? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1366 | #endif |
| 1367 | #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1368 | uint8_t MBEDTLS_PRIVATE(extended_ms); /*!< negotiate extended master secret? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1369 | #endif |
| 1370 | #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1371 | uint8_t MBEDTLS_PRIVATE(anti_replay); /*!< detect and prevent replay? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1372 | #endif |
| 1373 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1374 | uint8_t MBEDTLS_PRIVATE(disable_renegotiation); /*!< disable renegotiation? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1375 | #endif |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 1376 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) && \ |
| 1377 | defined(MBEDTLS_SSL_CLI_C) |
| 1378 | uint8_t MBEDTLS_PRIVATE(session_tickets); /*!< use session tickets? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1379 | #endif |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 1380 | |
| 1381 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) && \ |
| 1382 | defined(MBEDTLS_SSL_SRV_C) && \ |
| 1383 | defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Jerry Yu | d0766ec | 2022-09-22 10:46:57 +0800 | [diff] [blame] | 1384 | uint16_t MBEDTLS_PRIVATE(new_session_tickets_count); /*!< number of NewSessionTicket */ |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 1385 | #endif |
| 1386 | |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1387 | #if defined(MBEDTLS_SSL_SRV_C) |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1388 | uint8_t MBEDTLS_PRIVATE(cert_req_ca_list); /*!< enable sending CA list in |
| 1389 | Certificate Request messages? */ |
| 1390 | uint8_t MBEDTLS_PRIVATE(respect_cli_pref); /*!< pick the ciphersuite according to |
| 1391 | the client's preferences rather |
Gilles Peskine | b3ec69d | 2021-12-08 18:32:12 +0100 | [diff] [blame] | 1392 | than ours? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1393 | #endif |
| 1394 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Gilles Peskine | b3ec69d | 2021-12-08 18:32:12 +0100 | [diff] [blame] | 1395 | uint8_t MBEDTLS_PRIVATE(ignore_unexpected_cid); /*!< Should DTLS record with |
| 1396 | * unexpected CID |
| 1397 | * lead to failure? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1398 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
| 1399 | #if defined(MBEDTLS_SSL_DTLS_SRTP) |
Gilles Peskine | 533a728 | 2021-11-16 18:31:46 +0100 | [diff] [blame] | 1400 | uint8_t MBEDTLS_PRIVATE(dtls_srtp_mki_support); /* support having mki_value |
Gilles Peskine | b3ec69d | 2021-12-08 18:32:12 +0100 | [diff] [blame] | 1401 | in the use_srtp extension? */ |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1402 | #endif |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1403 | |
| 1404 | /* |
| 1405 | * Pointers |
| 1406 | */ |
| 1407 | |
Hanno Becker | d60b6c6 | 2021-04-29 12:04:11 +0100 | [diff] [blame] | 1408 | /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */ |
Ronald Cron | c4c761e | 2021-06-14 16:17:32 +0200 | [diff] [blame] | 1409 | const int *MBEDTLS_PRIVATE(ciphersuite_list); |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1410 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1411 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 1412 | /** Allowed TLS 1.3 key exchange modes. */ |
| 1413 | int MBEDTLS_PRIVATE(tls13_kex_modes); |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1414 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 1415 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1416 | /** Callback for printing debug output */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1417 | void(*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1418 | void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1419 | |
Manuel Pégourié-Gonnard | 750e4d7 | 2015-05-07 12:35:38 +0100 | [diff] [blame] | 1420 | /** Callback for getting (pseudo-)random numbers */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1421 | int(*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1422 | void *MBEDTLS_PRIVATE(p_rng); /*!< context for the RNG function */ |
Manuel Pégourié-Gonnard | 750e4d7 | 2015-05-07 12:35:38 +0100 | [diff] [blame] | 1423 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1424 | /** Callback to retrieve a session from the cache */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1425 | mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache); |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1426 | /** Callback to store a session into the cache */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1427 | mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache); |
| 1428 | void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1429 | |
| 1430 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) |
| 1431 | /** Callback for setting cert according to SNI extension */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1432 | int(*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1433 | void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1434 | #endif |
| 1435 | |
| 1436 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 1437 | /** Callback to customize X.509 certificate chain verification */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1438 | int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1439 | void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1440 | #endif |
| 1441 | |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 1442 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) |
Jerry Yu | 8897c07 | 2022-08-12 13:56:53 +0800 | [diff] [blame] | 1443 | #if defined(MBEDTLS_SSL_SRV_C) |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1444 | /** Callback to retrieve PSK key from identity */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1445 | int(*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1446 | void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1447 | #endif |
Jerry Yu | 8897c07 | 2022-08-12 13:56:53 +0800 | [diff] [blame] | 1448 | #endif |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1449 | |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 1450 | #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C) |
Tom Cosgrove | 1e21144 | 2022-05-26 11:51:00 +0100 | [diff] [blame] | 1451 | /** Callback to create & write a cookie for ClientHello verification */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1452 | int(*MBEDTLS_PRIVATE(f_cookie_write))(void *, unsigned char **, unsigned char *, |
| 1453 | const unsigned char *, size_t); |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1454 | /** Callback to verify validity of a ClientHello cookie */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1455 | int(*MBEDTLS_PRIVATE(f_cookie_check))(void *, const unsigned char *, size_t, |
| 1456 | const unsigned char *, size_t); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1457 | void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1458 | #endif |
| 1459 | |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 1460 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C) |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 1461 | /** Callback to create & write a session ticket */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1462 | int(*MBEDTLS_PRIVATE(f_ticket_write))(void *, const mbedtls_ssl_session *, |
| 1463 | unsigned char *, const unsigned char *, size_t *, |
| 1464 | uint32_t *); |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 1465 | /** Callback to parse a session ticket into a session structure */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1466 | int(*MBEDTLS_PRIVATE(f_ticket_parse))(void *, mbedtls_ssl_session *, unsigned char *, size_t); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1467 | void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */ |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 1468 | #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1469 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1470 | size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1471 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 1472 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1473 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1474 | const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */ |
| 1475 | mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */ |
| 1476 | mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */ |
| 1477 | mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */ |
Hanno Becker | 5adaad9 | 2019-03-27 16:54:37 +0000 | [diff] [blame] | 1478 | #if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1479 | mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb); |
| 1480 | void *MBEDTLS_PRIVATE(p_ca_cb); |
Hanno Becker | 5adaad9 | 2019-03-27 16:54:37 +0000 | [diff] [blame] | 1481 | #endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1482 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
| 1483 | |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 1484 | #if defined(MBEDTLS_SSL_ASYNC_PRIVATE) |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1485 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1486 | mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */ |
| 1487 | mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start); /*!< start asynchronous decryption operation */ |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1488 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1489 | mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */ |
| 1490 | mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */ |
| 1491 | void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */ |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 1492 | #endif /* MBEDTLS_SSL_ASYNC_PRIVATE */ |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 1493 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 1494 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Hanno Becker | 1cd6e00 | 2021-08-10 13:27:10 +0100 | [diff] [blame] | 1495 | |
Jerry Yu | f017ee4 | 2022-01-12 15:49:48 +0800 | [diff] [blame] | 1496 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
| 1497 | const int *MBEDTLS_PRIVATE(sig_hashes); /*!< allowed signature hashes */ |
| 1498 | #endif |
| 1499 | const uint16_t *MBEDTLS_PRIVATE(sig_algs); /*!< allowed signature algorithms */ |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 1500 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */ |
Manuel Pégourié-Gonnard | 36a8b57 | 2015-06-17 12:43:26 +0200 | [diff] [blame] | 1501 | |
Manuel Pégourié-Gonnard | f07ce3b | 2023-09-22 11:53:41 +0200 | [diff] [blame] | 1502 | #if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1503 | const mbedtls_ecp_group_id *MBEDTLS_PRIVATE(curve_list); /*!< allowed curves */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1504 | #endif |
| 1505 | |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 1506 | const uint16_t *MBEDTLS_PRIVATE(group_list); /*!< allowed IANA NamedGroups */ |
| 1507 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1508 | #if defined(MBEDTLS_DHM_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1509 | mbedtls_mpi MBEDTLS_PRIVATE(dhm_P); /*!< prime modulus for DHM */ |
| 1510 | mbedtls_mpi MBEDTLS_PRIVATE(dhm_G); /*!< generator for DHM */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1511 | #endif |
| 1512 | |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 1513 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) |
Hanno Becker | 4363313 | 2018-10-22 15:31:03 +0100 | [diff] [blame] | 1514 | |
| 1515 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
Andrzej Kurek | 03e0146 | 2022-01-03 12:53:24 +0100 | [diff] [blame] | 1516 | mbedtls_svc_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1517 | * should only be set via |
| 1518 | * mbedtls_ssl_conf_psk_opaque(). |
| 1519 | * If either no PSK or a raw PSK have been |
| 1520 | * configured, this has value \c 0. |
| 1521 | */ |
Neil Armstrong | 8ecd668 | 2022-05-05 11:40:35 +0200 | [diff] [blame] | 1522 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1523 | unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1524 | * only be set via mbedtls_ssl_conf_psk(). |
| 1525 | * If either no PSK or an opaque PSK |
| 1526 | * have been configured, this has value NULL. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1527 | size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key. |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1528 | * This field should only be set via |
| 1529 | * mbedtls_ssl_conf_psk(). |
| 1530 | * Its value is non-zero if and only if |
| 1531 | * \c psk is not \c NULL. */ |
Hanno Becker | 4363313 | 2018-10-22 15:31:03 +0100 | [diff] [blame] | 1532 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1533 | unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation. |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1534 | * This field should only be set via |
| 1535 | * mbedtls_ssl_conf_psk(). |
| 1536 | * This is set if and only if either |
| 1537 | * \c psk or \c psk_opaque are set. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1538 | size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity. |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1539 | * This field should only be set via |
| 1540 | * mbedtls_ssl_conf_psk(). |
| 1541 | * Its value is non-zero if and only if |
| 1542 | * \c psk is not \c NULL or \c psk_opaque |
| 1543 | * is not \c 0. */ |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 1544 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1545 | |
Xiaokang Qian | 54413b1 | 2022-10-20 05:57:03 +0000 | [diff] [blame] | 1546 | #if defined(MBEDTLS_SSL_EARLY_DATA) |
Xiaokang Qian | 72de95d | 2022-10-25 02:54:33 +0000 | [diff] [blame] | 1547 | int MBEDTLS_PRIVATE(early_data_enabled); /*!< Early data enablement: |
Xiaokang Qian | d69d06f | 2022-10-25 06:51:25 +0000 | [diff] [blame] | 1548 | * - MBEDTLS_SSL_EARLY_DATA_DISABLED, |
| 1549 | * - MBEDTLS_SSL_EARLY_DATA_ENABLED */ |
Jerry Yu | cc4e007 | 2022-11-22 17:22:22 +0800 | [diff] [blame] | 1550 | |
| 1551 | #if defined(MBEDTLS_SSL_SRV_C) |
Jerry Yu | 12c46bd | 2022-12-06 11:02:51 +0800 | [diff] [blame] | 1552 | /* The maximum amount of 0-RTT data. RFC 8446 section 4.6.1 */ |
Jerry Yu | cc4e007 | 2022-11-22 17:22:22 +0800 | [diff] [blame] | 1553 | uint32_t MBEDTLS_PRIVATE(max_early_data_size); |
| 1554 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 1555 | |
Xiaokang Qian | 54413b1 | 2022-10-20 05:57:03 +0000 | [diff] [blame] | 1556 | #endif /* MBEDTLS_SSL_EARLY_DATA */ |
| 1557 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1558 | #if defined(MBEDTLS_SSL_ALPN) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1559 | const char **MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1560 | #endif |
| 1561 | |
Johan Pascal | bbc057a | 2016-02-04 22:07:32 +0100 | [diff] [blame] | 1562 | #if defined(MBEDTLS_SSL_DTLS_SRTP) |
Ron Eldor | a978804 | 2018-12-05 11:04:31 +0200 | [diff] [blame] | 1563 | /*! ordered list of supported srtp profile */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1564 | const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list); |
Ron Eldor | a978804 | 2018-12-05 11:04:31 +0200 | [diff] [blame] | 1565 | /*! number of supported profiles */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1566 | size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len); |
Johan Pascal | bbc057a | 2016-02-04 22:07:32 +0100 | [diff] [blame] | 1567 | #endif /* MBEDTLS_SSL_DTLS_SRTP */ |
| 1568 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1569 | /* |
Gilles Peskine | 8834d87 | 2021-11-29 12:36:50 +0100 | [diff] [blame] | 1570 | * Numerical settings (int) |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1571 | */ |
| 1572 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1573 | uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */ |
Manuel Pégourié-Gonnard | 7ca4e4d | 2015-05-04 10:55:58 +0200 | [diff] [blame] | 1574 | |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1575 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1576 | uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1577 | retransmission timeout (ms) */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1578 | uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1579 | retransmission timeout (ms) */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1580 | #endif |
| 1581 | |
| 1582 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1583 | int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */ |
| 1584 | unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1585 | that triggers renegotiation */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1586 | #endif |
| 1587 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1588 | unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */ |
Manuel Pégourié-Gonnard | fa6473d | 2015-04-30 18:03:08 +0200 | [diff] [blame] | 1589 | |
Manuel Pégourié-Gonnard | bd990d6 | 2015-06-11 14:49:42 +0200 | [diff] [blame] | 1590 | #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1591 | unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen); /*!< min. bit length of the DHM prime */ |
Manuel Pégourié-Gonnard | bd990d6 | 2015-06-11 14:49:42 +0200 | [diff] [blame] | 1592 | #endif |
Gilles Peskine | 69477b5 | 2022-01-13 01:01:45 +0100 | [diff] [blame] | 1593 | |
| 1594 | /** User data pointer or handle. |
| 1595 | * |
| 1596 | * The library sets this to \p 0 when creating a context and does not |
| 1597 | * access it afterwards. |
| 1598 | */ |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 1599 | mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data); |
Glenn Strauss | 2ed9527 | 2022-01-21 18:02:17 -0500 | [diff] [blame] | 1600 | |
| 1601 | #if defined(MBEDTLS_SSL_SRV_C) |
Glenn Strauss | 236e17e | 2022-03-13 23:39:40 -0400 | [diff] [blame] | 1602 | mbedtls_ssl_hs_cb_t MBEDTLS_PRIVATE(f_cert_cb); /*!< certificate selection callback */ |
Glenn Strauss | 2ed9527 | 2022-01-21 18:02:17 -0500 | [diff] [blame] | 1603 | #endif /* MBEDTLS_SSL_SRV_C */ |
Glenn Strauss | 999ef70 | 2022-03-11 01:37:23 -0500 | [diff] [blame] | 1604 | |
| 1605 | #if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) |
| 1606 | const mbedtls_x509_crt *MBEDTLS_PRIVATE(dn_hints);/*!< acceptable client cert issuers */ |
| 1607 | #endif |
Manuel Pégourié-Gonnard | cd4fcc6 | 2015-05-26 12:11:48 +0200 | [diff] [blame] | 1608 | }; |
| 1609 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1610 | struct mbedtls_ssl_context { |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1611 | const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */ |
Manuel Pégourié-Gonnard | 7ca4e4d | 2015-05-04 10:55:58 +0200 | [diff] [blame] | 1612 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1613 | /* |
| 1614 | * Miscellaneous |
| 1615 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1616 | int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1617 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1618 | int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */ |
| 1619 | int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1620 | number of retransmissions of request if |
| 1621 | renego_max_records is < 0 */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1622 | #endif /* MBEDTLS_SSL_RENEGOTIATION */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1623 | |
Ronald Cron | 8a12aee | 2023-03-08 15:30:43 +0100 | [diff] [blame] | 1624 | /** |
| 1625 | * Maximum TLS version to be negotiated, then negotiated TLS version. |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 1626 | * |
Ronald Cron | 8a12aee | 2023-03-08 15:30:43 +0100 | [diff] [blame] | 1627 | * It is initialized as the configured maximum TLS version to be |
| 1628 | * negotiated by mbedtls_ssl_setup(). |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 1629 | * |
Ronald Cron | 8a12aee | 2023-03-08 15:30:43 +0100 | [diff] [blame] | 1630 | * When renegotiating or resuming a session, it is overwritten in the |
| 1631 | * ClientHello writing preparation stage with the previously negotiated |
| 1632 | * TLS version. |
| 1633 | * |
Ronald Cron | b828c7d | 2023-04-03 16:37:22 +0200 | [diff] [blame] | 1634 | * On client side, it is updated to the TLS version selected by the server |
| 1635 | * for the handshake when the ServerHello is received. |
Ronald Cron | 8a12aee | 2023-03-08 15:30:43 +0100 | [diff] [blame] | 1636 | * |
Ronald Cron | b828c7d | 2023-04-03 16:37:22 +0200 | [diff] [blame] | 1637 | * On server side, it is updated to the TLS version the server selects for |
| 1638 | * the handshake when the ClientHello is received. |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 1639 | */ |
Glenn Strauss | 60bfe60 | 2022-03-14 19:04:24 -0400 | [diff] [blame] | 1640 | mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version); |
Ronald Cron | bdb4f58 | 2022-03-31 15:37:44 +0200 | [diff] [blame] | 1641 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1642 | unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */ |
Manuel Pégourié-Gonnard | b0643d1 | 2014-10-14 18:30:36 +0200 | [diff] [blame] | 1643 | |
Hanno Becker | 8927c83 | 2019-04-03 12:52:50 +0100 | [diff] [blame] | 1644 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 1645 | /** Callback to customize X.509 certificate chain verification */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1646 | int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *); |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1647 | void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */ |
Hanno Becker | 8927c83 | 2019-04-03 12:52:50 +0100 | [diff] [blame] | 1648 | #endif |
| 1649 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1650 | mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */ |
| 1651 | mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */ |
| 1652 | mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout); |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1653 | /*!< Callback for network receive with timeout */ |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 1654 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1655 | void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */ |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 1656 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1657 | /* |
| 1658 | * Session layer |
| 1659 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1660 | mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */ |
| 1661 | mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */ |
| 1662 | mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */ |
| 1663 | mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1664 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1665 | mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1666 | the handshake process */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1667 | |
| 1668 | /* |
| 1669 | * Record layer transformations |
| 1670 | */ |
Hanno Becker | 0e719ff | 2021-08-10 09:24:08 +0100 | [diff] [blame] | 1671 | mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in) |
| 1672 | * This is always a reference, |
| 1673 | * never an owning pointer. */ |
| 1674 | mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (out) |
| 1675 | * This is always a reference, |
| 1676 | * never an owning pointer. */ |
| 1677 | mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params |
| 1678 | * This pointer owns the transform |
| 1679 | * it references. */ |
Jerry Yu | 2e19981 | 2022-12-01 18:57:19 +0800 | [diff] [blame] | 1680 | #if defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Hanno Becker | 0e719ff | 2021-08-10 09:24:08 +0100 | [diff] [blame] | 1681 | mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation |
| 1682 | * This pointer owns the transform |
| 1683 | * it references. */ |
Jerry Yu | 2e19981 | 2022-12-01 18:57:19 +0800 | [diff] [blame] | 1684 | #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1685 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1686 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Hanno Becker | e043d15 | 2021-08-12 06:22:32 +0100 | [diff] [blame] | 1687 | /*! The application data transform in TLS 1.3. |
| 1688 | * This pointer owns the transform it references. */ |
Hanno Becker | 3aa186f | 2021-08-10 09:24:19 +0100 | [diff] [blame] | 1689 | mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application); |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1690 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Hanno Becker | 3aa186f | 2021-08-10 09:24:19 +0100 | [diff] [blame] | 1691 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1692 | /* |
Manuel Pégourié-Gonnard | 8e704f0 | 2014-10-14 20:03:35 +0200 | [diff] [blame] | 1693 | * Timers |
Manuel Pégourié-Gonnard | db2858c | 2014-09-29 14:04:42 +0200 | [diff] [blame] | 1694 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1695 | void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */ |
Simon Butcher | e846b51 | 2016-03-01 17:31:49 +0000 | [diff] [blame] | 1696 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1697 | mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */ |
| 1698 | mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */ |
Manuel Pégourié-Gonnard | 905dd24 | 2014-10-01 12:03:55 +0200 | [diff] [blame] | 1699 | |
Manuel Pégourié-Gonnard | db2858c | 2014-09-29 14:04:42 +0200 | [diff] [blame] | 1700 | /* |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1701 | * Record layer (incoming data) |
| 1702 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1703 | unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */ |
| 1704 | unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1705 | TLS: maintained by us |
| 1706 | DTLS: read from peer */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1707 | unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1708 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1709 | unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1710 | * (the end is marked by in_len). */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1711 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1712 | unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */ |
| 1713 | unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */ |
| 1714 | unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */ |
| 1715 | unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1716 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1717 | int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */ |
| 1718 | size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */ |
| 1719 | size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */ |
Darryl Green | b33cc76 | 2019-11-28 14:29:44 +0000 | [diff] [blame] | 1720 | #if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1721 | size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */ |
Darryl Green | b33cc76 | 2019-11-28 14:29:44 +0000 | [diff] [blame] | 1722 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1723 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1724 | uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */ |
| 1725 | size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1726 | (equal to in_left if none) */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1727 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1728 | #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1729 | uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */ |
| 1730 | uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1731 | #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1732 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1733 | size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1734 | including the handshake header */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1735 | int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */ |
Hanno Becker | af0665d | 2017-05-24 09:16:26 +0100 | [diff] [blame] | 1736 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1737 | int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1738 | on next call to record layer? */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1739 | |
Jerry Yu | e704781 | 2021-09-13 19:26:39 +0800 | [diff] [blame] | 1740 | /* The following three variables indicate if and, if yes, |
Jerry Yu | 394ece6 | 2021-09-14 22:17:21 +0800 | [diff] [blame] | 1741 | * what kind of alert is pending to be sent. |
Jerry Yu | e704781 | 2021-09-13 19:26:39 +0800 | [diff] [blame] | 1742 | */ |
Jerry Yu | 33cedca | 2021-09-14 19:55:49 +0800 | [diff] [blame] | 1743 | unsigned char MBEDTLS_PRIVATE(send_alert); /*!< Determines if a fatal alert |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1744 | should be sent. Values: |
| 1745 | - \c 0 , no alert is to be sent. |
| 1746 | - \c 1 , alert is to be sent. */ |
Jerry Yu | 33cedca | 2021-09-14 19:55:49 +0800 | [diff] [blame] | 1747 | unsigned char MBEDTLS_PRIVATE(alert_type); /*!< Type of alert if send_alert |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1748 | != 0 */ |
Jerry Yu | 33cedca | 2021-09-14 19:55:49 +0800 | [diff] [blame] | 1749 | int MBEDTLS_PRIVATE(alert_reason); /*!< The error code to be returned |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1750 | to the user once the fatal alert |
| 1751 | has been sent. */ |
Jerry Yu | e704781 | 2021-09-13 19:26:39 +0800 | [diff] [blame] | 1752 | |
Hanno Becker | 04da189 | 2018-08-14 13:22:10 +0100 | [diff] [blame] | 1753 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1754 | uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1755 | * within a single datagram. */ |
Hanno Becker | 04da189 | 2018-08-14 13:22:10 +0100 | [diff] [blame] | 1756 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 1757 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1758 | /* |
| 1759 | * Record layer (outgoing data) |
| 1760 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1761 | unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */ |
| 1762 | unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */ |
| 1763 | unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1764 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1765 | unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1766 | * (the end is marked by in_len). */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1767 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1768 | unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */ |
| 1769 | unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */ |
| 1770 | unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1771 | |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1772 | int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */ |
| 1773 | size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */ |
| 1774 | size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */ |
Darryl Green | b33cc76 | 2019-11-28 14:29:44 +0000 | [diff] [blame] | 1775 | #if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1776 | size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */ |
Darryl Green | b33cc76 | 2019-11-28 14:29:44 +0000 | [diff] [blame] | 1777 | #endif |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1778 | |
Jerry Yu | ae0b2e2 | 2021-10-08 15:21:19 +0800 | [diff] [blame] | 1779 | unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Outgoing record sequence number. */ |
Hanno Becker | 1985947 | 2018-08-06 09:40:20 +0100 | [diff] [blame] | 1780 | |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 1781 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1782 | uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1783 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 1784 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1785 | /* |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1786 | * User settings |
| 1787 | */ |
Manuel Pégourié-Gonnard | bc2b771 | 2015-05-06 11:14:19 +0100 | [diff] [blame] | 1788 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1789 | char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1790 | (and SNI if available) */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1791 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1792 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1793 | #if defined(MBEDTLS_SSL_ALPN) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1794 | const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1795 | #endif /* MBEDTLS_SSL_ALPN */ |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 1796 | |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1797 | #if defined(MBEDTLS_SSL_DTLS_SRTP) |
| 1798 | /* |
| 1799 | * use_srtp extension |
| 1800 | */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1801 | mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info); |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1802 | #endif /* MBEDTLS_SSL_DTLS_SRTP */ |
| 1803 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1804 | /* |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 1805 | * Information for DTLS hello verify |
Manuel Pégourié-Gonnard | 43c0218 | 2014-07-22 17:32:01 +0200 | [diff] [blame] | 1806 | */ |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 1807 | #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1808 | unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */ |
| 1809 | size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1810 | #endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */ |
Manuel Pégourié-Gonnard | 43c0218 | 2014-07-22 17:32:01 +0200 | [diff] [blame] | 1811 | |
| 1812 | /* |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1813 | * Secure renegotiation |
| 1814 | */ |
Manuel Pégourié-Gonnard | 3b2c0d6 | 2015-03-10 13:20:49 +0000 | [diff] [blame] | 1815 | /* needed to know when to send extension on server */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1816 | int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1817 | secure renegotiation */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1818 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1819 | size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */ |
| 1820 | char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */ |
| 1821 | char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */ |
Hanno Becker | bc2498a | 2018-08-28 10:13:29 +0100 | [diff] [blame] | 1822 | #endif /* MBEDTLS_SSL_RENEGOTIATION */ |
Hanno Becker | 2f28c10 | 2019-04-25 15:46:59 +0100 | [diff] [blame] | 1823 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1824 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | 2f28c10 | 2019-04-25 15:46:59 +0100 | [diff] [blame] | 1825 | /* CID configuration to use in subsequent handshakes. */ |
| 1826 | |
| 1827 | /*! The next incoming CID, chosen by the user and applying to |
| 1828 | * all subsequent handshakes. This may be different from the |
| 1829 | * CID currently used in case the user has re-configured the CID |
| 1830 | * after an initial handshake. */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1831 | unsigned char MBEDTLS_PRIVATE(own_cid)[MBEDTLS_SSL_CID_IN_LEN_MAX]; |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 1832 | uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */ |
| 1833 | uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1834 | * be negotiated in the next handshake or not. |
| 1835 | * Possible values are #MBEDTLS_SSL_CID_ENABLED |
| 1836 | * and #MBEDTLS_SSL_CID_DISABLED. */ |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 1837 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | d8f32e7 | 2021-06-17 05:14:58 +0100 | [diff] [blame] | 1838 | |
Jerry Yu | 7a799cc | 2023-02-08 13:47:47 +0800 | [diff] [blame] | 1839 | #if defined(MBEDTLS_SSL_EARLY_DATA) |
Xiaokang Qian | 0e97d4d | 2022-10-24 11:12:51 +0000 | [diff] [blame] | 1840 | int MBEDTLS_PRIVATE(early_data_status); |
| 1841 | #endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */ |
| 1842 | |
Hanno Becker | d8f32e7 | 2021-06-17 05:14:58 +0100 | [diff] [blame] | 1843 | /** Callback to export key block and master secret */ |
| 1844 | mbedtls_ssl_export_keys_t *MBEDTLS_PRIVATE(f_export_keys); |
| 1845 | void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */ |
Gilles Peskine | 69477b5 | 2022-01-13 01:01:45 +0100 | [diff] [blame] | 1846 | |
| 1847 | /** User data pointer or handle. |
| 1848 | * |
| 1849 | * The library sets this to \p 0 when creating a context and does not |
| 1850 | * access it afterwards. |
Gilles Peskine | 49d7ddf | 2022-01-27 23:25:51 +0100 | [diff] [blame] | 1851 | * |
| 1852 | * \warning Serializing and restoring an SSL context with |
| 1853 | * mbedtls_ssl_context_save() and mbedtls_ssl_context_load() |
| 1854 | * does not currently restore the user data. |
Gilles Peskine | 69477b5 | 2022-01-13 01:01:45 +0100 | [diff] [blame] | 1855 | */ |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 1856 | mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1857 | }; |
| 1858 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1859 | /** |
Paul Bakker | b9e4e2c | 2014-05-01 14:18:25 +0200 | [diff] [blame] | 1860 | * \brief Return the name of the ciphersuite associated with the |
| 1861 | * given ID |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 1862 | * |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 1863 | * \param ciphersuite_id SSL ciphersuite ID |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 1864 | * |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 1865 | * \return a string containing the ciphersuite name |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 1866 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1867 | const char *mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id); |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 1868 | |
| 1869 | /** |
Paul Bakker | b9e4e2c | 2014-05-01 14:18:25 +0200 | [diff] [blame] | 1870 | * \brief Return the ID of the ciphersuite associated with the |
| 1871 | * given name |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 1872 | * |
| 1873 | * \param ciphersuite_name SSL ciphersuite name |
| 1874 | * |
| 1875 | * \return the ID with the ciphersuite or 0 if not found |
| 1876 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1877 | int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name); |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 1878 | |
| 1879 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1880 | * \brief Initialize an SSL context |
Tillmann Karras | 588ad50 | 2015-09-25 04:27:22 +0200 | [diff] [blame] | 1881 | * Just makes the context ready for mbedtls_ssl_setup() or |
Manuel Pégourié-Gonnard | 41d479e | 2015-04-29 00:48:22 +0200 | [diff] [blame] | 1882 | * mbedtls_ssl_free() |
| 1883 | * |
| 1884 | * \param ssl SSL context |
| 1885 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1886 | void mbedtls_ssl_init(mbedtls_ssl_context *ssl); |
Manuel Pégourié-Gonnard | 41d479e | 2015-04-29 00:48:22 +0200 | [diff] [blame] | 1887 | |
| 1888 | /** |
| 1889 | * \brief Set up an SSL context for use |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1890 | * |
Manuel Pégourié-Gonnard | 06939ce | 2015-05-11 11:25:46 +0200 | [diff] [blame] | 1891 | * \note No copy of the configuration context is made, it can be |
Manuel Pégourié-Gonnard | 151dc77 | 2015-05-14 13:55:51 +0200 | [diff] [blame] | 1892 | * shared by many mbedtls_ssl_context structures. |
Manuel Pégourié-Gonnard | 06939ce | 2015-05-11 11:25:46 +0200 | [diff] [blame] | 1893 | * |
Gilles Peskine | 4ae7d5d | 2017-05-26 11:59:29 +0200 | [diff] [blame] | 1894 | * \warning The conf structure will be accessed during the session. |
| 1895 | * It must not be modified or freed as long as the session |
| 1896 | * is active. |
| 1897 | * |
| 1898 | * \warning This function must be called exactly once per context. |
| 1899 | * Calling mbedtls_ssl_setup again is not supported, even |
| 1900 | * if no session is active. |
Manuel Pégourié-Gonnard | 06939ce | 2015-05-11 11:25:46 +0200 | [diff] [blame] | 1901 | * |
Gilles Peskine | 5b7e164 | 2022-08-04 23:44:59 +0200 | [diff] [blame] | 1902 | * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto |
| 1903 | * subsystem must have been initialized by calling |
| 1904 | * psa_crypto_init() before calling this function. |
| 1905 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1906 | * \param ssl SSL context |
Manuel Pégourié-Gonnard | def0bbe | 2015-05-04 14:56:36 +0200 | [diff] [blame] | 1907 | * \param conf SSL configuration to use |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1908 | * |
Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 1909 | * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if |
Paul Bakker | 69e095c | 2011-12-10 21:55:01 +0000 | [diff] [blame] | 1910 | * memory allocation failed |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1911 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1912 | int mbedtls_ssl_setup(mbedtls_ssl_context *ssl, |
| 1913 | const mbedtls_ssl_config *conf); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1914 | |
| 1915 | /** |
Paul Bakker | 7eb013f | 2011-10-06 12:37:39 +0000 | [diff] [blame] | 1916 | * \brief Reset an already initialized SSL context for re-use |
| 1917 | * while retaining application-set variables, function |
| 1918 | * pointers and data. |
| 1919 | * |
| 1920 | * \param ssl SSL context |
Mateusz Starzyk | a3a9984 | 2021-02-19 14:27:22 +0100 | [diff] [blame] | 1921 | * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or |
| 1922 | MBEDTLS_ERR_SSL_HW_ACCEL_FAILED |
Paul Bakker | 7eb013f | 2011-10-06 12:37:39 +0000 | [diff] [blame] | 1923 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1924 | int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl); |
Paul Bakker | 7eb013f | 2011-10-06 12:37:39 +0000 | [diff] [blame] | 1925 | |
| 1926 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1927 | * \brief Set the current endpoint type |
| 1928 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 1929 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1930 | * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1931 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1932 | void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1933 | |
| 1934 | /** |
Pengyu Lv | accd53f | 2023-03-07 10:31:08 +0800 | [diff] [blame] | 1935 | * \brief Get the current endpoint type |
| 1936 | * |
| 1937 | * \param conf SSL configuration |
| 1938 | * |
| 1939 | * \return Endpoint type, either MBEDTLS_SSL_IS_CLIENT |
| 1940 | * or MBEDTLS_SSL_IS_SERVER |
| 1941 | */ |
Pengyu Lv | 08daebb | 2023-07-10 10:36:48 +0800 | [diff] [blame] | 1942 | static inline int mbedtls_ssl_conf_get_endpoint(const mbedtls_ssl_config *conf) |
Pengyu Lv | accd53f | 2023-03-07 10:31:08 +0800 | [diff] [blame] | 1943 | { |
| 1944 | return conf->MBEDTLS_PRIVATE(endpoint); |
| 1945 | } |
| 1946 | |
| 1947 | /** |
Manuel Pégourié-Gonnard | 8fa6dfd | 2014-09-17 10:47:43 +0200 | [diff] [blame] | 1948 | * \brief Set the transport type (TLS or DTLS). |
| 1949 | * Default: TLS |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1950 | * |
Manuel Pégourié-Gonnard | 01e5e8c | 2015-05-11 10:11:56 +0200 | [diff] [blame] | 1951 | * \note For DTLS, you must either provide a recv callback that |
| 1952 | * doesn't block, or one that handles timeouts, see |
Manuel Pégourié-Gonnard | bbd28f7 | 2015-05-13 10:21:19 +0200 | [diff] [blame] | 1953 | * \c mbedtls_ssl_set_bio(). You also need to provide timer |
| 1954 | * callbacks with \c mbedtls_ssl_set_timer_cb(). |
Manuel Pégourié-Gonnard | 01e5e8c | 2015-05-11 10:11:56 +0200 | [diff] [blame] | 1955 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 1956 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1957 | * \param transport transport type: |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1958 | * MBEDTLS_SSL_TRANSPORT_STREAM for TLS, |
| 1959 | * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS. |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1960 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1961 | void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport); |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1962 | |
| 1963 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1964 | * \brief Set the certificate verification mode |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 1965 | * Default: NONE on server, REQUIRED on client |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1966 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 1967 | * \param conf SSL configuration |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1968 | * \param authmode can be: |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1969 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1970 | * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked |
Manuel Pégourié-Gonnard | fa44f20 | 2015-03-27 17:52:25 +0100 | [diff] [blame] | 1971 | * (default on server) |
| 1972 | * (insecure on client) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1973 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1974 | * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1975 | * handshake continues even if verification failed; |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1976 | * mbedtls_ssl_get_verify_result() can be called after the |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1977 | * handshake is complete. |
| 1978 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1979 | * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate, |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1980 | * handshake is aborted if verification failed. |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 1981 | * (default on client) |
Manuel Pégourié-Gonnard | e2ce211 | 2014-03-11 10:50:48 +0100 | [diff] [blame] | 1982 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1983 | * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode. |
| 1984 | * With MBEDTLS_SSL_VERIFY_OPTIONAL, the user needs to call mbedtls_ssl_get_verify_result() at |
Manuel Pégourié-Gonnard | e2ce211 | 2014-03-11 10:50:48 +0100 | [diff] [blame] | 1985 | * the right time(s), which may not be obvious, while REQUIRED always perform |
| 1986 | * the verification as soon as possible. For example, REQUIRED was protecting |
| 1987 | * against the "triple handshake" attack even before it was found. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1988 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1989 | void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1990 | |
Xiaokang Qian | d69d06f | 2022-10-25 06:51:25 +0000 | [diff] [blame] | 1991 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_EARLY_DATA) |
Xiaokang Qian | 54413b1 | 2022-10-20 05:57:03 +0000 | [diff] [blame] | 1992 | /** |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1993 | * \brief Set the early data mode |
| 1994 | * Default: disabled on server and client |
| 1995 | * |
| 1996 | * \param conf The SSL configuration to use. |
| 1997 | * \param early_data_enabled can be: |
| 1998 | * |
| 1999 | * MBEDTLS_SSL_EARLY_DATA_DISABLED: early data functionality is disabled |
| 2000 | * This is the default on client and server. |
| 2001 | * |
| 2002 | * MBEDTLS_SSL_EARLY_DATA_ENABLED: early data functionality is enabled and |
| 2003 | * may be negotiated in the handshake. Application using |
| 2004 | * early data functionality needs to be aware of the |
| 2005 | * lack of replay protection of the early data application |
| 2006 | * payloads. |
| 2007 | * |
| 2008 | * \warning This interface is experimental and may change without notice. |
| 2009 | * |
| 2010 | */ |
Yanray Wang | d5ed36f | 2023-11-07 11:40:43 +0800 | [diff] [blame] | 2011 | void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf, |
| 2012 | int early_data_enabled); |
Jerry Yu | cc4e007 | 2022-11-22 17:22:22 +0800 | [diff] [blame] | 2013 | |
| 2014 | #if defined(MBEDTLS_SSL_SRV_C) |
| 2015 | /** |
Jerry Yu | 12c46bd | 2022-12-06 11:02:51 +0800 | [diff] [blame] | 2016 | * \brief Set the maximum amount of 0-RTT data in bytes |
| 2017 | * Default: #MBEDTLS_SSL_MAX_EARLY_DATA_SIZE |
| 2018 | * |
| 2019 | * This function sets the value of the max_early_data_size |
| 2020 | * field of the early data indication extension included in |
| 2021 | * the NewSessionTicket messages that the server may send. |
| 2022 | * |
| 2023 | * The value defines the maximum amount of 0-RTT data |
| 2024 | * in bytes that a client will be allowed to send when using |
| 2025 | * one of the tickets defined by the NewSessionTicket messages. |
| 2026 | * |
| 2027 | * \note When resuming a session using a ticket, if the server receives more |
| 2028 | * early data than allowed for the ticket, it terminates the connection. |
| 2029 | * The maximum amount of 0-RTT data should thus be large enough |
| 2030 | * to allow a minimum of early data to be exchanged. |
Jerry Yu | cc4e007 | 2022-11-22 17:22:22 +0800 | [diff] [blame] | 2031 | * |
| 2032 | * \param[in] conf The SSL configuration to use. |
| 2033 | * \param[in] max_early_data_size The maximum amount of 0-RTT data. |
Jerry Yu | cc4e007 | 2022-11-22 17:22:22 +0800 | [diff] [blame] | 2034 | * |
| 2035 | * \warning This interface is experimental and may change without notice. |
| 2036 | * |
Jerry Yu | 6c485da | 2023-11-15 10:18:47 +0800 | [diff] [blame] | 2037 | * \warning This interface DOES NOT influence/limit the amount of early data |
Jerry Yu | fedaeb2 | 2023-11-15 13:59:07 +0800 | [diff] [blame] | 2038 | * that can be received through previously created and issued tickets, |
| 2039 | * which clients may have stored. |
Jerry Yu | 6c485da | 2023-11-15 10:18:47 +0800 | [diff] [blame] | 2040 | * |
Jerry Yu | cc4e007 | 2022-11-22 17:22:22 +0800 | [diff] [blame] | 2041 | */ |
Yanray Wang | 0751761 | 2023-11-07 11:47:36 +0800 | [diff] [blame] | 2042 | void mbedtls_ssl_conf_max_early_data_size( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2043 | mbedtls_ssl_config *conf, uint32_t max_early_data_size); |
Jerry Yu | cc4e007 | 2022-11-22 17:22:22 +0800 | [diff] [blame] | 2044 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 2045 | |
Xiaokang Qian | 54413b1 | 2022-10-20 05:57:03 +0000 | [diff] [blame] | 2046 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_EARLY_DATA */ |
| 2047 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2048 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2049 | /** |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 2050 | * \brief Set the verification callback (Optional). |
| 2051 | * |
Hanno Becker | 7b58fb1 | 2019-04-03 12:52:21 +0100 | [diff] [blame] | 2052 | * If set, the provided verify callback is called for each |
| 2053 | * certificate in the peer's CRT chain, including the trusted |
| 2054 | * root. For more information, please see the documentation of |
| 2055 | * \c mbedtls_x509_crt_verify(). |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 2056 | * |
Hanno Becker | 7b58fb1 | 2019-04-03 12:52:21 +0100 | [diff] [blame] | 2057 | * \note For per context callbacks and contexts, please use |
| 2058 | * mbedtls_ssl_set_verify() instead. |
| 2059 | * |
| 2060 | * \param conf The SSL configuration to use. |
| 2061 | * \param f_vrfy The verification callback to use during CRT verification. |
| 2062 | * \param p_vrfy The opaque context to be passed to the callback. |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 2063 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2064 | void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf, |
| 2065 | int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), |
| 2066 | void *p_vrfy); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2067 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 2068 | |
| 2069 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2070 | * \brief Set the random number generator callback |
| 2071 | * |
Manuel Pégourié-Gonnard | 750e4d7 | 2015-05-07 12:35:38 +0100 | [diff] [blame] | 2072 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | ad5390f | 2021-06-15 11:29:26 +0200 | [diff] [blame] | 2073 | * \param f_rng RNG function (mandatory) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2074 | * \param p_rng RNG parameter |
| 2075 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2076 | void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf, |
| 2077 | int (*f_rng)(void *, unsigned char *, size_t), |
| 2078 | void *p_rng); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2079 | |
| 2080 | /** |
| 2081 | * \brief Set the debug callback |
| 2082 | * |
Manuel Pégourié-Gonnard | fd47423 | 2015-06-23 16:34:24 +0200 | [diff] [blame] | 2083 | * The callback has the following argument: |
| 2084 | * void * opaque context for the callback |
| 2085 | * int debug level |
| 2086 | * const char * file name |
| 2087 | * int line number |
| 2088 | * const char * message |
| 2089 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 2090 | * \param conf SSL configuration |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2091 | * \param f_dbg debug function |
| 2092 | * \param p_dbg debug parameter |
| 2093 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2094 | void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf, |
| 2095 | void (*f_dbg)(void *, int, const char *, int, const char *), |
| 2096 | void *p_dbg); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2097 | |
Manuel Pégourié-Gonnard | 8fa6dfd | 2014-09-17 10:47:43 +0200 | [diff] [blame] | 2098 | /** |
Gilles Peskine | 915896f | 2022-01-13 01:05:10 +0100 | [diff] [blame] | 2099 | * \brief Return the SSL configuration structure associated |
| 2100 | * with the given SSL context. |
| 2101 | * |
| 2102 | * \note The pointer returned by this function is guaranteed to |
| 2103 | * remain valid until the context is freed. |
| 2104 | * |
| 2105 | * \param ssl The SSL context to query. |
| 2106 | * \return Pointer to the SSL configuration associated with \p ssl. |
| 2107 | */ |
| 2108 | static inline const mbedtls_ssl_config *mbedtls_ssl_context_get_config( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2109 | const mbedtls_ssl_context *ssl) |
Gilles Peskine | 915896f | 2022-01-13 01:05:10 +0100 | [diff] [blame] | 2110 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2111 | return ssl->MBEDTLS_PRIVATE(conf); |
Gilles Peskine | 915896f | 2022-01-13 01:05:10 +0100 | [diff] [blame] | 2112 | } |
| 2113 | |
| 2114 | /** |
Manuel Pégourié-Gonnard | 8fa6dfd | 2014-09-17 10:47:43 +0200 | [diff] [blame] | 2115 | * \brief Set the underlying BIO callbacks for write, read and |
| 2116 | * read-with-timeout. |
| 2117 | * |
| 2118 | * \param ssl SSL context |
| 2119 | * \param p_bio parameter (context) shared by BIO callbacks |
| 2120 | * \param f_send write callback |
| 2121 | * \param f_recv read callback |
Manuel Pégourié-Gonnard | 8836994 | 2015-05-06 16:19:31 +0100 | [diff] [blame] | 2122 | * \param f_recv_timeout blocking read callback with timeout. |
Manuel Pégourié-Gonnard | 8fa6dfd | 2014-09-17 10:47:43 +0200 | [diff] [blame] | 2123 | * |
Manuel Pégourié-Gonnard | bbd28f7 | 2015-05-13 10:21:19 +0200 | [diff] [blame] | 2124 | * \note One of f_recv or f_recv_timeout can be NULL, in which case |
| 2125 | * the other is used. If both are non-NULL, f_recv_timeout is |
| 2126 | * used and f_recv is ignored (as if it were NULL). |
Manuel Pégourié-Gonnard | 8fa6dfd | 2014-09-17 10:47:43 +0200 | [diff] [blame] | 2127 | * |
Manuel Pégourié-Gonnard | bbd28f7 | 2015-05-13 10:21:19 +0200 | [diff] [blame] | 2128 | * \note The two most common use cases are: |
| 2129 | * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL |
bootstrap-prime | 6dbbf44 | 2022-05-17 19:30:44 -0400 | [diff] [blame] | 2130 | * - blocking I/O, f_recv == NULL, f_recv_timeout != NULL |
Manuel Pégourié-Gonnard | bbd28f7 | 2015-05-13 10:21:19 +0200 | [diff] [blame] | 2131 | * |
| 2132 | * \note For DTLS, you need to provide either a non-NULL |
| 2133 | * f_recv_timeout callback, or a f_recv that doesn't block. |
Manuel Pégourié-Gonnard | d13b950 | 2016-02-22 09:33:52 +0100 | [diff] [blame] | 2134 | * |
Christopher Moynihan | 74e2534 | 2020-08-14 12:27:21 -0700 | [diff] [blame] | 2135 | * \note See the documentations of \c mbedtls_ssl_send_t, |
Manuel Pégourié-Gonnard | d13b950 | 2016-02-22 09:33:52 +0100 | [diff] [blame] | 2136 | * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 2137 | * the conventions those callbacks must follow. |
Manuel Pégourié-Gonnard | d13b950 | 2016-02-22 09:33:52 +0100 | [diff] [blame] | 2138 | * |
Andres AG | 3616f6f | 2016-09-14 14:32:09 +0100 | [diff] [blame] | 2139 | * \note On some platforms, net_sockets.c provides |
| 2140 | * \c mbedtls_net_send(), \c mbedtls_net_recv() and |
| 2141 | * \c mbedtls_net_recv_timeout() that are suitable to be used |
| 2142 | * here. |
Manuel Pégourié-Gonnard | 8fa6dfd | 2014-09-17 10:47:43 +0200 | [diff] [blame] | 2143 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2144 | void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl, |
| 2145 | void *p_bio, |
| 2146 | mbedtls_ssl_send_t *f_send, |
| 2147 | mbedtls_ssl_recv_t *f_recv, |
| 2148 | mbedtls_ssl_recv_timeout_t *f_recv_timeout); |
Manuel Pégourié-Gonnard | 97fd52c | 2015-05-06 15:38:52 +0100 | [diff] [blame] | 2149 | |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2150 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2151 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 2152 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2153 | |
| 2154 | |
| 2155 | /** |
Hanno Becker | 22a59fd | 2019-05-08 13:24:25 +0100 | [diff] [blame] | 2156 | * \brief Configure the use of the Connection ID (CID) |
Hanno Becker | f1f9a82 | 2019-04-23 12:01:20 +0100 | [diff] [blame] | 2157 | * extension in the next handshake. |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2158 | * |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 2159 | * Reference: RFC 9146 (or draft-ietf-tls-dtls-connection-id-05 |
Hanno Becker | ebcc913 | 2019-05-15 10:26:32 +0100 | [diff] [blame] | 2160 | * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05 |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 2161 | * for legacy version) |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2162 | * |
Hanno Becker | d9d4adb | 2019-05-15 10:08:35 +0100 | [diff] [blame] | 2163 | * The DTLS CID extension allows the reliable association of |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2164 | * DTLS records to DTLS connections across changes in the |
Hanno Becker | 08cd9db | 2019-05-15 10:10:36 +0100 | [diff] [blame] | 2165 | * underlying transport (changed IP and Port metadata) by |
| 2166 | * adding explicit connection identifiers (CIDs) to the |
| 2167 | * headers of encrypted DTLS records. The desired CIDs are |
| 2168 | * configured by the application layer and are exchanged in |
| 2169 | * new `ClientHello` / `ServerHello` extensions during the |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2170 | * handshake, where each side indicates the CID it wants the |
| 2171 | * peer to use when writing encrypted messages. The CIDs are |
| 2172 | * put to use once records get encrypted: the stack discards |
| 2173 | * any incoming records that don't include the configured CID |
| 2174 | * in their header, and adds the peer's requested CID to the |
| 2175 | * headers of outgoing messages. |
| 2176 | * |
Hanno Becker | 5cc145d | 2019-05-15 10:12:11 +0100 | [diff] [blame] | 2177 | * This API enables or disables the use of the CID extension |
| 2178 | * in the next handshake and sets the value of the CID to |
| 2179 | * be used for incoming messages. |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2180 | * |
| 2181 | * \param ssl The SSL context to configure. This must be initialized. |
| 2182 | * \param enable This value determines whether the CID extension should |
| 2183 | * be used or not. Possible values are: |
| 2184 | * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID. |
Hanno Becker | 318a87b | 2019-04-23 11:37:38 +0100 | [diff] [blame] | 2185 | * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use |
| 2186 | * of the CID. |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2187 | * \param own_cid The address of the readable buffer holding the CID we want |
| 2188 | * the peer to use when sending encrypted messages to us. |
| 2189 | * This may be \c NULL if \p own_cid_len is \c 0. |
Andrzej Kurek | 3bedb5b | 2022-02-17 14:39:00 -0500 | [diff] [blame] | 2190 | * This parameter is unused if \p enable is set to |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2191 | * MBEDTLS_SSL_CID_DISABLED. |
| 2192 | * \param own_cid_len The length of \p own_cid. |
Andrzej Kurek | 3bedb5b | 2022-02-17 14:39:00 -0500 | [diff] [blame] | 2193 | * This parameter is unused if \p enable is set to |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2194 | * MBEDTLS_SSL_CID_DISABLED. |
| 2195 | * |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 2196 | * \note The value of \p own_cid_len must match the value of the |
Hanno Becker | 8367ccc | 2019-05-14 11:30:10 +0100 | [diff] [blame] | 2197 | * \c len parameter passed to mbedtls_ssl_conf_cid() |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 2198 | * when configuring the ::mbedtls_ssl_config that \p ssl |
Hanno Becker | ddf775a | 2019-05-13 15:26:11 +0100 | [diff] [blame] | 2199 | * is bound to. |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 2200 | * |
Hanno Becker | 4f664cb | 2019-04-23 11:38:47 +0100 | [diff] [blame] | 2201 | * \note This CID configuration applies to subsequent handshakes |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2202 | * performed on the SSL context \p ssl, but does not trigger |
| 2203 | * one. You still have to call `mbedtls_ssl_handshake()` |
| 2204 | * (for the initial handshake) or `mbedtls_ssl_renegotiate()` |
| 2205 | * (for a renegotiation handshake) explicitly after a |
| 2206 | * successful call to this function to run the handshake. |
| 2207 | * |
| 2208 | * \note This call cannot guarantee that the use of the CID |
| 2209 | * will be successfully negotiated in the next handshake, |
| 2210 | * because the peer might not support it. Specifically: |
| 2211 | * - On the Client, enabling the use of the CID through |
| 2212 | * this call implies that the `ClientHello` in the next |
| 2213 | * handshake will include the CID extension, thereby |
| 2214 | * offering the use of the CID to the server. Only if |
| 2215 | * the `ServerHello` contains the CID extension, too, |
| 2216 | * the CID extension will actually be put to use. |
| 2217 | * - On the Server, enabling the use of the CID through |
Tom Cosgrove | 1797b05 | 2022-12-04 17:19:59 +0000 | [diff] [blame] | 2218 | * this call implies that the server will look for |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2219 | * the CID extension in a `ClientHello` from the client, |
| 2220 | * and, if present, reply with a CID extension in its |
| 2221 | * `ServerHello`. |
| 2222 | * |
| 2223 | * \note To check whether the use of the CID was negotiated |
| 2224 | * after the subsequent handshake has completed, please |
| 2225 | * use the API mbedtls_ssl_get_peer_cid(). |
| 2226 | * |
| 2227 | * \warning If the use of the CID extension is enabled in this call |
| 2228 | * and the subsequent handshake negotiates its use, Mbed TLS |
| 2229 | * will silently drop every packet whose CID does not match |
| 2230 | * the CID configured in \p own_cid. It is the responsibility |
| 2231 | * of the user to adapt the underlying transport to take care |
| 2232 | * of CID-based demultiplexing before handing datagrams to |
| 2233 | * Mbed TLS. |
| 2234 | * |
| 2235 | * \return \c 0 on success. In this case, the CID configuration |
| 2236 | * applies to the next handshake. |
| 2237 | * \return A negative error code on failure. |
| 2238 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2239 | int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl, |
| 2240 | int enable, |
| 2241 | unsigned char const *own_cid, |
| 2242 | size_t own_cid_len); |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2243 | |
| 2244 | /** |
Paul Elliott | 0113cf1 | 2022-03-11 20:26:47 +0000 | [diff] [blame] | 2245 | * \brief Get information about our request for usage of the CID |
| 2246 | * extension in the current connection. |
| 2247 | * |
| 2248 | * \param ssl The SSL context to query. |
| 2249 | * \param enabled The address at which to store whether the CID extension |
| 2250 | * is requested to be used or not. If the CID is |
| 2251 | * requested, `*enabled` is set to |
| 2252 | * MBEDTLS_SSL_CID_ENABLED; otherwise, it is set to |
| 2253 | * MBEDTLS_SSL_CID_DISABLED. |
| 2254 | * \param own_cid The address of the buffer in which to store our own |
| 2255 | * CID (if the CID extension is requested). This may be |
| 2256 | * \c NULL in case the value of our CID isn't needed. If |
| 2257 | * it is not \c NULL, \p own_cid_len must not be \c NULL. |
| 2258 | * \param own_cid_len The address at which to store the size of our own CID |
| 2259 | * (if the CID extension is requested). This is also the |
| 2260 | * number of Bytes in \p own_cid that have been written. |
| 2261 | * This may be \c NULL in case the length of our own CID |
| 2262 | * isn't needed. If it is \c NULL, \p own_cid must be |
| 2263 | * \c NULL, too. |
| 2264 | * |
| 2265 | *\note If we are requesting an empty CID this function sets |
| 2266 | * `*enabled` to #MBEDTLS_SSL_CID_DISABLED (the rationale |
| 2267 | * for this is that the resulting outcome is the |
| 2268 | * same as if the CID extensions wasn't requested). |
| 2269 | * |
| 2270 | * \return \c 0 on success. |
| 2271 | * \return A negative error code on failure. |
| 2272 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2273 | int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl, |
Paul Elliott | 0113cf1 | 2022-03-11 20:26:47 +0000 | [diff] [blame] | 2274 | int *enabled, |
| 2275 | unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX], |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2276 | size_t *own_cid_len); |
Paul Elliott | 0113cf1 | 2022-03-11 20:26:47 +0000 | [diff] [blame] | 2277 | |
| 2278 | /** |
Hanno Becker | fb034e8 | 2019-05-15 10:14:16 +0100 | [diff] [blame] | 2279 | * \brief Get information about the use of the CID extension |
| 2280 | * in the current connection. |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2281 | * |
| 2282 | * \param ssl The SSL context to query. |
| 2283 | * \param enabled The address at which to store whether the CID extension |
| 2284 | * is currently in use or not. If the CID is in use, |
| 2285 | * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED; |
| 2286 | * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED. |
| 2287 | * \param peer_cid The address of the buffer in which to store the CID |
| 2288 | * chosen by the peer (if the CID extension is used). |
Hanno Becker | 615ef17 | 2019-05-22 16:50:35 +0100 | [diff] [blame] | 2289 | * This may be \c NULL in case the value of peer CID |
| 2290 | * isn't needed. If it is not \c NULL, \p peer_cid_len |
| 2291 | * must not be \c NULL. |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2292 | * \param peer_cid_len The address at which to store the size of the CID |
| 2293 | * chosen by the peer (if the CID extension is used). |
| 2294 | * This is also the number of Bytes in \p peer_cid that |
| 2295 | * have been written. |
Hanno Becker | 615ef17 | 2019-05-22 16:50:35 +0100 | [diff] [blame] | 2296 | * This may be \c NULL in case the length of the peer CID |
| 2297 | * isn't needed. If it is \c NULL, \p peer_cid must be |
| 2298 | * \c NULL, too. |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2299 | * |
| 2300 | * \note This applies to the state of the CID negotiated in |
| 2301 | * the last complete handshake. If a handshake is in |
| 2302 | * progress, this function will attempt to complete |
| 2303 | * the handshake first. |
| 2304 | * |
Hanno Becker | c5f2422 | 2019-05-03 12:54:52 +0100 | [diff] [blame] | 2305 | * \note If CID extensions have been exchanged but both client |
| 2306 | * and server chose to use an empty CID, this function |
| 2307 | * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED |
| 2308 | * (the rationale for this is that the resulting |
| 2309 | * communication is the same as if the CID extensions |
| 2310 | * hadn't been used). |
| 2311 | * |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2312 | * \return \c 0 on success. |
| 2313 | * \return A negative error code on failure. |
| 2314 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2315 | int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl, |
| 2316 | int *enabled, |
| 2317 | unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX], |
| 2318 | size_t *peer_cid_len); |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2319 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 2320 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | 019f4b5 | 2019-04-09 15:12:56 +0100 | [diff] [blame] | 2321 | |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2322 | /** |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 2323 | * \brief Set the Maximum Transport Unit (MTU). |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2324 | * Special value: 0 means unset (no limit). |
| 2325 | * This represents the maximum size of a datagram payload |
| 2326 | * handled by the transport layer (usually UDP) as determined |
| 2327 | * by the network link and stack. In practice, this controls |
| 2328 | * the maximum size datagram the DTLS layer will pass to the |
| 2329 | * \c f_send() callback set using \c mbedtls_ssl_set_bio(). |
| 2330 | * |
Manuel Pégourié-Gonnard | 6611035 | 2018-08-21 11:55:40 +0200 | [diff] [blame] | 2331 | * \note The limit on datagram size is converted to a limit on |
| 2332 | * record payload by subtracting the current overhead of |
| 2333 | * encapsulation and encryption/authentication if any. |
| 2334 | * |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2335 | * \note This can be called at any point during the connection, for |
Hanno Becker | eefe084 | 2018-08-28 10:29:17 +0100 | [diff] [blame] | 2336 | * example when a Path Maximum Transfer Unit (PMTU) |
| 2337 | * estimate becomes available from other sources, |
| 2338 | * such as lower (or higher) protocol layers. |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2339 | * |
Manuel Pégourié-Gonnard | f2f1d40 | 2018-08-21 09:53:22 +0200 | [diff] [blame] | 2340 | * \note This setting only controls the size of the packets we send, |
| 2341 | * and does not restrict the size of the datagrams we're |
Manuel Pégourié-Gonnard | 68ae351 | 2018-08-22 10:24:31 +0200 | [diff] [blame] | 2342 | * willing to receive. Client-side, you can request the |
Manuel Pégourié-Gonnard | f2f1d40 | 2018-08-21 09:53:22 +0200 | [diff] [blame] | 2343 | * server to use smaller records with \c |
| 2344 | * mbedtls_ssl_conf_max_frag_len(). |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2345 | * |
| 2346 | * \note If both a MTU and a maximum fragment length have been |
Manuel Pégourié-Gonnard | 050dd6a | 2018-08-20 11:16:40 +0200 | [diff] [blame] | 2347 | * configured (or negotiated with the peer), the resulting |
Manuel Pégourié-Gonnard | 6611035 | 2018-08-21 11:55:40 +0200 | [diff] [blame] | 2348 | * lower limit on record payload (see first note) is used. |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2349 | * |
Manuel Pégourié-Gonnard | 050dd6a | 2018-08-20 11:16:40 +0200 | [diff] [blame] | 2350 | * \note This can only be used to decrease the maximum size |
Manuel Pégourié-Gonnard | 6611035 | 2018-08-21 11:55:40 +0200 | [diff] [blame] | 2351 | * of datagrams (hence records, see first note) sent. It |
| 2352 | * cannot be used to increase the maximum size of records over |
| 2353 | * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN. |
Manuel Pégourié-Gonnard | 050dd6a | 2018-08-20 11:16:40 +0200 | [diff] [blame] | 2354 | * |
| 2355 | * \note Values lower than the current record layer expansion will |
| 2356 | * result in an error when trying to send data. |
| 2357 | * |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2358 | * \param ssl SSL context |
| 2359 | * \param mtu Value of the path MTU in bytes |
| 2360 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2361 | void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu); |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 2362 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
| 2363 | |
Hanno Becker | 726c97a | 2019-04-03 12:52:35 +0100 | [diff] [blame] | 2364 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
| 2365 | /** |
| 2366 | * \brief Set a connection-specific verification callback (optional). |
| 2367 | * |
| 2368 | * If set, the provided verify callback is called for each |
| 2369 | * certificate in the peer's CRT chain, including the trusted |
| 2370 | * root. For more information, please see the documentation of |
| 2371 | * \c mbedtls_x509_crt_verify(). |
| 2372 | * |
| 2373 | * \note This call is analogous to mbedtls_ssl_conf_verify() but |
| 2374 | * binds the verification callback and context to an SSL context |
| 2375 | * as opposed to an SSL configuration. |
| 2376 | * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify() |
| 2377 | * are both used, mbedtls_ssl_set_verify() takes precedence. |
| 2378 | * |
Hanno Becker | f345baf | 2019-04-03 13:43:15 +0100 | [diff] [blame] | 2379 | * \param ssl The SSL context to use. |
Hanno Becker | 726c97a | 2019-04-03 12:52:35 +0100 | [diff] [blame] | 2380 | * \param f_vrfy The verification callback to use during CRT verification. |
| 2381 | * \param p_vrfy The opaque context to be passed to the callback. |
| 2382 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2383 | void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl, |
| 2384 | int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), |
| 2385 | void *p_vrfy); |
Hanno Becker | 726c97a | 2019-04-03 12:52:35 +0100 | [diff] [blame] | 2386 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
| 2387 | |
Manuel Pégourié-Gonnard | 97fd52c | 2015-05-06 15:38:52 +0100 | [diff] [blame] | 2388 | /** |
| 2389 | * \brief Set the timeout period for mbedtls_ssl_read() |
| 2390 | * (Default: no timeout.) |
| 2391 | * |
| 2392 | * \param conf SSL configuration context |
| 2393 | * \param timeout Timeout value in milliseconds. |
| 2394 | * Use 0 for no timeout (default). |
| 2395 | * |
| 2396 | * \note With blocking I/O, this will only work if a non-NULL |
Manuel Pégourié-Gonnard | 1b511f9 | 2015-05-06 15:54:23 +0100 | [diff] [blame] | 2397 | * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio(). |
Manuel Pégourié-Gonnard | bbd28f7 | 2015-05-13 10:21:19 +0200 | [diff] [blame] | 2398 | * With non-blocking I/O, this will only work if timer |
| 2399 | * callbacks were set with \c mbedtls_ssl_set_timer_cb(). |
| 2400 | * |
| 2401 | * \note With non-blocking I/O, you may also skip this function |
| 2402 | * altogether and handle timeouts at the application layer. |
Manuel Pégourié-Gonnard | 97fd52c | 2015-05-06 15:38:52 +0100 | [diff] [blame] | 2403 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2404 | void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout); |
Manuel Pégourié-Gonnard | 8fa6dfd | 2014-09-17 10:47:43 +0200 | [diff] [blame] | 2405 | |
Hanno Becker | cfe4579 | 2019-07-03 16:13:00 +0100 | [diff] [blame] | 2406 | /** |
Jarno Lamsa | 31c3b14 | 2019-08-14 10:39:32 +0300 | [diff] [blame] | 2407 | * \brief Check whether a buffer contains a valid and authentic record |
| 2408 | * that has not been seen before. (DTLS only). |
Hanno Becker | cfe4579 | 2019-07-03 16:13:00 +0100 | [diff] [blame] | 2409 | * |
| 2410 | * This function does not change the user-visible state |
Hanno Becker | b7d1dff | 2019-07-18 08:21:17 +0100 | [diff] [blame] | 2411 | * of the SSL context. Its sole purpose is to provide |
Hanno Becker | cfe4579 | 2019-07-03 16:13:00 +0100 | [diff] [blame] | 2412 | * an indication of the legitimacy of an incoming record. |
| 2413 | * |
| 2414 | * This can be useful e.g. in distributed server environments |
| 2415 | * using the DTLS Connection ID feature, in which connections |
| 2416 | * might need to be passed between service instances on a change |
| 2417 | * of peer address, but where such disruptive operations should |
| 2418 | * only happen after the validity of incoming records has been |
| 2419 | * confirmed. |
| 2420 | * |
| 2421 | * \param ssl The SSL context to use. |
| 2422 | * \param buf The address of the buffer holding the record to be checked. |
Jarno Lamsa | 31c3b14 | 2019-08-14 10:39:32 +0300 | [diff] [blame] | 2423 | * This must be a read/write buffer of length \p buflen Bytes. |
Hanno Becker | cfe4579 | 2019-07-03 16:13:00 +0100 | [diff] [blame] | 2424 | * \param buflen The length of \p buf in Bytes. |
| 2425 | * |
| 2426 | * \note This routine only checks whether the provided buffer begins |
Jarno Lamsa | 31c3b14 | 2019-08-14 10:39:32 +0300 | [diff] [blame] | 2427 | * with a valid and authentic record that has not been seen |
| 2428 | * before, but does not check potential data following the |
| 2429 | * initial record. In particular, it is possible to pass DTLS |
| 2430 | * datagrams containing multiple records, in which case only |
| 2431 | * the first record is checked. |
Hanno Becker | cfe4579 | 2019-07-03 16:13:00 +0100 | [diff] [blame] | 2432 | * |
| 2433 | * \note This function modifies the input buffer \p buf. If you need |
| 2434 | * to preserve the original record, you have to maintain a copy. |
| 2435 | * |
Jarno Lamsa | 31c3b14 | 2019-08-14 10:39:32 +0300 | [diff] [blame] | 2436 | * \return \c 0 if the record is valid and authentic and has not been |
| 2437 | * seen before. |
Hanno Becker | cfe4579 | 2019-07-03 16:13:00 +0100 | [diff] [blame] | 2438 | * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed |
| 2439 | * successfully but the record was found to be not authentic. |
| 2440 | * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed |
| 2441 | * successfully but the record was found to be invalid for |
| 2442 | * a reason different from authenticity checking. |
| 2443 | * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed |
| 2444 | * successfully but the record was found to be unexpected |
| 2445 | * in the state of the SSL context, including replayed records. |
| 2446 | * \return Another negative error code on different kinds of failure. |
| 2447 | * In this case, the SSL context becomes unusable and needs |
| 2448 | * to be freed or reset before reuse. |
| 2449 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2450 | int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl, |
| 2451 | unsigned char *buf, |
| 2452 | size_t buflen); |
Hanno Becker | cfe4579 | 2019-07-03 16:13:00 +0100 | [diff] [blame] | 2453 | |
Manuel Pégourié-Gonnard | 2e01291 | 2015-05-12 20:55:41 +0200 | [diff] [blame] | 2454 | /** |
Manuel Pégourié-Gonnard | d13b950 | 2016-02-22 09:33:52 +0100 | [diff] [blame] | 2455 | * \brief Set the timer callbacks (Mandatory for DTLS.) |
Manuel Pégourié-Gonnard | 2e01291 | 2015-05-12 20:55:41 +0200 | [diff] [blame] | 2456 | * |
| 2457 | * \param ssl SSL context |
Manuel Pégourié-Gonnard | d13b950 | 2016-02-22 09:33:52 +0100 | [diff] [blame] | 2458 | * \param p_timer parameter (context) shared by timer callbacks |
Manuel Pégourié-Gonnard | 2e01291 | 2015-05-12 20:55:41 +0200 | [diff] [blame] | 2459 | * \param f_set_timer set timer callback |
Manuel Pégourié-Gonnard | 2e01291 | 2015-05-12 20:55:41 +0200 | [diff] [blame] | 2460 | * \param f_get_timer get timer callback. Must return: |
Manuel Pégourié-Gonnard | d13b950 | 2016-02-22 09:33:52 +0100 | [diff] [blame] | 2461 | * |
| 2462 | * \note See the documentation of \c mbedtls_ssl_set_timer_t and |
| 2463 | * \c mbedtls_ssl_get_timer_t for the conventions this pair of |
Jaakko Korhonen | 14918fb | 2017-01-09 11:07:46 +0200 | [diff] [blame] | 2464 | * callbacks must follow. |
Manuel Pégourié-Gonnard | d13b950 | 2016-02-22 09:33:52 +0100 | [diff] [blame] | 2465 | * |
| 2466 | * \note On some platforms, timing.c provides |
| 2467 | * \c mbedtls_timing_set_delay() and |
| 2468 | * \c mbedtls_timing_get_delay() that are suitable for using |
| 2469 | * here, except if using an event-driven style. |
| 2470 | * |
| 2471 | * \note See also the "DTLS tutorial" article in our knowledge base. |
Dave Rodgman | b319684 | 2022-10-12 16:47:08 +0100 | [diff] [blame] | 2472 | * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/dtls-tutorial |
Manuel Pégourié-Gonnard | 2e01291 | 2015-05-12 20:55:41 +0200 | [diff] [blame] | 2473 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2474 | void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl, |
| 2475 | void *p_timer, |
| 2476 | mbedtls_ssl_set_timer_t *f_set_timer, |
| 2477 | mbedtls_ssl_get_timer_t *f_get_timer); |
Manuel Pégourié-Gonnard | 2e01291 | 2015-05-12 20:55:41 +0200 | [diff] [blame] | 2478 | |
Glenn Strauss | 2ed9527 | 2022-01-21 18:02:17 -0500 | [diff] [blame] | 2479 | #if defined(MBEDTLS_SSL_SRV_C) |
| 2480 | /** |
| 2481 | * \brief Set the certificate selection callback (server-side only). |
| 2482 | * |
| 2483 | * If set, the callback is always called for each handshake, |
| 2484 | * after `ClientHello` processing has finished. |
| 2485 | * |
Glenn Strauss | 2ed9527 | 2022-01-21 18:02:17 -0500 | [diff] [blame] | 2486 | * \param conf The SSL configuration to register the callback with. |
| 2487 | * \param f_cert_cb The callback for selecting server certificate after |
| 2488 | * `ClientHello` processing has finished. |
| 2489 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2490 | static inline void mbedtls_ssl_conf_cert_cb(mbedtls_ssl_config *conf, |
| 2491 | mbedtls_ssl_hs_cb_t f_cert_cb) |
Glenn Strauss | 236e17e | 2022-03-13 23:39:40 -0400 | [diff] [blame] | 2492 | { |
| 2493 | conf->MBEDTLS_PRIVATE(f_cert_cb) = f_cert_cb; |
| 2494 | } |
Glenn Strauss | 2ed9527 | 2022-01-21 18:02:17 -0500 | [diff] [blame] | 2495 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 2496 | |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2497 | /** |
| 2498 | * \brief Callback type: generate and write session ticket |
| 2499 | * |
| 2500 | * \note This describes what a callback implementation should do. |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 2501 | * This callback should generate an encrypted and |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2502 | * authenticated ticket for the session and write it to the |
| 2503 | * output buffer. Here, ticket means the opaque ticket part |
| 2504 | * of the NewSessionTicket structure of RFC 5077. |
| 2505 | * |
| 2506 | * \param p_ticket Context for the callback |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 2507 | * \param session SSL session to be written in the ticket |
| 2508 | * \param start Start of the output buffer |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2509 | * \param end End of the output buffer |
| 2510 | * \param tlen On exit, holds the length written |
| 2511 | * \param lifetime On exit, holds the lifetime of the ticket in seconds |
| 2512 | * |
| 2513 | * \return 0 if successful, or |
| 2514 | * a specific MBEDTLS_ERR_XXX code. |
| 2515 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2516 | typedef int mbedtls_ssl_ticket_write_t(void *p_ticket, |
| 2517 | const mbedtls_ssl_session *session, |
| 2518 | unsigned char *start, |
| 2519 | const unsigned char *end, |
| 2520 | size_t *tlen, |
| 2521 | uint32_t *lifetime); |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2522 | |
| 2523 | /** |
| 2524 | * \brief Callback type: parse and load session ticket |
| 2525 | * |
| 2526 | * \note This describes what a callback implementation should do. |
| 2527 | * This callback should parse a session ticket as generated |
| 2528 | * by the corresponding mbedtls_ssl_ticket_write_t function, |
| 2529 | * and, if the ticket is authentic and valid, load the |
| 2530 | * session. |
| 2531 | * |
| 2532 | * \note The implementation is allowed to modify the first len |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 2533 | * bytes of the input buffer, eg to use it as a temporary |
| 2534 | * area for the decrypted ticket contents. |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2535 | * |
| 2536 | * \param p_ticket Context for the callback |
| 2537 | * \param session SSL session to be loaded |
| 2538 | * \param buf Start of the buffer containing the ticket |
| 2539 | * \param len Length of the ticket. |
| 2540 | * |
| 2541 | * \return 0 if successful, or |
| 2542 | * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or |
| 2543 | * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or |
| 2544 | * any other non-zero code for other failures. |
| 2545 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2546 | typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket, |
| 2547 | mbedtls_ssl_session *session, |
| 2548 | unsigned char *buf, |
| 2549 | size_t len); |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2550 | |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 2551 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C) |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2552 | /** |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 2553 | * \brief Configure SSL session ticket callbacks (server only). |
| 2554 | * (Default: none.) |
| 2555 | * |
| 2556 | * \note On server, session tickets are enabled by providing |
| 2557 | * non-NULL callbacks. |
| 2558 | * |
Manuel Pégourié-Gonnard | 1b1e65f | 2015-06-11 13:29:15 +0200 | [diff] [blame] | 2559 | * \note On client, use \c mbedtls_ssl_conf_session_tickets(). |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2560 | * |
| 2561 | * \param conf SSL configuration context |
| 2562 | * \param f_ticket_write Callback for writing a ticket |
| 2563 | * \param f_ticket_parse Callback for parsing a ticket |
| 2564 | * \param p_ticket Context shared by the two callbacks |
| 2565 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2566 | void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf, |
| 2567 | mbedtls_ssl_ticket_write_t *f_ticket_write, |
| 2568 | mbedtls_ssl_ticket_parse_t *f_ticket_parse, |
| 2569 | void *p_ticket); |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 2570 | #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */ |
Manuel Pégourié-Gonnard | d59675d | 2015-05-19 15:28:00 +0200 | [diff] [blame] | 2571 | |
Robert Cragie | 4feb7ae | 2015-10-02 13:33:37 +0100 | [diff] [blame] | 2572 | /** |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 2573 | * \brief Configure a key export callback. |
| 2574 | * (Default: none.) |
Robert Cragie | 4feb7ae | 2015-10-02 13:33:37 +0100 | [diff] [blame] | 2575 | * |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 2576 | * This API can be used for two purposes: |
| 2577 | * - Debugging: Use this API to e.g. generate an NSSKeylog |
| 2578 | * file and use it to inspect encrypted traffic in tools |
| 2579 | * such as Wireshark. |
| 2580 | * - Application-specific export: Use this API to implement |
| 2581 | * key exporters, e.g. for EAP-TLS or DTLS-SRTP. |
Robert Cragie | 4feb7ae | 2015-10-02 13:33:37 +0100 | [diff] [blame] | 2582 | * |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 2583 | * |
Hanno Becker | 7e6c178 | 2021-06-08 09:24:55 +0100 | [diff] [blame] | 2584 | * \param ssl The SSL context to which the export |
| 2585 | * callback should be attached. |
Hanno Becker | 457d616 | 2021-05-24 10:27:39 +0100 | [diff] [blame] | 2586 | * \param f_export_keys The callback for the key export. |
| 2587 | * \param p_export_keys The opaque context pointer to be passed to the |
| 2588 | * callback \p f_export_keys. |
Robert Cragie | 4feb7ae | 2015-10-02 13:33:37 +0100 | [diff] [blame] | 2589 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2590 | void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl, |
| 2591 | mbedtls_ssl_export_keys_t *f_export_keys, |
| 2592 | void *p_export_keys); |
Robert Cragie | 4feb7ae | 2015-10-02 13:33:37 +0100 | [diff] [blame] | 2593 | |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2594 | /** \brief Set the user data in an SSL configuration to a pointer. |
| 2595 | * |
| 2596 | * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_p(). |
| 2597 | * |
| 2598 | * \note The library stores \c p without accessing it. It is the responsibility |
| 2599 | * of the caller to ensure that the pointer remains valid. |
| 2600 | * |
| 2601 | * \param conf The SSL configuration context to modify. |
| 2602 | * \param p The new value of the user data. |
| 2603 | */ |
| 2604 | static inline void mbedtls_ssl_conf_set_user_data_p( |
| 2605 | mbedtls_ssl_config *conf, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2606 | void *p) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2607 | { |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 2608 | conf->MBEDTLS_PRIVATE(user_data).p = p; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2609 | } |
| 2610 | |
| 2611 | /** \brief Set the user data in an SSL configuration to an integer. |
| 2612 | * |
| 2613 | * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_n(). |
| 2614 | * |
| 2615 | * \param conf The SSL configuration context to modify. |
| 2616 | * \param n The new value of the user data. |
| 2617 | */ |
| 2618 | static inline void mbedtls_ssl_conf_set_user_data_n( |
| 2619 | mbedtls_ssl_config *conf, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2620 | uintptr_t n) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2621 | { |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 2622 | conf->MBEDTLS_PRIVATE(user_data).n = n; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2623 | } |
| 2624 | |
| 2625 | /** \brief Retrieve the user data in an SSL configuration as a pointer. |
| 2626 | * |
Gilles Peskine | 1e265d2 | 2022-01-27 23:30:52 +0100 | [diff] [blame] | 2627 | * This is the value last set with mbedtls_ssl_conf_set_user_data_p(), or |
| 2628 | * \c NULL if mbedtls_ssl_conf_set_user_data_p() has not previously been |
| 2629 | * called. The value is undefined if mbedtls_ssl_conf_set_user_data_n() has |
| 2630 | * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_p(). |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2631 | * |
| 2632 | * \param conf The SSL configuration context to modify. |
| 2633 | * \return The current value of the user data. |
| 2634 | */ |
| 2635 | static inline void *mbedtls_ssl_conf_get_user_data_p( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2636 | mbedtls_ssl_config *conf) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2637 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2638 | return conf->MBEDTLS_PRIVATE(user_data).p; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2639 | } |
| 2640 | |
| 2641 | /** \brief Retrieve the user data in an SSL configuration as an integer. |
| 2642 | * |
Gilles Peskine | 1e265d2 | 2022-01-27 23:30:52 +0100 | [diff] [blame] | 2643 | * This is the value last set with mbedtls_ssl_conf_set_user_data_n(), or |
| 2644 | * \c 0 if mbedtls_ssl_conf_set_user_data_n() has not previously been |
| 2645 | * called. The value is undefined if mbedtls_ssl_conf_set_user_data_p() has |
| 2646 | * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_n(). |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2647 | * |
| 2648 | * \param conf The SSL configuration context to modify. |
| 2649 | * \return The current value of the user data. |
| 2650 | */ |
| 2651 | static inline uintptr_t mbedtls_ssl_conf_get_user_data_n( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2652 | mbedtls_ssl_config *conf) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2653 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2654 | return conf->MBEDTLS_PRIVATE(user_data).n; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2655 | } |
| 2656 | |
| 2657 | /** \brief Set the user data in an SSL context to a pointer. |
| 2658 | * |
| 2659 | * You can retrieve this value later with mbedtls_ssl_get_user_data_p(). |
| 2660 | * |
| 2661 | * \note The library stores \c p without accessing it. It is the responsibility |
| 2662 | * of the caller to ensure that the pointer remains valid. |
| 2663 | * |
Tom Cosgrove | 1797b05 | 2022-12-04 17:19:59 +0000 | [diff] [blame] | 2664 | * \param ssl The SSL context to modify. |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2665 | * \param p The new value of the user data. |
| 2666 | */ |
| 2667 | static inline void mbedtls_ssl_set_user_data_p( |
| 2668 | mbedtls_ssl_context *ssl, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2669 | void *p) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2670 | { |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 2671 | ssl->MBEDTLS_PRIVATE(user_data).p = p; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2672 | } |
| 2673 | |
| 2674 | /** \brief Set the user data in an SSL context to an integer. |
| 2675 | * |
| 2676 | * You can retrieve this value later with mbedtls_ssl_get_user_data_n(). |
| 2677 | * |
Tom Cosgrove | 1797b05 | 2022-12-04 17:19:59 +0000 | [diff] [blame] | 2678 | * \param ssl The SSL context to modify. |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2679 | * \param n The new value of the user data. |
| 2680 | */ |
| 2681 | static inline void mbedtls_ssl_set_user_data_n( |
| 2682 | mbedtls_ssl_context *ssl, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2683 | uintptr_t n) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2684 | { |
Gilles Peskine | ded2a42 | 2022-02-12 00:20:08 +0100 | [diff] [blame] | 2685 | ssl->MBEDTLS_PRIVATE(user_data).n = n; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2686 | } |
| 2687 | |
| 2688 | /** \brief Retrieve the user data in an SSL context as a pointer. |
| 2689 | * |
Gilles Peskine | 1e265d2 | 2022-01-27 23:30:52 +0100 | [diff] [blame] | 2690 | * This is the value last set with mbedtls_ssl_set_user_data_p(), or |
| 2691 | * \c NULL if mbedtls_ssl_set_user_data_p() has not previously been |
| 2692 | * called. The value is undefined if mbedtls_ssl_set_user_data_n() has |
| 2693 | * been called without a subsequent call to mbedtls_ssl_set_user_data_p(). |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2694 | * |
Tom Cosgrove | 1797b05 | 2022-12-04 17:19:59 +0000 | [diff] [blame] | 2695 | * \param ssl The SSL context to modify. |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2696 | * \return The current value of the user data. |
| 2697 | */ |
| 2698 | static inline void *mbedtls_ssl_get_user_data_p( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2699 | mbedtls_ssl_context *ssl) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2700 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2701 | return ssl->MBEDTLS_PRIVATE(user_data).p; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2702 | } |
| 2703 | |
| 2704 | /** \brief Retrieve the user data in an SSL context as an integer. |
| 2705 | * |
Gilles Peskine | 1e265d2 | 2022-01-27 23:30:52 +0100 | [diff] [blame] | 2706 | * This is the value last set with mbedtls_ssl_set_user_data_n(), or |
| 2707 | * \c 0 if mbedtls_ssl_set_user_data_n() has not previously been |
| 2708 | * called. The value is undefined if mbedtls_ssl_set_user_data_p() has |
| 2709 | * been called without a subsequent call to mbedtls_ssl_set_user_data_n(). |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2710 | * |
Tom Cosgrove | 1797b05 | 2022-12-04 17:19:59 +0000 | [diff] [blame] | 2711 | * \param ssl The SSL context to modify. |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2712 | * \return The current value of the user data. |
| 2713 | */ |
| 2714 | static inline uintptr_t mbedtls_ssl_get_user_data_n( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2715 | mbedtls_ssl_context *ssl) |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2716 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2717 | return ssl->MBEDTLS_PRIVATE(user_data).n; |
Gilles Peskine | 80dae04 | 2022-01-21 23:50:39 +0100 | [diff] [blame] | 2718 | } |
| 2719 | |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 2720 | #if defined(MBEDTLS_SSL_ASYNC_PRIVATE) |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 2721 | /** |
| 2722 | * \brief Configure asynchronous private key operation callbacks. |
| 2723 | * |
| 2724 | * \param conf SSL configuration context |
| 2725 | * \param f_async_sign Callback to start a signature operation. See |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 2726 | * the description of ::mbedtls_ssl_async_sign_t |
| 2727 | * for more information. This may be \c NULL if the |
Gilles Peskine | f112725 | 2018-04-24 13:05:39 +0200 | [diff] [blame] | 2728 | * external processor does not support any signature |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 2729 | * operation; in this case the private key object |
| 2730 | * associated with the certificate will be used. |
| 2731 | * \param f_async_decrypt Callback to start a decryption operation. See |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 2732 | * the description of ::mbedtls_ssl_async_decrypt_t |
| 2733 | * for more information. This may be \c NULL if the |
Gilles Peskine | f112725 | 2018-04-24 13:05:39 +0200 | [diff] [blame] | 2734 | * external processor does not support any decryption |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 2735 | * operation; in this case the private key object |
| 2736 | * associated with the certificate will be used. |
| 2737 | * \param f_async_resume Callback to resume an asynchronous operation. See |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 2738 | * the description of ::mbedtls_ssl_async_resume_t |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 2739 | * for more information. This may not be \c NULL unless |
| 2740 | * \p f_async_sign and \p f_async_decrypt are both |
| 2741 | * \c NULL. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 2742 | * \param f_async_cancel Callback to cancel an asynchronous operation. See |
Gilles Peskine | 2481a71 | 2018-04-26 07:28:44 +0200 | [diff] [blame] | 2743 | * the description of ::mbedtls_ssl_async_cancel_t |
Gilles Peskine | ad28bf0 | 2018-04-26 00:19:16 +0200 | [diff] [blame] | 2744 | * for more information. This may be \c NULL if |
| 2745 | * no cleanup is needed. |
Gilles Peskine | 8f97af7 | 2018-04-26 11:46:10 +0200 | [diff] [blame] | 2746 | * \param config_data A pointer to configuration data which can be |
| 2747 | * retrieved with |
| 2748 | * mbedtls_ssl_conf_get_async_config_data(). The |
| 2749 | * library stores this value without dereferencing it. |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 2750 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2751 | void mbedtls_ssl_conf_async_private_cb(mbedtls_ssl_config *conf, |
| 2752 | mbedtls_ssl_async_sign_t *f_async_sign, |
| 2753 | mbedtls_ssl_async_decrypt_t *f_async_decrypt, |
| 2754 | mbedtls_ssl_async_resume_t *f_async_resume, |
| 2755 | mbedtls_ssl_async_cancel_t *f_async_cancel, |
| 2756 | void *config_data); |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 2757 | |
| 2758 | /** |
Gilles Peskine | 8f97af7 | 2018-04-26 11:46:10 +0200 | [diff] [blame] | 2759 | * \brief Retrieve the configuration data set by |
| 2760 | * mbedtls_ssl_conf_async_private_cb(). |
| 2761 | * |
| 2762 | * \param conf SSL configuration context |
| 2763 | * \return The configuration data set by |
| 2764 | * mbedtls_ssl_conf_async_private_cb(). |
| 2765 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2766 | void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf); |
Gilles Peskine | 8f97af7 | 2018-04-26 11:46:10 +0200 | [diff] [blame] | 2767 | |
| 2768 | /** |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 2769 | * \brief Retrieve the asynchronous operation user context. |
| 2770 | * |
| 2771 | * \note This function may only be called while a handshake |
| 2772 | * is in progress. |
| 2773 | * |
| 2774 | * \param ssl The SSL context to access. |
| 2775 | * |
| 2776 | * \return The asynchronous operation user context that was last |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 2777 | * set during the current handshake. If |
| 2778 | * mbedtls_ssl_set_async_operation_data() has not yet been |
| 2779 | * called during the current handshake, this function returns |
| 2780 | * \c NULL. |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 2781 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2782 | void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl); |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 2783 | |
| 2784 | /** |
| 2785 | * \brief Retrieve the asynchronous operation user context. |
| 2786 | * |
| 2787 | * \note This function may only be called while a handshake |
| 2788 | * is in progress. |
| 2789 | * |
| 2790 | * \param ssl The SSL context to access. |
| 2791 | * \param ctx The new value of the asynchronous operation user context. |
Gilles Peskine | 1febfef | 2018-04-30 11:54:39 +0200 | [diff] [blame] | 2792 | * Call mbedtls_ssl_get_async_operation_data() later during the |
| 2793 | * same handshake to retrieve this value. |
Gilles Peskine | df13d5c | 2018-04-25 20:39:48 +0200 | [diff] [blame] | 2794 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2795 | void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl, |
| 2796 | void *ctx); |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 2797 | #endif /* MBEDTLS_SSL_ASYNC_PRIVATE */ |
Gilles Peskine | 8bf79f6 | 2018-01-05 21:11:53 +0100 | [diff] [blame] | 2798 | |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 2799 | /** |
| 2800 | * \brief Callback type: generate a cookie |
| 2801 | * |
| 2802 | * \param ctx Context for the callback |
| 2803 | * \param p Buffer to write to, |
| 2804 | * must be updated to point right after the cookie |
| 2805 | * \param end Pointer to one past the end of the output buffer |
| 2806 | * \param info Client ID info that was passed to |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2807 | * \c mbedtls_ssl_set_client_transport_id() |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 2808 | * \param ilen Length of info in bytes |
| 2809 | * |
| 2810 | * \return The callback must return 0 on success, |
| 2811 | * or a negative error code. |
| 2812 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2813 | typedef int mbedtls_ssl_cookie_write_t(void *ctx, |
| 2814 | unsigned char **p, unsigned char *end, |
| 2815 | const unsigned char *info, size_t ilen); |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 2816 | |
| 2817 | /** |
| 2818 | * \brief Callback type: verify a cookie |
| 2819 | * |
| 2820 | * \param ctx Context for the callback |
| 2821 | * \param cookie Cookie to verify |
| 2822 | * \param clen Length of cookie |
| 2823 | * \param info Client ID info that was passed to |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2824 | * \c mbedtls_ssl_set_client_transport_id() |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 2825 | * \param ilen Length of info in bytes |
| 2826 | * |
| 2827 | * \return The callback must return 0 if cookie is valid, |
| 2828 | * or a negative error code. |
| 2829 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2830 | typedef int mbedtls_ssl_cookie_check_t(void *ctx, |
| 2831 | const unsigned char *cookie, size_t clen, |
| 2832 | const unsigned char *info, size_t ilen); |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 2833 | |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 2834 | #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C) |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 2835 | /** |
| 2836 | * \brief Register callbacks for DTLS cookies |
| 2837 | * (Server only. DTLS only.) |
| 2838 | * |
Manuel Pégourié-Gonnard | b48ef9c | 2015-05-28 15:24:25 +0200 | [diff] [blame] | 2839 | * Default: dummy callbacks that fail, in order to force you to |
Manuel Pégourié-Gonnard | 7d38d21 | 2014-07-23 17:52:09 +0200 | [diff] [blame] | 2840 | * register working callbacks (and initialize their context). |
| 2841 | * |
| 2842 | * To disable HelloVerifyRequest, register NULL callbacks. |
| 2843 | * |
| 2844 | * \warning Disabling hello verification allows your server to be used |
| 2845 | * for amplification in DoS attacks against other hosts. |
| 2846 | * Only disable if you known this can't happen in your |
| 2847 | * particular environment. |
| 2848 | * |
Manuel Pégourié-Gonnard | b48ef9c | 2015-05-28 15:24:25 +0200 | [diff] [blame] | 2849 | * \note See comments on \c mbedtls_ssl_handshake() about handling |
| 2850 | * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected |
| 2851 | * on the first handshake attempt when this is enabled. |
| 2852 | * |
Manuel Pégourié-Gonnard | 3a2a448 | 2015-09-08 15:36:09 +0200 | [diff] [blame] | 2853 | * \note This is also necessary to handle client reconnection from |
| 2854 | * the same port as described in RFC 6347 section 4.2.8 (only |
| 2855 | * the variant with cookies is supported currently). See |
| 2856 | * comments on \c mbedtls_ssl_read() for details. |
| 2857 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 2858 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | d485d19 | 2014-07-23 14:56:15 +0200 | [diff] [blame] | 2859 | * \param f_cookie_write Cookie write callback |
| 2860 | * \param f_cookie_check Cookie check callback |
| 2861 | * \param p_cookie Context for both callbacks |
| 2862 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2863 | void mbedtls_ssl_conf_dtls_cookies(mbedtls_ssl_config *conf, |
| 2864 | mbedtls_ssl_cookie_write_t *f_cookie_write, |
| 2865 | mbedtls_ssl_cookie_check_t *f_cookie_check, |
| 2866 | void *p_cookie); |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 2867 | |
| 2868 | /** |
| 2869 | * \brief Set client's transport-level identification info. |
| 2870 | * (Server only. DTLS only.) |
| 2871 | * |
| 2872 | * This is usually the IP address (and port), but could be |
| 2873 | * anything identify the client depending on the underlying |
| 2874 | * network stack. Used for HelloVerifyRequest with DTLS. |
| 2875 | * This is *not* used to route the actual packets. |
| 2876 | * |
| 2877 | * \param ssl SSL context |
| 2878 | * \param info Transport-level info identifying the client (eg IP + port) |
| 2879 | * \param ilen Length of info in bytes |
| 2880 | * |
| 2881 | * \note An internal copy is made, so the info buffer can be reused. |
| 2882 | * |
| 2883 | * \return 0 on success, |
| 2884 | * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client, |
Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 2885 | * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory. |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 2886 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2887 | int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl, |
| 2888 | const unsigned char *info, |
| 2889 | size_t ilen); |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 2890 | |
| 2891 | #endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */ |
Manuel Pégourié-Gonnard | 43c0218 | 2014-07-22 17:32:01 +0200 | [diff] [blame] | 2892 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2893 | #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) |
Manuel Pégourié-Gonnard | 2739313 | 2014-09-24 14:41:11 +0200 | [diff] [blame] | 2894 | /** |
| 2895 | * \brief Enable or disable anti-replay protection for DTLS. |
| 2896 | * (DTLS only, no effect on TLS.) |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 2897 | * Default: enabled. |
Manuel Pégourié-Gonnard | 2739313 | 2014-09-24 14:41:11 +0200 | [diff] [blame] | 2898 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 2899 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2900 | * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED. |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 2901 | * |
| 2902 | * \warning Disabling this is a security risk unless the application |
| 2903 | * protocol handles duplicated packets in a safe way. You |
| 2904 | * should not disable this without careful consideration. |
| 2905 | * However, if your application already detects duplicated |
| 2906 | * packets and needs information about them to adjust its |
| 2907 | * transmission strategy, then you'll want to disable this. |
Manuel Pégourié-Gonnard | 2739313 | 2014-09-24 14:41:11 +0200 | [diff] [blame] | 2908 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2909 | void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2910 | #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */ |
Manuel Pégourié-Gonnard | 2739313 | 2014-09-24 14:41:11 +0200 | [diff] [blame] | 2911 | |
Manuel Pégourié-Gonnard | b0643d1 | 2014-10-14 18:30:36 +0200 | [diff] [blame] | 2912 | /** |
| 2913 | * \brief Set a limit on the number of records with a bad MAC |
| 2914 | * before terminating the connection. |
| 2915 | * (DTLS only, no effect on TLS.) |
| 2916 | * Default: 0 (disabled). |
| 2917 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 2918 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | b0643d1 | 2014-10-14 18:30:36 +0200 | [diff] [blame] | 2919 | * \param limit Limit, or 0 to disable. |
| 2920 | * |
| 2921 | * \note If the limit is N, then the connection is terminated when |
| 2922 | * the Nth non-authentic record is seen. |
| 2923 | * |
| 2924 | * \note Records with an invalid header are not counted, only the |
| 2925 | * ones going through the authentication-decryption phase. |
| 2926 | * |
| 2927 | * \note This is a security trade-off related to the fact that it's |
Andrzej Kurek | 5c65c57 | 2022-04-13 14:28:52 -0400 | [diff] [blame] | 2928 | * often relatively easy for an active attacker to inject UDP |
Manuel Pégourié-Gonnard | b0643d1 | 2014-10-14 18:30:36 +0200 | [diff] [blame] | 2929 | * datagrams. On one hand, setting a low limit here makes it |
| 2930 | * easier for such an attacker to forcibly terminated a |
| 2931 | * connection. On the other hand, a high limit or no limit |
| 2932 | * might make us waste resources checking authentication on |
| 2933 | * many bogus packets. |
| 2934 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2935 | void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit); |
Manuel Pégourié-Gonnard | b0643d1 | 2014-10-14 18:30:36 +0200 | [diff] [blame] | 2936 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2937 | #if defined(MBEDTLS_SSL_PROTO_DTLS) |
Hanno Becker | 04da189 | 2018-08-14 13:22:10 +0100 | [diff] [blame] | 2938 | |
| 2939 | /** |
| 2940 | * \brief Allow or disallow packing of multiple handshake records |
| 2941 | * within a single datagram. |
| 2942 | * |
| 2943 | * \param ssl The SSL context to configure. |
| 2944 | * \param allow_packing This determines whether datagram packing may |
| 2945 | * be used or not. A value of \c 0 means that every |
| 2946 | * record will be sent in a separate datagram; a |
| 2947 | * value of \c 1 means that, if space permits, |
| 2948 | * multiple handshake messages (including CCS) belonging to |
| 2949 | * a single flight may be packed within a single datagram. |
| 2950 | * |
| 2951 | * \note This is enabled by default and should only be disabled |
| 2952 | * for test purposes, or if datagram packing causes |
| 2953 | * interoperability issues with peers that don't support it. |
| 2954 | * |
| 2955 | * \note Allowing datagram packing reduces the network load since |
| 2956 | * there's less overhead if multiple messages share the same |
| 2957 | * datagram. Also, it increases the handshake efficiency |
| 2958 | * since messages belonging to a single datagram will not |
| 2959 | * be reordered in transit, and so future message buffering |
| 2960 | * or flight retransmission (if no buffering is used) as |
| 2961 | * means to deal with reordering are needed less frequently. |
| 2962 | * |
Hanno Becker | eb57008 | 2018-08-24 11:28:35 +0100 | [diff] [blame] | 2963 | * \note Application records are not affected by this option and |
Hanno Becker | 04da189 | 2018-08-14 13:22:10 +0100 | [diff] [blame] | 2964 | * are currently always sent in separate datagrams. |
| 2965 | * |
| 2966 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 2967 | void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl, |
| 2968 | unsigned allow_packing); |
Hanno Becker | 04da189 | 2018-08-14 13:22:10 +0100 | [diff] [blame] | 2969 | |
Manuel Pégourié-Gonnard | 905dd24 | 2014-10-01 12:03:55 +0200 | [diff] [blame] | 2970 | /** |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 2971 | * \brief Set retransmit timeout values for the DTLS handshake. |
Manuel Pégourié-Gonnard | 905dd24 | 2014-10-01 12:03:55 +0200 | [diff] [blame] | 2972 | * (DTLS only, no effect on TLS.) |
| 2973 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 2974 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 905dd24 | 2014-10-01 12:03:55 +0200 | [diff] [blame] | 2975 | * \param min Initial timeout value in milliseconds. |
| 2976 | * Default: 1000 (1 second). |
| 2977 | * \param max Maximum timeout value in milliseconds. |
| 2978 | * Default: 60000 (60 seconds). |
| 2979 | * |
| 2980 | * \note Default values are from RFC 6347 section 4.2.4.1. |
| 2981 | * |
Manuel Pégourié-Gonnard | edb1a48 | 2016-01-29 16:05:55 +0100 | [diff] [blame] | 2982 | * \note The 'min' value should typically be slightly above the |
| 2983 | * expected round-trip time to your peer, plus whatever time |
| 2984 | * it takes for the peer to process the message. For example, |
| 2985 | * if your RTT is about 600ms and you peer needs up to 1s to |
| 2986 | * do the cryptographic operations in the handshake, then you |
| 2987 | * should set 'min' slightly above 1600. Lower values of 'min' |
| 2988 | * might cause spurious resends which waste network resources, |
| 2989 | * while larger value of 'min' will increase overall latency |
| 2990 | * on unreliable network links. |
| 2991 | * |
| 2992 | * \note The more unreliable your network connection is, the larger |
| 2993 | * your max / min ratio needs to be in order to achieve |
| 2994 | * reliable handshakes. |
| 2995 | * |
| 2996 | * \note Messages are retransmitted up to log2(ceil(max/min)) times. |
| 2997 | * For example, if min = 1s and max = 5s, the retransmit plan |
| 2998 | * goes: send ... 1s -> resend ... 2s -> resend ... 4s -> |
| 2999 | * resend ... 5s -> give up and return a timeout error. |
Manuel Pégourié-Gonnard | 905dd24 | 2014-10-01 12:03:55 +0200 | [diff] [blame] | 3000 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3001 | void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3002 | #endif /* MBEDTLS_SSL_PROTO_DTLS */ |
Manuel Pégourié-Gonnard | 2739313 | 2014-09-24 14:41:11 +0200 | [diff] [blame] | 3003 | |
Manuel Pégourié-Gonnard | cc3195e | 2015-05-06 14:53:09 +0100 | [diff] [blame] | 3004 | #if defined(MBEDTLS_SSL_SRV_C) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3005 | /** |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3006 | * \brief Set the session cache callbacks (server-side only) |
Manuel Pégourié-Gonnard | 3e94493 | 2014-11-20 18:29:41 +0100 | [diff] [blame] | 3007 | * If not set, no session resuming is done (except if session |
| 3008 | * tickets are enabled too). |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3009 | * |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3010 | * The session cache has the responsibility to check for stale |
| 3011 | * entries based on timeout. See RFC 5246 for recommendations. |
| 3012 | * |
| 3013 | * Warning: session.peer_cert is cleared by the SSL/TLS layer on |
| 3014 | * connection shutdown, so do not cache the pointer! Either set |
| 3015 | * it to NULL or make a full copy of the certificate. |
| 3016 | * |
| 3017 | * The get callback is called once during the initial handshake |
| 3018 | * to enable session resuming. The get function has the |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3019 | * following parameters: (void *parameter, mbedtls_ssl_session *session) |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3020 | * If a valid entry is found, it should fill the master of |
| 3021 | * the session object with the cached values and return 0, |
| 3022 | * return 1 otherwise. Optionally peer_cert can be set as well |
| 3023 | * if it is properly present in cache entry. |
| 3024 | * |
| 3025 | * The set callback is called once during the initial handshake |
| 3026 | * to enable session resuming after the entire handshake has |
| 3027 | * been finished. The set function has the following parameters: |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3028 | * (void *parameter, const mbedtls_ssl_session *session). The function |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3029 | * should create a cache entry for future retrieval based on |
| 3030 | * the data in the session structure and should keep in mind |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3031 | * that the mbedtls_ssl_session object presented (and all its referenced |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3032 | * data) is cleared by the SSL/TLS layer when the connection is |
| 3033 | * terminated. It is recommended to add metadata to determine if |
| 3034 | * an entry is still valid in the future. Return 0 if |
Paul Bakker | 7a2538e | 2012-11-02 10:59:36 +0000 | [diff] [blame] | 3035 | * successfully cached, return 1 otherwise. |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3036 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 3037 | * \param conf SSL configuration |
Tom Cosgrove | 1e21144 | 2022-05-26 11:51:00 +0100 | [diff] [blame] | 3038 | * \param p_cache parameter (context) for both callbacks |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3039 | * \param f_get_cache session get callback |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3040 | * \param f_set_cache session set callback |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3041 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3042 | void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf, |
| 3043 | void *p_cache, |
| 3044 | mbedtls_ssl_cache_get_t *f_get_cache, |
| 3045 | mbedtls_ssl_cache_set_t *f_set_cache); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3046 | #endif /* MBEDTLS_SSL_SRV_C */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3047 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3048 | #if defined(MBEDTLS_SSL_CLI_C) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3049 | /** |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 3050 | * \brief Load a session for session resumption. |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3051 | * |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 3052 | * Sessions loaded through this call will be considered |
| 3053 | * for session resumption in the next handshake. |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 3054 | * |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 3055 | * \note Even if this call succeeds, it is not guaranteed that |
| 3056 | * the next handshake will indeed be shortened through the |
| 3057 | * use of session resumption: The server is always free |
| 3058 | * to reject any attempt for resumption and fall back to |
| 3059 | * a full handshake. |
| 3060 | * |
Hanno Becker | ab4ecfc | 2021-06-17 05:12:16 +0100 | [diff] [blame] | 3061 | * \note This function can handle a variety of mechanisms for session |
| 3062 | * resumption: For TLS 1.2, both session ID-based resumption and |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 3063 | * ticket-based resumption will be considered. For TLS 1.3, |
| 3064 | * once implemented, sessions equate to tickets, and loading |
| 3065 | * one or more sessions via this call will lead to their |
| 3066 | * corresponding tickets being advertised as resumption PSKs |
| 3067 | * by the client. |
| 3068 | * |
| 3069 | * \note Calling this function multiple times will only be useful |
| 3070 | * once TLS 1.3 is supported. For TLS 1.2 connections, this |
| 3071 | * function should be called at most once. |
| 3072 | * |
| 3073 | * \param ssl The SSL context representing the connection which should |
| 3074 | * be attempted to be setup using session resumption. This |
| 3075 | * must be initialized via mbedtls_ssl_init() and bound to |
| 3076 | * an SSL configuration via mbedtls_ssl_setup(), but |
| 3077 | * the handshake must not yet have been started. |
| 3078 | * \param session The session to be considered for session resumption. |
| 3079 | * This must be a session previously exported via |
| 3080 | * mbedtls_ssl_get_session(), and potentially serialized and |
| 3081 | * deserialized through mbedtls_ssl_session_save() and |
| 3082 | * mbedtls_ssl_session_load() in the meantime. |
| 3083 | * |
| 3084 | * \return \c 0 if successful. |
| 3085 | * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session |
| 3086 | * could not be loaded because of an implementation limitation. |
| 3087 | * This error is non-fatal, and has no observable effect on |
| 3088 | * the SSL context or the session that was attempted to be loaded. |
| 3089 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | 06650f6 | 2013-08-02 15:34:52 +0200 | [diff] [blame] | 3090 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3091 | * \sa mbedtls_ssl_get_session() |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 3092 | * \sa mbedtls_ssl_session_load() |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3093 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3094 | int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3095 | #endif /* MBEDTLS_SSL_CLI_C */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3096 | |
| 3097 | /** |
Manuel Pégourié-Gonnard | 686adb4 | 2019-06-03 09:55:16 +0200 | [diff] [blame] | 3098 | * \brief Load serialized session data into a session structure. |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3099 | * On client, this can be used for loading saved sessions |
Tom Cosgrove | 1e21144 | 2022-05-26 11:51:00 +0100 | [diff] [blame] | 3100 | * before resuming them with mbedtls_ssl_set_session(). |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3101 | * On server, this can be used for alternative implementations |
| 3102 | * of session cache or session tickets. |
| 3103 | * |
| 3104 | * \warning If a peer certificate chain is associated with the session, |
Manuel Pégourié-Gonnard | 686adb4 | 2019-06-03 09:55:16 +0200 | [diff] [blame] | 3105 | * the serialized state will only contain the peer's |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3106 | * end-entity certificate and the result of the chain |
| 3107 | * verification (unless verification was disabled), but not |
| 3108 | * the rest of the chain. |
| 3109 | * |
| 3110 | * \see mbedtls_ssl_session_save() |
| 3111 | * \see mbedtls_ssl_set_session() |
| 3112 | * |
| 3113 | * \param session The session structure to be populated. It must have been |
| 3114 | * initialised with mbedtls_ssl_session_init() but not |
| 3115 | * populated yet. |
Manuel Pégourié-Gonnard | 686adb4 | 2019-06-03 09:55:16 +0200 | [diff] [blame] | 3116 | * \param buf The buffer holding the serialized session data. It must be a |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3117 | * readable buffer of at least \p len bytes. |
Manuel Pégourié-Gonnard | 686adb4 | 2019-06-03 09:55:16 +0200 | [diff] [blame] | 3118 | * \param len The size of the serialized data in bytes. |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3119 | * |
| 3120 | * \return \c 0 if successful. |
| 3121 | * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed. |
| 3122 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid. |
Hanno Becker | f9b3303 | 2019-06-03 12:58:39 +0100 | [diff] [blame] | 3123 | * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data |
| 3124 | * was generated in a different version or configuration of |
| 3125 | * Mbed TLS. |
Manuel Pégourié-Gonnard | df9bc21 | 2019-05-27 09:58:07 +0200 | [diff] [blame] | 3126 | * \return Another negative value for other kinds of errors (for |
| 3127 | * example, unsupported features in the embedded certificate). |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3128 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3129 | int mbedtls_ssl_session_load(mbedtls_ssl_session *session, |
| 3130 | const unsigned char *buf, |
| 3131 | size_t len); |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3132 | |
| 3133 | /** |
Manuel Pégourié-Gonnard | 686adb4 | 2019-06-03 09:55:16 +0200 | [diff] [blame] | 3134 | * \brief Save session structure as serialized data in a buffer. |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3135 | * On client, this can be used for saving session data, |
| 3136 | * potentially in non-volatile storage, for resuming later. |
| 3137 | * On server, this can be used for alternative implementations |
| 3138 | * of session cache or session tickets. |
| 3139 | * |
| 3140 | * \see mbedtls_ssl_session_load() |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3141 | * |
| 3142 | * \param session The session structure to be saved. |
| 3143 | * \param buf The buffer to write the serialized data to. It must be a |
Andrzej Kurek | 377eb5f | 2023-05-06 09:57:40 -0400 | [diff] [blame] | 3144 | * writeable buffer of at least \p buf_len bytes, or may be \c |
| 3145 | * NULL if \p buf_len is \c 0. |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3146 | * \param buf_len The number of bytes available for writing in \p buf. |
Manuel Pégourié-Gonnard | 26f982f | 2019-05-21 11:01:32 +0200 | [diff] [blame] | 3147 | * \param olen The size in bytes of the data that has been or would have |
| 3148 | * been written. It must point to a valid \c size_t. |
| 3149 | * |
| 3150 | * \note \p olen is updated to the correct value regardless of |
| 3151 | * whether \p buf_len was large enough. This makes it possible |
| 3152 | * to determine the necessary size by calling this function |
| 3153 | * with \p buf set to \c NULL and \p buf_len to \c 0. |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3154 | * |
| 3155 | * \return \c 0 if successful. |
| 3156 | * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small. |
| 3157 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3158 | int mbedtls_ssl_session_save(const mbedtls_ssl_session *session, |
| 3159 | unsigned char *buf, |
| 3160 | size_t buf_len, |
| 3161 | size_t *olen); |
Manuel Pégourié-Gonnard | 5a6d6ec | 2019-05-15 16:13:59 +0200 | [diff] [blame] | 3162 | |
| 3163 | /** |
Paul Bakker | cf1d73b | 2014-01-14 14:08:13 +0100 | [diff] [blame] | 3164 | * \brief Set the list of allowed ciphersuites and the preference |
| 3165 | * order. First in the list has the highest preference. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3166 | * |
Hanno Becker | e486b2d | 2021-07-23 19:24:30 +0100 | [diff] [blame] | 3167 | * For TLS 1.2, the notion of ciphersuite determines both |
| 3168 | * the key exchange mechanism and the suite of symmetric |
| 3169 | * algorithms to be used during and after the handshake. |
Manuel Pégourié-Gonnard | eecb43c | 2015-05-12 12:56:41 +0200 | [diff] [blame] | 3170 | * |
Hanno Becker | e486b2d | 2021-07-23 19:24:30 +0100 | [diff] [blame] | 3171 | * For TLS 1.3 (in development), the notion of ciphersuite |
Hanno Becker | 674f948 | 2021-08-02 21:21:19 +0100 | [diff] [blame] | 3172 | * only determines the suite of symmetric algorithms to be |
Hanno Becker | e486b2d | 2021-07-23 19:24:30 +0100 | [diff] [blame] | 3173 | * used during and after the handshake, while key exchange |
| 3174 | * mechanisms are configured separately. |
| 3175 | * |
| 3176 | * In Mbed TLS, ciphersuites for both TLS 1.2 and TLS 1.3 |
| 3177 | * are configured via this function. For users of TLS 1.3, |
| 3178 | * there will be separate API for the configuration of key |
| 3179 | * exchange mechanisms. |
| 3180 | * |
| 3181 | * The list of ciphersuites passed to this function may |
| 3182 | * contain a mixture of TLS 1.2 and TLS 1.3 ciphersuite |
| 3183 | * identifiers. This is useful if negotiation of TLS 1.3 |
| 3184 | * should be attempted, but a fallback to TLS 1.2 would |
| 3185 | * be tolerated. |
| 3186 | * |
| 3187 | * \note By default, the server chooses its preferred |
TRodziewicz | 3946f79 | 2021-06-14 12:11:18 +0200 | [diff] [blame] | 3188 | * ciphersuite among those that the client supports. If |
| 3189 | * mbedtls_ssl_conf_preference_order() is called to prefer |
| 3190 | * the client's preferences, the server instead chooses |
| 3191 | * the client's preferred ciphersuite among those that |
| 3192 | * the server supports. |
Paul Bakker | cf1d73b | 2014-01-14 14:08:13 +0100 | [diff] [blame] | 3193 | * |
Hanno Becker | e486b2d | 2021-07-23 19:24:30 +0100 | [diff] [blame] | 3194 | * \warning The ciphersuites array \p ciphersuites is not copied. |
Jerry Yu | cadebe5 | 2021-08-24 10:36:45 +0800 | [diff] [blame] | 3195 | * It must remain valid for the lifetime of the SSL |
Hanno Becker | e486b2d | 2021-07-23 19:24:30 +0100 | [diff] [blame] | 3196 | * configuration \p conf. |
| 3197 | * |
| 3198 | * \param conf The SSL configuration to modify. |
| 3199 | * \param ciphersuites A 0-terminated list of IANA identifiers of supported |
| 3200 | * ciphersuites, accessible through \c MBEDTLS_TLS_XXX |
| 3201 | * and \c MBEDTLS_TLS1_3_XXX macros defined in |
| 3202 | * ssl_ciphersuites.h. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3203 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3204 | void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf, |
| 3205 | const int *ciphersuites); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3206 | |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 3207 | #if defined(MBEDTLS_SSL_PROTO_TLS1_3) |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3208 | /** |
| 3209 | * \brief Set the supported key exchange modes for TLS 1.3 connections. |
| 3210 | * |
| 3211 | * In contrast to TLS 1.2, the ciphersuite concept in TLS 1.3 does not |
| 3212 | * include the choice of key exchange mechanism. It is therefore not |
| 3213 | * covered by the API mbedtls_ssl_conf_ciphersuites(). See the |
| 3214 | * documentation of mbedtls_ssl_conf_ciphersuites() for more |
| 3215 | * information on the ciphersuite concept in TLS 1.2 and TLS 1.3. |
| 3216 | * |
| 3217 | * The present function is specific to TLS 1.3 and allows users to |
| 3218 | * configure the set of supported key exchange mechanisms in TLS 1.3. |
| 3219 | * |
| 3220 | * \param conf The SSL configuration the change should apply to. |
| 3221 | * \param kex_modes A bitwise combination of one or more of the following: |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3222 | * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3223 | * This flag enables pure-PSK key exchanges. |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3224 | * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3225 | * This flag enables combined PSK-ephemeral key exchanges. |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3226 | * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3227 | * This flag enables pure-ephemeral key exchanges. |
| 3228 | * For convenience, the following pre-defined macros are |
| 3229 | * available for combinations of the above: |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3230 | * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3231 | * Includes all of pure-PSK, PSK-ephemeral and pure-ephemeral. |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3232 | * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3233 | * Includes both pure-PSK and combined PSK-ephemeral |
| 3234 | * key exchanges, but excludes pure-ephemeral key exchanges. |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3235 | * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3236 | * Includes both pure-ephemeral and combined PSK-ephemeral |
| 3237 | * key exchanges. |
| 3238 | * |
| 3239 | * \note If a PSK-based key exchange mode shall be supported, applications |
| 3240 | * must also use the APIs mbedtls_ssl_conf_psk() or |
| 3241 | * mbedtls_ssl_conf_psk_cb() or mbedtls_ssl_conf_psk_opaque() |
| 3242 | * to configure the PSKs to be used. |
| 3243 | * |
Hanno Becker | 5d045a8 | 2021-08-02 21:21:30 +0100 | [diff] [blame] | 3244 | * \note If a pure-ephemeral key exchange mode shall be supported, |
Hanno Becker | 71f1ed6 | 2021-07-24 06:01:47 +0100 | [diff] [blame] | 3245 | * server-side applications must also provide a certificate via |
| 3246 | * mbedtls_ssl_conf_own_cert(). |
| 3247 | * |
| 3248 | */ |
| 3249 | |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3250 | void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf, |
| 3251 | const int kex_modes); |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 3252 | #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3253 | |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 3254 | #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) |
Hanno Becker | 7fefd83 | 2019-05-14 11:44:35 +0100 | [diff] [blame] | 3255 | #define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0 |
| 3256 | #define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1 |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 3257 | /** |
Hanno Becker | 1125952 | 2019-05-23 16:55:50 +0100 | [diff] [blame] | 3258 | * \brief Specify the length of Connection IDs for incoming |
| 3259 | * encrypted DTLS records, as well as the behaviour |
| 3260 | * on unexpected CIDs. |
Hanno Becker | 8367ccc | 2019-05-14 11:30:10 +0100 | [diff] [blame] | 3261 | * |
| 3262 | * By default, the CID length is set to \c 0, |
| 3263 | * and unexpected CIDs are silently ignored. |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 3264 | * |
| 3265 | * \param conf The SSL configuration to modify. |
| 3266 | * \param len The length in Bytes of the CID fields in encrypted |
| 3267 | * DTLS records using the CID mechanism. This must |
| 3268 | * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX. |
Hanno Becker | 62e5afa | 2019-05-20 10:19:56 +0100 | [diff] [blame] | 3269 | * \param ignore_other_cids This determines the stack's behaviour when |
Hanno Becker | 8367ccc | 2019-05-14 11:30:10 +0100 | [diff] [blame] | 3270 | * receiving a record with an unexpected CID. |
| 3271 | * Possible values are: |
| 3272 | * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE |
| 3273 | * In this case, the record is silently ignored. |
| 3274 | * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL |
| 3275 | * In this case, the stack fails with the specific |
| 3276 | * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID. |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 3277 | * |
Hanno Becker | ddf775a | 2019-05-13 15:26:11 +0100 | [diff] [blame] | 3278 | * \note The CID specification allows implementations to either |
| 3279 | * use a common length for all incoming connection IDs or |
| 3280 | * allow variable-length incoming IDs. Mbed TLS currently |
| 3281 | * requires a common length for all connections sharing the |
| 3282 | * same SSL configuration; this allows simpler parsing of |
| 3283 | * record headers. |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 3284 | * |
| 3285 | * \return \c 0 on success. |
Andrzej Kurek | 3bedb5b | 2022-02-17 14:39:00 -0500 | [diff] [blame] | 3286 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p len |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 3287 | * is too large. |
| 3288 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3289 | int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len, |
| 3290 | int ignore_other_cids); |
Hanno Becker | a0e20d0 | 2019-05-15 14:03:01 +0100 | [diff] [blame] | 3291 | #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */ |
Hanno Becker | ad4a137 | 2019-05-03 13:06:44 +0100 | [diff] [blame] | 3292 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3293 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Paul Bakker | 8f4ddae | 2013-04-15 15:09:54 +0200 | [diff] [blame] | 3294 | /** |
Manuel Pégourié-Gonnard | 6e3ee3a | 2015-06-17 10:58:20 +0200 | [diff] [blame] | 3295 | * \brief Set the X.509 security profile used for verification |
| 3296 | * |
Manuel Pégourié-Gonnard | 65eefc8 | 2015-10-23 14:08:48 +0200 | [diff] [blame] | 3297 | * \note The restrictions are enforced for all certificates in the |
| 3298 | * chain. However, signatures in the handshake are not covered |
| 3299 | * by this setting but by \b mbedtls_ssl_conf_sig_hashes(). |
| 3300 | * |
Manuel Pégourié-Gonnard | 6e3ee3a | 2015-06-17 10:58:20 +0200 | [diff] [blame] | 3301 | * \param conf SSL configuration |
| 3302 | * \param profile Profile to use |
| 3303 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3304 | void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf, |
| 3305 | const mbedtls_x509_crt_profile *profile); |
Manuel Pégourié-Gonnard | 6e3ee3a | 2015-06-17 10:58:20 +0200 | [diff] [blame] | 3306 | |
| 3307 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3308 | * \brief Set the data required to verify peer certificate |
| 3309 | * |
Manuel Pégourié-Gonnard | 7766a2c | 2017-08-21 10:57:57 +0200 | [diff] [blame] | 3310 | * \note See \c mbedtls_x509_crt_verify() for notes regarding the |
Manuel Pégourié-Gonnard | a4a206e | 2017-06-21 09:35:44 +0200 | [diff] [blame] | 3311 | * parameters ca_chain (maps to trust_ca for that function) |
| 3312 | * and ca_crl. |
| 3313 | * |
Manuel Pégourié-Gonnard | bc2b771 | 2015-05-06 11:14:19 +0100 | [diff] [blame] | 3314 | * \param conf SSL configuration |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 3315 | * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs) |
Paul Bakker | 40ea7de | 2009-05-03 10:18:48 +0000 | [diff] [blame] | 3316 | * \param ca_crl trusted CA CRLs |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3317 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3318 | void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf, |
Manuel Pégourié-Gonnard | bc2b771 | 2015-05-06 11:14:19 +0100 | [diff] [blame] | 3319 | mbedtls_x509_crt *ca_chain, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3320 | mbedtls_x509_crl *ca_crl); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3321 | |
Glenn Strauss | 999ef70 | 2022-03-11 01:37:23 -0500 | [diff] [blame] | 3322 | #if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) |
| 3323 | /** |
| 3324 | * \brief Set DN hints sent to client in CertificateRequest message |
| 3325 | * |
| 3326 | * \note If not set, subject distinguished names (DNs) are taken |
| 3327 | * from \c mbedtls_ssl_conf_ca_chain() |
| 3328 | * or \c mbedtls_ssl_set_hs_ca_chain()) |
| 3329 | * |
| 3330 | * \param conf SSL configuration |
| 3331 | * \param crt crt chain whose subject DNs are issuer DNs of client certs |
| 3332 | * from which the client should select client peer certificate. |
| 3333 | */ |
| 3334 | static inline |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3335 | void mbedtls_ssl_conf_dn_hints(mbedtls_ssl_config *conf, |
| 3336 | const mbedtls_x509_crt *crt) |
Glenn Strauss | 999ef70 | 2022-03-11 01:37:23 -0500 | [diff] [blame] | 3337 | { |
| 3338 | conf->MBEDTLS_PRIVATE(dn_hints) = crt; |
| 3339 | } |
| 3340 | #endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */ |
| 3341 | |
Hanno Becker | 8bf74f3 | 2019-03-27 11:01:30 +0000 | [diff] [blame] | 3342 | #if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK) |
| 3343 | /** |
| 3344 | * \brief Set the trusted certificate callback. |
| 3345 | * |
| 3346 | * This API allows to register the set of trusted certificates |
| 3347 | * through a callback, instead of a linked list as configured |
| 3348 | * by mbedtls_ssl_conf_ca_chain(). |
| 3349 | * |
| 3350 | * This is useful for example in contexts where a large number |
| 3351 | * of CAs are used, and the inefficiency of maintaining them |
| 3352 | * in a linked list cannot be tolerated. It is also useful when |
| 3353 | * the set of trusted CAs needs to be modified frequently. |
| 3354 | * |
| 3355 | * See the documentation of `mbedtls_x509_crt_ca_cb_t` for |
| 3356 | * more information. |
| 3357 | * |
| 3358 | * \param conf The SSL configuration to register the callback with. |
| 3359 | * \param f_ca_cb The trusted certificate callback to use when verifying |
| 3360 | * certificate chains. |
| 3361 | * \param p_ca_cb The context to be passed to \p f_ca_cb (for example, |
| 3362 | * a reference to a trusted CA database). |
| 3363 | * |
| 3364 | * \note This API is incompatible with mbedtls_ssl_conf_ca_chain(): |
| 3365 | * Any call to this function overwrites the values set through |
| 3366 | * earlier calls to mbedtls_ssl_conf_ca_chain() or |
| 3367 | * mbedtls_ssl_conf_ca_cb(). |
| 3368 | * |
| 3369 | * \note This API is incompatible with CA indication in |
| 3370 | * CertificateRequest messages: A server-side SSL context which |
| 3371 | * is bound to an SSL configuration that uses a CA callback |
| 3372 | * configured via mbedtls_ssl_conf_ca_cb(), and which requires |
| 3373 | * client authentication, will send an empty CA list in the |
| 3374 | * corresponding CertificateRequest message. |
| 3375 | * |
| 3376 | * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain(): |
| 3377 | * If an SSL context is bound to an SSL configuration which uses |
| 3378 | * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then |
| 3379 | * calls to mbedtls_ssl_set_hs_ca_chain() have no effect. |
| 3380 | * |
| 3381 | * \note The use of this API disables the use of restartable ECC |
| 3382 | * during X.509 CRT signature verification (but doesn't affect |
| 3383 | * other uses). |
| 3384 | * |
| 3385 | * \warning This API is incompatible with the use of CRLs. Any call to |
| 3386 | * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through |
| 3387 | * earlier calls to mbedtls_ssl_conf_ca_chain(). |
| 3388 | * |
| 3389 | * \warning In multi-threaded environments, the callback \p f_ca_cb |
| 3390 | * must be thread-safe, and it is the user's responsibility |
Janos Follath | d7ecbd6 | 2019-04-05 14:52:17 +0100 | [diff] [blame] | 3391 | * to guarantee this (for example through a mutex |
Hanno Becker | 8bf74f3 | 2019-03-27 11:01:30 +0000 | [diff] [blame] | 3392 | * contained in the callback context pointed to by \p p_ca_cb). |
| 3393 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3394 | void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf, |
| 3395 | mbedtls_x509_crt_ca_cb_t f_ca_cb, |
| 3396 | void *p_ca_cb); |
Hanno Becker | 8bf74f3 | 2019-03-27 11:01:30 +0000 | [diff] [blame] | 3397 | #endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */ |
| 3398 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3399 | /** |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 3400 | * \brief Set own certificate chain and private key |
| 3401 | * |
Manuel Pégourié-Gonnard | 834ea85 | 2013-09-23 14:46:13 +0200 | [diff] [blame] | 3402 | * \note own_cert should contain in order from the bottom up your |
| 3403 | * certificate chain. The top certificate (self-signed) |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 3404 | * can be omitted. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3405 | * |
Manuel Pégourié-Gonnard | 22bfa4b | 2015-05-11 08:46:37 +0200 | [diff] [blame] | 3406 | * \note On server, this function can be called multiple times to |
| 3407 | * provision more than one cert/key pair (eg one ECDSA, one |
| 3408 | * RSA with SHA-256, one RSA with SHA-1). An adequate |
| 3409 | * certificate will be selected according to the client's |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 3410 | * advertised capabilities. In case multiple certificates are |
Manuel Pégourié-Gonnard | 22bfa4b | 2015-05-11 08:46:37 +0200 | [diff] [blame] | 3411 | * adequate, preference is given to the one set by the first |
| 3412 | * call to this function, then second, etc. |
| 3413 | * |
Manuel Pégourié-Gonnard | d1b7f2b | 2016-02-24 14:13:22 +0000 | [diff] [blame] | 3414 | * \note On client, only the first call has any effect. That is, |
| 3415 | * only one client certificate can be provisioned. The |
bootstrap-prime | 6dbbf44 | 2022-05-17 19:30:44 -0400 | [diff] [blame] | 3416 | * server's preferences in its CertificateRequest message will |
Manuel Pégourié-Gonnard | d1b7f2b | 2016-02-24 14:13:22 +0000 | [diff] [blame] | 3417 | * be ignored and our only cert will be sent regardless of |
| 3418 | * whether it matches those preferences - the server can then |
| 3419 | * decide what it wants to do with it. |
Manuel Pégourié-Gonnard | 834ea85 | 2013-09-23 14:46:13 +0200 | [diff] [blame] | 3420 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 3421 | * \note The provided \p pk_key needs to match the public key in the |
| 3422 | * first certificate in \p own_cert, or all handshakes using |
| 3423 | * that certificate will fail. It is your responsibility |
| 3424 | * to ensure that; this function will not perform any check. |
| 3425 | * You may use mbedtls_pk_check_pair() in order to perform |
| 3426 | * this check yourself, but be aware that this function can |
| 3427 | * be computationally expensive on some key types. |
| 3428 | * |
Manuel Pégourié-Gonnard | 17a40cd | 2015-05-10 23:17:17 +0200 | [diff] [blame] | 3429 | * \param conf SSL configuration |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 3430 | * \param own_cert own public certificate chain |
Manuel Pégourié-Gonnard | ac75523 | 2013-08-19 14:10:16 +0200 | [diff] [blame] | 3431 | * \param pk_key own private key |
Manuel Pégourié-Gonnard | 834ea85 | 2013-09-23 14:46:13 +0200 | [diff] [blame] | 3432 | * |
Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 3433 | * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3434 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3435 | int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf, |
Manuel Pégourié-Gonnard | 8f618a8 | 2015-05-10 21:13:36 +0200 | [diff] [blame] | 3436 | mbedtls_x509_crt *own_cert, |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3437 | mbedtls_pk_context *pk_key); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3438 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 3439 | |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 3440 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 3441 | /** |
Hanno Becker | 196739b | 2021-05-28 05:25:46 +0100 | [diff] [blame] | 3442 | * \brief Configure pre-shared keys (PSKs) and their |
Hanno Becker | 946c925 | 2021-04-19 21:41:47 +0100 | [diff] [blame] | 3443 | * identities to be used in PSK-based ciphersuites. |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3444 | * |
Hanno Becker | 196739b | 2021-05-28 05:25:46 +0100 | [diff] [blame] | 3445 | * Only one PSK can be registered, through either |
| 3446 | * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque(). |
| 3447 | * If you attempt to register more than one PSK, this function |
| 3448 | * fails, though this may change in future versions, which |
| 3449 | * may add support for multiple PSKs. |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3450 | * |
| 3451 | * \note This is mainly useful for clients. Servers will usually |
Manuel Pégourié-Gonnard | 6729e79 | 2015-05-11 09:50:24 +0200 | [diff] [blame] | 3452 | * want to use \c mbedtls_ssl_conf_psk_cb() instead. |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 3453 | * |
Guilhem Bryant | e40a2f7 | 2020-03-25 16:57:00 +0000 | [diff] [blame] | 3454 | * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback |
| 3455 | * takes precedence over a PSK configured by this function. |
| 3456 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3457 | * \param conf The SSL configuration to register the PSK with. |
| 3458 | * \param psk The pointer to the pre-shared key to use. |
| 3459 | * \param psk_len The length of the pre-shared key in bytes. |
| 3460 | * \param psk_identity The pointer to the pre-shared key identity. |
| 3461 | * \param psk_identity_len The length of the pre-shared key identity |
| 3462 | * in bytes. |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3463 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3464 | * \note The PSK and its identity are copied internally and |
| 3465 | * hence need not be preserved by the caller for the lifetime |
| 3466 | * of the SSL configuration. |
| 3467 | * |
| 3468 | * \return \c 0 if successful. |
Hanno Becker | 946c925 | 2021-04-19 21:41:47 +0100 | [diff] [blame] | 3469 | * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs |
Hanno Becker | 196739b | 2021-05-28 05:25:46 +0100 | [diff] [blame] | 3470 | * can be configured. In this case, the old PSK(s) remain intact. |
Hanno Becker | 946c925 | 2021-04-19 21:41:47 +0100 | [diff] [blame] | 3471 | * \return Another negative error code on other kinds of failure. |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 3472 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3473 | int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf, |
| 3474 | const unsigned char *psk, size_t psk_len, |
| 3475 | const unsigned char *psk_identity, size_t psk_identity_len); |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3476 | |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3477 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 3478 | /** |
Hanno Becker | 946c925 | 2021-04-19 21:41:47 +0100 | [diff] [blame] | 3479 | * \brief Configure one or more opaque pre-shared keys (PSKs) and |
| 3480 | * their identities to be used in PSK-based ciphersuites. |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3481 | * |
Hanno Becker | 196739b | 2021-05-28 05:25:46 +0100 | [diff] [blame] | 3482 | * Only one PSK can be registered, through either |
| 3483 | * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque(). |
| 3484 | * If you attempt to register more than one PSK, this function |
| 3485 | * fails, though this may change in future versions, which |
| 3486 | * may add support for multiple PSKs. |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3487 | * |
| 3488 | * \note This is mainly useful for clients. Servers will usually |
| 3489 | * want to use \c mbedtls_ssl_conf_psk_cb() instead. |
| 3490 | * |
Guilhem Bryant | e40a2f7 | 2020-03-25 16:57:00 +0000 | [diff] [blame] | 3491 | * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in |
| 3492 | * the PSK callback takes precedence over an opaque PSK |
| 3493 | * configured by this function. |
| 3494 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3495 | * \param conf The SSL configuration to register the PSK with. |
| 3496 | * \param psk The identifier of the key slot holding the PSK. |
| 3497 | * Until \p conf is destroyed or this function is successfully |
Hanno Becker | 463194d | 2018-11-05 12:44:15 +0000 | [diff] [blame] | 3498 | * called again, the key slot \p psk must be populated with a |
Andrzej Kurek | 7deba18 | 2019-01-22 06:29:45 -0500 | [diff] [blame] | 3499 | * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy |
Hanno Becker | 463194d | 2018-11-05 12:44:15 +0000 | [diff] [blame] | 3500 | * allows its use for the key derivation algorithm applied |
| 3501 | * in the handshake. |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3502 | * \param psk_identity The pointer to the pre-shared key identity. |
| 3503 | * \param psk_identity_len The length of the pre-shared key identity |
| 3504 | * in bytes. |
| 3505 | * |
| 3506 | * \note The PSK identity hint is copied internally and hence need |
| 3507 | * not be preserved by the caller for the lifetime of the |
| 3508 | * SSL configuration. |
| 3509 | * |
| 3510 | * \return \c 0 if successful. |
Hanno Becker | 946c925 | 2021-04-19 21:41:47 +0100 | [diff] [blame] | 3511 | * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs |
Hanno Becker | 196739b | 2021-05-28 05:25:46 +0100 | [diff] [blame] | 3512 | * can be configured. In this case, the old PSK(s) remain intact. |
Hanno Becker | 946c925 | 2021-04-19 21:41:47 +0100 | [diff] [blame] | 3513 | * \return Another negative error code on other kinds of failure. |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3514 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3515 | int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf, |
| 3516 | mbedtls_svc_key_id_t psk, |
| 3517 | const unsigned char *psk_identity, |
| 3518 | size_t psk_identity_len); |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3519 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3520 | |
| 3521 | /** |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3522 | * \brief Set the pre-shared Key (PSK) for the current handshake. |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3523 | * |
| 3524 | * \note This should only be called inside the PSK callback, |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3525 | * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb(). |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3526 | * |
Guilhem Bryant | e40a2f7 | 2020-03-25 16:57:00 +0000 | [diff] [blame] | 3527 | * \note A PSK set by this function takes precedence over a PSK |
| 3528 | * configured by \c mbedtls_ssl_conf_psk(). |
| 3529 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3530 | * \param ssl The SSL context to configure a PSK for. |
| 3531 | * \param psk The pointer to the pre-shared key. |
| 3532 | * \param psk_len The length of the pre-shared key in bytes. |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3533 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3534 | * \return \c 0 if successful. |
| 3535 | * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure. |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3536 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3537 | int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl, |
| 3538 | const unsigned char *psk, size_t psk_len); |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3539 | |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3540 | #if defined(MBEDTLS_USE_PSA_CRYPTO) |
| 3541 | /** |
| 3542 | * \brief Set an opaque pre-shared Key (PSK) for the current handshake. |
| 3543 | * |
| 3544 | * \note This should only be called inside the PSK callback, |
| 3545 | * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb(). |
| 3546 | * |
Guilhem Bryant | e40a2f7 | 2020-03-25 16:57:00 +0000 | [diff] [blame] | 3547 | * \note An opaque PSK set by this function takes precedence over an |
| 3548 | * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque(). |
| 3549 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3550 | * \param ssl The SSL context to configure a PSK for. |
| 3551 | * \param psk The identifier of the key slot holding the PSK. |
| 3552 | * For the duration of the current handshake, the key slot |
| 3553 | * must be populated with a key of type |
Andrzej Kurek | 7deba18 | 2019-01-22 06:29:45 -0500 | [diff] [blame] | 3554 | * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3555 | * use for the key derivation algorithm |
| 3556 | * applied in the handshake. |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3557 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3558 | * \return \c 0 if successful. |
| 3559 | * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure. |
| 3560 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3561 | int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl, |
| 3562 | mbedtls_svc_key_id_t psk); |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3563 | #endif /* MBEDTLS_USE_PSA_CRYPTO */ |
| 3564 | |
Jerry Yu | 8897c07 | 2022-08-12 13:56:53 +0800 | [diff] [blame] | 3565 | #if defined(MBEDTLS_SSL_SRV_C) |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3566 | /** |
| 3567 | * \brief Set the PSK callback (server-side only). |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3568 | * |
| 3569 | * If set, the PSK callback is called for each |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3570 | * handshake where a PSK-based ciphersuite was negotiated. |
Manuel Pégourié-Gonnard | a612b44 | 2014-02-25 13:08:08 +0100 | [diff] [blame] | 3571 | * The caller provides the identity received and wants to |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3572 | * receive the actual PSK data and length. |
| 3573 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3574 | * The callback has the following parameters: |
| 3575 | * - \c void*: The opaque pointer \p p_psk. |
| 3576 | * - \c mbedtls_ssl_context*: The SSL context to which |
| 3577 | * the operation applies. |
| 3578 | * - \c const unsigned char*: The PSK identity |
| 3579 | * selected by the client. |
| 3580 | * - \c size_t: The length of the PSK identity |
| 3581 | * selected by the client. |
| 3582 | * |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3583 | * If a valid PSK identity is found, the callback should use |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3584 | * \c mbedtls_ssl_set_hs_psk() or |
| 3585 | * \c mbedtls_ssl_set_hs_psk_opaque() |
| 3586 | * on the SSL context to set the correct PSK and return \c 0. |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3587 | * Any other return value will result in a denied PSK identity. |
| 3588 | * |
Guilhem Bryant | e40a2f7 | 2020-03-25 16:57:00 +0000 | [diff] [blame] | 3589 | * \note A dynamic PSK (i.e. set by the PSK callback) takes |
| 3590 | * precedence over a static PSK (i.e. set by |
| 3591 | * \c mbedtls_ssl_conf_psk() or |
| 3592 | * \c mbedtls_ssl_conf_psk_opaque()). |
| 3593 | * This means that if you set a PSK callback using this |
| 3594 | * function, you don't need to set a PSK using |
| 3595 | * \c mbedtls_ssl_conf_psk() or |
| 3596 | * \c mbedtls_ssl_conf_psk_opaque()). |
Manuel Pégourié-Gonnard | 4b68296 | 2015-05-07 15:59:54 +0100 | [diff] [blame] | 3597 | * |
Hanno Becker | 0228304 | 2018-10-22 15:28:02 +0100 | [diff] [blame] | 3598 | * \param conf The SSL configuration to register the callback with. |
| 3599 | * \param f_psk The callback for selecting and setting the PSK based |
| 3600 | * in the PSK identity chosen by the client. |
| 3601 | * \param p_psk A pointer to an opaque structure to be passed to |
| 3602 | * the callback, for example a PSK store. |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3603 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3604 | void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf, |
| 3605 | int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, |
| 3606 | size_t), |
| 3607 | void *p_psk); |
Jerry Yu | 8897c07 | 2022-08-12 13:56:53 +0800 | [diff] [blame] | 3608 | #endif /* MBEDTLS_SSL_SRV_C */ |
Ronald Cron | 73fe8df | 2022-10-05 14:31:43 +0200 | [diff] [blame] | 3609 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */ |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 3610 | |
Manuel Pégourié-Gonnard | 1028b74 | 2015-05-06 17:33:07 +0100 | [diff] [blame] | 3611 | #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C) |
Hanno Becker | a90658f | 2017-10-04 15:29:08 +0100 | [diff] [blame] | 3612 | /** |
| 3613 | * \brief Set the Diffie-Hellman public P and G values |
| 3614 | * from big-endian binary presentations. |
| 3615 | * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN) |
| 3616 | * |
| 3617 | * \param conf SSL configuration |
| 3618 | * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form |
| 3619 | * \param P_len Length of DHM modulus |
| 3620 | * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form |
| 3621 | * \param G_len Length of DHM generator |
| 3622 | * |
| 3623 | * \return 0 if successful |
| 3624 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3625 | int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf, |
| 3626 | const unsigned char *dhm_P, size_t P_len, |
| 3627 | const unsigned char *dhm_G, size_t G_len); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3628 | |
| 3629 | /** |
Paul Bakker | 1b57b06 | 2011-01-06 15:48:19 +0000 | [diff] [blame] | 3630 | * \brief Set the Diffie-Hellman public P and G values, |
| 3631 | * read from existing context (server-side only) |
| 3632 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 3633 | * \param conf SSL configuration |
Paul Bakker | 1b57b06 | 2011-01-06 15:48:19 +0000 | [diff] [blame] | 3634 | * \param dhm_ctx Diffie-Hellman-Merkle context |
| 3635 | * |
| 3636 | * \return 0 if successful |
| 3637 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3638 | int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx); |
Manuel Pégourié-Gonnard | cf141ca | 2015-05-20 10:35:51 +0200 | [diff] [blame] | 3639 | #endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */ |
Paul Bakker | 1b57b06 | 2011-01-06 15:48:19 +0000 | [diff] [blame] | 3640 | |
Manuel Pégourié-Gonnard | bd990d6 | 2015-06-11 14:49:42 +0200 | [diff] [blame] | 3641 | #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C) |
| 3642 | /** |
| 3643 | * \brief Set the minimum length for Diffie-Hellman parameters. |
| 3644 | * (Client-side only.) |
| 3645 | * (Default: 1024 bits.) |
| 3646 | * |
| 3647 | * \param conf SSL configuration |
| 3648 | * \param bitlen Minimum bit length of the DHM prime |
| 3649 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3650 | void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf, |
| 3651 | unsigned int bitlen); |
Manuel Pégourié-Gonnard | bd990d6 | 2015-06-11 14:49:42 +0200 | [diff] [blame] | 3652 | #endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */ |
| 3653 | |
Manuel Pégourié-Gonnard | f07ce3b | 2023-09-22 11:53:41 +0200 | [diff] [blame] | 3654 | #if defined(MBEDTLS_ECP_C) |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 3655 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
Gergely Budai | 987bfb5 | 2014-01-19 21:48:42 +0100 | [diff] [blame] | 3656 | /** |
Manuel Pégourié-Gonnard | cd49f76 | 2014-02-04 15:14:13 +0100 | [diff] [blame] | 3657 | * \brief Set the allowed curves in order of preference. |
Gergely Budai | 987bfb5 | 2014-01-19 21:48:42 +0100 | [diff] [blame] | 3658 | * |
Manuel Pégourié-Gonnard | cd49f76 | 2014-02-04 15:14:13 +0100 | [diff] [blame] | 3659 | * On server: this only affects selection of the ECDHE curve; |
| 3660 | * the curves used for ECDH and ECDSA are determined by the |
| 3661 | * list of available certificates instead. |
| 3662 | * |
| 3663 | * On client: this affects the list of curves offered for any |
Manuel Pégourié-Gonnard | ab24010 | 2014-02-04 16:18:07 +0100 | [diff] [blame] | 3664 | * use. The server can override our preference order. |
| 3665 | * |
Manuel Pégourié-Gonnard | 65eefc8 | 2015-10-23 14:08:48 +0200 | [diff] [blame] | 3666 | * Both sides: limits the set of curves accepted for use in |
| 3667 | * ECDHE and in the peer's end-entity certificate. |
Manuel Pégourié-Gonnard | 27716cc | 2015-06-17 11:49:39 +0200 | [diff] [blame] | 3668 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 3669 | * \deprecated Superseded by mbedtls_ssl_conf_groups(). |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 3670 | * |
Manuel Pégourié-Gonnard | 65eefc8 | 2015-10-23 14:08:48 +0200 | [diff] [blame] | 3671 | * \note This has no influence on which curves are allowed inside the |
Manuel Pégourié-Gonnard | 27716cc | 2015-06-17 11:49:39 +0200 | [diff] [blame] | 3672 | * certificate chains, see \c mbedtls_ssl_conf_cert_profile() |
Manuel Pégourié-Gonnard | 65eefc8 | 2015-10-23 14:08:48 +0200 | [diff] [blame] | 3673 | * for that. For the end-entity certificate however, the key |
| 3674 | * will be accepted only if it is allowed both by this list |
| 3675 | * and by the cert profile. |
Gergely Budai | 987bfb5 | 2014-01-19 21:48:42 +0100 | [diff] [blame] | 3676 | * |
Manuel Pégourié-Gonnard | 36a8b57 | 2015-06-17 12:43:26 +0200 | [diff] [blame] | 3677 | * \note This list should be ordered by decreasing preference |
| 3678 | * (preferred curve first). |
| 3679 | * |
Gilles Peskine | ae270bf | 2021-06-02 00:05:29 +0200 | [diff] [blame] | 3680 | * \note The default list is the same set of curves that |
| 3681 | * #mbedtls_x509_crt_profile_default allows, plus |
| 3682 | * ECDHE-only curves selected according to the same criteria. |
Gilles Peskine | b1940a7 | 2021-06-02 15:18:12 +0200 | [diff] [blame] | 3683 | * The order favors curves with the lowest resource usage. |
Gilles Peskine | ae270bf | 2021-06-02 00:05:29 +0200 | [diff] [blame] | 3684 | * |
Gilles Peskine | a03fb29 | 2021-06-17 23:17:05 +0200 | [diff] [blame] | 3685 | * \note New minor versions of Mbed TLS may extend this list, |
| 3686 | * for example if new curves are added to the library. |
| 3687 | * New minor versions of Mbed TLS will not remove items |
| 3688 | * from this list unless serious security concerns require it. |
| 3689 | * New minor versions of Mbed TLS may change the order in |
| 3690 | * keeping with the general principle of favoring the lowest |
| 3691 | * resource usage. |
| 3692 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 3693 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | cd49f76 | 2014-02-04 15:14:13 +0100 | [diff] [blame] | 3694 | * \param curves Ordered list of allowed curves, |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3695 | * terminated by MBEDTLS_ECP_DP_NONE. |
Gergely Budai | 987bfb5 | 2014-01-19 21:48:42 +0100 | [diff] [blame] | 3696 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3697 | void MBEDTLS_DEPRECATED mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf, |
| 3698 | const mbedtls_ecp_group_id *curves); |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 3699 | #endif /* MBEDTLS_DEPRECATED_REMOVED */ |
Manuel Pégourié-Gonnard | f07ce3b | 2023-09-22 11:53:41 +0200 | [diff] [blame] | 3700 | #endif /* MBEDTLS_ECP_C */ |
Gergely Budai | 987bfb5 | 2014-01-19 21:48:42 +0100 | [diff] [blame] | 3701 | |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 3702 | /** |
| 3703 | * \brief Set the allowed groups in order of preference. |
| 3704 | * |
| 3705 | * On server: This only affects the choice of key agreement mechanism |
| 3706 | * |
| 3707 | * On client: this affects the list of groups offered for any |
| 3708 | * use. The server can override our preference order. |
| 3709 | * |
| 3710 | * Both sides: limits the set of groups accepted for use in |
| 3711 | * key sharing. |
| 3712 | * |
| 3713 | * \note This function replaces the deprecated mbedtls_ssl_conf_curves(), |
| 3714 | * which only allows ECP curves to be configured. |
| 3715 | * |
| 3716 | * \note The most recent invocation of either mbedtls_ssl_conf_curves() |
| 3717 | * or mbedtls_ssl_conf_groups() nullifies all previous invocations |
| 3718 | * of both. |
| 3719 | * |
| 3720 | * \note This list should be ordered by decreasing preference |
| 3721 | * (preferred group first). |
| 3722 | * |
| 3723 | * \note When this function is not called, a default list is used, |
| 3724 | * consisting of all supported curves at 255 bits and above, |
| 3725 | * and all supported finite fields at 2048 bits and above. |
| 3726 | * The order favors groups with the lowest resource usage. |
| 3727 | * |
| 3728 | * \note New minor versions of Mbed TLS will not remove items |
| 3729 | * from the default list unless serious security concerns require it. |
| 3730 | * New minor versions of Mbed TLS may change the order in |
| 3731 | * keeping with the general principle of favoring the lowest |
| 3732 | * resource usage. |
| 3733 | * |
| 3734 | * \param conf SSL configuration |
| 3735 | * \param groups List of allowed groups ordered by preference, terminated by 0. |
| 3736 | * Must contain valid IANA NamedGroup IDs (provided via either an integer |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3737 | * or using MBEDTLS_TLS1_3_NAMED_GROUP_XXX macros). |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 3738 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3739 | void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf, |
| 3740 | const uint16_t *groups); |
Brett Warren | e0edc84 | 2021-08-17 09:53:13 +0100 | [diff] [blame] | 3741 | |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 3742 | #if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) |
Jerry Yu | 7ddc38c | 2022-01-19 11:08:05 +0800 | [diff] [blame] | 3743 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2) |
Manuel Pégourié-Gonnard | 36a8b57 | 2015-06-17 12:43:26 +0200 | [diff] [blame] | 3744 | /** |
| 3745 | * \brief Set the allowed hashes for signatures during the handshake. |
Manuel Pégourié-Gonnard | 36a8b57 | 2015-06-17 12:43:26 +0200 | [diff] [blame] | 3746 | * |
| 3747 | * \note This only affects which hashes are offered and can be used |
| 3748 | * for signatures during the handshake. Hashes for message |
| 3749 | * authentication and the TLS PRF are controlled by the |
| 3750 | * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes |
| 3751 | * used for certificate signature are controlled by the |
| 3752 | * verification profile, see \c mbedtls_ssl_conf_cert_profile(). |
| 3753 | * |
| 3754 | * \note This list should be ordered by decreasing preference |
| 3755 | * (preferred hash first). |
| 3756 | * |
Gilles Peskine | ae270bf | 2021-06-02 00:05:29 +0200 | [diff] [blame] | 3757 | * \note By default, all supported hashes whose length is at least |
| 3758 | * 256 bits are allowed. This is the same set as the default |
| 3759 | * for certificate verification |
Gilles Peskine | a28f0f5 | 2021-06-02 15:29:38 +0200 | [diff] [blame] | 3760 | * (#mbedtls_x509_crt_profile_default). |
| 3761 | * The preference order is currently unspecified and may |
| 3762 | * change in future versions. |
Gilles Peskine | ae270bf | 2021-06-02 00:05:29 +0200 | [diff] [blame] | 3763 | * |
Gilles Peskine | a03fb29 | 2021-06-17 23:17:05 +0200 | [diff] [blame] | 3764 | * \note New minor versions of Mbed TLS may extend this list, |
| 3765 | * for example if new curves are added to the library. |
| 3766 | * New minor versions of Mbed TLS will not remove items |
| 3767 | * from this list unless serious security concerns require it. |
| 3768 | * |
Manuel Pégourié-Gonnard | 36a8b57 | 2015-06-17 12:43:26 +0200 | [diff] [blame] | 3769 | * \param conf SSL configuration |
| 3770 | * \param hashes Ordered list of allowed signature hashes, |
| 3771 | * terminated by \c MBEDTLS_MD_NONE. |
| 3772 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3773 | void MBEDTLS_DEPRECATED mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf, |
| 3774 | const int *hashes); |
Jerry Yu | 7ddc38c | 2022-01-19 11:08:05 +0800 | [diff] [blame] | 3775 | #endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */ |
Hanno Becker | 1cd6e00 | 2021-08-10 13:27:10 +0100 | [diff] [blame] | 3776 | |
Hanno Becker | 1cd6e00 | 2021-08-10 13:27:10 +0100 | [diff] [blame] | 3777 | /** |
| 3778 | * \brief Configure allowed signature algorithms for use in TLS 1.3 |
| 3779 | * |
| 3780 | * \param conf The SSL configuration to use. |
Jerry Yu | 7899de8 | 2021-08-17 13:09:23 +0800 | [diff] [blame] | 3781 | * \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms, |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3782 | * terminated by \c MBEDTLS_TLS1_3_SIG_NONE. The list must remain |
Jerry Yu | 447a3be | 2021-08-18 09:55:32 +0800 | [diff] [blame] | 3783 | * available throughout the lifetime of the conf object. Supported |
Xiaofei Bai | 746f948 | 2021-11-12 08:53:56 +0000 | [diff] [blame] | 3784 | * values are available as \c MBEDTLS_TLS1_3_SIG_XXXX |
Hanno Becker | 1cd6e00 | 2021-08-10 13:27:10 +0100 | [diff] [blame] | 3785 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3786 | void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf, |
| 3787 | const uint16_t *sig_algs); |
Ronald Cron | e68ab4f | 2022-10-05 12:46:29 +0200 | [diff] [blame] | 3788 | #endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */ |
Manuel Pégourié-Gonnard | 36a8b57 | 2015-06-17 12:43:26 +0200 | [diff] [blame] | 3789 | |
Manuel Pégourié-Gonnard | bc2b771 | 2015-05-06 11:14:19 +0100 | [diff] [blame] | 3790 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Paul Bakker | 1b57b06 | 2011-01-06 15:48:19 +0000 | [diff] [blame] | 3791 | /** |
Darryl Green | 11999bb | 2018-03-13 15:22:58 +0000 | [diff] [blame] | 3792 | * \brief Set or reset the hostname to check against the received |
| 3793 | * server certificate. It sets the ServerName TLS extension, |
Hanno Becker | 0446a39 | 2017-04-07 12:59:32 +0100 | [diff] [blame] | 3794 | * too, if that extension is enabled. (client-side only) |
Paul Bakker | 6db455e | 2013-09-18 17:29:31 +0200 | [diff] [blame] | 3795 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3796 | * \param ssl SSL context |
Hanno Becker | 0446a39 | 2017-04-07 12:59:32 +0100 | [diff] [blame] | 3797 | * \param hostname the server hostname, may be NULL to clear hostname |
Darryl Green | 11999bb | 2018-03-13 15:22:58 +0000 | [diff] [blame] | 3798 | |
Hanno Becker | 0446a39 | 2017-04-07 12:59:32 +0100 | [diff] [blame] | 3799 | * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3800 | * |
Darryl Green | 11999bb | 2018-03-13 15:22:58 +0000 | [diff] [blame] | 3801 | * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on |
| 3802 | * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on |
Hanno Becker | 0446a39 | 2017-04-07 12:59:32 +0100 | [diff] [blame] | 3803 | * too long input hostname. |
| 3804 | * |
Hanno Becker | 1a9a51c | 2017-04-07 13:02:16 +0100 | [diff] [blame] | 3805 | * Hostname set to the one provided on success (cleared |
Darryl Green | 11999bb | 2018-03-13 15:22:58 +0000 | [diff] [blame] | 3806 | * when NULL). On allocation failure hostname is cleared. |
Hanno Becker | 0446a39 | 2017-04-07 12:59:32 +0100 | [diff] [blame] | 3807 | * On too long input failure, old hostname is unchanged. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3808 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3809 | int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname); |
Pengyu Lv | 918ebf3 | 2023-03-07 10:17:31 +0800 | [diff] [blame] | 3810 | |
| 3811 | /** |
| 3812 | * \brief Get the hostname that checked against the received |
| 3813 | * server certificate. It is used to set the ServerName |
| 3814 | * TLS extension, too, if that extension is enabled. |
| 3815 | * (client-side only) |
| 3816 | * |
| 3817 | * \param ssl SSL context |
| 3818 | * |
| 3819 | * \return const pointer to the hostname value |
| 3820 | */ |
| 3821 | static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl) |
| 3822 | { |
| 3823 | return ssl->MBEDTLS_PRIVATE(hostname); |
| 3824 | } |
Manuel Pégourié-Gonnard | bc2b771 | 2015-05-06 11:14:19 +0100 | [diff] [blame] | 3825 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3826 | |
Manuel Pégourié-Gonnard | bc2b771 | 2015-05-06 11:14:19 +0100 | [diff] [blame] | 3827 | #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3828 | /** |
Glenn Strauss | 6989407 | 2022-01-24 12:58:00 -0500 | [diff] [blame] | 3829 | * \brief Retrieve SNI extension value for the current handshake. |
Andrzej Kurek | 00b54e6 | 2023-05-06 09:38:57 -0400 | [diff] [blame] | 3830 | * Available in \c f_cert_cb of \c mbedtls_ssl_conf_cert_cb(), |
| 3831 | * this is the same value passed to \c f_sni callback of |
Glenn Strauss | 6989407 | 2022-01-24 12:58:00 -0500 | [diff] [blame] | 3832 | * \c mbedtls_ssl_conf_sni() and may be used instead of |
| 3833 | * \c mbedtls_ssl_conf_sni(). |
| 3834 | * |
| 3835 | * \param ssl SSL context |
| 3836 | * \param name_len pointer into which to store length of returned value. |
| 3837 | * 0 if SNI extension is not present or not yet processed. |
| 3838 | * |
| 3839 | * \return const pointer to SNI extension value. |
Andrzej Kurek | 00b54e6 | 2023-05-06 09:38:57 -0400 | [diff] [blame] | 3840 | * - value is valid only when called in \c f_cert_cb |
Glenn Strauss | 6989407 | 2022-01-24 12:58:00 -0500 | [diff] [blame] | 3841 | * registered with \c mbedtls_ssl_conf_cert_cb(). |
| 3842 | * - value is NULL if SNI extension is not present. |
Andrzej Kurek | 00b54e6 | 2023-05-06 09:38:57 -0400 | [diff] [blame] | 3843 | * - value is not '\0'-terminated. Use \c name_len for len. |
Glenn Strauss | 6989407 | 2022-01-24 12:58:00 -0500 | [diff] [blame] | 3844 | * - value must not be freed. |
| 3845 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3846 | const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl, |
| 3847 | size_t *name_len); |
Glenn Strauss | 6989407 | 2022-01-24 12:58:00 -0500 | [diff] [blame] | 3848 | |
| 3849 | /** |
Manuel Pégourié-Gonnard | 1af6c85 | 2015-05-10 23:10:37 +0200 | [diff] [blame] | 3850 | * \brief Set own certificate and key for the current handshake |
| 3851 | * |
Manuel Pégourié-Gonnard | 6729e79 | 2015-05-11 09:50:24 +0200 | [diff] [blame] | 3852 | * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within |
Glenn Strauss | 9bff95f | 2022-03-09 14:39:08 -0500 | [diff] [blame] | 3853 | * the SNI callback or the certificate selection callback. |
Manuel Pégourié-Gonnard | 1af6c85 | 2015-05-10 23:10:37 +0200 | [diff] [blame] | 3854 | * |
Glenn Strauss | 36872db | 2022-01-22 05:06:31 -0500 | [diff] [blame] | 3855 | * \note Passing null \c own_cert clears the certificate list for |
| 3856 | * the current handshake. |
| 3857 | * |
Manuel Pégourié-Gonnard | 1af6c85 | 2015-05-10 23:10:37 +0200 | [diff] [blame] | 3858 | * \param ssl SSL context |
| 3859 | * \param own_cert own public certificate chain |
| 3860 | * \param pk_key own private key |
| 3861 | * |
Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 3862 | * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED |
Manuel Pégourié-Gonnard | 1af6c85 | 2015-05-10 23:10:37 +0200 | [diff] [blame] | 3863 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3864 | int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl, |
| 3865 | mbedtls_x509_crt *own_cert, |
| 3866 | mbedtls_pk_context *pk_key); |
Manuel Pégourié-Gonnard | 1af6c85 | 2015-05-10 23:10:37 +0200 | [diff] [blame] | 3867 | |
| 3868 | /** |
Manuel Pégourié-Gonnard | 22bfa4b | 2015-05-11 08:46:37 +0200 | [diff] [blame] | 3869 | * \brief Set the data required to verify peer certificate for the |
| 3870 | * current handshake |
| 3871 | * |
Manuel Pégourié-Gonnard | 6729e79 | 2015-05-11 09:50:24 +0200 | [diff] [blame] | 3872 | * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within |
Glenn Strauss | 9bff95f | 2022-03-09 14:39:08 -0500 | [diff] [blame] | 3873 | * the SNI callback or the certificate selection callback. |
Manuel Pégourié-Gonnard | 22bfa4b | 2015-05-11 08:46:37 +0200 | [diff] [blame] | 3874 | * |
| 3875 | * \param ssl SSL context |
| 3876 | * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs) |
| 3877 | * \param ca_crl trusted CA CRLs |
| 3878 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3879 | void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl, |
| 3880 | mbedtls_x509_crt *ca_chain, |
| 3881 | mbedtls_x509_crl *ca_crl); |
Manuel Pégourié-Gonnard | 22bfa4b | 2015-05-11 08:46:37 +0200 | [diff] [blame] | 3882 | |
Glenn Strauss | 999ef70 | 2022-03-11 01:37:23 -0500 | [diff] [blame] | 3883 | #if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED) |
| 3884 | /** |
| 3885 | * \brief Set DN hints sent to client in CertificateRequest message |
| 3886 | * |
| 3887 | * \note Same as \c mbedtls_ssl_conf_dn_hints() but for use within |
| 3888 | * the SNI callback or the certificate selection callback. |
| 3889 | * |
| 3890 | * \param ssl SSL context |
| 3891 | * \param crt crt chain whose subject DNs are issuer DNs of client certs |
| 3892 | * from which the client should select client peer certificate. |
| 3893 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3894 | void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl, |
| 3895 | const mbedtls_x509_crt *crt); |
Glenn Strauss | 999ef70 | 2022-03-11 01:37:23 -0500 | [diff] [blame] | 3896 | #endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */ |
| 3897 | |
Manuel Pégourié-Gonnard | 22bfa4b | 2015-05-11 08:46:37 +0200 | [diff] [blame] | 3898 | /** |
Manuel Pégourié-Gonnard | cdc26ae | 2015-06-19 12:16:31 +0200 | [diff] [blame] | 3899 | * \brief Set authmode for the current handshake. |
| 3900 | * |
| 3901 | * \note Same as \c mbedtls_ssl_conf_authmode() but for use within |
Glenn Strauss | 9bff95f | 2022-03-09 14:39:08 -0500 | [diff] [blame] | 3902 | * the SNI callback or the certificate selection callback. |
Manuel Pégourié-Gonnard | cdc26ae | 2015-06-19 12:16:31 +0200 | [diff] [blame] | 3903 | * |
| 3904 | * \param ssl SSL context |
| 3905 | * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or |
| 3906 | * MBEDTLS_SSL_VERIFY_REQUIRED |
| 3907 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3908 | void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl, |
| 3909 | int authmode); |
Manuel Pégourié-Gonnard | cdc26ae | 2015-06-19 12:16:31 +0200 | [diff] [blame] | 3910 | |
| 3911 | /** |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 3912 | * \brief Set server side ServerName TLS extension callback |
| 3913 | * (optional, server-side only). |
| 3914 | * |
| 3915 | * If set, the ServerName callback is called whenever the |
| 3916 | * server receives a ServerName TLS extension from the client |
| 3917 | * during a handshake. The ServerName callback has the |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3918 | * following parameters: (void *parameter, mbedtls_ssl_context *ssl, |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 3919 | * const unsigned char *hostname, size_t len). If a suitable |
Manuel Pégourié-Gonnard | cdc26ae | 2015-06-19 12:16:31 +0200 | [diff] [blame] | 3920 | * certificate is found, the callback must set the |
Manuel Pégourié-Gonnard | 22bfa4b | 2015-05-11 08:46:37 +0200 | [diff] [blame] | 3921 | * certificate(s) and key(s) to use with \c |
| 3922 | * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly), |
Manuel Pégourié-Gonnard | cdc26ae | 2015-06-19 12:16:31 +0200 | [diff] [blame] | 3923 | * and may optionally adjust the CA and associated CRL with \c |
| 3924 | * mbedtls_ssl_set_hs_ca_chain() as well as the client |
| 3925 | * authentication mode with \c mbedtls_ssl_set_hs_authmode(), |
| 3926 | * then must return 0. If no matching name is found, the |
Glenn Strauss | 0ebf24a | 2022-01-24 18:30:13 -0500 | [diff] [blame] | 3927 | * callback may return non-zero to abort the handshake. |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 3928 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 3929 | * \param conf SSL configuration |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 3930 | * \param f_sni verification function |
| 3931 | * \param p_sni verification parameter |
| 3932 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3933 | void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf, |
| 3934 | int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, |
| 3935 | size_t), |
| 3936 | void *p_sni); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3937 | #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */ |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 3938 | |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 3939 | #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) |
Manuel Pégourié-Gonnard | 7002f4a | 2015-09-15 12:43:43 +0200 | [diff] [blame] | 3940 | /** |
| 3941 | * \brief Set the EC J-PAKE password for current handshake. |
| 3942 | * |
| 3943 | * \note An internal copy is made, and destroyed as soon as the |
| 3944 | * handshake is completed, or when the SSL context is reset or |
| 3945 | * freed. |
| 3946 | * |
| 3947 | * \note The SSL context needs to be already set up. The right place |
| 3948 | * to call this function is between \c mbedtls_ssl_setup() or |
| 3949 | * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake(). |
Valerio Setti | aca21b7 | 2022-11-17 18:17:01 +0100 | [diff] [blame] | 3950 | * Password cannot be empty (see RFC 8236). |
Manuel Pégourié-Gonnard | 7002f4a | 2015-09-15 12:43:43 +0200 | [diff] [blame] | 3951 | * |
| 3952 | * \param ssl SSL context |
Valerio Setti | aca21b7 | 2022-11-17 18:17:01 +0100 | [diff] [blame] | 3953 | * \param pw EC J-PAKE password (pre-shared secret). It cannot be empty |
Manuel Pégourié-Gonnard | 7002f4a | 2015-09-15 12:43:43 +0200 | [diff] [blame] | 3954 | * \param pw_len length of pw in bytes |
| 3955 | * |
| 3956 | * \return 0 on success, or a negative error code. |
| 3957 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3958 | int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl, |
| 3959 | const unsigned char *pw, |
| 3960 | size_t pw_len); |
Valerio Setti | a9a97dc | 2022-11-28 18:26:16 +0100 | [diff] [blame] | 3961 | |
| 3962 | /** |
| 3963 | * \brief Set the EC J-PAKE opaque password for current handshake. |
| 3964 | * |
Valerio Setti | c689ed8 | 2022-12-07 14:40:38 +0100 | [diff] [blame] | 3965 | * \note The key must remain valid until the handshake is over. |
Valerio Setti | a9a97dc | 2022-11-28 18:26:16 +0100 | [diff] [blame] | 3966 | * |
| 3967 | * \note The SSL context needs to be already set up. The right place |
| 3968 | * to call this function is between \c mbedtls_ssl_setup() or |
| 3969 | * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake(). |
Valerio Setti | a9a97dc | 2022-11-28 18:26:16 +0100 | [diff] [blame] | 3970 | * |
| 3971 | * \param ssl SSL context |
| 3972 | * \param pwd EC J-PAKE opaque password |
| 3973 | * |
| 3974 | * \return 0 on success, or a negative error code. |
| 3975 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3976 | int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl, |
| 3977 | mbedtls_svc_key_id_t pwd); |
Manuel Pégourié-Gonnard | eef142d | 2015-09-16 10:05:04 +0200 | [diff] [blame] | 3978 | #endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */ |
Manuel Pégourié-Gonnard | 7002f4a | 2015-09-15 12:43:43 +0200 | [diff] [blame] | 3979 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3980 | #if defined(MBEDTLS_SSL_ALPN) |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 3981 | /** |
| 3982 | * \brief Set the supported Application Layer Protocols. |
| 3983 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 3984 | * \param conf SSL configuration |
Simon Butcher | 157cb65 | 2016-02-13 23:19:04 +0000 | [diff] [blame] | 3985 | * \param protos Pointer to a NULL-terminated list of supported protocols, |
| 3986 | * in decreasing preference order. The pointer to the list is |
| 3987 | * recorded by the library for later reference as required, so |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 3988 | * the lifetime of the table must be at least as long as the |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 3989 | * lifetime of the SSL configuration structure. |
Manuel Pégourié-Gonnard | 0b874dc | 2014-04-07 10:57:45 +0200 | [diff] [blame] | 3990 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3991 | * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA. |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 3992 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 3993 | int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos); |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 3994 | |
| 3995 | /** |
| 3996 | * \brief Get the name of the negotiated Application Layer Protocol. |
| 3997 | * This function should be called after the handshake is |
| 3998 | * completed. |
| 3999 | * |
| 4000 | * \param ssl SSL context |
| 4001 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 4002 | * \return Protocol name, or NULL if no protocol was negotiated. |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 4003 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4004 | const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4005 | #endif /* MBEDTLS_SSL_ALPN */ |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 4006 | |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4007 | #if defined(MBEDTLS_SSL_DTLS_SRTP) |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4008 | #if defined(MBEDTLS_DEBUG_C) |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4009 | static inline const char *mbedtls_ssl_get_srtp_profile_as_string(mbedtls_ssl_srtp_profile profile) |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4010 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4011 | switch (profile) { |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4012 | case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4013 | return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80"; |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4014 | case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4015 | return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32"; |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4016 | case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4017 | return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80"; |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4018 | case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32: |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4019 | return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32"; |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4020 | default: break; |
| 4021 | } |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4022 | return ""; |
Johan Pascal | a455cd9 | 2020-09-22 15:28:11 +0200 | [diff] [blame] | 4023 | } |
| 4024 | #endif /* MBEDTLS_DEBUG_C */ |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4025 | /** |
Johan Pascal | 9bc97ca | 2020-09-21 23:44:45 +0200 | [diff] [blame] | 4026 | * \brief Manage support for mki(master key id) value |
| 4027 | * in use_srtp extension. |
| 4028 | * MKI is an optional part of SRTP used for key management |
| 4029 | * and re-keying. See RFC3711 section 3.1 for details. |
Ron Eldor | a978804 | 2018-12-05 11:04:31 +0200 | [diff] [blame] | 4030 | * The default value is |
| 4031 | * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED. |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 4032 | * |
Johan Pascal | 9bc97ca | 2020-09-21 23:44:45 +0200 | [diff] [blame] | 4033 | * \param conf The SSL configuration to manage mki support. |
Ron Eldor | a978804 | 2018-12-05 11:04:31 +0200 | [diff] [blame] | 4034 | * \param support_mki_value Enable or disable mki usage. Values are |
| 4035 | * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED |
| 4036 | * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED. |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 4037 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4038 | void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf, |
| 4039 | int support_mki_value); |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 4040 | |
| 4041 | /** |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4042 | * \brief Set the supported DTLS-SRTP protection profiles. |
| 4043 | * |
Johan Pascal | c28f1f6 | 2017-02-09 08:55:16 +0700 | [diff] [blame] | 4044 | * \param conf SSL configuration |
Johan Pascal | 253d026 | 2020-09-22 13:04:45 +0200 | [diff] [blame] | 4045 | * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated |
| 4046 | * supported protection profiles |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4047 | * in decreasing preference order. |
Johan Pascal | 253d026 | 2020-09-22 13:04:45 +0200 | [diff] [blame] | 4048 | * The pointer to the list is recorded by the library |
| 4049 | * for later reference as required, so the lifetime |
| 4050 | * of the table must be at least as long as the lifetime |
| 4051 | * of the SSL configuration structure. |
Johan Pascal | aae4d22 | 2020-09-22 21:21:39 +0200 | [diff] [blame] | 4052 | * The list must not hold more than |
| 4053 | * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements |
Johan Pascal | d387aa0 | 2020-09-23 18:47:56 +0200 | [diff] [blame] | 4054 | * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET). |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4055 | * |
Johan Pascal | 8526957 | 2020-08-25 10:01:54 +0200 | [diff] [blame] | 4056 | * \return 0 on success |
Johan Pascal | 9bc97ca | 2020-09-21 23:44:45 +0200 | [diff] [blame] | 4057 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of |
| 4058 | * protection profiles is incorrect. |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4059 | */ |
Ron Eldor | a978804 | 2018-12-05 11:04:31 +0200 | [diff] [blame] | 4060 | int mbedtls_ssl_conf_dtls_srtp_protection_profiles |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4061 | (mbedtls_ssl_config *conf, |
| 4062 | const mbedtls_ssl_srtp_profile *profiles); |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 4063 | |
| 4064 | /** |
Ron Eldor | a978804 | 2018-12-05 11:04:31 +0200 | [diff] [blame] | 4065 | * \brief Set the mki_value for the current DTLS-SRTP session. |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 4066 | * |
Ron Eldor | a978804 | 2018-12-05 11:04:31 +0200 | [diff] [blame] | 4067 | * \param ssl SSL context to use. |
| 4068 | * \param mki_value The MKI value to set. |
| 4069 | * \param mki_len The length of the MKI value. |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 4070 | * |
Johan Pascal | 76fdf1d | 2020-10-22 23:31:00 +0200 | [diff] [blame] | 4071 | * \note This function is relevant on client side only. |
| 4072 | * The server discovers the mki value during handshake. |
| 4073 | * A mki value set on server side using this function |
| 4074 | * is ignored. |
| 4075 | * |
Johan Pascal | 8526957 | 2020-08-25 10:01:54 +0200 | [diff] [blame] | 4076 | * \return 0 on success |
| 4077 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA |
| 4078 | * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE |
Ron Eldor | 591f162 | 2018-01-22 12:30:04 +0200 | [diff] [blame] | 4079 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4080 | int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl, |
| 4081 | unsigned char *mki_value, |
| 4082 | uint16_t mki_len); |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4083 | /** |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 4084 | * \brief Get the negotiated DTLS-SRTP information: |
Johan Pascal | 2258a4f | 2020-10-28 13:53:09 +0100 | [diff] [blame] | 4085 | * Protection profile and MKI value. |
Johan Pascal | 76fdf1d | 2020-10-22 23:31:00 +0200 | [diff] [blame] | 4086 | * |
Johan Pascal | 2258a4f | 2020-10-28 13:53:09 +0100 | [diff] [blame] | 4087 | * \warning This function must be called after the handshake is |
| 4088 | * completed. The value returned by this function must |
| 4089 | * not be trusted or acted upon before the handshake completes. |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4090 | * |
Johan Pascal | 2258a4f | 2020-10-28 13:53:09 +0100 | [diff] [blame] | 4091 | * \param ssl The SSL context to query. |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 4092 | * \param dtls_srtp_info The negotiated DTLS-SRTP information: |
Johan Pascal | 2258a4f | 2020-10-28 13:53:09 +0100 | [diff] [blame] | 4093 | * - Protection profile in use. |
| 4094 | * A direct mapping of the iana defined value for protection |
| 4095 | * profile on an uint16_t. |
| 4096 | http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml |
| 4097 | * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated |
| 4098 | * or peer's Hello packet was not parsed yet. |
| 4099 | * - mki size and value( if size is > 0 ). |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4100 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4101 | void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl, |
| 4102 | mbedtls_dtls_srtp_info *dtls_srtp_info); |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 4103 | #endif /* MBEDTLS_SSL_DTLS_SRTP */ |
| 4104 | |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 4105 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 4106 | /** |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 4107 | * \brief Set the maximum supported version sent from the client side |
Gilles Peskine | 57bf02b | 2022-02-16 12:06:22 +0100 | [diff] [blame] | 4108 | * and/or accepted at the server side. |
| 4109 | * |
| 4110 | * See also the documentation of mbedtls_ssl_conf_min_version(). |
Paul Bakker | 2fbefde | 2013-06-29 16:01:15 +0200 | [diff] [blame] | 4111 | * |
Manuel Pégourié-Gonnard | 01e5e8c | 2015-05-11 10:11:56 +0200 | [diff] [blame] | 4112 | * \note This ignores ciphersuites from higher versions. |
| 4113 | * |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 4114 | * \note This function is deprecated and has been replaced by |
| 4115 | * \c mbedtls_ssl_conf_max_tls_version(). |
| 4116 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4117 | * \param conf SSL configuration |
Gilles Peskine | 57bf02b | 2022-02-16 12:06:22 +0100 | [diff] [blame] | 4118 | * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3) |
| 4119 | * \param minor Minor version number |
| 4120 | * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2, |
| 4121 | * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3) |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 4122 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4123 | void MBEDTLS_DEPRECATED mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, |
| 4124 | int minor); |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 4125 | #endif /* MBEDTLS_DEPRECATED_REMOVED */ |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 4126 | |
Paul Bakker | 1d29fb5 | 2012-09-28 13:28:45 +0000 | [diff] [blame] | 4127 | /** |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 4128 | * \brief Set the maximum supported version sent from the client side |
| 4129 | * and/or accepted at the server side. |
| 4130 | * |
| 4131 | * \note After the handshake, you can call |
| 4132 | * mbedtls_ssl_get_version_number() to see what version was |
| 4133 | * negotiated. |
| 4134 | * |
| 4135 | * \param conf SSL configuration |
Andrzej Kurek | 00b54e6 | 2023-05-06 09:38:57 -0400 | [diff] [blame] | 4136 | * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version) |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 4137 | * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid) |
| 4138 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4139 | static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf, |
| 4140 | mbedtls_ssl_protocol_version tls_version) |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 4141 | { |
| 4142 | conf->MBEDTLS_PRIVATE(max_tls_version) = tls_version; |
| 4143 | } |
| 4144 | |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 4145 | #if !defined(MBEDTLS_DEPRECATED_REMOVED) |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 4146 | /** |
Paul Bakker | 1d29fb5 | 2012-09-28 13:28:45 +0000 | [diff] [blame] | 4147 | * \brief Set the minimum accepted SSL/TLS protocol version |
Gilles Peskine | 57bf02b | 2022-02-16 12:06:22 +0100 | [diff] [blame] | 4148 | * |
| 4149 | * \note By default, all supported versions are accepted. |
| 4150 | * Future versions of the library may disable older |
| 4151 | * protocol versions by default if they become deprecated. |
| 4152 | * |
| 4153 | * \note The following versions are supported (if enabled at |
| 4154 | * compile time): |
| 4155 | * - (D)TLS 1.2: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3, |
| 4156 | * \p minor = #MBEDTLS_SSL_MINOR_VERSION_3 |
| 4157 | * - TLS 1.3: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3, |
| 4158 | * \p minor = #MBEDTLS_SSL_MINOR_VERSION_4 |
| 4159 | * |
| 4160 | * Note that the numbers in the constant names are the |
| 4161 | * TLS internal protocol numbers, and the minor versions |
| 4162 | * differ by one from the human-readable versions! |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 4163 | * |
Manuel Pégourié-Gonnard | 448ea50 | 2015-01-12 11:40:14 +0100 | [diff] [blame] | 4164 | * \note Input outside of the SSL_MAX_XXXXX_VERSION and |
| 4165 | * SSL_MIN_XXXXX_VERSION range is ignored. |
| 4166 | * |
Gilles Peskine | 57bf02b | 2022-02-16 12:06:22 +0100 | [diff] [blame] | 4167 | * \note After the handshake, you can call |
Gilles Peskine | ce4f00d | 2022-02-12 00:47:23 +0100 | [diff] [blame] | 4168 | * mbedtls_ssl_get_version_number() to see what version was |
| 4169 | * negotiated. |
| 4170 | * |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 4171 | * \note This function is deprecated and has been replaced by |
| 4172 | * \c mbedtls_ssl_conf_min_tls_version(). |
| 4173 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4174 | * \param conf SSL configuration |
Gilles Peskine | 57bf02b | 2022-02-16 12:06:22 +0100 | [diff] [blame] | 4175 | * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3) |
| 4176 | * \param minor Minor version number |
| 4177 | * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2, |
| 4178 | * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3) |
Paul Bakker | 1d29fb5 | 2012-09-28 13:28:45 +0000 | [diff] [blame] | 4179 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4180 | void MBEDTLS_DEPRECATED mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, |
| 4181 | int minor); |
Glenn Strauss | d09b343 | 2022-04-11 13:58:11 -0400 | [diff] [blame] | 4182 | #endif /* MBEDTLS_DEPRECATED_REMOVED */ |
Paul Bakker | 1d29fb5 | 2012-09-28 13:28:45 +0000 | [diff] [blame] | 4183 | |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 4184 | /** |
| 4185 | * \brief Set the minimum supported version sent from the client side |
| 4186 | * and/or accepted at the server side. |
| 4187 | * |
| 4188 | * \note After the handshake, you can call |
| 4189 | * mbedtls_ssl_get_version_number() to see what version was |
| 4190 | * negotiated. |
| 4191 | * |
| 4192 | * \param conf SSL configuration |
Andrzej Kurek | 00b54e6 | 2023-05-06 09:38:57 -0400 | [diff] [blame] | 4193 | * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version) |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 4194 | * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid) |
| 4195 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4196 | static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf, |
| 4197 | mbedtls_ssl_protocol_version tls_version) |
Glenn Strauss | 2dfcea2 | 2022-03-14 17:26:42 -0400 | [diff] [blame] | 4198 | { |
| 4199 | conf->MBEDTLS_PRIVATE(min_tls_version) = tls_version; |
| 4200 | } |
Paul Bakker | d0f6fa7 | 2012-09-17 09:18:12 +0000 | [diff] [blame] | 4201 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4202 | #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 4203 | /** |
| 4204 | * \brief Enable or disable Encrypt-then-MAC |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4205 | * (Default: MBEDTLS_SSL_ETM_ENABLED) |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 4206 | * |
| 4207 | * \note This should always be enabled, it is a security |
| 4208 | * improvement, and should not cause any interoperability |
| 4209 | * issue (used only if the peer supports it too). |
| 4210 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4211 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4212 | * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 4213 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4214 | void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4215 | #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */ |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 4216 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4217 | #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 4218 | /** |
| 4219 | * \brief Enable or disable Extended Master Secret negotiation. |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4220 | * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED) |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 4221 | * |
| 4222 | * \note This should always be enabled, it is a security fix to the |
| 4223 | * protocol, and should not cause any interoperability issue |
| 4224 | * (used only if the peer supports it too). |
| 4225 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4226 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4227 | * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 4228 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4229 | void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4230 | #endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */ |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 4231 | |
Janos Follath | 088ce43 | 2017-04-10 12:42:31 +0100 | [diff] [blame] | 4232 | #if defined(MBEDTLS_SSL_SRV_C) |
| 4233 | /** |
| 4234 | * \brief Whether to send a list of acceptable CAs in |
| 4235 | * CertificateRequest messages. |
| 4236 | * (Default: do send) |
| 4237 | * |
| 4238 | * \param conf SSL configuration |
| 4239 | * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or |
| 4240 | * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED |
| 4241 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4242 | void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf, |
| 4243 | char cert_req_ca_list); |
Janos Follath | 088ce43 | 2017-04-10 12:42:31 +0100 | [diff] [blame] | 4244 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 4245 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4246 | #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 4247 | /** |
k-stachowiak | 6d72212 | 2019-02-08 17:03:33 +0100 | [diff] [blame] | 4248 | * \brief Set the maximum fragment length to emit and/or negotiate. |
| 4249 | * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and |
| 4250 | * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes) |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 4251 | * (Server: set maximum fragment length to emit, |
k-stachowiak | eb1bb3d | 2019-02-04 10:43:40 +0100 | [diff] [blame] | 4252 | * usually negotiated by the client during handshake) |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 4253 | * (Client: set maximum fragment length to emit *and* |
| 4254 | * negotiate with the server during handshake) |
Krzysztof Stachowiak | abdf1c6 | 2019-04-25 16:07:37 +0200 | [diff] [blame] | 4255 | * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE) |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 4256 | * |
k-stachowiak | 6d72212 | 2019-02-08 17:03:33 +0100 | [diff] [blame] | 4257 | * \note On the client side, the maximum fragment length extension |
| 4258 | * *will not* be used, unless the maximum fragment length has |
| 4259 | * been set via this function to a value different than |
| 4260 | * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE. |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 4261 | * |
Manuel Pégourié-Gonnard | 0b1d9b2 | 2017-09-21 13:15:27 +0200 | [diff] [blame] | 4262 | * \note With TLS, this currently only affects ApplicationData (sent |
| 4263 | * with \c mbedtls_ssl_read()), not handshake messages. |
| 4264 | * With DTLS, this affects both ApplicationData and handshake. |
| 4265 | * |
Manuel Pégourié-Gonnard | 7e89c17 | 2018-08-13 12:45:26 +0200 | [diff] [blame] | 4266 | * \note This sets the maximum length for a record's payload, |
Manuel Pégourié-Gonnard | 0b1d9b2 | 2017-09-21 13:15:27 +0200 | [diff] [blame] | 4267 | * excluding record overhead that will be added to it, see |
| 4268 | * \c mbedtls_ssl_get_record_expansion(). |
| 4269 | * |
| 4270 | * \note For DTLS, it is also possible to set a limit for the total |
Tom Cosgrove | 1e21144 | 2022-05-26 11:51:00 +0100 | [diff] [blame] | 4271 | * size of datagrams passed to the transport layer, including |
Manuel Pégourié-Gonnard | 6e7aaca | 2018-08-20 10:37:23 +0200 | [diff] [blame] | 4272 | * record overhead, see \c mbedtls_ssl_set_mtu(). |
Manuel Pégourié-Gonnard | 0b1d9b2 | 2017-09-21 13:15:27 +0200 | [diff] [blame] | 4273 | * |
Manuel Pégourié-Gonnard | 6bf89d6 | 2015-05-05 17:01:57 +0100 | [diff] [blame] | 4274 | * \param conf SSL configuration |
Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 4275 | * \param mfl_code Code for maximum fragment length (allowed values: |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4276 | * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024, |
| 4277 | * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096) |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 4278 | * |
Manuel Pégourié-Gonnard | eecb43c | 2015-05-12 12:56:41 +0200 | [diff] [blame] | 4279 | * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 4280 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4281 | int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4282 | #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */ |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 4283 | |
TRodziewicz | 8476f2f | 2021-06-02 14:34:47 +0200 | [diff] [blame] | 4284 | #if defined(MBEDTLS_SSL_SRV_C) |
| 4285 | /** |
TRodziewicz | 3946f79 | 2021-06-14 12:11:18 +0200 | [diff] [blame] | 4286 | * \brief Pick the ciphersuites order according to the second parameter |
| 4287 | * in the SSL Server module (MBEDTLS_SSL_SRV_C). |
| 4288 | * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER) |
TRodziewicz | 8476f2f | 2021-06-02 14:34:47 +0200 | [diff] [blame] | 4289 | * |
| 4290 | * \param conf SSL configuration |
TRodziewicz | 3946f79 | 2021-06-14 12:11:18 +0200 | [diff] [blame] | 4291 | * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER |
| 4292 | * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT) |
TRodziewicz | 8476f2f | 2021-06-02 14:34:47 +0200 | [diff] [blame] | 4293 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4294 | void mbedtls_ssl_conf_preference_order(mbedtls_ssl_config *conf, int order); |
TRodziewicz | 8476f2f | 2021-06-02 14:34:47 +0200 | [diff] [blame] | 4295 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 4296 | |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 4297 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) && \ |
| 4298 | defined(MBEDTLS_SSL_CLI_C) |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 4299 | /** |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 4300 | * \brief Enable / Disable session tickets (client only). |
| 4301 | * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.) |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 4302 | * |
Manuel Pégourié-Gonnard | b596abf | 2015-05-20 10:45:29 +0200 | [diff] [blame] | 4303 | * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb(). |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 4304 | * |
Manuel Pégourié-Gonnard | 2b49445 | 2015-05-06 10:05:11 +0100 | [diff] [blame] | 4305 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4306 | * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or |
| 4307 | * MBEDTLS_SSL_SESSION_TICKETS_DISABLED) |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 4308 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4309 | void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets); |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 4310 | #endif /* MBEDTLS_SSL_SESSION_TICKETS && |
| 4311 | MBEDTLS_SSL_CLI_C */ |
| 4312 | |
| 4313 | #if defined(MBEDTLS_SSL_SESSION_TICKETS) && \ |
| 4314 | defined(MBEDTLS_SSL_SRV_C) && \ |
| 4315 | defined(MBEDTLS_SSL_PROTO_TLS1_3) |
| 4316 | /** |
Jerry Yu | ba627bf | 2022-09-23 09:58:22 +0800 | [diff] [blame] | 4317 | * \brief Number of NewSessionTicket messages for the server to send |
| 4318 | * after handshake completion. |
| 4319 | * |
Jerry Yu | 40b4a01 | 2022-09-22 23:48:38 +0800 | [diff] [blame] | 4320 | * \note The default value is |
Jerry Yu | ba627bf | 2022-09-23 09:58:22 +0800 | [diff] [blame] | 4321 | * \c MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS. |
| 4322 | * |
| 4323 | * \note In case of a session resumption, this setting only partially apply. |
| 4324 | * At most one ticket is sent in that case to just renew the pool of |
| 4325 | * tickets of the client. The rationale is to avoid the number of |
| 4326 | * tickets on the server to become rapidly out of control when the |
| 4327 | * server has the same configuration for all its connection instances. |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 4328 | * |
Jerry Yu | 40b4a01 | 2022-09-22 23:48:38 +0800 | [diff] [blame] | 4329 | * \param conf SSL configuration |
| 4330 | * \param num_tickets Number of NewSessionTicket. |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 4331 | * |
| 4332 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4333 | void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf, |
| 4334 | uint16_t num_tickets); |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 4335 | #endif /* MBEDTLS_SSL_SESSION_TICKETS && |
| 4336 | MBEDTLS_SSL_SRV_C && |
| 4337 | MBEDTLS_SSL_PROTO_TLS1_3*/ |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 4338 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4339 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 4340 | /** |
Paul Bakker | 09f097d | 2012-10-23 11:54:56 +0000 | [diff] [blame] | 4341 | * \brief Enable / Disable renegotiation support for connection when |
| 4342 | * initiated by peer |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4343 | * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED) |
Paul Bakker | 09f097d | 2012-10-23 11:54:56 +0000 | [diff] [blame] | 4344 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 4345 | * \warning It is recommended to always disable renegotiation unless you |
Manuel Pégourié-Gonnard | 398b206 | 2015-05-28 15:13:30 +0200 | [diff] [blame] | 4346 | * know you need it and you know what you're doing. In the |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 4347 | * past, there have been several issues associated with |
Manuel Pégourié-Gonnard | 398b206 | 2015-05-28 15:13:30 +0200 | [diff] [blame] | 4348 | * renegotiation or a poor understanding of its properties. |
| 4349 | * |
| 4350 | * \note Server-side, enabling renegotiation also makes the server |
| 4351 | * susceptible to a resource DoS by a malicious client. |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4352 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4353 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4354 | * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or |
| 4355 | * MBEDTLS_SSL_RENEGOTIATION_DISABLED) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4356 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4357 | void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4358 | #endif /* MBEDTLS_SSL_RENEGOTIATION */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4359 | |
| 4360 | /** |
| 4361 | * \brief Prevent or allow legacy renegotiation. |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4362 | * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION) |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 4363 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4364 | * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to |
Paul Bakker | d0f6fa7 | 2012-09-17 09:18:12 +0000 | [diff] [blame] | 4365 | * be established even if the peer does not support |
| 4366 | * secure renegotiation, but does not allow renegotiation |
| 4367 | * to take place if not secure. |
| 4368 | * (Interoperable and secure option) |
| 4369 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4370 | * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations |
Paul Bakker | d0f6fa7 | 2012-09-17 09:18:12 +0000 | [diff] [blame] | 4371 | * with non-upgraded peers. Allowing legacy renegotiation |
| 4372 | * makes the connection vulnerable to specific man in the |
| 4373 | * middle attacks. (See RFC 5746) |
| 4374 | * (Most interoperable and least secure option) |
| 4375 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4376 | * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections |
Paul Bakker | d0f6fa7 | 2012-09-17 09:18:12 +0000 | [diff] [blame] | 4377 | * if peer does not support secure renegotiation. Results |
| 4378 | * in interoperability issues with non-upgraded peers |
| 4379 | * that do not support renegotiation altogether. |
| 4380 | * (Most secure option, interoperability issues) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4381 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4382 | * \param conf SSL configuration |
Paul Bakker | 6831c4a | 2012-11-07 19:46:27 +0000 | [diff] [blame] | 4383 | * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION, |
| 4384 | * SSL_ALLOW_LEGACY_RENEGOTIATION or |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4385 | * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4386 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4387 | void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy); |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4388 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4389 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4390 | /** |
Manuel Pégourié-Gonnard | df3acd8 | 2014-10-15 15:07:45 +0200 | [diff] [blame] | 4391 | * \brief Enforce renegotiation requests. |
Manuel Pégourié-Gonnard | a9964db | 2014-07-03 19:29:16 +0200 | [diff] [blame] | 4392 | * (Default: enforced, max_records = 16) |
Manuel Pégourié-Gonnard | a9964db | 2014-07-03 19:29:16 +0200 | [diff] [blame] | 4393 | * |
Manuel Pégourié-Gonnard | 44ade65 | 2014-08-19 13:58:40 +0200 | [diff] [blame] | 4394 | * When we request a renegotiation, the peer can comply or |
| 4395 | * ignore the request. This function allows us to decide |
| 4396 | * whether to enforce our renegotiation requests by closing |
| 4397 | * the connection if the peer doesn't comply. |
Manuel Pégourié-Gonnard | a9964db | 2014-07-03 19:29:16 +0200 | [diff] [blame] | 4398 | * |
Manuel Pégourié-Gonnard | 44ade65 | 2014-08-19 13:58:40 +0200 | [diff] [blame] | 4399 | * However, records could already be in transit from the peer |
| 4400 | * when the request is emitted. In order to increase |
| 4401 | * reliability, we can accept a number of records before the |
| 4402 | * expected handshake records. |
Manuel Pégourié-Gonnard | a9964db | 2014-07-03 19:29:16 +0200 | [diff] [blame] | 4403 | * |
| 4404 | * The optimal value is highly dependent on the specific usage |
| 4405 | * scenario. |
| 4406 | * |
Manuel Pégourié-Gonnard | df3acd8 | 2014-10-15 15:07:45 +0200 | [diff] [blame] | 4407 | * \note With DTLS and server-initiated renegotiation, the |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 4408 | * HelloRequest is retransmitted every time mbedtls_ssl_read() times |
Manuel Pégourié-Gonnard | df3acd8 | 2014-10-15 15:07:45 +0200 | [diff] [blame] | 4409 | * out or receives Application Data, until: |
| 4410 | * - max_records records have beens seen, if it is >= 0, or |
| 4411 | * - the number of retransmits that would happen during an |
| 4412 | * actual handshake has been reached. |
| 4413 | * Please remember the request might be lost a few times |
| 4414 | * if you consider setting max_records to a really low value. |
| 4415 | * |
Manuel Pégourié-Gonnard | 44ade65 | 2014-08-19 13:58:40 +0200 | [diff] [blame] | 4416 | * \warning On client, the grace period can only happen during |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4417 | * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate() |
Manuel Pégourié-Gonnard | 44ade65 | 2014-08-19 13:58:40 +0200 | [diff] [blame] | 4418 | * which always behave as if max_record was 0. The reason is, |
| 4419 | * if we receive application data from the server, we need a |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4420 | * place to write it, which only happens during mbedtls_ssl_read(). |
Manuel Pégourié-Gonnard | 44ade65 | 2014-08-19 13:58:40 +0200 | [diff] [blame] | 4421 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4422 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4423 | * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to |
Manuel Pégourié-Gonnard | a9964db | 2014-07-03 19:29:16 +0200 | [diff] [blame] | 4424 | * enforce renegotiation, or a non-negative value to enforce |
| 4425 | * it but allow for a grace period of max_records records. |
| 4426 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4427 | void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records); |
Manuel Pégourié-Gonnard | a9964db | 2014-07-03 19:29:16 +0200 | [diff] [blame] | 4428 | |
| 4429 | /** |
Manuel Pégourié-Gonnard | 837f0fe | 2014-11-05 13:58:53 +0100 | [diff] [blame] | 4430 | * \brief Set record counter threshold for periodic renegotiation. |
Andres AG | 18c5c59 | 2016-12-15 17:01:16 +0000 | [diff] [blame] | 4431 | * (Default: 2^48 - 1) |
Manuel Pégourié-Gonnard | 837f0fe | 2014-11-05 13:58:53 +0100 | [diff] [blame] | 4432 | * |
| 4433 | * Renegotiation is automatically triggered when a record |
Hanno Becker | 1c1f046 | 2019-05-03 12:55:51 +0100 | [diff] [blame] | 4434 | * counter (outgoing or incoming) crosses the defined |
Manuel Pégourié-Gonnard | 837f0fe | 2014-11-05 13:58:53 +0100 | [diff] [blame] | 4435 | * threshold. The default value is meant to prevent the |
| 4436 | * connection from being closed when the counter is about to |
| 4437 | * reached its maximal value (it is not allowed to wrap). |
| 4438 | * |
| 4439 | * Lower values can be used to enforce policies such as "keys |
| 4440 | * must be refreshed every N packets with cipher X". |
| 4441 | * |
Simon Butcher | ee75b9b | 2017-02-03 00:21:28 +0000 | [diff] [blame] | 4442 | * The renegotiation period can be disabled by setting |
| 4443 | * conf->disable_renegotiation to |
| 4444 | * MBEDTLS_SSL_RENEGOTIATION_DISABLED. |
| 4445 | * |
| 4446 | * \note When the configured transport is |
| 4447 | * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation |
| 4448 | * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM, |
| 4449 | * the maximum renegotiation period is 2^64 - 1. |
Andres AG | 18c5c59 | 2016-12-15 17:01:16 +0000 | [diff] [blame] | 4450 | * |
Manuel Pégourié-Gonnard | d36e33f | 2015-05-05 10:45:39 +0200 | [diff] [blame] | 4451 | * \param conf SSL configuration |
Manuel Pégourié-Gonnard | 837f0fe | 2014-11-05 13:58:53 +0100 | [diff] [blame] | 4452 | * \param period The threshold value: a big-endian 64-bit number. |
Manuel Pégourié-Gonnard | 837f0fe | 2014-11-05 13:58:53 +0100 | [diff] [blame] | 4453 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4454 | void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf, |
| 4455 | const unsigned char period[8]); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4456 | #endif /* MBEDTLS_SSL_RENEGOTIATION */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4457 | |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 4458 | /** |
Hanno Becker | 8b170a0 | 2017-10-10 11:51:19 +0100 | [diff] [blame] | 4459 | * \brief Check if there is data already read from the |
| 4460 | * underlying transport but not yet processed. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4461 | * |
| 4462 | * \param ssl SSL context |
| 4463 | * |
Hanno Becker | 8b170a0 | 2017-10-10 11:51:19 +0100 | [diff] [blame] | 4464 | * \return 0 if nothing's pending, 1 otherwise. |
| 4465 | * |
Hanno Becker | 8b170a0 | 2017-10-10 11:51:19 +0100 | [diff] [blame] | 4466 | * \note This is different in purpose and behaviour from |
| 4467 | * \c mbedtls_ssl_get_bytes_avail in that it considers |
| 4468 | * any kind of unprocessed data, not only unread |
| 4469 | * application data. If \c mbedtls_ssl_get_bytes |
| 4470 | * returns a non-zero value, this function will |
| 4471 | * also signal pending data, but the converse does |
| 4472 | * not hold. For example, in DTLS there might be |
| 4473 | * further records waiting to be processed from |
| 4474 | * the current underlying transport's datagram. |
| 4475 | * |
Hanno Becker | 9b19a12 | 2017-10-31 13:00:14 +0000 | [diff] [blame] | 4476 | * \note If this function returns 1 (data pending), this |
Hanno Becker | 8b170a0 | 2017-10-10 11:51:19 +0100 | [diff] [blame] | 4477 | * does not imply that a subsequent call to |
| 4478 | * \c mbedtls_ssl_read will provide any data; |
| 4479 | * e.g., the unprocessed data might turn out |
| 4480 | * to be an alert or a handshake message. |
Hanno Becker | 9b19a12 | 2017-10-31 13:00:14 +0000 | [diff] [blame] | 4481 | * |
| 4482 | * \note This function is useful in the following situation: |
| 4483 | * If the SSL/TLS module successfully returns from an |
| 4484 | * operation - e.g. a handshake or an application record |
| 4485 | * read - and you're awaiting incoming data next, you |
| 4486 | * must not immediately idle on the underlying transport |
| 4487 | * to have data ready, but you need to check the value |
| 4488 | * of this function first. The reason is that the desired |
| 4489 | * data might already be read but not yet processed. |
| 4490 | * If, in contrast, a previous call to the SSL/TLS module |
| 4491 | * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary |
| 4492 | * to call this function, as the latter error code entails |
| 4493 | * that all internal data has been processed. |
| 4494 | * |
Hanno Becker | 8b170a0 | 2017-10-10 11:51:19 +0100 | [diff] [blame] | 4495 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4496 | int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl); |
Hanno Becker | 8b170a0 | 2017-10-10 11:51:19 +0100 | [diff] [blame] | 4497 | |
| 4498 | /** |
| 4499 | * \brief Return the number of application data bytes |
| 4500 | * remaining to be read from the current record. |
| 4501 | * |
| 4502 | * \param ssl SSL context |
| 4503 | * |
| 4504 | * \return How many bytes are available in the application |
| 4505 | * data record read buffer. |
| 4506 | * |
| 4507 | * \note When working over a datagram transport, this is |
| 4508 | * useful to detect the current datagram's boundary |
| 4509 | * in case \c mbedtls_ssl_read has written the maximal |
| 4510 | * amount of data fitting into the input buffer. |
| 4511 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4512 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4513 | size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4514 | |
| 4515 | /** |
| 4516 | * \brief Return the result of the certificate verification |
| 4517 | * |
Hanno Becker | cc40d86 | 2018-10-23 10:28:01 +0100 | [diff] [blame] | 4518 | * \param ssl The SSL context to use. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4519 | * |
Hanno Becker | cc40d86 | 2018-10-23 10:28:01 +0100 | [diff] [blame] | 4520 | * \return \c 0 if the certificate verification was successful. |
| 4521 | * \return \c -1u if the result is not available. This may happen |
| 4522 | * e.g. if the handshake aborts early, or a verification |
| 4523 | * callback returned a fatal error. |
| 4524 | * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX |
| 4525 | * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4526 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4527 | uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl); |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 4528 | |
| 4529 | /** |
Glenn Strauss | 8f52690 | 2022-01-13 00:04:49 -0500 | [diff] [blame] | 4530 | * \brief Return the id of the current ciphersuite |
| 4531 | * |
| 4532 | * \param ssl SSL context |
| 4533 | * |
| 4534 | * \return a ciphersuite id |
| 4535 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4536 | int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl); |
Glenn Strauss | 8f52690 | 2022-01-13 00:04:49 -0500 | [diff] [blame] | 4537 | |
| 4538 | /** |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 4539 | * \brief Return the name of the current ciphersuite |
| 4540 | * |
| 4541 | * \param ssl SSL context |
| 4542 | * |
| 4543 | * \return a string containing the ciphersuite name |
| 4544 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4545 | const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4546 | |
Gilles Peskine | e1a0c25 | 2022-01-13 01:08:03 +0100 | [diff] [blame] | 4547 | |
| 4548 | /** |
| 4549 | * \brief Return the (D)TLS protocol version negotiated in the |
| 4550 | * given connection. |
| 4551 | * |
Gilles Peskine | d44e050 | 2022-02-12 00:45:21 +0100 | [diff] [blame] | 4552 | * \note If you call this function too early during the initial |
| 4553 | * handshake, before the two sides have agreed on a version, |
| 4554 | * this function returns #MBEDTLS_SSL_VERSION_UNKNOWN. |
| 4555 | * |
Gilles Peskine | e1a0c25 | 2022-01-13 01:08:03 +0100 | [diff] [blame] | 4556 | * \param ssl The SSL context to query. |
| 4557 | * \return The negotiated protocol version. |
| 4558 | */ |
Glenn Strauss | 60bfe60 | 2022-03-14 19:04:24 -0400 | [diff] [blame] | 4559 | static inline mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number( |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4560 | const mbedtls_ssl_context *ssl) |
Glenn Strauss | 60bfe60 | 2022-03-14 19:04:24 -0400 | [diff] [blame] | 4561 | { |
| 4562 | return ssl->MBEDTLS_PRIVATE(tls_version); |
| 4563 | } |
Gilles Peskine | e1a0c25 | 2022-01-13 01:08:03 +0100 | [diff] [blame] | 4564 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4565 | /** |
Mateusz Starzyk | 06b07fb | 2021-02-18 13:55:21 +0100 | [diff] [blame] | 4566 | * \brief Return the current TLS version |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 4567 | * |
| 4568 | * \param ssl SSL context |
| 4569 | * |
Mateusz Starzyk | 06b07fb | 2021-02-18 13:55:21 +0100 | [diff] [blame] | 4570 | * \return a string containing the TLS version |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 4571 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4572 | const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl); |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 4573 | |
Manuel Pégourié-Gonnard | 9b35f18 | 2014-10-14 17:47:31 +0200 | [diff] [blame] | 4574 | /** |
| 4575 | * \brief Return the (maximum) number of bytes added by the record |
| 4576 | * layer: header + encryption/MAC overhead (inc. padding) |
| 4577 | * |
| 4578 | * \param ssl SSL context |
| 4579 | * |
Mateusz Starzyk | a3a9984 | 2021-02-19 14:27:22 +0100 | [diff] [blame] | 4580 | * \return Current maximum record expansion in bytes |
Manuel Pégourié-Gonnard | 9b35f18 | 2014-10-14 17:47:31 +0200 | [diff] [blame] | 4581 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4582 | int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl); |
Manuel Pégourié-Gonnard | 9b35f18 | 2014-10-14 17:47:31 +0200 | [diff] [blame] | 4583 | |
Manuel Pégourié-Gonnard | 9468ff1 | 2017-09-21 13:49:50 +0200 | [diff] [blame] | 4584 | /** |
| 4585 | * \brief Return the current maximum outgoing record payload in bytes. |
Hanno Becker | ebd6ab7 | 2021-05-23 05:59:46 +0100 | [diff] [blame] | 4586 | * |
| 4587 | * \note The logic to determine the maximum outgoing record payload is |
| 4588 | * version-specific. It takes into account various factors, such as |
Bence Szépkúti | bb0cfeb | 2021-05-28 09:42:25 +0200 | [diff] [blame] | 4589 | * the mbedtls_config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions |
Hanno Becker | ebd6ab7 | 2021-05-23 05:59:46 +0100 | [diff] [blame] | 4590 | * such as the max fragment length or record size limit extension if |
| 4591 | * used, and for DTLS the path MTU as configured and current |
| 4592 | * record expansion. |
Manuel Pégourié-Gonnard | 9468ff1 | 2017-09-21 13:49:50 +0200 | [diff] [blame] | 4593 | * |
| 4594 | * \note With DTLS, \c mbedtls_ssl_write() will return an error if |
| 4595 | * called with a larger length value. |
| 4596 | * With TLS, \c mbedtls_ssl_write() will fragment the input if |
| 4597 | * necessary and return the number of bytes written; it is up |
| 4598 | * to the caller to call \c mbedtls_ssl_write() again in |
| 4599 | * order to send the remaining bytes if any. |
| 4600 | * |
Hanno Becker | 80d163d | 2021-04-21 06:28:18 +0100 | [diff] [blame] | 4601 | * \sa mbedtls_ssl_get_max_out_record_payload() |
Manuel Pégourié-Gonnard | 9468ff1 | 2017-09-21 13:49:50 +0200 | [diff] [blame] | 4602 | * \sa mbedtls_ssl_get_record_expansion() |
| 4603 | * |
| 4604 | * \param ssl SSL context |
| 4605 | * |
| 4606 | * \return Current maximum payload for an outgoing record, |
| 4607 | * or a negative error code. |
| 4608 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4609 | int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl); |
Manuel Pégourié-Gonnard | 9468ff1 | 2017-09-21 13:49:50 +0200 | [diff] [blame] | 4610 | |
Hanno Becker | 2d8e99b | 2021-04-21 06:19:50 +0100 | [diff] [blame] | 4611 | /** |
| 4612 | * \brief Return the current maximum incoming record payload in bytes. |
Hanno Becker | ebd6ab7 | 2021-05-23 05:59:46 +0100 | [diff] [blame] | 4613 | * |
Jan Bruckner | 1aabe5c | 2023-02-06 12:54:53 +0100 | [diff] [blame] | 4614 | * \note The logic to determine the maximum incoming record payload is |
Hanno Becker | ebd6ab7 | 2021-05-23 05:59:46 +0100 | [diff] [blame] | 4615 | * version-specific. It takes into account various factors, such as |
Bence Szépkúti | bb0cfeb | 2021-05-28 09:42:25 +0200 | [diff] [blame] | 4616 | * the mbedtls_config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions |
Hanno Becker | 2d8e99b | 2021-04-21 06:19:50 +0100 | [diff] [blame] | 4617 | * such as the max fragment length extension or record size limit |
| 4618 | * extension if used, and the current record expansion. |
| 4619 | * |
Hanno Becker | 2d8e99b | 2021-04-21 06:19:50 +0100 | [diff] [blame] | 4620 | * \sa mbedtls_ssl_set_mtu() |
Hanno Becker | 80d163d | 2021-04-21 06:28:18 +0100 | [diff] [blame] | 4621 | * \sa mbedtls_ssl_get_max_in_record_payload() |
Hanno Becker | 2d8e99b | 2021-04-21 06:19:50 +0100 | [diff] [blame] | 4622 | * \sa mbedtls_ssl_get_record_expansion() |
| 4623 | * |
| 4624 | * \param ssl SSL context |
| 4625 | * |
Jan Bruckner | 1aabe5c | 2023-02-06 12:54:53 +0100 | [diff] [blame] | 4626 | * \return Current maximum payload for an incoming record, |
Hanno Becker | 2d8e99b | 2021-04-21 06:19:50 +0100 | [diff] [blame] | 4627 | * or a negative error code. |
| 4628 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4629 | int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl); |
Hanno Becker | 2d8e99b | 2021-04-21 06:19:50 +0100 | [diff] [blame] | 4630 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4631 | #if defined(MBEDTLS_X509_CRT_PARSE_C) |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 4632 | /** |
Hanno Becker | 4a82c1c | 2019-02-05 11:33:12 +0000 | [diff] [blame] | 4633 | * \brief Return the peer certificate from the current connection. |
Paul Bakker | b0550d9 | 2012-10-30 07:51:03 +0000 | [diff] [blame] | 4634 | * |
Hanno Becker | 4a82c1c | 2019-02-05 11:33:12 +0000 | [diff] [blame] | 4635 | * \param ssl The SSL context to use. This must be initialized and setup. |
Paul Bakker | b0550d9 | 2012-10-30 07:51:03 +0000 | [diff] [blame] | 4636 | * |
Hanno Becker | 958efeb | 2019-02-25 10:13:43 +0000 | [diff] [blame] | 4637 | * \return The current peer certificate, if available. |
| 4638 | * The returned certificate is owned by the SSL context and |
| 4639 | * is valid only until the next call to the SSL API. |
| 4640 | * \return \c NULL if no peer certificate is available. This might |
| 4641 | * be because the chosen ciphersuite doesn't use CRTs |
| 4642 | * (PSK-based ciphersuites, for example), or because |
| 4643 | * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled, |
| 4644 | * allowing the stack to free the peer's CRT to save memory. |
Hanno Becker | 4a82c1c | 2019-02-05 11:33:12 +0000 | [diff] [blame] | 4645 | * |
| 4646 | * \note For one-time inspection of the peer's certificate during |
| 4647 | * the handshake, consider registering an X.509 CRT verification |
| 4648 | * callback through mbedtls_ssl_conf_verify() instead of calling |
| 4649 | * this function. Using mbedtls_ssl_conf_verify() also comes at |
| 4650 | * the benefit of allowing you to influence the verification |
| 4651 | * process, for example by masking expected and tolerated |
| 4652 | * verification failures. |
| 4653 | * |
| 4654 | * \warning You must not use the pointer returned by this function |
| 4655 | * after any further call to the SSL API, including |
| 4656 | * mbedtls_ssl_read() and mbedtls_ssl_write(); this is |
| 4657 | * because the pointer might change during renegotiation, |
| 4658 | * which happens transparently to the user. |
| 4659 | * If you want to use the certificate across API calls, |
| 4660 | * you must make a copy. |
Paul Bakker | b0550d9 | 2012-10-30 07:51:03 +0000 | [diff] [blame] | 4661 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4662 | const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4663 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ |
Paul Bakker | b0550d9 | 2012-10-30 07:51:03 +0000 | [diff] [blame] | 4664 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4665 | #if defined(MBEDTLS_SSL_CLI_C) |
Paul Bakker | b0550d9 | 2012-10-30 07:51:03 +0000 | [diff] [blame] | 4666 | /** |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 4667 | * \brief Export a session in order to resume it later. |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 4668 | * |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 4669 | * \param ssl The SSL context representing the connection for which to |
| 4670 | * to export a session structure for later resumption. |
| 4671 | * \param session The target structure in which to store the exported session. |
Benson Liou | 6d0a093 | 2023-12-27 22:03:24 +0800 | [diff] [blame^] | 4672 | * This must have been initialized with mbedtls_ssl_session_init() |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 4673 | * but otherwise be unused. |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 4674 | * |
Hanno Becker | 5c5b820 | 2021-06-18 12:21:25 +0100 | [diff] [blame] | 4675 | * \note This function can handle a variety of mechanisms for session |
Hanno Becker | ab4ecfc | 2021-06-17 05:12:16 +0100 | [diff] [blame] | 4676 | * resumption: For TLS 1.2, both session ID-based resumption and |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 4677 | * ticket-based resumption will be considered. For TLS 1.3, |
| 4678 | * once implemented, sessions equate to tickets, and calling |
| 4679 | * this function multiple times will export the available |
| 4680 | * tickets one a time until no further tickets are available, |
| 4681 | * in which case MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE will |
| 4682 | * be returned. |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 4683 | * |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 4684 | * \note Calling this function multiple times will only be useful |
| 4685 | * once TLS 1.3 is supported. For TLS 1.2 connections, this |
| 4686 | * function should be called at most once. |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 4687 | * |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 4688 | * \return \c 0 if successful. In this case, \p session can be used for |
| 4689 | * session resumption by passing it to mbedtls_ssl_set_session(), |
| 4690 | * and serialized for storage via mbedtls_ssl_session_save(). |
| 4691 | * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no further session |
| 4692 | * is available for export. |
| 4693 | * This error is a non-fatal, and has no observable effect on |
| 4694 | * the SSL context or the destination session. |
| 4695 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 4696 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4697 | * \sa mbedtls_ssl_set_session() |
Hanno Becker | e810bbc | 2021-05-14 16:01:05 +0100 | [diff] [blame] | 4698 | * \sa mbedtls_ssl_session_save() |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 4699 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4700 | int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl, |
| 4701 | mbedtls_ssl_session *session); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4702 | #endif /* MBEDTLS_SSL_CLI_C */ |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 4703 | |
| 4704 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4705 | * \brief Perform the SSL handshake |
| 4706 | * |
| 4707 | * \param ssl SSL context |
| 4708 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4709 | * \return \c 0 if successful. |
| 4710 | * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE |
Manuel Pégourié-Gonnard | a966fde | 2018-10-23 10:41:11 +0200 | [diff] [blame] | 4711 | * if the handshake is incomplete and waiting for data to |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4712 | * be available for reading from or writing to the underlying |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4713 | * transport - in this case you must call this function again |
| 4714 | * when the underlying transport is ready for the operation. |
| 4715 | * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous |
| 4716 | * operation is in progress (see |
| 4717 | * mbedtls_ssl_conf_async_private_cb()) - in this case you |
| 4718 | * must call this function again when the operation is ready. |
| 4719 | * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic |
| 4720 | * operation is in progress (see mbedtls_ecp_set_max_ops()) - |
| 4721 | * in this case you must call this function again to complete |
| 4722 | * the handshake when you're done attending other tasks. |
| 4723 | * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use |
| 4724 | * and the client did not demonstrate reachability yet - in |
| 4725 | * this case you must stop using the context (see below). |
| 4726 | * \return Another SSL error code - in this case you must stop using |
| 4727 | * the context (see below). |
Manuel Pégourié-Gonnard | b48ef9c | 2015-05-28 15:24:25 +0200 | [diff] [blame] | 4728 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4729 | * \warning If this function returns something other than |
| 4730 | * \c 0, |
| 4731 | * #MBEDTLS_ERR_SSL_WANT_READ, |
| 4732 | * #MBEDTLS_ERR_SSL_WANT_WRITE, |
| 4733 | * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or |
| 4734 | * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, |
| 4735 | * you must stop using the SSL context for reading or writing, |
| 4736 | * and either free it or call \c mbedtls_ssl_session_reset() |
| 4737 | * on it before re-using it for a new connection; the current |
| 4738 | * connection must be closed. |
| 4739 | * |
| 4740 | * \note If DTLS is in use, then you may choose to handle |
| 4741 | * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging |
| 4742 | * purposes, as it is an expected return value rather than an |
| 4743 | * actual error, but you still need to reset/free the context. |
Hanno Becker | 8ec8102 | 2017-10-10 10:35:08 +0100 | [diff] [blame] | 4744 | * |
| 4745 | * \note Remarks regarding event-driven DTLS: |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4746 | * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram |
Hanno Becker | 8ec8102 | 2017-10-10 10:35:08 +0100 | [diff] [blame] | 4747 | * from the underlying transport layer is currently being processed, |
| 4748 | * and it is safe to idle until the timer or the underlying transport |
| 4749 | * signal a new event. This is not true for a successful handshake, |
Hanno Becker | ffb1e1a | 2017-10-23 13:17:42 +0100 | [diff] [blame] | 4750 | * in which case the datagram of the underlying transport that is |
| 4751 | * currently being processed might or might not contain further |
| 4752 | * DTLS records. |
Gilles Peskine | 8c2830a | 2022-08-04 23:37:51 +0200 | [diff] [blame] | 4753 | * |
| 4754 | * \note If the context is configured to allow TLS 1.3, or if |
| 4755 | * #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto |
| 4756 | * subsystem must have been initialized by calling |
| 4757 | * psa_crypto_init() before calling this function. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4758 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4759 | int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4760 | |
| 4761 | /** |
Paul Elliott | 93ba3e3 | 2022-03-18 21:51:13 +0000 | [diff] [blame] | 4762 | * \brief After calling mbedtls_ssl_handshake() to start the SSL |
| 4763 | * handshake you can call this function to check whether the |
| 4764 | * handshake is over for a given SSL context. This function |
| 4765 | * should be also used to determine when to stop calling |
| 4766 | * mbedtls_handshake_step() for that context. |
| 4767 | * |
| 4768 | * \param ssl SSL context |
| 4769 | * |
| 4770 | * \return \c 1 if handshake is over, \c 0 if it is still ongoing. |
| 4771 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4772 | static inline int mbedtls_ssl_is_handshake_over(mbedtls_ssl_context *ssl) |
Paul Elliott | 93ba3e3 | 2022-03-18 21:51:13 +0000 | [diff] [blame] | 4773 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4774 | return ssl->MBEDTLS_PRIVATE(state) >= MBEDTLS_SSL_HANDSHAKE_OVER; |
Paul Elliott | 93ba3e3 | 2022-03-18 21:51:13 +0000 | [diff] [blame] | 4775 | } |
| 4776 | |
| 4777 | /** |
Paul Bakker | 1961b70 | 2013-01-25 14:49:24 +0100 | [diff] [blame] | 4778 | * \brief Perform a single step of the SSL handshake |
| 4779 | * |
Manuel Pégourié-Gonnard | 222cb8d | 2015-09-08 15:43:59 +0200 | [diff] [blame] | 4780 | * \note The state of the context (ssl->state) will be at |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4781 | * the next state after this function returns \c 0. Do not |
Paul Elliott | 93ba3e3 | 2022-03-18 21:51:13 +0000 | [diff] [blame] | 4782 | * call this function if mbedtls_ssl_is_handshake_over() |
| 4783 | * returns \c 1. |
| 4784 | * |
| 4785 | * \warning Whilst in the past you may have used direct access to the |
| 4786 | * context state (ssl->state) in order to ascertain when to |
| 4787 | * stop calling this function and although you can still do |
| 4788 | * so with something like ssl->MBEDTLS_PRIVATE(state) or by |
| 4789 | * defining MBEDTLS_ALLOW_PRIVATE_ACCESS, this is now |
| 4790 | * considered deprecated and could be broken in any future |
| 4791 | * release. If you still find you have good reason for such |
| 4792 | * direct access, then please do contact the team to explain |
| 4793 | * this (raise an issue or post to the mailing list), so that |
| 4794 | * we can add a solution to your problem that will be |
| 4795 | * guaranteed to work in the future. |
Paul Bakker | 1961b70 | 2013-01-25 14:49:24 +0100 | [diff] [blame] | 4796 | * |
| 4797 | * \param ssl SSL context |
| 4798 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4799 | * \return See mbedtls_ssl_handshake(). |
| 4800 | * |
| 4801 | * \warning If this function returns something other than \c 0, |
| 4802 | * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE, |
| 4803 | * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or |
| 4804 | * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using |
| 4805 | * the SSL context for reading or writing, and either free it |
| 4806 | * or call \c mbedtls_ssl_session_reset() on it before |
| 4807 | * re-using it for a new connection; the current connection |
| 4808 | * must be closed. |
Paul Bakker | 1961b70 | 2013-01-25 14:49:24 +0100 | [diff] [blame] | 4809 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4810 | int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl); |
Paul Bakker | 1961b70 | 2013-01-25 14:49:24 +0100 | [diff] [blame] | 4811 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4812 | #if defined(MBEDTLS_SSL_RENEGOTIATION) |
Paul Bakker | 1961b70 | 2013-01-25 14:49:24 +0100 | [diff] [blame] | 4813 | /** |
Manuel Pégourié-Gonnard | 9c1e189 | 2013-10-30 16:41:21 +0100 | [diff] [blame] | 4814 | * \brief Initiate an SSL renegotiation on the running connection. |
| 4815 | * Client: perform the renegotiation right now. |
| 4816 | * Server: request renegotiation, which will be performed |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 4817 | * during the next call to mbedtls_ssl_read() if honored by |
| 4818 | * client. |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4819 | * |
| 4820 | * \param ssl SSL context |
| 4821 | * |
Aaron Jones | d96e526 | 2016-06-17 14:40:41 +0000 | [diff] [blame] | 4822 | * \return 0 if successful, or any mbedtls_ssl_handshake() return |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4823 | * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't |
| 4824 | * happen during a renegotiation. |
Manuel Pégourié-Gonnard | acbb050 | 2015-12-10 13:57:27 +0100 | [diff] [blame] | 4825 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4826 | * \warning If this function returns something other than \c 0, |
| 4827 | * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE, |
| 4828 | * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or |
| 4829 | * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using |
| 4830 | * the SSL context for reading or writing, and either free it |
| 4831 | * or call \c mbedtls_ssl_session_reset() on it before |
| 4832 | * re-using it for a new connection; the current connection |
| 4833 | * must be closed. |
| 4834 | * |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4835 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4836 | int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4837 | #endif /* MBEDTLS_SSL_RENEGOTIATION */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 4838 | |
| 4839 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4840 | * \brief Read at most 'len' application data bytes |
| 4841 | * |
| 4842 | * \param ssl SSL context |
| 4843 | * \param buf buffer that will hold the data |
Paul Bakker | 9e4ff95 | 2014-09-24 11:13:11 +0200 | [diff] [blame] | 4844 | * \param len maximum number of bytes to read |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4845 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4846 | * \return The (positive) number of bytes read if successful. |
Manuel Pégourié-Gonnard | a966fde | 2018-10-23 10:41:11 +0200 | [diff] [blame] | 4847 | * \return \c 0 if the read end of the underlying transport was closed |
Andrzej Kurek | 03da084 | 2020-03-17 11:11:36 -0400 | [diff] [blame] | 4848 | * without sending a CloseNotify beforehand, which might happen |
| 4849 | * because of various reasons (internal error of an underlying |
| 4850 | * stack, non-conformant peer not sending a CloseNotify and |
| 4851 | * such) - in this case you must stop using the context |
| 4852 | * (see below). |
| 4853 | * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying |
| 4854 | * transport is still functional, but the peer has |
| 4855 | * acknowledged to not send anything anymore. |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4856 | * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE |
Manuel Pégourié-Gonnard | a966fde | 2018-10-23 10:41:11 +0200 | [diff] [blame] | 4857 | * if the handshake is incomplete and waiting for data to |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4858 | * be available for reading from or writing to the underlying |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4859 | * transport - in this case you must call this function again |
| 4860 | * when the underlying transport is ready for the operation. |
| 4861 | * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous |
| 4862 | * operation is in progress (see |
| 4863 | * mbedtls_ssl_conf_async_private_cb()) - in this case you |
| 4864 | * must call this function again when the operation is ready. |
| 4865 | * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic |
| 4866 | * operation is in progress (see mbedtls_ecp_set_max_ops()) - |
| 4867 | * in this case you must call this function again to complete |
| 4868 | * the handshake when you're done attending other tasks. |
| 4869 | * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server |
| 4870 | * side of a DTLS connection and the client is initiating a |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4871 | * new connection using the same source port. See below. |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4872 | * \return Another SSL error code - in this case you must stop using |
| 4873 | * the context (see below). |
Manuel Pégourié-Gonnard | 3a2a448 | 2015-09-08 15:36:09 +0200 | [diff] [blame] | 4874 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4875 | * \warning If this function returns something other than |
| 4876 | * a positive value, |
| 4877 | * #MBEDTLS_ERR_SSL_WANT_READ, |
| 4878 | * #MBEDTLS_ERR_SSL_WANT_WRITE, |
| 4879 | * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, |
| 4880 | * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or |
| 4881 | * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT, |
| 4882 | * you must stop using the SSL context for reading or writing, |
| 4883 | * and either free it or call \c mbedtls_ssl_session_reset() |
| 4884 | * on it before re-using it for a new connection; the current |
| 4885 | * connection must be closed. |
Manuel Pégourié-Gonnard | acbb050 | 2015-12-10 13:57:27 +0100 | [diff] [blame] | 4886 | * |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4887 | * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT |
Manuel Pégourié-Gonnard | 3a2a448 | 2015-09-08 15:36:09 +0200 | [diff] [blame] | 4888 | * (which can only happen server-side), it means that a client |
| 4889 | * is initiating a new connection using the same source port. |
| 4890 | * You can either treat that as a connection close and wait |
| 4891 | * for the client to resend a ClientHello, or directly |
| 4892 | * continue with \c mbedtls_ssl_handshake() with the same |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4893 | * context (as it has been reset internally). Either way, you |
| 4894 | * must make sure this is seen by the application as a new |
Manuel Pégourié-Gonnard | 3a2a448 | 2015-09-08 15:36:09 +0200 | [diff] [blame] | 4895 | * connection: application state, if any, should be reset, and |
| 4896 | * most importantly the identity of the client must be checked |
| 4897 | * again. WARNING: not validating the identity of the client |
| 4898 | * again, or not transmitting the new identity to the |
| 4899 | * application layer, would allow authentication bypass! |
Hanno Becker | 8ec8102 | 2017-10-10 10:35:08 +0100 | [diff] [blame] | 4900 | * |
Hanno Becker | 8ec8102 | 2017-10-10 10:35:08 +0100 | [diff] [blame] | 4901 | * \note Remarks regarding event-driven DTLS: |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4902 | * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram |
Hanno Becker | 8ec8102 | 2017-10-10 10:35:08 +0100 | [diff] [blame] | 4903 | * from the underlying transport layer is currently being processed, |
| 4904 | * and it is safe to idle until the timer or the underlying transport |
| 4905 | * signal a new event. |
Hanno Becker | ffb1e1a | 2017-10-23 13:17:42 +0100 | [diff] [blame] | 4906 | * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was |
| 4907 | * initially available on the underlying transport, as this data may have |
| 4908 | * been only e.g. duplicated messages or a renegotiation request. |
| 4909 | * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even |
| 4910 | * when reacting to an incoming-data event from the underlying transport. |
| 4911 | * - On success, the datagram of the underlying transport that is currently |
| 4912 | * being processed may contain further DTLS records. You should call |
| 4913 | * \c mbedtls_ssl_check_pending to check for remaining records. |
Hanno Becker | 8ec8102 | 2017-10-10 10:35:08 +0100 | [diff] [blame] | 4914 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4915 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4916 | int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4917 | |
| 4918 | /** |
Manuel Pégourié-Gonnard | 5f5e0ec | 2015-08-31 20:44:12 +0200 | [diff] [blame] | 4919 | * \brief Try to write exactly 'len' application data bytes |
| 4920 | * |
| 4921 | * \warning This function will do partial writes in some cases. If the |
| 4922 | * return value is non-negative but less than length, the |
| 4923 | * function must be called again with updated arguments: |
| 4924 | * buf + ret, len - ret (if ret is the return value) until |
| 4925 | * it returns a value equal to the last 'len' argument. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4926 | * |
| 4927 | * \param ssl SSL context |
| 4928 | * \param buf buffer holding the data |
| 4929 | * \param len how many bytes must be written |
| 4930 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4931 | * \return The (non-negative) number of bytes actually written if |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4932 | * successful (may be less than \p len). |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4933 | * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE |
Manuel Pégourié-Gonnard | a966fde | 2018-10-23 10:41:11 +0200 | [diff] [blame] | 4934 | * if the handshake is incomplete and waiting for data to |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4935 | * be available for reading from or writing to the underlying |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4936 | * transport - in this case you must call this function again |
| 4937 | * when the underlying transport is ready for the operation. |
| 4938 | * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous |
| 4939 | * operation is in progress (see |
| 4940 | * mbedtls_ssl_conf_async_private_cb()) - in this case you |
| 4941 | * must call this function again when the operation is ready. |
| 4942 | * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic |
| 4943 | * operation is in progress (see mbedtls_ecp_set_max_ops()) - |
| 4944 | * in this case you must call this function again to complete |
| 4945 | * the handshake when you're done attending other tasks. |
| 4946 | * \return Another SSL error code - in this case you must stop using |
| 4947 | * the context (see below). |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4948 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 4949 | * \warning If this function returns something other than |
| 4950 | * a non-negative value, |
| 4951 | * #MBEDTLS_ERR_SSL_WANT_READ, |
| 4952 | * #MBEDTLS_ERR_SSL_WANT_WRITE, |
| 4953 | * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or |
| 4954 | * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, |
| 4955 | * you must stop using the SSL context for reading or writing, |
| 4956 | * and either free it or call \c mbedtls_ssl_session_reset() |
| 4957 | * on it before re-using it for a new connection; the current |
| 4958 | * connection must be closed. |
Manuel Pégourié-Gonnard | acbb050 | 2015-12-10 13:57:27 +0100 | [diff] [blame] | 4959 | * |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4960 | * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ, |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4961 | * it must be called later with the *same* arguments, |
Jan Bruckner | 9ff6f8c | 2022-08-22 16:05:58 +0200 | [diff] [blame] | 4962 | * until it returns a value greater than or equal to 0. When |
Manuel Pégourié-Gonnard | ca29fdf | 2018-10-22 09:56:53 +0200 | [diff] [blame] | 4963 | * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be |
Andres Amaya Garcia | 7ee25d7 | 2017-07-11 16:15:54 +0100 | [diff] [blame] | 4964 | * some partial data in the output buffer, however this is not |
| 4965 | * yet sent. |
Manuel Pégourié-Gonnard | 37e08e1 | 2014-10-13 17:55:52 +0200 | [diff] [blame] | 4966 | * |
Manuel Pégourié-Gonnard | 8fbb01e | 2015-01-21 13:37:08 +0000 | [diff] [blame] | 4967 | * \note If the requested length is greater than the maximum |
| 4968 | * fragment length (either the built-in limit or the one set |
| 4969 | * or negotiated with the peer), then: |
Manuel Pégourié-Gonnard | 5f5e0ec | 2015-08-31 20:44:12 +0200 | [diff] [blame] | 4970 | * - with TLS, less bytes than requested are written. |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4971 | * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned. |
Hanno Becker | 80d163d | 2021-04-21 06:28:18 +0100 | [diff] [blame] | 4972 | * \c mbedtls_ssl_get_max_out_record_payload() may be used to |
Andrzej Kurek | 90c6e84 | 2020-04-03 05:25:29 -0400 | [diff] [blame] | 4973 | * query the active maximum fragment length. |
Andres Amaya Garcia | 7ee25d7 | 2017-07-11 16:15:54 +0100 | [diff] [blame] | 4974 | * |
| 4975 | * \note Attempting to write 0 bytes will result in an empty TLS |
| 4976 | * application record being sent. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4977 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4978 | int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 4979 | |
| 4980 | /** |
Paul Bakker | 0a92518 | 2012-04-16 06:46:41 +0000 | [diff] [blame] | 4981 | * \brief Send an alert message |
| 4982 | * |
| 4983 | * \param ssl SSL context |
| 4984 | * \param level The alert level of the message |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 4985 | * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL) |
Paul Bakker | 0a92518 | 2012-04-16 06:46:41 +0000 | [diff] [blame] | 4986 | * \param message The alert message (SSL_ALERT_MSG_*) |
| 4987 | * |
Paul Bakker | 6831c4a | 2012-11-07 19:46:27 +0000 | [diff] [blame] | 4988 | * \return 0 if successful, or a specific SSL error code. |
Manuel Pégourié-Gonnard | acbb050 | 2015-12-10 13:57:27 +0100 | [diff] [blame] | 4989 | * |
| 4990 | * \note If this function returns something other than 0 or |
Hanno Becker | 298a7b2 | 2017-11-06 10:45:26 +0000 | [diff] [blame] | 4991 | * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using |
| 4992 | * the SSL context for reading or writing, and either free it or |
| 4993 | * call \c mbedtls_ssl_session_reset() on it before re-using it |
| 4994 | * for a new connection; the current connection must be closed. |
Paul Bakker | 0a92518 | 2012-04-16 06:46:41 +0000 | [diff] [blame] | 4995 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 4996 | int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl, |
| 4997 | unsigned char level, |
| 4998 | unsigned char message); |
Paul Bakker | 0a92518 | 2012-04-16 06:46:41 +0000 | [diff] [blame] | 4999 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 5000 | * \brief Notify the peer that the connection is being closed |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 5001 | * |
| 5002 | * \param ssl SSL context |
Manuel Pégourié-Gonnard | acbb050 | 2015-12-10 13:57:27 +0100 | [diff] [blame] | 5003 | * |
| 5004 | * \return 0 if successful, or a specific SSL error code. |
| 5005 | * |
| 5006 | * \note If this function returns something other than 0 or |
Hanno Becker | 298a7b2 | 2017-11-06 10:45:26 +0000 | [diff] [blame] | 5007 | * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using |
| 5008 | * the SSL context for reading or writing, and either free it or |
| 5009 | * call \c mbedtls_ssl_session_reset() on it before re-using it |
| 5010 | * for a new connection; the current connection must be closed. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 5011 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5012 | int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 5013 | |
Ronald Cron | 4a8c9e2 | 2022-10-26 18:49:09 +0200 | [diff] [blame] | 5014 | #if defined(MBEDTLS_SSL_EARLY_DATA) |
| 5015 | |
Jerry Yu | 7a799cc | 2023-02-08 13:47:47 +0800 | [diff] [blame] | 5016 | #define MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT 0 |
| 5017 | #define MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED 1 |
| 5018 | #define MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED 2 |
| 5019 | |
Ronald Cron | 4a8c9e2 | 2022-10-26 18:49:09 +0200 | [diff] [blame] | 5020 | #if defined(MBEDTLS_SSL_SRV_C) |
| 5021 | /** |
| 5022 | * \brief Read at most 'len' application data bytes while performing |
| 5023 | * the handshake (early data). |
| 5024 | * |
| 5025 | * \note This function behaves mainly as mbedtls_ssl_read(). The |
| 5026 | * specification of mbedtls_ssl_read() relevant to TLS 1.3 |
| 5027 | * (thus not the parts specific to (D)TLS 1.2) applies to this |
| 5028 | * function and the present documentation is restricted to the |
| 5029 | * differences with mbedtls_ssl_read(). |
| 5030 | * |
| 5031 | * \param ssl SSL context |
| 5032 | * \param buf buffer that will hold the data |
| 5033 | * \param len maximum number of bytes to read |
| 5034 | * |
| 5035 | * \return One additional specific return value: |
| 5036 | * #MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA. |
| 5037 | * |
| 5038 | * #MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA is returned when it |
| 5039 | * is not possible to read early data for the SSL context |
| 5040 | * \p ssl. |
| 5041 | * |
| 5042 | * It may have been possible and it is not possible |
| 5043 | * anymore because the server received the End of Early Data |
| 5044 | * message or the maximum number of allowed early data for the |
| 5045 | * PSK in use has been reached. |
| 5046 | * |
| 5047 | * It may never have been possible and will never be possible |
| 5048 | * for the SSL context \p ssl because the use of early data |
| 5049 | * is disabled for that context or more generally the context |
| 5050 | * is not suitably configured to enable early data or the |
| 5051 | * client does not use early data or the first call to the |
| 5052 | * function was done while the handshake was already too |
| 5053 | * advanced to gather and accept early data. |
| 5054 | * |
| 5055 | * It is not possible to read early data for the SSL context |
| 5056 | * \p ssl but this does not preclude for using it with |
| 5057 | * mbedtls_ssl_write(), mbedtls_ssl_read() or |
| 5058 | * mbedtls_ssl_handshake(). |
| 5059 | * |
| 5060 | * \note When a server wants to retrieve early data, it is expected |
| 5061 | * that this function starts the handshake for the SSL context |
| 5062 | * \p ssl. But this is not mandatory. |
| 5063 | * |
| 5064 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5065 | int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl, |
| 5066 | unsigned char *buf, size_t len); |
Ronald Cron | 4a8c9e2 | 2022-10-26 18:49:09 +0200 | [diff] [blame] | 5067 | #endif /* MBEDTLS_SSL_SRV_C */ |
| 5068 | |
| 5069 | #if defined(MBEDTLS_SSL_CLI_C) |
| 5070 | /** |
| 5071 | * \brief Try to write exactly 'len' application data bytes while |
| 5072 | * performing the handshake (early data). |
| 5073 | * |
| 5074 | * \note This function behaves mainly as mbedtls_ssl_write(). The |
| 5075 | * specification of mbedtls_ssl_write() relevant to TLS 1.3 |
| 5076 | * (thus not the parts specific to (D)TLS1.2) applies to this |
| 5077 | * function and the present documentation is restricted to the |
| 5078 | * differences with mbedtls_ssl_write(). |
| 5079 | * |
| 5080 | * \param ssl SSL context |
| 5081 | * \param buf buffer holding the data |
| 5082 | * \param len how many bytes must be written |
| 5083 | * |
| 5084 | * \return One additional specific return value: |
| 5085 | * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA. |
| 5086 | * |
| 5087 | * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA is returned when it |
| 5088 | * is not possible to write early data for the SSL context |
| 5089 | * \p ssl. |
| 5090 | * |
| 5091 | * It may have been possible and it is not possible |
| 5092 | * anymore because the client received the server Finished |
| 5093 | * message, the server rejected early data or the maximum |
| 5094 | * number of allowed early data for the PSK in use has been |
| 5095 | * reached. |
| 5096 | * |
| 5097 | * It may never have been possible and will never be possible |
| 5098 | * for the SSL context \p ssl because the use of early data |
| 5099 | * is disabled for that context or more generally the context |
| 5100 | * is not suitably configured to enable early data or the first |
| 5101 | * call to the function was done while the handshake was |
| 5102 | * already completed. |
| 5103 | * |
| 5104 | * It is not possible to write early data for the SSL context |
| 5105 | * \p ssl but this does not preclude for using it with |
| 5106 | * mbedtls_ssl_write(), mbedtls_ssl_read() or |
| 5107 | * mbedtls_ssl_handshake(). |
| 5108 | * |
| 5109 | * \note This function may write early data only if the SSL context |
| 5110 | * has been configured for the handshake with a PSK for which |
| 5111 | * early data is allowed. |
| 5112 | * |
| 5113 | * \note To maximize the number of early data that can be written in |
| 5114 | * the course of the handshake, it is expected that this |
| 5115 | * function starts the handshake for the SSL context \p ssl. |
| 5116 | * But this is not mandatory. |
| 5117 | * |
| 5118 | * \note This function does not provide any information on whether |
| 5119 | * the server has accepted or will accept early data or not. |
| 5120 | * When it returns a positive value, it just means that it |
| 5121 | * has written early data to the server. To know whether the |
| 5122 | * server has accepted early data or not, you should call |
| 5123 | * mbedtls_ssl_get_early_data_status() with the handshake |
| 5124 | * completed. |
| 5125 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5126 | int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl, |
| 5127 | const unsigned char *buf, size_t len); |
Ronald Cron | 4a8c9e2 | 2022-10-26 18:49:09 +0200 | [diff] [blame] | 5128 | |
Ronald Cron | 4a8c9e2 | 2022-10-26 18:49:09 +0200 | [diff] [blame] | 5129 | /** |
| 5130 | * \brief Get the status of the negotiation of the use of early data. |
| 5131 | * |
| 5132 | * \param ssl The SSL context to query |
| 5133 | * |
| 5134 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called |
| 5135 | * from the server-side. |
| 5136 | * |
| 5137 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called |
| 5138 | * prior to completion of the handshake. |
| 5139 | * |
| 5140 | * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT if the client has |
| 5141 | * not indicated the use of early data to the server. |
| 5142 | * |
| 5143 | * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED if the client has |
| 5144 | * indicated the use of early data and the server has accepted |
| 5145 | * it. |
| 5146 | * |
| 5147 | * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED if the client has |
| 5148 | * indicated the use of early data but the server has rejected |
| 5149 | * it. In this situation, the client may want to re-send the |
| 5150 | * early data it may have tried to send by calling |
| 5151 | * mbedtls_ssl_write_early_data() as ordinary post-handshake |
| 5152 | * application data by calling mbedtls_ssl_write(). |
| 5153 | * |
| 5154 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5155 | int mbedtls_ssl_get_early_data_status(mbedtls_ssl_context *ssl); |
Ronald Cron | 4a8c9e2 | 2022-10-26 18:49:09 +0200 | [diff] [blame] | 5156 | #endif /* MBEDTLS_SSL_CLI_C */ |
| 5157 | |
| 5158 | #endif /* MBEDTLS_SSL_EARLY_DATA */ |
| 5159 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 5160 | /** |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 5161 | * \brief Free referenced items in an SSL context and clear memory |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 5162 | * |
| 5163 | * \param ssl SSL context |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 5164 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5165 | void mbedtls_ssl_free(mbedtls_ssl_context *ssl); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 5166 | |
Manuel Pégourié-Gonnard | 5c0e377 | 2019-07-23 16:13:17 +0200 | [diff] [blame] | 5167 | #if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 5168 | /** |
Manuel Pégourié-Gonnard | 6d8f128 | 2019-06-05 09:47:18 +0200 | [diff] [blame] | 5169 | * \brief Save an active connection as serialized data in a buffer. |
| 5170 | * This allows the freeing or re-using of the SSL context |
| 5171 | * while still picking up the connection later in a way that |
| 5172 | * it entirely transparent to the peer. |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5173 | * |
| 5174 | * \see mbedtls_ssl_context_load() |
| 5175 | * |
Gilles Peskine | 49d7ddf | 2022-01-27 23:25:51 +0100 | [diff] [blame] | 5176 | * \note The serialized data only contains the data that is |
| 5177 | * necessary to resume the connection: negotiated protocol |
| 5178 | * options, session identifier, keys, etc. |
| 5179 | * Loading a saved SSL context does not restore settings and |
| 5180 | * state related to how the application accesses the context, |
| 5181 | * such as configured callback functions, user data, pending |
| 5182 | * incoming or outgoing data, etc. |
| 5183 | * |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5184 | * \note This feature is currently only available under certain |
Manuel Pégourié-Gonnard | 6d8f128 | 2019-06-05 09:47:18 +0200 | [diff] [blame] | 5185 | * conditions, see the documentation of the return value |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5186 | * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details. |
| 5187 | * |
Manuel Pégourié-Gonnard | 6d8f128 | 2019-06-05 09:47:18 +0200 | [diff] [blame] | 5188 | * \note When this function succeeds, it calls |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5189 | * mbedtls_ssl_session_reset() on \p ssl which as a result is |
| 5190 | * no longer associated with the connection that has been |
Manuel Pégourié-Gonnard | 9df5a82 | 2019-07-23 14:51:09 +0200 | [diff] [blame] | 5191 | * serialized. This avoids creating copies of the connection |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5192 | * state. You're then free to either re-use the context |
| 5193 | * structure for a different connection, or call |
Manuel Pégourié-Gonnard | 9df5a82 | 2019-07-23 14:51:09 +0200 | [diff] [blame] | 5194 | * mbedtls_ssl_free() on it. See the documentation of |
Manuel Pégourié-Gonnard | 6d8f128 | 2019-06-05 09:47:18 +0200 | [diff] [blame] | 5195 | * mbedtls_ssl_session_reset() for more details. |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5196 | * |
| 5197 | * \param ssl The SSL context to save. On success, it is no longer |
| 5198 | * associated with the connection that has been serialized. |
| 5199 | * \param buf The buffer to write the serialized data to. It must be a |
Jarno Lamsa | b9ca1b0 | 2019-08-20 12:05:57 +0300 | [diff] [blame] | 5200 | * writeable buffer of at least \p buf_len bytes, or may be \c |
| 5201 | * NULL if \p buf_len is \c 0. |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5202 | * \param buf_len The number of bytes available for writing in \p buf. |
| 5203 | * \param olen The size in bytes of the data that has been or would have |
| 5204 | * been written. It must point to a valid \c size_t. |
| 5205 | * |
| 5206 | * \note \p olen is updated to the correct value regardless of |
| 5207 | * whether \p buf_len was large enough. This makes it possible |
| 5208 | * to determine the necessary size by calling this function |
Manuel Pégourié-Gonnard | 4b7e6b9 | 2019-07-11 12:50:53 +0200 | [diff] [blame] | 5209 | * with \p buf set to \c NULL and \p buf_len to \c 0. However, |
| 5210 | * the value of \p olen is only guaranteed to be correct when |
| 5211 | * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or |
| 5212 | * \c 0. If the return value is different, then the value of |
| 5213 | * \p olen is undefined. |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5214 | * |
| 5215 | * \return \c 0 if successful. |
| 5216 | * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small. |
Manuel Pégourié-Gonnard | 9df5a82 | 2019-07-23 14:51:09 +0200 | [diff] [blame] | 5217 | * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 5218 | * while resetting the context. |
Manuel Pégourié-Gonnard | 6d8f128 | 2019-06-05 09:47:18 +0200 | [diff] [blame] | 5219 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5220 | * progress, or there is pending data for reading or sending, |
Manuel Pégourié-Gonnard | 1aaf669 | 2019-07-10 14:14:05 +0200 | [diff] [blame] | 5221 | * or the connection does not use DTLS 1.2 with an AEAD |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5222 | * ciphersuite, or renegotiation is enabled. |
| 5223 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5224 | int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl, |
| 5225 | unsigned char *buf, |
| 5226 | size_t buf_len, |
| 5227 | size_t *olen); |
Manuel Pégourié-Gonnard | 1aaf669 | 2019-07-10 14:14:05 +0200 | [diff] [blame] | 5228 | |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5229 | /** |
| 5230 | * \brief Load serialized connection data to an SSL context. |
| 5231 | * |
| 5232 | * \see mbedtls_ssl_context_save() |
| 5233 | * |
| 5234 | * \warning The same serialized data must never be loaded into more |
| 5235 | * that one context. In order to ensure that, after |
| 5236 | * successfully loading serialized data to an SSL context, you |
| 5237 | * should immediately destroy or invalidate all copies of the |
| 5238 | * serialized data that was loaded. Loading the same data in |
| 5239 | * more than one context would cause severe security failures |
| 5240 | * including but not limited to loss of confidentiality. |
| 5241 | * |
| 5242 | * \note Before calling this function, the SSL context must be |
Manuel Pégourié-Gonnard | d0a86f9 | 2019-06-11 11:25:10 +0200 | [diff] [blame] | 5243 | * prepared in one of the two following ways. The first way is |
| 5244 | * to take a context freshly initialised with |
| 5245 | * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5246 | * the same ::mbedtls_ssl_config structure that was used in |
Manuel Pégourié-Gonnard | d0a86f9 | 2019-06-11 11:25:10 +0200 | [diff] [blame] | 5247 | * the original connection. The second way is to |
| 5248 | * call mbedtls_ssl_session_reset() on a context that was |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5249 | * previously prepared as above but used in the meantime. |
Manuel Pégourié-Gonnard | d0a86f9 | 2019-06-11 11:25:10 +0200 | [diff] [blame] | 5250 | * Either way, you must not use the context to perform a |
| 5251 | * handshake between calling mbedtls_ssl_setup() or |
| 5252 | * mbedtls_ssl_session_reset() and calling this function. You |
| 5253 | * may however call other setter functions in that time frame |
| 5254 | * as indicated in the note below. |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5255 | * |
Manuel Pégourié-Gonnard | 6d8f128 | 2019-06-05 09:47:18 +0200 | [diff] [blame] | 5256 | * \note Before or after calling this function successfully, you |
Manuel Pégourié-Gonnard | d0a86f9 | 2019-06-11 11:25:10 +0200 | [diff] [blame] | 5257 | * also need to configure some connection-specific callbacks |
Manuel Pégourié-Gonnard | 6d8f128 | 2019-06-05 09:47:18 +0200 | [diff] [blame] | 5258 | * and settings before you can use the connection again |
| 5259 | * (unless they were already set before calling |
| 5260 | * mbedtls_ssl_session_reset() and the values are suitable for |
| 5261 | * the present connection). Specifically, you want to call |
Gilles Peskine | 49d7ddf | 2022-01-27 23:25:51 +0100 | [diff] [blame] | 5262 | * at least mbedtls_ssl_set_bio(), |
| 5263 | * mbedtls_ssl_set_timer_cb(), and |
| 5264 | * mbedtls_ssl_set_user_data_n() or |
| 5265 | * mbedtls_ssl_set_user_data_p() if they were set originally. |
| 5266 | * All other SSL setter functions |
Manuel Pégourié-Gonnard | 13c8e68 | 2019-07-15 12:23:22 +0200 | [diff] [blame] | 5267 | * are not necessary to call, either because they're only used |
| 5268 | * in handshakes, or because the setting is already saved. You |
| 5269 | * might choose to call them anyway, for example in order to |
| 5270 | * share code between the cases of establishing a new |
Manuel Pégourié-Gonnard | d0a86f9 | 2019-06-11 11:25:10 +0200 | [diff] [blame] | 5271 | * connection and the case of loading an already-established |
| 5272 | * connection. |
| 5273 | * |
| 5274 | * \note If you have new information about the path MTU, you want to |
| 5275 | * call mbedtls_ssl_set_mtu() after calling this function, as |
| 5276 | * otherwise this function would overwrite your |
| 5277 | * newly-configured value with the value that was active when |
| 5278 | * the context was saved. |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5279 | * |
Manuel Pégourié-Gonnard | 4b7e6b9 | 2019-07-11 12:50:53 +0200 | [diff] [blame] | 5280 | * \note When this function returns an error code, it calls |
| 5281 | * mbedtls_ssl_free() on \p ssl. In this case, you need to |
| 5282 | * prepare the context with the usual sequence starting with a |
| 5283 | * call to mbedtls_ssl_init() if you want to use it again. |
| 5284 | * |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5285 | * \param ssl The SSL context structure to be populated. It must have |
| 5286 | * been prepared as described in the note above. |
| 5287 | * \param buf The buffer holding the serialized connection data. It must |
| 5288 | * be a readable buffer of at least \p len bytes. |
| 5289 | * \param len The size of the serialized data in bytes. |
| 5290 | * |
| 5291 | * \return \c 0 if successful. |
| 5292 | * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed. |
Manuel Pégourié-Gonnard | 4c90e85 | 2019-07-11 10:58:10 +0200 | [diff] [blame] | 5293 | * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data |
| 5294 | * comes from a different Mbed TLS version or build. |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5295 | * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid. |
| 5296 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5297 | int mbedtls_ssl_context_load(mbedtls_ssl_context *ssl, |
| 5298 | const unsigned char *buf, |
| 5299 | size_t len); |
Manuel Pégourié-Gonnard | 5c0e377 | 2019-07-23 16:13:17 +0200 | [diff] [blame] | 5300 | #endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */ |
Manuel Pégourié-Gonnard | ac87e28 | 2019-05-28 13:02:16 +0200 | [diff] [blame] | 5301 | |
| 5302 | /** |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5303 | * \brief Initialize an SSL configuration context |
| 5304 | * Just makes the context ready for |
Manuel Pégourié-Gonnard | 1b1e65f | 2015-06-11 13:29:15 +0200 | [diff] [blame] | 5305 | * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free(). |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5306 | * |
| 5307 | * \note You need to call mbedtls_ssl_config_defaults() unless you |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 5308 | * manually set all of the relevant fields yourself. |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5309 | * |
| 5310 | * \param conf SSL configuration context |
| 5311 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5312 | void mbedtls_ssl_config_init(mbedtls_ssl_config *conf); |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5313 | |
| 5314 | /** |
Adam Wolf | 039080f | 2019-09-10 09:53:08 -0500 | [diff] [blame] | 5315 | * \brief Load reasonable default SSL configuration values. |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5316 | * (You need to call mbedtls_ssl_config_init() first.) |
| 5317 | * |
| 5318 | * \param conf SSL configuration context |
Manuel Pégourié-Gonnard | 1b1e65f | 2015-06-11 13:29:15 +0200 | [diff] [blame] | 5319 | * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER |
| 5320 | * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or |
| 5321 | * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS |
Manuel Pégourié-Gonnard | b31c5f6 | 2015-06-17 13:53:47 +0200 | [diff] [blame] | 5322 | * \param preset a MBEDTLS_SSL_PRESET_XXX value |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5323 | * |
Manuel Pégourié-Gonnard | 6729e79 | 2015-05-11 09:50:24 +0200 | [diff] [blame] | 5324 | * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS. |
Manuel Pégourié-Gonnard | 8620f73 | 2015-05-06 14:42:06 +0100 | [diff] [blame] | 5325 | * |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5326 | * \return 0 if successful, or |
Manuel Pégourié-Gonnard | 1b1e65f | 2015-06-11 13:29:15 +0200 | [diff] [blame] | 5327 | * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error. |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5328 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5329 | int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf, |
| 5330 | int endpoint, int transport, int preset); |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5331 | |
| 5332 | /** |
| 5333 | * \brief Free an SSL configuration context |
| 5334 | * |
| 5335 | * \param conf SSL configuration context |
| 5336 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5337 | void mbedtls_ssl_config_free(mbedtls_ssl_config *conf); |
Manuel Pégourié-Gonnard | cd523e2 | 2015-05-04 13:35:39 +0200 | [diff] [blame] | 5338 | |
| 5339 | /** |
Paul Bakker | accaffe | 2014-06-26 13:37:14 +0200 | [diff] [blame] | 5340 | * \brief Initialize SSL session structure |
| 5341 | * |
| 5342 | * \param session SSL session |
| 5343 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5344 | void mbedtls_ssl_session_init(mbedtls_ssl_session *session); |
Paul Bakker | accaffe | 2014-06-26 13:37:14 +0200 | [diff] [blame] | 5345 | |
| 5346 | /** |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 5347 | * \brief Free referenced items in an SSL session including the |
| 5348 | * peer certificate and clear memory |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 5349 | * |
Ron Eldor | 0011503 | 2018-07-17 11:21:50 +0300 | [diff] [blame] | 5350 | * \note A session object can be freed even if the SSL context |
| 5351 | * that was used to retrieve the session is still in use. |
| 5352 | * |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 5353 | * \param session SSL session |
| 5354 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5355 | void mbedtls_ssl_session_free(mbedtls_ssl_session *session); |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 5356 | |
Ron Eldor | 51d3ab5 | 2019-05-12 14:54:30 +0300 | [diff] [blame] | 5357 | /** |
| 5358 | * \brief TLS-PRF function for key derivation. |
| 5359 | * |
Tobias Nießen | 1e8ca12 | 2021-05-10 19:53:15 +0200 | [diff] [blame] | 5360 | * \param prf The tls_prf type function type to be used. |
Ron Eldor | 51d3ab5 | 2019-05-12 14:54:30 +0300 | [diff] [blame] | 5361 | * \param secret Secret for the key derivation function. |
| 5362 | * \param slen Length of the secret. |
| 5363 | * \param label String label for the key derivation function, |
| 5364 | * terminated with null character. |
| 5365 | * \param random Random bytes. |
| 5366 | * \param rlen Length of the random bytes buffer. |
| 5367 | * \param dstbuf The buffer holding the derived key. |
| 5368 | * \param dlen Length of the output buffer. |
| 5369 | * |
Tobias Nießen | 1e8ca12 | 2021-05-10 19:53:15 +0200 | [diff] [blame] | 5370 | * \return 0 on success. An SSL specific error on failure. |
Ron Eldor | 51d3ab5 | 2019-05-12 14:54:30 +0300 | [diff] [blame] | 5371 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 5372 | int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf, |
| 5373 | const unsigned char *secret, size_t slen, |
| 5374 | const char *label, |
| 5375 | const unsigned char *random, size_t rlen, |
| 5376 | unsigned char *dstbuf, size_t dlen); |
Ron Eldor | 51d3ab5 | 2019-05-12 14:54:30 +0300 | [diff] [blame] | 5377 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 5378 | #ifdef __cplusplus |
| 5379 | } |
| 5380 | #endif |
| 5381 | |
| 5382 | #endif /* ssl.h */ |