1Mbed TLS ChangeLog (Sorted per branch, date)
2
3= Mbed TLS 3.6.2 branch released 2024-10-14
4
5Security
6   * Fix a buffer underrun in mbedtls_pk_write_key_der() when
7     called on an opaque key, MBEDTLS_USE_PSA_CRYPTO is enabled,
8     and the output buffer is smaller than the actual output.
9     Fix a related buffer underrun in mbedtls_pk_write_key_pem()
10     when called on an opaque RSA key, MBEDTLS_USE_PSA_CRYPTO is enabled
11     and MBEDTLS_MPI_MAX_SIZE is smaller than needed for a 4096-bit RSA key.
12     CVE-2024-49195
13
14= Mbed TLS 3.6.1 branch released 2024-08-30
15
16API changes
17   * The experimental functions psa_generate_key_ext() and
18     psa_key_derivation_output_key_ext() are no longer declared when compiling
19     in C++. This resolves a build failure under C++ compilers that do not
20     support flexible array members (a C99 feature not adopted by C++).
21     Fixes #9020.
22
23Default behavior changes
24   * In a PSA-client-only build (i.e. MBEDTLS_PSA_CRYPTO_CLIENT &&
25     !MBEDTLS_PSA_CRYPTO_C), do not automatically enable local crypto when the
26     corresponding PSA mechanism is enabled, since the server provides the
27     crypto. Fixes #9126.
28   * A TLS handshake may now call psa_crypto_init() if TLS 1.3 is enabled.
29     This can happen even if TLS 1.3 is offered but eventually not selected
30     in the protocol version negotiation.
31   * By default, the handling of TLS 1.3 tickets by the Mbed TLS client is now
32     disabled at runtime. Applications that were using TLS 1.3 tickets
33     signalled by MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET return values now
34     need to enable the handling of TLS 1.3 tickets through the new
35     mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets() API.
36
37New deprecations
38   * The experimental functions psa_generate_key_ext() and
39     psa_key_derivation_output_key_ext() are deprecated in favor of
40     psa_generate_key_custom() and psa_key_derivation_output_key_custom().
41     They have almost exactly the same interface, but the variable-length
42     data is passed in a separate parameter instead of a flexible array
43     member.
44   * The following cryptographic mechanisms are planned to be removed
45     in Mbed TLS 4.0:
46     - DES (including 3DES).
47     - PKCS#1v1.5 encryption/decryption (RSAES-PKCS1-v1_5).
48       (OAEP, PSS, and PKCS#1v1.5 signature are staying.)
49     - Finite-field Diffie-Hellman with custom groups.
50       (RFC 7919 groups remain supported.)
51     - Elliptic curves of size 225 bits or less.
52   * The following cipher suites are planned to be removed from (D)TLS 1.2
53     in Mbed TLS 4.0:
54     - TLS_RSA_* (including TLS_RSA_PSK_*), i.e. cipher suites using
55       RSA decryption.
56       (RSA signatures, i.e. TLS_ECDHE_RSA_*, are staying.)
57     - TLS_ECDH_*, i.e. cipher suites using static ECDH.
58       (Ephemeral ECDH, i.e. TLS_ECDHE_*, is staying.)
59     - TLS_DHE_*, i.e. cipher suites using finite-field Diffie-Hellman.
60       (Ephemeral ECDH, i.e. TLS_ECDHE_*, is staying.)
61     - TLS_*CBC*, i.e. all cipher suites using CBC.
62   * The following low-level application interfaces are planned to be removed
63     from the public API in Mbed TLS 4.0:
64     - Hashes: hkdf.h, md5.h, ripemd160.h, sha1.h, sha3.h, sha256.h, sha512.h;
65     - Random generation: ctr_drbg.h, hmac_drbg.h, entropy.h;
66     - Ciphers and modes: aes.h, aria.h, camellia.h, chacha20.h, chachapoly.h,
67       cipher.h, cmac.h, gcm.h, poly1305.h;
68     - Private key encryption mechanisms: pkcs5.h, pkcs12.h.
69     - Asymmetric cryptography: bignum.h, dhm.h, ecdh.h, ecdsa.h, ecjpake.h,
70       ecp.h, rsa.h.
71     The cryptographic mechanisms remain present, but they will only be
72     accessible via the PSA API (psa_xxx functions introduced gradually
73     starting with Mbed TLS 2.17) and, where relevant, `pk.h`.
74     For guidance on migrating application code to the PSA API, please consult
75     the PSA transition guide (docs/psa-transition.md).
76   * The following integration interfaces are planned to be removed
77     in Mbed TLS 4.0:
78     - MBEDTLS_xxx_ALT replacement of cryptographic modules and functions.
79       Use PSA transparent drivers instead.
80     - MBEDTLS_PK_RSA_ALT and MBEDTLS_PSA_CRYPTO_SE_C.
81       Use PSA opaque drivers instead.
82
83Features
84   * When the new compilation option MBEDTLS_PSA_KEY_STORE_DYNAMIC is enabled,
85     the number of volatile PSA keys is virtually unlimited, at the expense
86     of increased code size. This option is off by default, but enabled in
87     the default mbedtls_config.h. Fixes #9216.
88
89Security
90   * Unlike previously documented, enabling MBEDTLS_PSA_HMAC_DRBG_MD_TYPE does
91     not cause the PSA subsystem to use HMAC_DRBG: it uses HMAC_DRBG only when
92     MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG and MBEDTLS_CTR_DRBG_C are disabled.
93     CVE-2024-45157
94   * Fix a stack buffer overflow in mbedtls_ecdsa_der_to_raw() and
95     mbedtls_ecdsa_raw_to_der() when the bits parameter is larger than the
96     largest supported curve. In some configurations with PSA disabled,
97     all values of bits are affected. This never happens in internal library
98     calls, but can affect applications that call these functions directly.
99     CVE-2024-45158
100   * With TLS 1.3, when a server enables optional authentication of the
101     client, if the client-provided certificate does not have appropriate values
102     in keyUsage or extKeyUsage extensions, then the return value of
103     mbedtls_ssl_get_verify_result() would incorrectly have the
104     MBEDTLS_X509_BADCERT_KEY_USAGE and MBEDTLS_X509_BADCERT_EXT_KEY_USAGE bits
105     clear. As a result, an attacker that had a certificate valid for uses other
106     than TLS client authentication could be able to use it for TLS client
107     authentication anyway. Only TLS 1.3 servers were affected, and only with
108     optional authentication (required would abort the handshake with a fatal
109     alert).
110     CVE-2024-45159
111
112Bugfix
113   * Fix TLS 1.3 client build and runtime when support for session tickets is
114     disabled (MBEDTLS_SSL_SESSION_TICKETS configuration option). Fixes #6395.
115   * Fix compilation error when memcpy() is a function-like macros. Fixes #8994.
116   * MBEDTLS_ASN1_PARSE_C and MBEDTLS_ASN1_WRITE_C are now automatically enabled
117     as soon as MBEDTLS_RSA_C is enabled. Fixes #9041.
118   * Fix undefined behaviour (incrementing a NULL pointer by zero length) when
119     passing in zero length additional data to multipart AEAD.
120   * Fix rare concurrent access bug where attempting to operate on a
121     non-existent key while concurrently creating a new key could potentially
122     corrupt the key store.
123   * Fix error handling when creating a key in a dynamic secure element
124     (feature enabled by MBEDTLS_PSA_CRYPTO_SE_C). In a low memory condition,
125     the creation could return PSA_SUCCESS but using or destroying the key
126     would not work. Fixes #8537.
127   * Fix issue of redefinition warning messages for _GNU_SOURCE in
128     entropy_poll.c and sha_256.c. There was a build warning during
129     building for linux platform.
130     Resolves #9026
131   * Fix a compilation warning in pk.c when PSA is enabled and RSA is disabled.
132   * Fix the build when MBEDTLS_PSA_CRYPTO_CONFIG is enabled and the built-in
133     CMAC is enabled, but no built-in unauthenticated cipher is enabled.
134     Fixes #9209.
135   * Fix redefinition warnings when SECP192R1 and/or SECP192K1 are disabled.
136     Fixes #9029.
137   * Fix psa_cipher_decrypt() with CCM* rejecting messages less than 3 bytes
138     long. Credit to Cryptofuzz. Fixes #9314.
139   * Fix interference between PSA volatile keys and built-in keys
140     when MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS is enabled and
141     MBEDTLS_PSA_KEY_SLOT_COUNT is more than 4096.
142   * Document and enforce the limitation of mbedtls_psa_register_se_key()
143     to persistent keys. Resolves #9253.
144   * Fix Clang compilation error when MBEDTLS_USE_PSA_CRYPTO is enabled
145     but MBEDTLS_DHM_C is disabled. Reported by Michael Schuster in #9188.
146   * Fix server mode only build when MBEDTLS_SSL_SRV_C is enabled but
147     MBEDTLS_SSL_CLI_C is disabled. Reported by M-Bab on GitHub in #9186.
148   * When MBEDTLS_PSA_CRYPTO_C was disabled and MBEDTLS_ECDSA_C enabled,
149     some code was defining 0-size arrays, resulting in compilation errors.
150     Fixed by disabling the offending code in configurations without PSA
151     Crypto, where it never worked. Fixes #9311.
152   * Fix unintended performance regression when using short RSA public keys.
153     Fixes #9232.
154   * Fixes an issue where some TLS 1.2 clients could not connect to an
155     Mbed TLS 3.6.0 server, due to incorrect handling of
156     legacy_compression_methods in the ClientHello.
157     Fixes #8995, #9243.
158   * Fix TLS connections failing when the handshake selects TLS 1.3
159     in an application that does not call psa_crypto_init().
160     Fixes #9072.
161   * Fix TLS connection failure in applications using an Mbed TLS client in
162     the default configuration connecting to a TLS 1.3 server sending tickets.
163     See the documentation of
164     mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets() for more
165     information.
166     Fixes #8749.
167   * Fix a memory leak that could occur when failing to process an RSA
168     key through some PSA functions due to low memory conditions.
169   * Fixed a regression introduced in 3.6.0 where the CA callback set with
170     mbedtls_ssl_conf_ca_cb() would stop working when connections were
171     upgraded to TLS 1.3. Fixed by adding support for the CA callback with TLS
172     1.3.
173   * Fixed a regression introduced in 3.6.0 where clients that relied on
174     optional/none authentication mode, by calling mbedtls_ssl_conf_authmode()
175     with MBEDTLS_SSL_VERIFY_OPTIONAL or MBEDTLS_SSL_VERIFY_NONE, would stop
176     working when connections were upgraded to TLS 1.3. Fixed by adding
177     support for optional/none with TLS 1.3 as well. Note that the TLS 1.3
178     standard makes server authentication mandatory; users are advised not to
179     use authmode none, and to carefully check the results when using optional
180     mode.
181   * Fixed a regression introduced in 3.6.0 where context-specific certificate
182     verify callbacks, set with mbedtls_ssl_set_verify() as opposed to
183     mbedtls_ssl_conf_verify(), would stop working when connections were
184     upgraded to TLS 1.3. Fixed by adding support for context-specific verify
185     callback in TLS 1.3.
186
187Changes
188   * Warn if mbedtls/check_config.h is included manually, as this can
189     lead to spurious errors. Error if a *adjust*.h header is included
190     manually, as this can lead to silently inconsistent configurations,
191     potentially resulting in buffer overflows.
192     When migrating from Mbed TLS 2.x, if you had a custom config.h that
193     included check_config.h, remove this inclusion from the Mbed TLS 3.x
194     configuration file (renamed to mbedtls_config.h). This change was made
195     in Mbed TLS 3.0, but was not announced in a changelog entry at the time.
196
197= Mbed TLS 3.6.0 branch released 2024-03-28
198
199API changes
200   * Remove `tls13_` in mbedtls_ssl_tls13_conf_early_data() and
201     mbedtls_ssl_tls13_conf_max_early_data_size() API names. Early data
202     feature may not be TLS 1.3 specific in the future. Fixes #6909.
203
204Default behavior changes
205   * psa_import_key() now only accepts RSA keys in the PSA standard formats.
206     The undocumented ability to import other formats (PKCS#8, SubjectPublicKey,
207     PEM) accepted by the pkparse module has been removed. Applications that
208     need these formats can call mbedtls_pk_parse_{public,}key() followed by
209     mbedtls_pk_import_into_psa().
210
211Requirement changes
212   * Drop support for Visual Studio 2013 and 2015, and Arm Compiler 5.
213
214New deprecations
215   * Rename the MBEDTLS_SHA256_USE_A64_CRYPTO_xxx config options to
216     MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_xxx. The old names may still
217     be used, but are deprecated.
218   * In the PSA API, domain parameters are no longer used for anything.
219     They are deprecated and will be removed in a future version of the
220     library.
221   * mbedtls_ecp_write_key() is deprecated in favor of
222     mbedtls_ecp_write_key_ext().
223
224Removals
225   * In the PSA API, the experimental way to encode the public exponent of
226     an RSA key as a domain parameter is no longer supported. Use
227     psa_generate_key_ext() instead.
228   * Temporary function mbedtls_pk_wrap_as_opaque() is removed. To mimic the
229     same behavior mbedtls_pk_get_psa_attributes() and
230     mbedtls_pk_import_into_psa() can be used to import a PK key into PSA,
231     while mbedtls_pk_setup_opaque() can be used to wrap a PSA key into a opaque
232     PK context.
233
234Features
235   * Added an example program showing how to hash with the PSA API.
236   * Support Armv8-A Crypto Extension acceleration for SHA-256
237     when compiling for Thumb (T32) or 32-bit Arm (A32).
238   * AES-NI is now supported in Windows builds with clang and clang-cl.
239     Resolves #8372.
240   * Add new mbedtls_x509_csr_parse_der_with_ext_cb() routine which allows
241     parsing unsupported certificate extensions via user provided callback.
242   * Enable the new option MBEDTLS_BLOCK_CIPHER_NO_DECRYPT to omit
243     the decryption direction of block ciphers (AES, ARIA, Camellia).
244     This affects both the low-level modules and the high-level APIs
245     (the cipher and PSA interfaces). This option is incompatible with modes
246     that use the decryption direction (ECB in PSA, CBC, XTS, KW) and with DES.
247   * Support use of Armv8-A Cryptographic Extensions for hardware acclerated
248     AES when compiling for Thumb (T32) or 32-bit Arm (A32).
249   * If a cipher or AEAD mechanism has a PSA driver, you can now build the
250     library without the corresponding built-in implementation. Generally
251     speaking that requires both the key type and algorithm to be accelerated
252     or they'll both be built in. However, for CCM and GCM the built-in
253     implementation is able to take advantage of a driver that only
254     accelerates the key type (that is, the block cipher primitive). See
255     docs/driver-only-builds.md for full details and current limitations.
256   * The CTR_DRBG module will now use AES from a PSA driver if MBEDTLS_AES_C is
257     disabled. This requires PSA_WANT_ALG_ECB_NO_PADDING in addition to
258     MBEDTLS_PSA_CRYPTO_C and PSA_WANT_KEY_TYPE_AES.
259   * Fewer modules depend on MBEDTLS_CIPHER_C, making it possible to save code
260     size by disabling it in more circumstances. In particular, the CCM and
261     GCM modules no longer depend on MBEDTLS_CIPHER_C. Also,
262     MBEDTLS_PSA_CRYPTO can now be enabled without MBEDTLS_CIPHER_C if all
263     unauthenticated (non-AEAD) ciphers are disabled, or if they're all
264     fully provided by drivers. See docs/driver-only-builds.md for full
265     details and current limitations; in particular, NIST_KW and PKCS5/PKCS12
266     decryption still unconditionally depend on MBEDTLS_CIPHER_C.
267   * Add support for record size limit extension as defined by RFC 8449
268     and configured with MBEDTLS_SSL_RECORD_SIZE_LIMIT.
269     Application data sent and received will be fragmented according to
270     Record size limits negotiated during handshake.
271   * Improve performance of AES-GCM, AES-CTR and CTR-DRBG when
272     hardware accelerated AES is not present (around 13-23% on 64-bit Arm).
273   * Add functions mbedtls_ecc_group_to_psa() and mbedtls_ecc_group_from_psa()
274     to convert between Mbed TLS and PSA curve identifiers.
275   * Add utility functions to manipulate mbedtls_ecp_keypair objects, filling
276     gaps made by making its fields private: mbedtls_ecp_set_public_key(),
277     mbedtls_ecp_write_public_key(), mbedtls_ecp_keypair_calc_public(),
278     mbedtls_ecp_keypair_get_group_id(). Fixes #5017, #5441, #8367, #8652.
279   * Add functions mbedtls_md_psa_alg_from_type() and
280     mbedtls_md_type_from_psa_alg() to convert between mbedtls_md_type_t and
281     psa_algorithm_t.
282   * Add partial platform support for z/OS.
283   * Improve performance for gcc (versions older than 9.3.0) and IAR.
284   * Add functions mbedtls_ecdsa_raw_to_der() and mbedtls_ecdsa_der_to_raw() to
285     convert ECDSA signatures between raw and DER (ASN.1) formats.
286   * Add support for using AES-CBC 128, 192, and 256 bit schemes
287     with PKCS#5 PBES2. Keys encrypted this way can now be parsed by PK parse.
288   * The new function mbedtls_rsa_get_bitlen() returns the length of the modulus
289     in bits, i.e. the key size for an RSA key.
290   * Add pc files for pkg-config, e.g.:
291     pkg-config --cflags --libs (mbedtls|mbedcrypto|mbedx509)
292   * Add getter (mbedtls_ssl_session_get_ticket_creation_time()) to access
293     `mbedtls_ssl_session.ticket_creation_time`.
294   * The new functions mbedtls_pk_get_psa_attributes() and
295     mbedtls_pk_import_into_psa() provide a uniform way to create a PSA
296     key from a PK key.
297   * The benchmark program now reports times for both ephemeral and static
298     ECDH in all ECDH configurations.
299   * Add support for 8-bit GCM tables for Shoup's algorithm to speedup GCM
300     operations when hardware accelerated AES is not present. Improves
301     performance by around 30% on 64-bit Intel; 125% on Armv7-M.
302   * The new function psa_generate_key_ext() allows generating an RSA
303     key pair with a custom public exponent.
304   * The new function mbedtls_ecp_write_key_ext() is similar to
305     mbedtls_ecp_write_key(), but can be used without separately calculating
306     the output length.
307   * Add new accessor to expose the private group id member of
308     `mbedtls_ecdh_context` structure.
309   * Add new accessor to expose the `MBEDTLS_PRIVATE(ca_istrue)` member of
310     `mbedtls_x509_crt` structure. This requires setting
311     the MBEDTLS_X509_EXT_BASIC_CONSTRAINTS bit in the certificate's
312     ext_types field.
313   * mbedtls_psa_get_random() is always available as soon as
314     MBEDTLS_PSA_CRYPTO_CLIENT is enabled at build time and psa_crypto_init() is
315     called at runtime. This together with MBEDTLS_PSA_RANDOM_STATE can be
316     used as random number generator function (f_rng) and context (p_rng) in
317     legacy functions.
318   * The new functions mbedtls_pk_copy_from_psa() and
319     mbedtls_pk_copy_public_from_psa() provide ways to set up a PK context
320     with the same content as a PSA key.
321   * Add new accessors to expose the private session-id,
322     session-id length, and ciphersuite-id members of
323     `mbedtls_ssl_session` structure.
324     Add new accessor to expose the ciphersuite-id of
325     `mbedtls_ssl_ciphersuite_t` structure.Design ref: #8529
326   * Mbed TLS now supports the writing and reading of TLS 1.3 early data (see
327     docs/tls13-early-data.md). The support enablement is controlled at build
328     time by the MBEDTLS_SSL_EARLY_DATA configuration option and at runtime by
329     the mbedtls_ssl_conf_early_data() API (by default disabled in both cases).
330   * Add protection for multithreaded access to the PSA keystore and protection
331     for multithreaded access to the the PSA global state, including
332     concurrently calling psa_crypto_init() when MBEDTLS_THREADING_C and
333     MBEDTLS_THREADING_PTHREAD are defined. See
334     docs/architecture/psa-thread-safety/psa-thread-safety.md for more details.
335     Resolves issues #3263 and #7945.
336
337Security
338   * Fix a stack buffer overread (less than 256 bytes) when parsing a TLS 1.3
339     ClientHello in a TLS 1.3 server supporting some PSK key exchange mode. A
340     malicious client could cause information disclosure or a denial of service.
341     Fixes CVE-2024-30166.
342   * Passing buffers that are stored in untrusted memory as arguments
343     to PSA functions is now secure by default.
344     The PSA core now protects against modification of inputs or exposure
345     of intermediate outputs during operations. This is currently implemented
346     by copying buffers.
347     This feature increases code size and memory usage. If buffers passed to
348     PSA functions are owned exclusively by the PSA core for the duration of
349     the function call (i.e. no buffer parameters are in shared memory),
350     copying may be disabled by setting MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS.
351     Note that setting this option will cause input-output buffer overlap to
352     be only partially supported (#3266).
353     Fixes CVE-2024-28960.
354   * Restore the maximum TLS version to be negotiated to the configured one
355     when an SSL context is reset with the mbedtls_ssl_session_reset() API.
356     An attacker was able to prevent an Mbed TLS server from establishing any
357     TLS 1.3 connection potentially resulting in a Denial of Service or forced
358     version downgrade from TLS 1.3 to TLS 1.2. Fixes #8654 reported by hey3e.
359     Fixes CVE-2024-28755.
360   * When negotiating TLS version on server side, do not fall back to the
361     TLS 1.2 implementation of the protocol if it is disabled.
362     - If the TLS 1.2 implementation was disabled at build time, a TLS 1.2
363       client could put the TLS 1.3-only server in an infinite loop processing
364       a TLS 1.2 ClientHello, resulting in a denial of service. Reported by
365       Matthias Mucha and Thomas Blattmann, SICK AG.
366     - If the TLS 1.2 implementation was disabled at runtime, a TLS 1.2 client
367       was able to successfully establish a TLS 1.2 connection with the server.
368       Reported by alluettiv on GitHub.
369    Fixes CVE-2024-28836.
370
371Bugfix
372   * Fix the build with CMake when Everest or P256-m is enabled through
373     a user configuration file or the compiler command line. Fixes #8165.
374   * Fix compilation error in C++ programs when MBEDTLS_ASN1_PARSE_C is
375     disabled.
376   * Fix possible NULL dereference issue in X509 cert_req program if an entry
377     in the san parameter is not separated by a colon.
378   * Fix possible NULL dereference issue in X509 cert_write program if an entry
379     in the san parameter is not separated by a colon.
380   * Fix an inconsistency between implementations and usages of `__cpuid`,
381     which mainly causes failures when building Windows target using
382     mingw or clang. Fixes #8334 & #8332.
383   * Fix build failure in conda-forge.  Fixes #8422.
384   * Fix parsing of CSRs with critical extensions.
385   * Switch to milliseconds as the unit for ticket creation and reception time
386     instead of seconds. That avoids rounding errors when computing the age of
387     tickets compared to peer using a millisecond clock (observed with GnuTLS).
388     Fixes #6623.
389   * Fix TLS server accepting TLS 1.2 handshake while TLS 1.2
390     is disabled at runtime. Fixes #8593.
391   * Remove accidental introduction of RSA signature algorithms
392     in TLS Suite B Profile. Fixes #8221.
393   * Fix unsupported PSA asymmetric encryption and decryption
394     (psa_asymmetric_[en|de]crypt) with opaque keys.
395     Resolves #8461.
396   * On Linux on ARMv8, fix a build error with SHA-256 and SHA-512
397     acceleration detection when the libc headers do not define the
398     corresponding constant. Reported by valord577.
399   * Correct initial capacities for key derivation algorithms:TLS12_PRF,
400     TLS12_PSK_TO_MS, PBKDF2-HMAC, PBKDF2-CMAC
401   * Fix mbedtls_pk_get_bitlen() for RSA keys whose size is not a
402     multiple of 8. Fixes #868.
403   * Avoid segmentation fault caused by releasing not initialized
404     entropy resource in gen_key example. Fixes #8809.
405   * mbedtls_pem_read_buffer() now performs a check on the padding data of
406     decrypted keys and it rejects invalid ones.
407   * Fix mbedtls_pk_sign(), mbedtls_pk_verify(), mbedtls_pk_decrypt() and
408     mbedtls_pk_encrypt() on non-opaque RSA keys to honor the padding mode in
409     the RSA context. Before, if MBEDTLS_USE_PSA_CRYPTO was enabled and the
410     RSA context was configured for PKCS#1 v2.1 (PSS/OAEP), the sign/verify
411     functions performed a PKCS#1 v1.5 signature instead and the
412     encrypt/decrypt functions returned an error. Fixes #8824.
413   * Fix missing bitflags in SSL session serialization headers. Their absence
414     allowed SSL sessions saved in one configuration to be loaded in a
415     different, incompatible configuration.
416   * In TLS 1.3 clients, fix an interoperability problem due to the client
417     generating a new random after a HelloRetryRequest. Fixes #8669.
418   * Fix the restoration of the ALPN when loading serialized connection with
419     the mbedtls_ssl_context_load() API.
420   * Fix NULL pointer dereference in mbedtls_pk_verify_ext() when called using
421     an opaque RSA context and specifying MBEDTLS_PK_RSASSA_PSS as key type.
422   * Fix RSA opaque keys always using PKCS1 v1.5 algorithms instead of the
423     primary algorithm of the wrapped PSA key.
424   * Fully support arbitrary overlap between inputs and outputs of PSA
425     functions. Note that overlap is still only partially supported when
426     MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS is set (#3266).
427
428Changes
429   * Use heap memory to allocate DER encoded public/private key.
430     This reduces stack usage significantly for writing a public/private
431     key to a PEM string.
432   * PSA_WANT_ALG_CCM and PSA_WANT_ALG_CCM_STAR_NO_TAG are no more synonyms and
433     they are now treated separately. This means that they should be
434     individually enabled in order to enable respective support; also the
435     corresponding MBEDTLS_PSA_ACCEL symbol should be defined in case
436     acceleration is required.
437   * Moved declaration of functions mbedtls_ecc_group_to_psa and
438     mbedtls_ecc_group_of_psa from psa/crypto_extra.h to mbedtls/psa_util.h
439   * mbedtls_pk_sign_ext() is now always available, not just when
440     PSA (MBEDTLS_PSA_CRYPTO_C) is enabled.
441   * Extended PSA Crypto configurations options for FFDH by making it possible
442     to select only some of the parameters / groups, with the macros
443     PSA_WANT_DH_RFC7919_XXXX. You now need to defined the corresponding macro
444     for each size you want to support. Also, if you have an FFDH accelerator,
445     you'll need to define the appropriate MBEDTLS_PSA_ACCEL macros to signal
446     support for these domain parameters.
447   * RSA support in PSA no longer auto-enables the pkparse and pkwrite modules,
448     saving code size when those are not otherwise enabled.
449   * mbedtls_mpi_exp_mod and code that uses it, notably RSA and DHM operations,
450     have changed their speed/memory compromise as part of a proactive security
451     improvement. The new default value of MBEDTLS_MPI_WINDOW_SIZE roughly
452     preserves the current speed, at the expense of increasing memory
453     consumption.
454   * Rename directory containing Visual Studio files from visualc/VS2013 to
455     visualc/VS2017.
456   * The TLS 1.3 protocol is now enabled in the default configuration.
457
458= Mbed TLS 3.5.2 branch released 2024-01-26
459
460Security
461   * Fix a timing side channel in private key RSA operations. This side channel
462     could be sufficient for an attacker to recover the plaintext. A local
463     attacker or a remote attacker who is close to the victim on the network
464     might have precise enough timing measurements to exploit this. It requires
465     the attacker to send a large number of messages for decryption. For
466     details, see "Everlasting ROBOT: the Marvin Attack", Hubert Kario. Reported
467     by Hubert Kario, Red Hat.
468   * Fix a failure to validate input when writing x509 extensions lengths which
469     could result in an integer overflow, causing a zero-length buffer to be
470     allocated to hold the extension. The extension would then be copied into
471     the buffer, causing a heap buffer overflow.
472
473= Mbed TLS 3.5.1 branch released 2023-11-06
474
475Changes
476   *  Mbed TLS is now released under a dual Apache-2.0 OR GPL-2.0-or-later
477      license. Users may choose which license they take the code under.
478
479Bugfix
480   * Fix accidental omission of MBEDTLS_TARGET_PREFIX in 3rdparty modules
481     in CMake.
482
483= Mbed TLS 3.5.0 branch released 2023-10-05
484
485API changes
486   * Mbed TLS 3.4 introduced support for omitting the built-in implementation
487     of ECDSA and/or EC J-PAKE when those are provided by a driver. However,
488     there was a flaw in the logic checking if the built-in implementation, in
489     that it failed to check if all the relevant curves were supported by the
490     accelerator. As a result, it was possible to declare no curves as
491     accelerated and still have the built-in implementation compiled out.
492     Starting with this release, it is necessary to declare which curves are
493     accelerated (using MBEDTLS_PSA_ACCEL_ECC_xxx macros), or they will be
494     considered not accelerated, and the built-in implementation of the curves
495     and any algorithm possible using them will be included in the build.
496   * Add new millisecond time type `mbedtls_ms_time_t` and `mbedtls_ms_time()`
497     function, needed for TLS 1.3 ticket lifetimes. Alternative implementations
498     can be created using an ALT interface.
499
500Requirement changes
501   * Officially require Python 3.8 now that earlier versions are out of support.
502   * Minimum required Windows version is now Windows Vista, or
503     Windows Server 2008.
504
505New deprecations
506   * PSA_WANT_KEY_TYPE_xxx_KEY_PAIR and
507     MBEDTLS_PSA_ACCEL_KEY_TYPE_xxx_KEY_PAIR, where xxx is either ECC or RSA,
508     are now being deprecated in favor of PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy and
509     MBEDTLS_PSA_ACCEL_KEY_TYPE_xxx_KEY_PAIR_yyy. Here yyy can be: BASIC,
510     IMPORT, EXPORT, GENERATE, DERIVE. The goal is to have a finer detail about
511     the capabilities of the PSA side for either key.
512   * MBEDTLS_CIPHER_BLKSIZE_MAX is deprecated in favor of
513     MBEDTLS_MAX_BLOCK_LENGTH (if you intended what the name suggests:
514     maximum size of any supported block cipher) or the new name
515     MBEDTLS_CMAC_MAX_BLOCK_SIZE (if you intended the actual semantics:
516     maximum size of a block cipher supported by the CMAC module).
517   * mbedtls_pkcs5_pbes2() and mbedtls_pkcs12_pbe() functions are now
518     deprecated in favor of mbedtls_pkcs5_pbes2_ext() and
519     mbedtls_pkcs12_pbe_ext() as they offer more security by checking
520     for overflow of the output buffer and reporting the actual length
521     of the output.
522
523Features
524   * All modules that use hashes or HMAC can now take advantage of PSA Crypto
525     drivers when MBEDTLS_PSA_CRYPTO_C is enabled and psa_crypto_init() has
526     been called. Previously (in 3.3), this was restricted to a few modules,
527     and only in builds where MBEDTLS_MD_C was disabled; in particular the
528     entropy module was not covered which meant an external RNG had to be
529     provided - these limitations are lifted in this version. A new set of
530     feature macros, MBEDTLS_MD_CAN_xxx, has been introduced that can be used
531     to check for availability of hash algorithms, regardless of whether
532     they're provided by a built-in implementation, a driver or both. See
533     docs/driver-only-builds.md.
534   * When a PSA driver for ECDH is present, it is now possible to disable
535     MBEDTLS_ECDH_C in the build in order to save code size. For TLS 1.2
536     key exchanges based on ECDH(E) to work, this requires
537     MBEDTLS_USE_PSA_CRYPTO. Restartable/interruptible ECDHE operations in
538     TLS 1.2 (ECDHE-ECDSA key exchange) are not supported in those builds yet,
539     as PSA does not have an API for restartable ECDH yet.
540   * When all of ECDH, ECDSA and EC J-PAKE are either disabled or provided by
541     a driver, it is possible to disable MBEDTLS_ECP_C (and MBEDTLS_BIGNUM_C
542     if not required by another module) and still get support for ECC keys and
543     algorithms in PSA, with some limitations. See docs/driver-only-builds.txt
544     for details.
545   * Add parsing of directoryName subtype for subjectAltName extension in
546     x509 certificates.
547   * Add support for server-side TLS version negotiation. If both TLS 1.2 and
548     TLS 1.3 protocols are enabled, the TLS server now selects TLS 1.2 or
549     TLS 1.3 depending on the capabilities and preferences of TLS clients.
550     Fixes #6867.
551   * X.509 hostname verification now supports IPAddress Subject Alternate Names.
552   * Add support for reading and writing X25519 and X448
553     public and private keys in RFC 8410 format using the existing PK APIs.
554   * When parsing X.509 certificates, support the extensions
555     SignatureKeyIdentifier and AuthorityKeyIdentifier.
556   * Don't include the PSA dispatch functions for PAKEs (psa_pake_setup() etc)
557     if no PAKE algorithms are requested
558   * Add support for the FFDH algorithm and DH key types in PSA, with
559     parameters from RFC 7919. This includes a built-in implementation based
560     on MBEDTLS_BIGNUM_C, and a driver dispatch layer enabling alternative
561     implementations of FFDH through the driver entry points.
562   * It is now possible to generate certificates with SubjectAltNames.
563     Currently supported subtypes: DnsName, UniformResourceIdentifier,
564     IP address, OtherName, and DirectoryName, as defined in RFC 5280.
565     See mbedtls_x509write_crt_set_subject_alternative_name for
566     more information.
567   * X.509 hostname verification now partially supports URI Subject Alternate
568     Names. Only exact matching, without any normalization procedures
569     described in 7.4 of RFC5280, will result in a positive URI verification.
570   * Add function mbedtls_oid_from_numeric_string() to parse an OID from a
571     string to a DER-encoded mbedtls_asn1_buf.
572   * Add SHA-3 family hash functions.
573   * Add support to restrict AES to 128-bit keys in order to save code size.
574     A new configuration option, MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH, can be
575     used to enable this feature.
576   * AES performance improvements. Uplift varies by platform,
577     toolchain, optimisation flags and mode.
578     Aarch64, gcc -Os and CCM, GCM and XTS benefit the most.
579     On Aarch64, uplift is typically around 20 - 110%.
580     When compiling with gcc -Os on Aarch64, AES-XTS improves
581     by 4.5x.
582   * Add support for PBKDF2-HMAC through the PSA API.
583   * New symbols PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy and
584     MBEDTLS_PSA_ACCEL_KEY_TYPE_xxx_KEY_PAIR_yyy (where xxx is either ECC, RSA
585     or DH) were introduced in order to have finer accuracy in defining the
586     PSA capabilities for each key. These capabilities, named yyy above, can be
587     any of: BASIC, IMPORT, EXPORT, GENERATE, DERIVE.
588     - DERIVE is only available for ECC keys, not for RSA or DH ones.
589     - implementations are free to enable more than what it was strictly
590       requested. For example BASIC internally enables IMPORT and EXPORT
591       (useful for testing purposes), but this might change in the future.
592   * Add support for FFDH key exchange in TLS 1.3.
593     This is automatically enabled as soon as PSA_WANT_ALG_FFDH
594     and the ephemeral or psk-ephemeral key exchange mode are enabled.
595     By default, all groups are offered; the list of groups can be
596     configured using the existing API function mbedtls_ssl_conf_groups().
597   * Improve mbedtls_x509_time performance and reduce memory use.
598   * Reduce syscalls to time() during certificate verification.
599   * Allow MBEDTLS_CONFIG_FILE and MBEDTLS_USER_CONFIG_FILE to be set by
600     setting the CMake variable of the same name at configuration time.
601   * Add getter (mbedtls_ssl_cache_get_timeout()) to access
602     `mbedtls_ssl_cache_context.timeout`.
603   * Add getter (mbedtls_ssl_get_hostname()) to access
604     `mbedtls_ssl_context.hostname`.
605   * Add getter (mbedtls_ssl_conf_get_endpoint()) to access
606     `mbedtls_ssl_config.endpoint`.
607   * Support for "opaque" (PSA-held) ECC keys in the PK module has been
608     extended: it is now possible to use mbedtls_pk_write_key_der(),
609     mbedtls_pk_write_key_pem(), mbedtls_pk_check_pair(), and
610     mbedtls_pk_verify() with opaque ECC keys (provided the PSA attributes
611     allow it).
612   * The documentation of mbedtls_ecp_group now describes the optimized
613     representation of A for some curves. Fixes #8045.
614   * Add a possibility to generate CSR's with RCF822 and directoryName subtype
615     of subjectAltName extension in x509 certificates.
616   * Add support for PBKDF2-CMAC through the PSA API.
617   * New configuration option MBEDTLS_AES_USE_HARDWARE_ONLY introduced. When
618     using CPU-accelerated AES (e.g., Arm Crypto Extensions), this option
619     disables the plain C implementation and the run-time detection for the
620     CPU feature, which reduces code size and avoids the vulnerability of the
621     plain C implementation.
622   * Accept arbitrary AttributeType and AttributeValue in certificate
623     Distinguished Names using RFC 4514 syntax.
624   * Applications using ECC over secp256r1 through the PSA API can use a
625     new implementation with a much smaller footprint, but some minor
626     usage restrictions. See the documentation of the new configuration
627     option MBEDTLS_PSA_P256M_DRIVER_ENABLED for details.
628
629Security
630   * Fix a case where potentially sensitive information held in memory would not
631     be completely zeroized during TLS 1.2 handshake, in both server and client
632     configurations.
633   * In configurations with ARIA or Camellia but not AES, the value of
634     MBEDTLS_CIPHER_BLKSIZE_MAX was 8, rather than 16 as the name might
635     suggest. This did not affect any library code, because this macro was
636     only used in relation with CMAC which does not support these ciphers.
637     This may affect application code that uses this macro.
638   * Developers using mbedtls_pkcs5_pbes2() or mbedtls_pkcs12_pbe() should
639     review the size of the output buffer passed to this function, and note
640     that the output after decryption may include CBC padding. Consider moving
641     to the new functions mbedtls_pkcs5_pbes2_ext() or mbedtls_pkcs12_pbe_ext()
642     which checks for overflow of the output buffer and reports the actual
643     length of the output.
644   * Improve padding calculations in CBC decryption, NIST key unwrapping and
645     RSA OAEP decryption. With the previous implementation, some compilers
646     (notably recent versions of Clang and IAR) could produce non-constant
647     time code, which could allow a padding oracle attack if the attacker
648     has access to precise timing measurements.
649   * Updates to constant-time C code so that compilers are less likely to use
650     conditional instructions, which can have an observable difference in
651     timing. (Clang has been seen to do this.) Also introduce assembly
652     implementations for 32- and 64-bit Arm and for x86 and x86-64, which are
653     guaranteed not to use conditional instructions.
654   * Fix definition of MBEDTLS_MD_MAX_BLOCK_SIZE, which was too
655     small when MBEDTLS_SHA384_C was defined and MBEDTLS_SHA512_C was
656     undefined. Mbed TLS itself was unaffected by this, but user code
657     which used MBEDTLS_MD_MAX_BLOCK_SIZE could be affected. The only
658     release containing this bug was Mbed TLS 3.4.0.
659   * Fix a buffer overread when parsing short TLS application data records in
660     null-cipher cipher suites. Credit to OSS-Fuzz.
661   * Fix a remotely exploitable heap buffer overflow in TLS handshake parsing.
662     In TLS 1.3, all configurations are affected except PSK-only ones, and
663     both clients and servers are affected.
664     In TLS 1.2, the affected configurations are those with
665     MBEDTLS_USE_PSA_CRYPTO and ECDH enabled but DHM and RSA disabled,
666     and only servers are affected, not clients.
667     Credit to OSS-Fuzz.
668
669Bugfix
670   * Fix proper sizing for PSA_EXPORT_[KEY_PAIR/PUBLIC_KEY]_MAX_SIZE and
671     PSA_SIGNATURE_MAX_SIZE buffers when at least one accelerated EC is bigger
672     than all built-in ones and RSA is disabled.
673     Resolves #6622.
674   * Add missing md.h includes to some of the external programs from
675     the programs directory. Without this, even though the configuration
676     was sufficient for a particular program to work, it would only print
677     a message that one of the required defines is missing.
678   * Fix declaration of mbedtls_ecdsa_sign_det_restartable() function
679     in the ecdsa.h header file. There was a build warning when the
680     configuration macro MBEDTLS_ECDSA_SIGN_ALT was defined.
681     Resolves #7407.
682   * Fix an error when MBEDTLS_ECDSA_SIGN_ALT is defined but not
683     MBEDTLS_ECDSA_VERIFY_ALT, causing ecdsa verify to fail. Fixes #7498.
684   * Fix missing PSA initialization in sample programs when
685     MBEDTLS_USE_PSA_CRYPTO is enabled.
686   * Fix the J-PAKE driver interface for user and peer to accept any values
687     (previously accepted values were limited to "client" or "server").
688   * Fix clang and armclang compilation error when targeting certain Arm
689     M-class CPUs (Cortex-M0, Cortex-M0+, Cortex-M1, Cortex-M23,
690     SecurCore SC000). Fixes #1077.
691   * Fix "unterminated '#pragma clang attribute push'" in sha256/sha512.c when
692     built with MBEDTLS_SHAxxx_USE_A64_CRYPTO_IF_PRESENT but don't have a
693     way to detect the crypto extensions required. A warning is still issued.
694   * Fixed an issue that caused compile errors when using CMake and the IAR
695     toolchain.
696   * Fix very high stack usage in SSL debug code. Reported by Maximilian
697     Gerhardt in #7804.
698   * Fix a compilation failure in the constant_time module when
699     building for arm64_32 (e.g., for watchos). Reported by Paulo
700     Coutinho in #7787.
701   * Fix crypt_and_hash decryption fail when used with a stream cipher
702     mode of operation due to the input not being multiple of block size.
703     Resolves #7417.
704   * Fix a bug in which mbedtls_x509_string_to_names() would return success
705     when given a invalid name string if it did not contain '=' or ','.
706   * Fix compilation warnings in aes.c, which prevented the
707     example TF-M configuration in configs/ from building cleanly:
708     tfm_mbedcrypto_config_profile_medium.h with
709     crypto_config_profile_medium.h.
710   * In TLS 1.3, fix handshake failure when a client in its ClientHello
711     proposes an handshake based on PSK only key exchange mode or at least
712     one of the key exchange modes using ephemeral keys to a server that
713     supports only the PSK key exchange mode.
714   * Fix CCM* with no tag being not supported in a build with CCM as the only
715     symmetric encryption algorithm and the PSA configuration enabled.
716   * Fix the build with MBEDTLS_PSA_INJECT_ENTROPY. Fixes #7516.
717   * Fix a compilation error on some platforms when including mbedtls/ssl.h
718     with all TLS support disabled. Fixes #6628.
719   * Fix x509 certificate generation to conform to RFC 5480 / RFC 5758 when
720     using ECC key. The certificate was rejected by some crypto frameworks.
721     Fixes #2924.
722   * Fix a potential corruption of the passed-in IV when mbedtls_aes_crypt_cbc()
723     is called with zero length and padlock is not enabled.
724   * Fix compile failure due to empty enum in cipher_wrap.c, when building
725     with a very minimal configuration. Fixes #7625.
726   * Fix some cases where mbedtls_mpi_mod_exp, RSA key construction or ECDSA
727     signature can silently return an incorrect result in low memory conditions.
728   * Don't try to include MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE when
729     MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
730   * Fix IAR compiler warnings.
731   * Fix an issue when parsing an otherName subject alternative name into a
732     mbedtls_x509_san_other_name struct. The type-id of the otherName was not
733     copied to the struct. This meant that the struct had incomplete
734     information about the otherName SAN and contained uninitialized memory.
735   * Fix the detection of HardwareModuleName otherName SANs. These were being
736     detected by comparing the wrong field and the check was erroneously
737     inverted.
738   * Fix a build error in some configurations with MBEDTLS_PSA_CRYPTO_CONFIG
739     enabled, where some low-level modules required by requested PSA crypto
740     features were not getting automatically enabled. Fixes #7420.
741   * Fix undefined symbols in some builds using TLS 1.3 with a custom
742     configuration file.
743   * Fix log level for the got supported group message. Fixes #6765
744   * Functions in the ssl_cache module now return a negative MBEDTLS_ERR_xxx
745     error code on failure. Before, they returned 1 to indicate failure in
746     some cases involving a missing entry or a full cache.
747   * mbedtls_pk_parse_key() now rejects trailing garbage in encrypted keys.
748   * Fix the build with CMake when Everest or P256-m is enabled through
749     a user configuration file or the compiler command line. Fixes #8165.
750
751Changes
752   * Enable Arm / Thumb bignum assembly for most Arm platforms when
753     compiling with gcc, clang or armclang and -O0.
754   * Enforce minimum RSA key size when generating a key
755     to avoid accidental misuse.
756   * Use heap memory to allocate DER encoded RSA private key.
757     This reduces stack usage significantly for RSA signature
758     operations when MBEDTLS_PSA_CRYPTO_C is defined.
759   * Update Windows code to use BCryptGenRandom and wcslen, and
760     ensure that conversions between size_t, ULONG, and int are
761     always done safely.  Original contribution by Kevin Kane #635, #730
762     followed by Simon Butcher #1453.
763   * Users integrating their own PSA drivers should be aware that
764     the file library/psa_crypto_driver_wrappers.c has been renamed
765     to psa_crypto_driver_wrappers_no_static.c.
766   * When using CBC with the cipher module, the requirement to call
767     mbedtls_cipher_set_padding_mode() is now enforced. Previously, omitting
768     this call accidentally applied a default padding mode chosen at compile
769     time.
770
771= Mbed TLS 3.4.1 branch released 2023-08-04
772
773Bugfix
774   * Fix builds on Windows with clang
775
776Changes
777   * Update test data to avoid failures of unit tests after 2023-08-07.
778
779= Mbed TLS 3.4.0 branch released 2023-03-28
780
781Default behavior changes
782   * The default priority order of TLS 1.3 cipher suites has been modified to
783     follow the same rules as the TLS 1.2 cipher suites (see
784     ssl_ciphersuites.c). The preferred cipher suite is now
785     TLS_CHACHA20_POLY1305_SHA256.
786
787New deprecations
788   * mbedtls_x509write_crt_set_serial() is now being deprecated in favor of
789     mbedtls_x509write_crt_set_serial_raw(). The goal here is to remove any
790     direct dependency of X509 on BIGNUM_C.
791   * PSA to mbedtls error translation is now unified in psa_util.h,
792     deprecating mbedtls_md_error_from_psa. Each file that performs error
793     translation should define its own version of PSA_TO_MBEDTLS_ERR,
794     optionally providing file-specific error pairs. Please see psa_util.h for
795     more details.
796
797Features
798   * Added partial support for parsing the PKCS #7 Cryptographic Message
799     Syntax, as defined in RFC 2315. Currently, support is limited to the
800     following:
801     - Only the signed-data content type, version 1 is supported.
802     - Only DER encoding is supported.
803     - Only a single digest algorithm per message is supported.
804     - Certificates must be in X.509 format. A message must have either 0
805       or 1 certificates.
806     - There is no support for certificate revocation lists.
807     - The authenticated and unauthenticated attribute fields of SignerInfo
808       must be empty.
809     Many thanks to Daniel Axtens, Nayna Jain, and Nick Child from IBM for
810     contributing this feature, and to Demi-Marie Obenour for contributing
811     various improvements, tests and bug fixes.
812   * General performance improvements by accessing multiple bytes at a time.
813     Fixes #1666.
814   * Improvements to use of unaligned and byte-swapped memory, reducing code
815     size and improving performance (depending on compiler and target
816     architecture).
817   * Add support for reading points in compressed format
818     (MBEDTLS_ECP_PF_COMPRESSED) with mbedtls_ecp_point_read_binary()
819     (and callers) for Short Weierstrass curves with prime p where p = 3 mod 4
820     (all mbedtls MBEDTLS_ECP_DP_SECP* and MBEDTLS_ECP_DP_BP* curves
821      except MBEDTLS_ECP_DP_SECP224R1 and MBEDTLS_ECP_DP_SECP224K1)
822   * SHA224_C/SHA384_C are now independent from SHA384_C/SHA512_C respectively.
823     This helps in saving code size when some of the above hashes are not
824     required.
825   * Add parsing of V3 extensions (key usage, Netscape cert-type,
826     Subject Alternative Names) in x509 Certificate Sign Requests.
827   * Use HOSTCC (if it is set) when compiling C code during generation of the
828     configuration-independent files. This allows them to be generated when
829     CC is set for cross compilation.
830   * Add parsing of uniformResourceIdentifier subtype for subjectAltName
831     extension in x509 certificates.
832   * Add an interruptible version of sign and verify hash to the PSA interface,
833     backed by internal library support for ECDSA signing and verification.
834   * Add parsing of rfc822Name subtype for subjectAltName
835     extension in x509 certificates.
836   * The configuration macros MBEDTLS_PSA_CRYPTO_PLATFORM_FILE and
837     MBEDTLS_PSA_CRYPTO_STRUCT_FILE specify alternative locations for
838     the headers "psa/crypto_platform.h" and "psa/crypto_struct.h".
839   * When a PSA driver for ECDSA is present, it is now possible to disable
840     MBEDTLS_ECDSA_C in the build in order to save code size. For PK, X.509
841     and TLS to fully work, this requires MBEDTLS_USE_PSA_CRYPTO to be enabled.
842     Restartable/interruptible ECDSA operations in PK, X.509 and TLS are not
843     supported in those builds yet, as driver support for interruptible ECDSA
844     operations is not present yet.
845   * Add a driver dispatch layer for EC J-PAKE, enabling alternative
846     implementations of EC J-PAKE through the driver entry points.
847   * Add new API mbedtls_ssl_cache_remove for cache entry removal by
848     its session id.
849   * Add support to include the SubjectAltName extension to a CSR.
850   * Add support for AES with the Armv8-A Cryptographic Extension on
851     64-bit Arm. A new configuration option, MBEDTLS_AESCE_C, can
852     be used to enable this feature. Run-time detection is supported
853     under Linux only.
854   * When a PSA driver for EC J-PAKE is present, it is now possible to disable
855     MBEDTLS_ECJPAKE_C in the build in order to save code size. For the
856     corresponding TLS 1.2 key exchange to work, MBEDTLS_USE_PSA_CRYPTO needs
857     to be enabled.
858   * Add functions mbedtls_rsa_get_padding_mode() and mbedtls_rsa_get_md_alg()
859     to read non-public fields for padding mode and hash id from
860     an mbedtls_rsa_context, as requested in #6917.
861   * AES-NI is now supported with Visual Studio.
862   * AES-NI is now supported in 32-bit builds, or when MBEDTLS_HAVE_ASM
863     is disabled, when compiling with GCC or Clang or a compatible compiler
864     for a target CPU that supports the requisite instructions (for example
865     gcc -m32 -msse2 -maes -mpclmul). (Generic x86 builds with GCC-like
866     compilers still require MBEDTLS_HAVE_ASM and a 64-bit target.)
867   * It is now possible to use a PSA-held (opaque) password with the TLS 1.2
868     ECJPAKE key exchange, using the new API function
869     mbedtls_ssl_set_hs_ecjpake_password_opaque().
870
871Security
872   * Use platform-provided secure zeroization function where possible, such as
873     explicit_bzero().
874   * Zeroize SSL cache entries when they are freed.
875   * Fix a potential heap buffer overread in TLS 1.3 client-side when
876     MBEDTLS_DEBUG_C is enabled. This may result in an application crash.
877   * Add support for AES with the Armv8-A Cryptographic Extension on 64-bit
878     Arm, so that these systems are no longer vulnerable to timing side-channel
879     attacks. This is configured by MBEDTLS_AESCE_C, which is on by default.
880     Reported by Demi Marie Obenour.
881   * MBEDTLS_AESNI_C, which is enabled by default, was silently ignored on
882     builds that couldn't compile the GCC-style assembly implementation
883     (most notably builds with Visual Studio), leaving them vulnerable to
884     timing side-channel attacks. There is now an intrinsics-based AES-NI
885     implementation as a fallback for when the assembly one cannot be used.
886
887Bugfix
888   * Fix possible integer overflow in mbedtls_timing_hardclock(), which
889     could cause a crash in programs/test/benchmark.
890   * Fix IAR compiler warnings. Fixes #6924.
891   * Fix a bug in the build where directory names containing spaces were
892     causing generate_errors.pl to error out resulting in a build failure.
893     Fixes issue #6879.
894   * In TLS 1.3, when using a ticket for session resumption, tweak its age
895     calculation on the client side. It prevents a server with more accurate
896     ticket timestamps (typically timestamps in milliseconds) compared to the
897     Mbed TLS ticket timestamps (in seconds) to compute a ticket age smaller
898     than the age computed and transmitted by the client and thus potentially
899     reject the ticket. Fix #6623.
900   * Fix compile error where MBEDTLS_RSA_C and MBEDTLS_X509_CRT_WRITE_C are
901     defined, but MBEDTLS_PK_RSA_ALT_SUPPORT is not defined. Fixes #3174.
902   * List PSA_WANT_ALG_CCM_STAR_NO_TAG in psa/crypto_config.h so that it can
903     be toggled with config.py.
904   * The key derivation algorithm PSA_ALG_TLS12_ECJPAKE_TO_PMS cannot be
905     used on a shared secret from a key agreement since its input must be
906     an ECC public key. Reject this properly.
907   * mbedtls_x509write_crt_set_serial() now explicitly rejects serial numbers
908     whose binary representation is longer than 20 bytes. This was already
909     forbidden by the standard (RFC5280 - section 4.1.2.2) and now it's being
910     enforced also at code level.
911   * Fix potential undefined behavior in mbedtls_mpi_sub_abs().  Reported by
912     Pascal Cuoq using TrustInSoft Analyzer in #6701; observed independently by
913     Aaron Ucko under Valgrind.
914   * Fix behavior of certain sample programs which could, when run with no
915     arguments, access uninitialized memory in some cases. Fixes #6700 (which
916     was found by TrustInSoft Analyzer during REDOCS'22) and #1120.
917   * Fix parsing of X.509 SubjectAlternativeName extension. Previously,
918     malformed alternative name components were not caught during initial
919     certificate parsing, but only on subsequent calls to
920     mbedtls_x509_parse_subject_alt_name(). Fixes #2838.
921   * Make the fields of mbedtls_pk_rsassa_pss_options public. This makes it
922     possible to verify RSA PSS signatures with the pk module, which was
923     inadvertently broken since Mbed TLS 3.0.
924   * Fix bug in conversion from OID to string in
925     mbedtls_oid_get_numeric_string(). OIDs such as 2.40.0.25 are now printed
926     correctly.
927   * Reject OIDs with overlong-encoded subidentifiers when converting
928     them to a string.
929   * Reject OIDs with subidentifier values exceeding UINT_MAX.  Such
930     subidentifiers can be valid, but Mbed TLS cannot currently handle them.
931   * Reject OIDs that have unterminated subidentifiers, or (equivalently)
932     have the most-significant bit set in their last byte.
933   * Silence warnings from clang -Wdocumentation about empty \retval
934     descriptions, which started appearing with Clang 15. Fixes #6960.
935   * Fix the handling of renegotiation attempts in TLS 1.3. They are now
936     systematically rejected.
937   * Fix an unused-variable warning in TLS 1.3-only builds if
938     MBEDTLS_SSL_RENEGOTIATION was enabled. Fixes #6200.
939   * Fix undefined behavior in mbedtls_ssl_read() and mbedtls_ssl_write() if
940     len argument is 0 and buffer is NULL.
941   * Allow setting user and peer identifiers for EC J-PAKE operation
942     instead of role in PAKE PSA Crypto API as described in the specification.
943     This is a partial fix that allows only "client" and "server" identifiers.
944   * Fix a compilation error when PSA Crypto is built with support for
945     TLS12_PRF but not TLS12_PSK_TO_MS. Reported by joerchan in #7125.
946   * In the TLS 1.3 server, select the preferred client cipher suite, not the
947     least preferred. The selection error was introduced in Mbed TLS 3.3.0.
948   * Fix TLS 1.3 session resumption when the established pre-shared key is
949     384 bits long. That is the length of pre-shared keys created under a
950     session where the cipher suite is TLS_AES_256_GCM_SHA384.
951   * Fix an issue when compiling with MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
952     enabled, which required specifying compiler flags enabling SHA3 Crypto
953     Extensions, where some compilers would emit EOR3 instructions in other
954     modules, which would then fail if run on a CPU without the SHA3
955     extensions. Fixes #5758.
956
957Changes
958   * Install the .cmake files into CMAKE_INSTALL_LIBDIR/cmake/MbedTLS,
959     typically /usr/lib/cmake/MbedTLS.
960   * Mixed-endian systems are explicitly not supported any more.
961   * When MBEDTLS_USE_PSA_CRYPTO and MBEDTLS_ECDSA_DETERMINISTIC are both
962     defined, mbedtls_pk_sign() now use deterministic ECDSA for ECDSA
963     signatures. This aligns the behaviour with MBEDTLS_USE_PSA_CRYPTO to
964     the behaviour without it, where deterministic ECDSA was already used.
965   * Visual Studio: Rename the directory containing Visual Studio files from
966     visualc/VS2010 to visualc/VS2013 as we do not support building with versions
967     older than 2013. Update the solution file to specify VS2013 as a minimum.
968   * programs/x509/cert_write:
969     - now it accepts the serial number in 2 different formats: decimal and
970       hex. They cannot be used simultaneously
971     - "serial" is used for the decimal format and it's limted in size to
972       unsigned long long int
973     - "serial_hex" is used for the hex format; max length here is
974       MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN*2
975   * The C code follows a new coding style. This is transparent for users but
976     affects contributors and maintainers of local patches. For more
977     information, see
978     https://mbed-tls.readthedocs.io/en/latest/kb/how-to/rewrite-branch-for-coding-style/
979   * Changed the default MBEDTLS_ECP_WINDOW_SIZE from 6 to 2.
980     As tested in issue 6790, the correlation between this define and
981     RSA decryption performance has changed lately due to security fixes.
982     To fix the performance degradation when using default values the
983     window was reduced from 6 to 2, a value that gives the best or close
984     to best results when tested on Cortex-M4 and Intel i7.
985   * When enabling MBEDTLS_SHA256_USE_A64_CRYPTO_* or
986     MBEDTLS_SHA512_USE_A64_CRYPTO_*, it is no longer necessary to specify
987     compiler target flags on the command line; the library now sets target
988     options within the appropriate modules.
989
990= Mbed TLS 3.3.0 branch released 2022-12-14
991
992Default behavior changes
993   * Previously the macro MBEDTLS_SSL_DTLS_CONNECTION_ID implemented version 05
994     of the IETF draft, and was marked experimental and disabled by default.
995     It is now no longer experimental, and implements the final version from
996     RFC 9146, which is not interoperable with the draft-05 version.
997     If you need to communicate with peers that use earlier versions of
998     Mbed TLS, then you need to define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
999     to 1, but then you won't be able to communicate with peers that use the
1000     standard (non-draft) version.
1001     If you need to interoperate with both classes of peers with the
1002     same build of Mbed TLS, please let us know about your situation on the
1003     mailing list or GitHub.
1004
1005Requirement changes
1006   * When building with PSA drivers using generate_driver_wrappers.py, or
1007     when building the library from the development branch rather than
1008     from a release, the Python module jsonschema is now necessary, in
1009     addition to jinja2. The official list of required Python modules is
1010     maintained in scripts/basic.requirements.txt and may change again
1011     in the future.
1012
1013New deprecations
1014   * Deprecate mbedtls_asn1_free_named_data().
1015     Use mbedtls_asn1_free_named_data_list()
1016     or mbedtls_asn1_free_named_data_list_shallow().
1017
1018Features
1019   * Support rsa_pss_rsae_* signature algorithms in TLS 1.2.
1020   * make: enable building unversioned shared library, with e.g.:
1021     "SHARED=1 SOEXT_TLS=so SOEXT_X509=so SOEXT_CRYPTO=so make lib"
1022     resulting in library names like "libmbedtls.so" rather than
1023     "libmbedcrypto.so.11".
1024   * Expose the EC J-PAKE functionality through the Draft PSA PAKE Crypto API.
1025     Only the ECC primitive with secp256r1 curve and SHA-256 hash algorithm
1026     are supported in this implementation.
1027   * Some modules can now use PSA drivers for hashes, including with no
1028     built-in implementation present, but only in some configurations.
1029     - RSA OAEP and PSS (PKCS#1 v2.1), PKCS5, PKCS12 and EC J-PAKE now use
1030       hashes from PSA when (and only when) MBEDTLS_MD_C is disabled.
1031     - PEM parsing of encrypted files now uses MD-5 from PSA when (and only
1032       when) MBEDTLS_MD5_C is disabled.
1033     See the documentation of the corresponding macros in mbedtls_config.h for
1034     details.
1035     Note that some modules are not able to use hashes from PSA yet, including
1036     the entropy module. As a consequence, for now the only way to build with
1037     all hashes only provided by drivers (no built-in hash) is to use
1038     MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
1039   * When MBEDTLS_USE_PSA_CRYPTO is enabled, X.509, TLS 1.2 and TLS 1.3 now
1040     properly negotiate/accept hashes based on their availability in PSA.
1041     As a consequence, they now work in configurations where the built-in
1042     implementations of (some) hashes are excluded and those hashes are only
1043     provided by PSA drivers. (See previous entry for limitation on RSA-PSS
1044     though: that module only use hashes from PSA when MBEDTLS_MD_C is off).
1045   * Add support for opaque keys as the private keys associated to certificates
1046     for authentication in TLS 1.3.
1047   * Add the LMS post-quantum-safe stateful-hash asymmetric signature scheme.
1048     Signature verification is production-ready, but generation is for testing
1049     purposes only. This currently only supports one parameter set
1050     (LMS_SHA256_M32_H10), meaning that each private key can be used to sign
1051     1024 messages. As such, it is not intended for use in TLS, but instead
1052     for verification of assets transmitted over an insecure channel,
1053     particularly firmware images.
1054   * Add the LM-OTS post-quantum-safe one-time signature scheme, which is
1055     required for LMS. This can be used independently, but each key can only
1056     be used to sign one message so is impractical for most circumstances.
1057   * Mbed TLS now supports TLS 1.3 key establishment via pre-shared keys.
1058     The pre-shared keys can be provisioned externally or via the ticket
1059     mechanism (session resumption).
1060     The ticket mechanism is supported when the configuration option
1061     MBEDTLS_SSL_SESSION_TICKETS is enabled.
1062     New options MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_xxx_ENABLED
1063     control the support for the three possible TLS 1.3 key exchange modes.
1064   * cert_write: support for setting extended key usage attributes. A
1065     corresponding new public API call has been added in the library,
1066     mbedtls_x509write_crt_set_ext_key_usage().
1067   * cert_write: support for writing certificate files in either PEM
1068     or DER format.
1069   * The PSA driver wrapper generator generate_driver_wrappers.py now
1070     supports a subset of the driver description language, including
1071     the following entry points: import_key, export_key, export_public_key,
1072     get_builtin_key, copy_key.
1073   * The new functions mbedtls_asn1_free_named_data_list() and
1074     mbedtls_asn1_free_named_data_list_shallow() simplify the management
1075     of memory in named data lists in X.509 structures.
1076   * The TLS 1.2 EC J-PAKE key exchange can now use the PSA Crypto API.
1077     Additional PSA key slots will be allocated in the process of such key
1078     exchange for builds that enable MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED and
1079     MBEDTLS_USE_PSA_CRYPTO.
1080   * Add support for DTLS Connection ID as defined by RFC 9146, controlled by
1081     MBEDTLS_SSL_DTLS_CONNECTION_ID (enabled by default) and configured with
1082     mbedtls_ssl_set_cid().
1083   * Add a driver dispatch layer for raw key agreement, enabling alternative
1084     implementations of raw key agreement through the key_agreement driver
1085     entry point. This entry point is specified in the proposed PSA driver
1086     interface, but had not yet been implemented.
1087   * Add an ad-hoc key derivation function handling EC J-PAKE to PMS
1088     calculation that can be used to derive the session secret in TLS 1.2,
1089     as described in draft-cragie-tls-ecjpake-01. This can be achieved by
1090     using PSA_ALG_TLS12_ECJPAKE_TO_PMS as the key derivation algorithm.
1091
1092Security
1093   * Fix potential heap buffer overread and overwrite in DTLS if
1094     MBEDTLS_SSL_DTLS_CONNECTION_ID is enabled and
1095     MBEDTLS_SSL_CID_IN_LEN_MAX > 2 * MBEDTLS_SSL_CID_OUT_LEN_MAX.
1096   * Fix an issue where an adversary with access to precise enough information
1097     about memory accesses (typically, an untrusted operating system attacking
1098     a secure enclave) could recover an RSA private key after observing the
1099     victim performing a single private-key operation if the window size used
1100     for the exponentiation was 3 or smaller. Found and reported by Zili KOU,
1101     Wenjian HE, Sharad Sinha, and Wei ZHANG. See "Cache Side-channel Attacks
1102     and Defenses of the Sliding Window Algorithm in TEEs" - Design, Automation
1103     and Test in Europe 2023.
1104
1105Bugfix
1106   * Refactor mbedtls_aes_context to support shallow-copying. Fixes #2147.
1107   * Fix an issue with in-tree CMake builds in releases with GEN_FILES
1108     turned off: if a shipped file was missing from the working directory,
1109     it could be turned into a symbolic link to itself.
1110   * Fix a long-standing build failure when building x86 PIC code with old
1111     gcc (4.x). The code will be slower, but will compile. We do however
1112     recommend upgrading to a more recent compiler instead. Fixes #1910.
1113   * Fix support for little-endian Microblaze when MBEDTLS_HAVE_ASM is defined.
1114     Contributed by Kazuyuki Kimura to fix #2020.
1115   * Use double quotes to include private header file psa_crypto_cipher.h.
1116     Fixes 'file not found with <angled> include' error
1117     when building with Xcode.
1118   * Fix handling of broken symlinks when loading certificates using
1119     mbedtls_x509_crt_parse_path(). Instead of returning an error as soon as a
1120     broken link is encountered, skip the broken link and continue parsing
1121     other certificate files. Contributed by Eduardo Silva in #2602.
1122   * Fix an interoperability failure between an Mbed TLS client with both
1123     TLS 1.2 and TLS 1.3 support, and a TLS 1.2 server that supports
1124     rsa_pss_rsae_* signature algorithms. This failed because Mbed TLS
1125     advertised support for PSS in both TLS 1.2 and 1.3, but only
1126     actually supported PSS in TLS 1.3.
1127   * Fix a compilation error when using CMake with an IAR toolchain.
1128     Fixes #5964.
1129   * Fix a build error due to a missing prototype warning when
1130     MBEDTLS_DEPRECATED_REMOVED is enabled.
1131   * Fix mbedtls_ctr_drbg_free() on an initialized but unseeded context. When
1132     MBEDTLS_AES_ALT is enabled, it could call mbedtls_aes_free() on an
1133     uninitialized context.
1134   * Fix a build issue on Windows using CMake where the source and build
1135     directories could not be on different drives. Fixes #5751.
1136   * Fix bugs and missing dependencies when building and testing
1137     configurations with only one encryption type enabled in TLS 1.2.
1138   * Provide the missing definition of mbedtls_setbuf() in some configurations
1139     with MBEDTLS_PLATFORM_C disabled. Fixes #6118, #6196.
1140   * Fix compilation errors when trying to build with
1141     PSA drivers for AEAD (GCM, CCM, Chacha20-Poly1305).
1142   * Fix memory leak in ssl_parse_certificate_request() caused by
1143     mbedtls_x509_get_name() not freeing allocated objects in case of error.
1144     Change mbedtls_x509_get_name() to clean up allocated objects on error.
1145   * Fix build failure with MBEDTLS_RSA_C and MBEDTLS_PSA_CRYPTO_C but not
1146     MBEDTLS_USE_PSA_CRYPTO or MBEDTLS_PK_WRITE_C. Fixes #6408.
1147   * Fix build failure with MBEDTLS_RSA_C and MBEDTLS_PSA_CRYPTO_C but not
1148     MBEDTLS_PK_PARSE_C. Fixes #6409.
1149   * Fix ECDSA verification, where it was not always validating the
1150     public key. This bug meant that it was possible to verify a
1151     signature with an invalid public key, in some cases. Reported by
1152     Guido Vranken using Cryptofuzz in #4420.
1153   * Fix a possible null pointer dereference if a memory allocation fails
1154     in TLS PRF code. Reported by Michael Madsen in #6516.
1155   * Fix TLS 1.3 session resumption. Fixes #6488.
1156   * Add a configuration check to exclude optional client authentication
1157     in TLS 1.3 (where it is forbidden).
1158   * Fix a bug in which mbedtls_x509_crt_info() would produce non-printable
1159     bytes when parsing certificates containing a binary RFC 4108
1160     HardwareModuleName as a Subject Alternative Name extension. Hardware
1161     serial numbers are now rendered in hex format. Fixes #6262.
1162   * Fix bug in error reporting in dh_genprime.c where upon failure,
1163     the error code returned by mbedtls_mpi_write_file() is overwritten
1164     and therefore not printed.
1165   * In the bignum module, operations of the form (-A) - (+A) or (-A) - (-A)
1166     with A > 0 created an unintended representation of the value 0 which was
1167     not processed correctly by some bignum operations. Fix this. This had no
1168     consequence on cryptography code, but might affect applications that call
1169     bignum directly and use negative numbers.
1170   * Fix a bug whereby the list of signature algorithms sent as part of
1171     the TLS 1.2 server certificate request would get corrupted, meaning the
1172     first algorithm would not get sent and an entry consisting of two random
1173     bytes would be sent instead. Found by Serban Bejan and Dudek Sebastian.
1174   * Fix undefined behavior (typically harmless in practice) of
1175     mbedtls_mpi_add_mpi(), mbedtls_mpi_add_abs() and mbedtls_mpi_add_int()
1176     when both operands are 0 and the left operand is represented with 0 limbs.
1177   * Fix undefined behavior (typically harmless in practice) when some bignum
1178     functions receive the most negative value of mbedtls_mpi_sint. Credit
1179     to OSS-Fuzz. Fixes #6597.
1180   * Fix undefined behavior (typically harmless in practice) in PSA ECB
1181     encryption and decryption.
1182   * Move some SSL-specific code out of libmbedcrypto where it had been placed
1183     accidentally.
1184   * Fix a build error when compiling the bignum module for some Arm platforms.
1185     Fixes #6089, #6124, #6217.
1186
1187Changes
1188   * Add the ability to query PSA_WANT_xxx macros to query_compile_time_config.
1189   * Calling AEAD tag-specific functions for non-AEAD algorithms (which
1190     should not be done - they are documented for use only by AES-GCM and
1191     ChaCha20+Poly1305) now returns MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE
1192     instead of success (0).
1193
1194= Mbed TLS 3.2.1 branch released 2022-07-12
1195
1196Bugfix
1197   *  Re-add missing generated file library/psa_crypto_driver_wrappers.c
1198
1199= Mbed TLS 3.2.0 branch released 2022-07-11
1200
1201Default behavior changes
1202   * mbedtls_cipher_set_iv will now fail with ChaCha20 and ChaCha20+Poly1305
1203     for IV lengths other than 12. The library was silently overwriting this
1204     length with 12, but did not inform the caller about it. Fixes #4301.
1205
1206Requirement changes
1207   * The library will no longer compile out of the box on a platform without
1208     setbuf(). If your platform does not have setbuf(), you can configure an
1209     alternative function by enabling MBEDTLS_PLATFORM_SETBUF_ALT or
1210     MBEDTLS_PLATFORM_SETBUF_MACRO.
1211
1212New deprecations
1213   * Deprecate mbedtls_ssl_conf_max_version() and
1214     mbedtls_ssl_conf_min_version() in favor of
1215     mbedtls_ssl_conf_max_tls_version() and
1216     mbedtls_ssl_conf_min_tls_version().
1217   * Deprecate mbedtls_cipher_setup_psa(). Use psa_aead_xxx() or
1218     psa_cipher_xxx() directly instead.
1219   * Secure element drivers enabled by MBEDTLS_PSA_CRYPTO_SE_C are deprecated.
1220     This was intended as an experimental feature, but had not been explicitly
1221     documented as such. Use opaque drivers with the interface enabled by
1222     MBEDTLS_PSA_CRYPTO_DRIVERS instead.
1223   * Deprecate mbedtls_ssl_conf_sig_hashes() in favor of the more generic
1224     mbedtls_ssl_conf_sig_algs(). Signature algorithms for the TLS 1.2 and
1225     TLS 1.3 handshake should now be configured with
1226     mbedtls_ssl_conf_sig_algs().
1227
1228Features
1229   * Add accessor to obtain ciphersuite id from ssl context.
1230   * Add accessors to get members from ciphersuite info.
1231   * Add mbedtls_ssl_ticket_rotate() for external ticket rotation.
1232   * Add accessor to get the raw buffer pointer from a PEM context.
1233   * The structures mbedtls_ssl_config and mbedtls_ssl_context now store
1234     a piece of user data which is reserved for the application. The user
1235     data can be either a pointer or an integer.
1236   * Add an accessor function to get the configuration associated with
1237     an SSL context.
1238   * Add a function to access the protocol version from an SSL context in a
1239     form that's easy to compare. Fixes #5407.
1240   * Add function mbedtls_md_info_from_ctx() to recall the message digest
1241     information that was used to set up a message digest context.
1242   * Add ALPN support in TLS 1.3 clients.
1243   * Add server certificate selection callback near end of Client Hello.
1244     Register callback with mbedtls_ssl_conf_cert_cb().
1245   * Provide mechanism to reset handshake cert list by calling
1246     mbedtls_ssl_set_hs_own_cert() with NULL value for own_cert param.
1247   * Add accessor mbedtls_ssl_get_hs_sni() to retrieve SNI from within
1248     cert callback (mbedtls_ssl_conf_cert_cb()) during handshake.
1249   * The X.509 module now uses PSA hash acceleration if present.
1250   * Add support for psa crypto key derivation for elliptic curve
1251     keys. Fixes #3260.
1252   * Add function mbedtls_timing_get_final_delay() to access the private
1253     final delay field in an mbedtls_timing_delay_context, as requested in
1254     #5183.
1255    * Add mbedtls_pk_sign_ext() which allows generating RSA-PSS signatures when
1256      PSA Crypto is enabled.
1257   * Add function mbedtls_ecp_export() to export ECP key pair parameters.
1258     Fixes #4838.
1259   * Add function mbedtls_ssl_is_handshake_over() to enable querying if the SSL
1260     Handshake has completed or not, and thus whether to continue calling
1261     mbedtls_ssl_handshake_step(), requested in #4383.
1262   * Add the function mbedtls_ssl_get_own_cid() to access our own connection id
1263     within mbedtls_ssl_context, as requested in #5184.
1264   * Introduce mbedtls_ssl_hs_cb_t typedef for use with
1265     mbedtls_ssl_conf_cert_cb() and perhaps future callbacks
1266     during TLS handshake.
1267   * Add functions mbedtls_ssl_conf_max_tls_version() and
1268     mbedtls_ssl_conf_min_tls_version() that use a single value to specify
1269     the protocol version.
1270    * Extend the existing PSA_ALG_TLS12_PSK_TO_MS() algorithm to support
1271      mixed-PSK. Add an optional input PSA_KEY_DERIVATION_INPUT_OTHER_SECRET
1272      holding the other secret.
1273   * When MBEDTLS_PSA_CRYPTO_CONFIG is enabled, you may list the PSA crypto
1274     feature requirements in the file named by the new macro
1275     MBEDTLS_PSA_CRYPTO_CONFIG_FILE instead of the default psa/crypto_config.h.
1276     Furthermore you may name an additional file to include after the main
1277     file with the macro MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE.
1278   * Add the function mbedtls_x509_crt_has_ext_type() to access the ext types
1279     field within mbedtls_x509_crt context, as requested in #5585.
1280   * Add HKDF-Expand and HKDF-Extract as separate algorithms in the PSA API.
1281   * Add support for the ARMv8 SHA-2 acceleration instructions when building
1282     for Aarch64.
1283   * Add support for authentication of TLS 1.3 clients by TLS 1.3 servers.
1284   * Add support for server HelloRetryRequest message. The TLS 1.3 client is
1285     now capable of negotiating another shared secret if the one sent in its
1286     first ClientHello was not suitable to the server.
1287   * Add support for client-side TLS version negotiation. If both TLS 1.2 and
1288     TLS 1.3 protocols are enabled in the build of Mbed TLS, the TLS client now
1289     negotiates TLS 1.3 or TLS 1.2 with TLS servers.
1290   * Enable building of Mbed TLS with TLS 1.3 protocol support but without TLS
1291     1.2 protocol support.
1292   * Mbed TLS provides an implementation of a TLS 1.3 server (ephemeral key
1293     establishment only). See docs/architecture/tls13-support.md for a
1294     description of the support. The MBEDTLS_SSL_PROTO_TLS1_3 and
1295     MBEDTLS_SSL_SRV_C configuration options control this.
1296   * Add accessors to configure DN hints for certificate request:
1297     mbedtls_ssl_conf_dn_hints() and mbedtls_ssl_set_hs_dn_hints()
1298   * The configuration option MBEDTLS_USE_PSA_CRYPTO, which previously
1299     affected only a limited subset of crypto operations in TLS, X.509 and PK,
1300     now causes most of them to be done using PSA Crypto; see
1301     docs/use-psa-crypto.md for the list of exceptions.
1302   * The function mbedtls_pk_setup_opaque() now supports RSA key pairs as well.
1303     Opaque keys can now be used everywhere a private key is expected in the
1304     TLS and X.509 modules.
1305   * Opaque pre-shared keys for TLS, provisioned with
1306     mbedtls_ssl_conf_psk_opaque() or mbedtls_ssl_set_hs_psk_opaque(), which
1307     previously only worked for "pure" PSK key exchange, now can also be used
1308     for the "mixed" PSK key exchanges as well: ECDHE-PSK, DHE-PSK, RSA-PSK.
1309   * cmake now detects if it is being built as a sub-project, and in that case
1310     disables the target export/installation and package configuration.
1311   * Make USE_PSA_CRYPTO compatible with KEY_ID_ENCODES_OWNER. Fixes #5259.
1312   * Add example programs cipher_aead_demo.c, md_hmac_demo.c, aead_demo.c
1313     and hmac_demo.c, which use PSA and the md/cipher interfaces side
1314     by side in order to illustrate how the operation is performed in PSA.
1315     Addresses #5208.
1316
1317Security
1318   * Zeroize dynamically-allocated buffers used by the PSA Crypto key storage
1319     module before freeing them. These buffers contain secret key material, and
1320     could thus potentially leak the key through freed heap.
1321   * Fix potential memory leak inside mbedtls_ssl_cache_set() with
1322     an invalid session id length.
1323   * Add the platform function mbedtls_setbuf() to allow buffering to be
1324     disabled on stdio files, to stop secrets loaded from said files being
1325     potentially left in memory after file operations. Reported by
1326     Glenn Strauss.
1327   * Fix a potential heap buffer overread in TLS 1.2 server-side when
1328     MBEDTLS_USE_PSA_CRYPTO is enabled, an opaque key (created with
1329     mbedtls_pk_setup_opaque()) is provisioned, and a static ECDH ciphersuite
1330     is selected. This may result in an application crash or potentially an
1331     information leak.
1332   * Fix a buffer overread in DTLS ClientHello parsing in servers with
1333     MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE enabled. An unauthenticated client
1334     or a man-in-the-middle could cause a DTLS server to read up to 255 bytes
1335     after the end of the SSL input buffer. The buffer overread only happens
1336     when MBEDTLS_SSL_IN_CONTENT_LEN is less than a threshold that depends on
1337     the exact configuration: 258 bytes if using mbedtls_ssl_cookie_check(),
1338     and possibly up to 571 bytes with a custom cookie check function.
1339     Reported by the Cybeats PSI Team.
1340    * Fix a buffer overread in TLS 1.3 Certificate parsing. An unauthenticated
1341      client or server could cause an MbedTLS server or client to overread up
1342      to 64 kBytes of data and potentially overread the input buffer by that
1343      amount minus the size of the input buffer. As overread data undergoes
1344      various checks, the likelihood of reaching the boundary of the input
1345      buffer is rather small but increases as its size
1346      MBEDTLS_SSL_IN_CONTENT_LEN decreases.
1347   * Fix check of certificate key usage in TLS 1.3. The usage of the public key
1348     provided by a client or server certificate for authentication was not
1349     checked properly when validating the certificate. This could cause a
1350     client or server to be able to authenticate itself through a certificate
1351     to an Mbed TLS TLS 1.3 server or client while it does not own a proper
1352     certificate to do so.
1353
1354Bugfix
1355   * Declare or use PSA_WANT_ALG_CCM_STAR_NO_TAG following the general
1356     pattern for PSA_WANT_xxx symbols. Previously you had to specify
1357     PSA_WANT_ALG_CCM for PSA_ALG_CCM_STAR_NO_TAG.
1358   * Fix a memory leak if mbedtls_ssl_config_defaults() is called twice.
1359   * Fixed swap of client and server random bytes when exporting them alongside
1360     TLS 1.3 handshake and application traffic secret.
1361   * Fix several bugs (warnings, compiler and linker errors, test failures)
1362     in reduced configurations when MBEDTLS_USE_PSA_CRYPTO is enabled.
1363   * Fix a bug in (D)TLS curve negotiation: when MBEDTLS_USE_PSA_CRYPTO was
1364     enabled and an ECDHE-ECDSA or ECDHE-RSA key exchange was used, the
1365     client would fail to check that the curve selected by the server for
1366     ECDHE was indeed one that was offered. As a result, the client would
1367     accept any curve that it supported, even if that curve was not allowed
1368     according to its configuration. Fixes #5291.
1369   * The TLS 1.3 implementation is now compatible with the
1370     MBEDTLS_USE_PSA_CRYPTO configuration option.
1371   * Fix unit tests that used 0 as the file UID. This failed on some
1372     implementations of PSA ITS. Fixes #3838.
1373   * Fix mbedtls_ssl_get_version() not reporting TLSv1.3. Fixes #5406.
1374   * Fix API violation in mbedtls_md_process() test by adding a call to
1375     mbedtls_md_starts(). Fixes #2227.
1376   * Fix compile errors when MBEDTLS_HAVE_TIME is not defined. Add tests
1377     to catch bad uses of time.h.
1378   * Fix a race condition in out-of-source builds with CMake when generated data
1379     files are already present. Fixes #5374.
1380   * Fix the library search path when building a shared library with CMake
1381     on Windows.
1382   * Fix bug in the alert sending function mbedtls_ssl_send_alert_message()
1383     potentially leading to corrupted alert messages being sent in case
1384     the function needs to be re-called after initially returning
1385     MBEDTLS_SSL_WANT_WRITE. Fixes #1916.
1386   * In configurations with MBEDTLS_SSL_DTLS_CONNECTION_ID enabled but not
1387     MBEDTLS_DEBUG_C, DTLS handshakes using CID would crash due to a null
1388     pointer dereference. Fix this. Fixes #3998.
1389     The fix was released, but not announced, in Mbed TLS 3.1.0.
1390   * Fix incorrect documentation of mbedtls_x509_crt_profile. The previous
1391     documentation stated that the `allowed_pks` field applies to signatures
1392     only, but in fact it does apply to the public key type of the end entity
1393     certificate, too. Fixes #1992.
1394   * Fix undefined behavior in mbedtls_asn1_find_named_data(), where val is
1395     not NULL and val_len is zero.
1396   * Fix compilation error with mingw32. Fixed by Cameron Cawley in #4211.
1397   * Fix compilation error when using C++ Builder on Windows. Reported by
1398     Miroslav Mastny in #4015.
1399   * psa_raw_key_agreement() now returns PSA_ERROR_BUFFER_TOO_SMALL when
1400     applicable. Fixes #5735.
1401   * Fix a bug in the x25519 example program where the removal of
1402     MBEDTLS_ECDH_LEGACY_CONTEXT caused the program not to run. Fixes #4901 and
1403     #3191.
1404   * Fix a TLS 1.3 handshake failure when the peer Finished message has not
1405     been received yet when we first try to fetch it.
1406   * Encode X.509 dates before 1/1/2000 as UTCTime rather than
1407     GeneralizedTime. Fixes #5465.
1408   * Add mbedtls_x509_dn_get_next function to return the next relative DN in
1409     an X509 name, to allow walking the name list. Fixes #5431.
1410    * Fix order value of curve x448.
1411   * Fix string representation of DNs when outputting values containing commas
1412     and other special characters, conforming to RFC 1779. Fixes #769.
1413   * Silence a warning from GCC 12 in the selftest program. Fixes #5974.
1414   * Fix check_config.h to check that we have MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1415     when MBEDTLS_SSL_PROTO_TLS1_3 is specified, and make this and other
1416     dependencies explicit in the documentation. Fixes #5610.
1417   * Fix mbedtls_asn1_write_mpi() writing an incorrect encoding of 0.
1418   * Fix a TLS 1.3 handshake failure when the first attempt to send the client
1419     Finished message on the network cannot be satisfied. Fixes #5499.
1420   * Fix resource leaks in mbedtls_pk_parse_public_key() in low
1421     memory conditions.
1422   * Fix server connection identifier setting for outgoing encrypted records
1423     on DTLS 1.2 session resumption. After DTLS 1.2 session resumption with
1424     connection identifier, the Mbed TLS client now properly sends the server
1425     connection identifier in encrypted record headers. Fix #5872.
1426   * Fix a null pointer dereference when performing some operations on zero
1427     represented with 0 limbs (specifically mbedtls_mpi_mod_int() dividing
1428     by 2, and mbedtls_mpi_write_string() in base 2).
1429   * Fix record sizes larger than 16384 being sometimes accepted despite being
1430     non-compliant. This could not lead to a buffer overflow. In particular,
1431     application data size was already checked correctly.
1432   * Fix MBEDTLS_SVC_KEY_ID_GET_KEY_ID() and MBEDTLS_SVC_KEY_ID_GET_OWNER_ID()
1433     which have been broken, resulting in compilation errors, since Mbed TLS
1434     3.0.
1435   * Ensure that TLS 1.2 ciphersuite/certificate and key selection takes into
1436     account not just the type of the key (RSA vs EC) but also what it can
1437     actually do. Resolves #5831.
1438   * Fix CMake windows host detection, especially when cross compiling.
1439   * Fix an error in make where the absence of a generated file caused
1440     make to break on a clean checkout. Fixes #5340.
1441   * Work around an MSVC ARM64 compiler bug causing incorrect behaviour
1442     in mbedtls_mpi_exp_mod(). Reported by Tautvydas Žilys in #5467.
1443   * Removed the prompt to exit from all windows build programs, which was causing
1444     issues in CI/CD environments.
1445
1446Changes
1447   * The file library/psa_crypto_driver_wrappers.c is now generated
1448     from a template. In the future, the generation will support
1449     driver descriptions. For the time being, to customize this file,
1450     see docs/proposed/psa-driver-wrappers-codegen-migration-guide.md
1451   * Return PSA_ERROR_INVALID_ARGUMENT if the algorithm passed to one-shot
1452     AEAD functions is not an AEAD algorithm. This aligns them with the
1453     multipart functions, and the PSA Crypto API 1.1 specification.
1454   * In mbedtls_pk_parse_key(), if no password is provided, don't allocate a
1455     temporary variable on the heap. Suggested by Sergey Kanatov in #5304.
1456   * Assume source files are in UTF-8 when using MSVC with CMake.
1457   * Fix runtime library install location when building with CMake and MinGW.
1458     DLLs are now installed in the bin directory instead of lib.
1459   * cmake: Use GnuInstallDirs to customize install directories
1460     Replace custom LIB_INSTALL_DIR variable with standard CMAKE_INSTALL_LIBDIR
1461     variable. For backward compatibility, set CMAKE_INSTALL_LIBDIR if
1462     LIB_INSTALL_DIR is set.
1463   * Add a CMake option that enables static linking of the runtime library
1464     in Microsoft Visual C++ compiler. Contributed by Microplankton.
1465   * In CMake builds, add aliases for libraries so that the normal MbedTLS::*
1466     targets work when MbedTLS is built as a subdirectory. This allows the
1467     use of FetchContent, as requested in #5688.
1468
1469= mbed TLS 3.1.0 branch released 2021-12-17
1470
1471API changes
1472   * New error code for GCM: MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL.
1473     Alternative GCM implementations are expected to verify
1474     the length of the provided output buffers and to return the
1475     MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL in case the buffer length is too small.
1476   * You can configure groups for a TLS key exchange with the new function
1477     mbedtls_ssl_conf_groups(). It extends mbedtls_ssl_conf_curves().
1478   * Declare a number of structure fields as public: the fields of
1479     mbedtls_ecp_curve_info, the fields describing the result of ASN.1 and
1480     X.509 parsing, and finally the field fd of mbedtls_net_context on
1481     POSIX/Unix-like platforms.
1482
1483Requirement changes
1484   * Sign-magnitude and one's complement representations for signed integers are
1485     not supported. Two's complement is the only supported representation.
1486
1487New deprecations
1488   * Deprecate mbedtls_ssl_conf_curves() in favor of the more generic
1489     mbedtls_ssl_conf_groups().
1490
1491Removals
1492   * Remove the partial support for running unit tests via Greentea on Mbed OS,
1493     which had been unmaintained since 2018.
1494
1495Features
1496   * Enable support for Curve448 via the PSA API. Contributed by
1497     Archana Madhavan in #4626. Fixes #3399 and #4249.
1498   * The identifier of the CID TLS extension can be configured by defining
1499     MBEDTLS_TLS_EXT_CID at compile time.
1500   * Implement the PSA multipart AEAD interface, currently supporting
1501     ChaChaPoly and GCM.
1502   * Warn if errors from certain functions are ignored. This is currently
1503     supported on GCC-like compilers and on MSVC and can be configured through
1504     the macro MBEDTLS_CHECK_RETURN. The warnings are always enabled
1505     (where supported) for critical functions where ignoring the return
1506     value is almost always a bug. Enable the new configuration option
1507     MBEDTLS_CHECK_RETURN_WARNING to get warnings for other functions. This
1508     is currently implemented in the AES, DES and md modules, and will be
1509     extended to other modules in the future.
1510   * Add missing PSA macros declared by PSA Crypto API 1.0.0:
1511     PSA_ALG_IS_SIGN_HASH, PSA_ALG_NONE, PSA_HASH_BLOCK_LENGTH, PSA_KEY_ID_NULL.
1512   * Add support for CCM*-no-tag cipher to the PSA.
1513     Currently only 13-byte long IV's are supported.
1514     For decryption a minimum of 16-byte long input is expected.
1515     These restrictions may be subject to change.
1516   * Add new API mbedtls_ct_memcmp for constant time buffer comparison.
1517   * Add functions to get the IV and block size from cipher_info structs.
1518   * Add functions to check if a cipher supports variable IV or key size.
1519   * Add the internal implementation of and support for CCM to the PSA multipart
1520     AEAD interface.
1521   * Mbed TLS provides a minimum viable implementation of the TLS 1.3
1522     protocol. See docs/architecture/tls13-support.md for the definition of
1523     the TLS 1.3 Minimum Viable Product (MVP). The MBEDTLS_SSL_PROTO_TLS1_3
1524     configuration option controls the enablement of the support. The APIs
1525     mbedtls_ssl_conf_min_version() and mbedtls_ssl_conf_max_version() allow
1526     to select the 1.3 version of the protocol to establish a TLS connection.
1527   * Add PSA API definition for ARIA.
1528
1529Security
1530   * Zeroize several intermediate variables used to calculate the expected
1531     value when verifying a MAC or AEAD tag. This hardens the library in
1532     case the value leaks through a memory disclosure vulnerability. For
1533     example, a memory disclosure vulnerability could have allowed a
1534     man-in-the-middle to inject fake ciphertext into a DTLS connection.
1535   * In psa_aead_generate_nonce(), do not read back from the output buffer.
1536     This fixes a potential policy bypass or decryption oracle vulnerability
1537     if the output buffer is in memory that is shared with an untrusted
1538     application.
1539   * In psa_cipher_generate_iv() and psa_cipher_encrypt(), do not read back
1540     from the output buffer. This fixes a potential policy bypass or decryption
1541     oracle vulnerability if the output buffer is in memory that is shared with
1542     an untrusted application.
1543   * Fix a double-free that happened after mbedtls_ssl_set_session() or
1544     mbedtls_ssl_get_session() failed with MBEDTLS_ERR_SSL_ALLOC_FAILED
1545     (out of memory). After that, calling mbedtls_ssl_session_free()
1546     and mbedtls_ssl_free() would cause an internal session buffer to
1547     be free()'d twice.
1548
1549Bugfix
1550   * Stop using reserved identifiers as local variables. Fixes #4630.
1551   * The GNU makefiles invoke python3 in preference to python except on Windows.
1552     The check was accidentally not performed when cross-compiling for Windows
1553     on Linux. Fix this. Fixes #4774.
1554   * Prevent divide by zero if either of PSA_CIPHER_ENCRYPT_OUTPUT_SIZE() or
1555     PSA_CIPHER_UPDATE_OUTPUT_SIZE() were called using an asymmetric key type.
1556   * Fix a parameter set but unused in psa_crypto_cipher.c. Fixes #4935.
1557   * Don't use the obsolete header path sys/fcntl.h in unit tests.
1558     These header files cause compilation errors in musl.
1559     Fixes #4969.
1560   * Fix missing constraints on x86_64 and aarch64 assembly code
1561     for bignum multiplication that broke some bignum operations with
1562     (at least) Clang 12.
1563     Fixes #4116, #4786, #4917, #4962.
1564   * Fix mbedtls_cipher_crypt: AES-ECB when MBEDTLS_USE_PSA_CRYPTO is enabled.
1565   * Failures of alternative implementations of AES or DES single-block
1566     functions enabled with MBEDTLS_AES_ENCRYPT_ALT, MBEDTLS_AES_DECRYPT_ALT,
1567     MBEDTLS_DES_CRYPT_ECB_ALT or MBEDTLS_DES3_CRYPT_ECB_ALT were ignored.
1568     This does not concern the implementation provided with Mbed TLS,
1569     where this function cannot fail, or full-module replacements with
1570     MBEDTLS_AES_ALT or MBEDTLS_DES_ALT. Reported by Armelle Duboc in #1092.
1571   * Some failures of HMAC operations were ignored. These failures could only
1572     happen with an alternative implementation of the underlying hash module.
1573   * Fix the error returned by psa_generate_key() for a public key. Fixes #4551.
1574   * Fix compile-time or run-time errors in PSA
1575     AEAD functions when ChachaPoly is disabled. Fixes #5065.
1576   * Remove PSA'a AEAD finish/verify output buffer limitation for GCM.
1577     The requirement of minimum 15 bytes for output buffer in
1578     psa_aead_finish() and psa_aead_verify() does not apply to the built-in
1579     implementation of GCM.
1580   * Move GCM's update output buffer length verification from PSA AEAD to
1581     the built-in implementation of the GCM.
1582     The requirement for output buffer size to be equal or greater then
1583     input buffer size is valid only for the built-in implementation of GCM.
1584     Alternative GCM implementations can process whole blocks only.
1585   * Fix the build of sample programs when neither MBEDTLS_ERROR_C nor
1586     MBEDTLS_ERROR_STRERROR_DUMMY is enabled.
1587   * Fix PSA_ALG_RSA_PSS verification accepting an arbitrary salt length.
1588     This algorithm now accepts only the same salt length for verification
1589     that it produces when signing, as documented. Use the new algorithm
1590     PSA_ALG_RSA_PSS_ANY_SALT to accept any salt length. Fixes #4946.
1591   * The existing predicate macro name PSA_ALG_IS_HASH_AND_SIGN is now reserved
1592     for algorithm values that fully encode the hashing step, as per the PSA
1593     Crypto API specification. This excludes PSA_ALG_RSA_PKCS1V15_SIGN_RAW and
1594     PSA_ALG_ECDSA_ANY. The new predicate macro PSA_ALG_IS_SIGN_HASH covers
1595     all algorithms that can be used with psa_{sign,verify}_hash(), including
1596     these two.
1597   * Fix issue in Makefile on Linux with SHARED=1, that caused shared libraries
1598     not to list other shared libraries they need.
1599   * Fix a bug in mbedtls_gcm_starts() when the bit length of the iv
1600     exceeds 2^32. Fixes #4884.
1601   * Fix an uninitialized variable warning in test_suite_ssl.function with GCC
1602     version 11.
1603   * Fix the build when no SHA2 module is included. Fixes #4930.
1604   * Fix the build when only the bignum module is included. Fixes #4929.
1605   * Fix a potential invalid pointer dereference and infinite loop bugs in
1606     pkcs12 functions when the password is empty. Fix the documentation to
1607     better describe the inputs to these functions and their possible values.
1608     Fixes #5136.
1609   * The key usage flags PSA_KEY_USAGE_SIGN_MESSAGE now allows the MAC
1610     operations psa_mac_compute() and psa_mac_sign_setup().
1611   * The key usage flags PSA_KEY_USAGE_VERIFY_MESSAGE now allows the MAC
1612     operations psa_mac_verify() and psa_mac_verify_setup().
1613
1614Changes
1615    * Explicitly mark the fields mbedtls_ssl_session.exported and
1616      mbedtls_ssl_config.respect_cli_pref as private. This was an
1617      oversight during the run-up to the release of Mbed TLS 3.0.
1618      The fields were never intended to be public.
1619   * Implement multi-part CCM API.
1620     The multi-part functions: mbedtls_ccm_starts(), mbedtls_ccm_set_lengths(),
1621     mbedtls_ccm_update_ad(), mbedtls_ccm_update(), mbedtls_ccm_finish()
1622     were introduced in mbedTLS 3.0 release, however their implementation was
1623     postponed until now.
1624     Implemented functions support chunked data input for both CCM and CCM*
1625     algorithms.
1626   * Remove MBEDTLS_SSL_EXPORT_KEYS, making it always on and increasing the
1627     code size by about 80B on an M0 build. This option only gated an ability
1628     to set a callback, but was deemed unnecessary as it was yet another define
1629     to remember when writing tests, or test configurations. Fixes #4653.
1630   * Improve the performance of base64 constant-flow code. The result is still
1631     slower than the original non-constant-flow implementation, but much faster
1632     than the previous constant-flow implementation. Fixes #4814.
1633   * Ignore plaintext/ciphertext lengths for CCM*-no-tag operations.
1634     For CCM* encryption/decryption without authentication, input
1635     length will be ignored.
1636   * Indicate in the error returned if the nonce length used with
1637     ChaCha20-Poly1305 is invalid, and not just unsupported.
1638   * The mbedcrypto library includes a new source code module constant_time.c,
1639     containing various functions meant to resist timing side channel attacks.
1640     This module does not have a separate configuration option, and functions
1641     from this module will be included in the build as required. Currently
1642     most of the interface of this module is private and may change at any
1643     time.
1644   * The generated configuration-independent files are now automatically
1645     generated by the CMake build system on Unix-like systems. This is not
1646     yet supported when cross-compiling.
1647
1648= Mbed TLS 3.0.0 branch released 2021-07-07
1649
1650API changes
1651   * Remove HAVEGE module.
1652     The design of HAVEGE makes it unsuitable for microcontrollers. Platforms
1653     with a more complex CPU usually have an operating system interface that
1654     provides better randomness. Instead of HAVEGE, declare OS or hardware RNG
1655     interfaces with mbedtls_entropy_add_source() and/or use an entropy seed
1656     file created securely during device provisioning. See
1657     https://mbed-tls.readthedocs.io/en/latest/kb/how-to/add-entropy-sources-to-entropy-pool/ for
1658     more information.
1659   * Add missing const attributes to API functions.
1660   * Remove helpers for the transition from Mbed TLS 1.3 to Mbed TLS 2.0: the
1661     header compat-1.3.h and the script rename.pl.
1662   * Remove certs module from the API.
1663     Transfer keys and certificates embedded in the library to the test
1664     component. This contributes to minimizing library API and discourages
1665     users from using unsafe keys in production.
1666   * Move alt helpers and definitions.
1667     Various helpers and definitions available for use in alt implementations
1668     have been moved out of the include/ directory and into the library/
1669     directory. The files concerned are ecp_internal.h and rsa_internal.h
1670     which have also been renamed to ecp_internal_alt.h and rsa_alt_helpers.h
1671     respectively.
1672   * Move internal headers.
1673     Header files that were only meant for the library's internal use and
1674     were not meant to be used in application code have been moved out of
1675     the include/ directory. The headers concerned are bn_mul.h, aesni.h,
1676     padlock.h, entropy_poll.h and *_internal.h.
1677   * Drop support for parsing SSLv2 ClientHello
1678     (MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO).
1679   * Drop support for SSLv3 (MBEDTLS_SSL_PROTO_SSL3).
1680   * Drop support for TLS record-level compression (MBEDTLS_ZLIB_SUPPORT).
1681   * Drop support for RC4 TLS ciphersuites.
1682   * Drop support for single-DES ciphersuites.
1683   * Drop support for MBEDTLS_SSL_HW_RECORD_ACCEL.
1684   * Update AEAD output size macros to bring them in line with the PSA Crypto
1685     API version 1.0 spec. This version of the spec parameterizes them on the
1686     key type used, as well as the key bit-size in the case of
1687     PSA_AEAD_TAG_LENGTH.
1688   * Add configuration option MBEDTLS_X509_REMOVE_INFO which
1689     removes the mbedtls_x509_*_info(), mbedtls_debug_print_crt()
1690     as well as other functions and constants only used by
1691     those functions. This reduces the code footprint by
1692     several kB.
1693   * Remove SSL error codes `MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED`
1694     and `MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH` which are never
1695     returned from the public SSL API.
1696   * Remove `MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE` and return
1697     `MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL` instead.
1698   * The output parameter of mbedtls_sha512_finish, mbedtls_sha512,
1699     mbedtls_sha256_finish and mbedtls_sha256 now has a pointer type
1700     rather than array type. This removes spurious warnings in some compilers
1701     when outputting a SHA-384 or SHA-224 hash into a buffer of exactly
1702     the hash size.
1703   * Remove the MBEDTLS_TEST_NULL_ENTROPY config option. Fixes #4388.
1704   * The interface of the GCM module has changed to remove restrictions on
1705     how the input to multipart operations is broken down. mbedtls_gcm_finish()
1706     now takes extra output parameters for the last partial output block.
1707     mbedtls_gcm_update() now takes extra parameters for the output length.
1708     The software implementation always produces the full output at each
1709     call to mbedtls_gcm_update(), but alternative implementations activated
1710     by MBEDTLS_GCM_ALT may delay partial blocks to the next call to
1711     mbedtls_gcm_update() or mbedtls_gcm_finish(). Furthermore, applications
1712     no longer pass the associated data to mbedtls_gcm_starts(), but to the
1713     new function mbedtls_gcm_update_ad().
1714     These changes are backward compatible for users of the cipher API.
1715   * Replace MBEDTLS_SHA512_NO_SHA384 config option with MBEDTLS_SHA384_C.
1716     This separates config option enabling the SHA384 algorithm from option
1717     enabling the SHA512 algorithm. Fixes #4034.
1718   * Introduce MBEDTLS_SHA224_C.
1719     This separates config option enabling the SHA224 algorithm from option
1720     enabling SHA256.
1721   * The getter and setter API of the SSL session cache (used for
1722     session-ID based session resumption) has changed to that of
1723     a key-value store with keys being session IDs and values
1724     being opaque instances of `mbedtls_ssl_session`.
1725   * Remove the mode parameter from RSA operation functions. Signature and
1726     decryption functions now always use the private key and verification and
1727     encryption use the public key. Verification functions also no longer have
1728     RNG parameters.
1729   * Modify semantics of `mbedtls_ssl_conf_[opaque_]psk()`:
1730     In Mbed TLS 2.X, the API prescribes that later calls overwrite
1731     the effect of earlier calls. In Mbed TLS 3.0, calling
1732     `mbedtls_ssl_conf_[opaque_]psk()` more than once will fail,
1733     leaving the PSK that was configured first intact.
1734     Support for more than one PSK may be added in 3.X.
1735   * The function mbedtls_x509write_csr_set_extension() has an extra parameter
1736     which allows to mark an extension as critical. Fixes #4055.
1737   * For multi-part AEAD operations with the cipher module, calling
1738     mbedtls_cipher_finish() is now mandatory. Previously the documentation
1739     was unclear on this point, and this function happened to never do
1740     anything with the currently implemented AEADs, so in practice it was
1741     possible to skip calling it, which is no longer supported.
1742   * The option MBEDTLS_ECP_FIXED_POINT_OPTIM use pre-computed comb tables
1743     instead of computing tables in runtime. Thus, this option now increase
1744     code size, and it does not increase RAM usage in runtime anymore.
1745   * Remove the SSL APIs mbedtls_ssl_get_input_max_frag_len() and
1746     mbedtls_ssl_get_output_max_frag_len(), and add a new API
1747     mbedtls_ssl_get_max_in_record_payload(), complementing the existing
1748     mbedtls_ssl_get_max_out_record_payload().
1749     Uses of mbedtls_ssl_get_input_max_frag_len() and
1750     mbedtls_ssl_get_input_max_frag_len() should be replaced by
1751     mbedtls_ssl_get_max_in_record_payload() and
1752     mbedtls_ssl_get_max_out_record_payload(), respectively.
1753   * mbedtls_rsa_init() now always selects the PKCS#1v1.5 encoding for an RSA
1754     key. To use an RSA key with PSS or OAEP, call mbedtls_rsa_set_padding()
1755     after initializing the context. mbedtls_rsa_set_padding() now returns an
1756     error if its parameters are invalid.
1757   * Replace MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE by a runtime
1758     configuration function mbedtls_ssl_conf_preference_order(). Fixes #4398.
1759   * Instead of accessing the len field of a DHM context, which is no longer
1760     supported, use the new function mbedtls_dhm_get_len() .
1761   * In modules that implement cryptographic hash functions, many functions
1762     mbedtls_xxx() now return int instead of void, and the corresponding
1763     function mbedtls_xxx_ret() which was identical except for returning int
1764     has been removed. This also concerns mbedtls_xxx_drbg_update(). See the
1765     migration guide for more information. Fixes #4212.
1766   * For all functions that take a random number generator (RNG) as a
1767     parameter, this parameter is now mandatory (that is, NULL is not an
1768     acceptable value). Functions which previously accepted NULL and now
1769     reject it are: the X.509 CRT and CSR writing functions; the PK and RSA
1770     sign and decrypt function; mbedtls_rsa_private(); the functions
1771     in DHM and ECDH that compute the shared secret; the scalar multiplication
1772     functions in ECP.
1773   * The following functions now require an RNG parameter:
1774     mbedtls_ecp_check_pub_priv(), mbedtls_pk_check_pair(),
1775     mbedtls_pk_parse_key(), mbedtls_pk_parse_keyfile().
1776   * mbedtls_ssl_conf_export_keys_ext_cb() and
1777     mbedtls_ssl_conf_export_keys_cb() have been removed and
1778     replaced by a new API mbedtls_ssl_set_export_keys_cb().
1779     Raw keys and IVs are no longer passed to the callback.
1780     Further, callbacks now receive an additional parameter
1781     indicating the type of secret that's being exported,
1782     paving the way for the larger number of secrets
1783     in TLS 1.3. Finally, the key export callback and
1784     context are now connection-specific.
1785   * Signature functions in the RSA and PK modules now require the hash
1786     length parameter to be the size of the hash input. For RSA signatures
1787     other than raw PKCS#1 v1.5, this must match the output size of the
1788     specified hash algorithm.
1789   * The functions mbedtls_pk_sign(), mbedtls_pk_sign_restartable(),
1790     mbedtls_ecdsa_write_signature() and
1791     mbedtls_ecdsa_write_signature_restartable() now take an extra parameter
1792     indicating the size of the output buffer for the signature.
1793   * Implement one-shot cipher functions, psa_cipher_encrypt and
1794     psa_cipher_decrypt, according to the PSA Crypto API 1.0.0
1795     specification.
1796   * Direct access to fields of structures declared in public headers is no
1797     longer supported except for fields that are documented public. Use accessor
1798     functions instead. For more information, see the migration guide entry
1799     "Most structure fields are now private".
1800   * mbedtls_ssl_get_session_pointer() has been removed, and
1801     mbedtls_ssl_{set,get}_session() may now only be called once for any given
1802     SSL context.
1803
1804Default behavior changes
1805   * Enable by default the functionalities which have no reason to be disabled.
1806     They are: ARIA block cipher, CMAC mode, elliptic curve J-PAKE library and
1807     Key Wrapping mode as defined in NIST SP 800-38F. Fixes #4036.
1808   * Some default policies for X.509 certificate verification and TLS have
1809     changed: curves and hashes weaker than 255 bits are no longer accepted
1810     by default. The default order in TLS now favors faster curves over larger
1811     curves.
1812
1813Requirement changes
1814   * The library now uses the %zu format specifier with the printf() family of
1815     functions, so requires a toolchain that supports it. This change does not
1816     affect the maintained LTS branches, so when contributing changes please
1817     bear this in mind and do not add them to backported code.
1818   * If you build the development version of Mbed TLS, rather than an official
1819     release, some configuration-independent files are now generated at build
1820     time rather than checked into source control. This includes some library
1821     source files as well as the Visual Studio solution. Perl, Python 3 and a
1822     C compiler for the host platform are required. See “Generated source files
1823     in the development branch” in README.md for more information.
1824   * Refresh the minimum supported versions of tools to build the
1825     library. CMake versions older than 3.10.2 and Python older
1826     than 3.6 are no longer supported.
1827
1828Removals
1829   * Remove the MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
1830     compile-time option, which was off by default. Users should not trust
1831     certificates signed with SHA-1 due to the known attacks against SHA-1.
1832     If needed, SHA-1 certificates can still be verified by using a custom
1833     verification profile.
1834   * Removed deprecated things in psa/crypto_compat.h. Fixes #4284
1835   * Removed deprecated functions from hashing modules. Fixes #4280.
1836   * Remove PKCS#11 library wrapper. PKCS#11 has limited functionality,
1837     lacks automated tests and has scarce documentation. Also, PSA Crypto
1838     provides a more flexible private key management.
1839     More details on PCKS#11 wrapper removal can be found in the mailing list
1840     https://lists.trustedfirmware.org/pipermail/mbed-tls/2020-April/000024.html
1841   * Remove deprecated error codes. Fix #4283
1842   * Remove MBEDTLS_ENABLE_WEAK_CIPHERSUITES configuration option. Fixes #4416.
1843   * Remove the MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
1844     compile-time option. This option has been inactive for a long time.
1845     Please use the `lifetime` parameter of `mbedtls_ssl_ticket_setup()`
1846     instead.
1847   * Remove the following deprecated functions and constants of hex-encoded
1848     primes based on RFC 5114 and RFC 3526 from library code and tests:
1849     mbedtls_aes_encrypt(), mbedtls_aes_decrypt(), mbedtls_mpi_is_prime(),
1850     mbedtls_cipher_auth_encrypt(), mbedtls_cipher_auth_decrypt(),
1851     mbedtls_ctr_drbg_update(), mbedtls_hmac_drbg_update(),
1852     mbedtls_ecdsa_write_signature_det(), mbedtls_ecdsa_sign_det(),
1853     mbedtls_ssl_conf_dh_param(), mbedtls_ssl_get_max_frag_len(),
1854     MBEDTLS_DHM_RFC5114_MODP_2048_P, MBEDTLS_DHM_RFC5114_MODP_2048_G,
1855     MBEDTLS_DHM_RFC3526_MODP_2048_P, MBEDTLS_DHM_RFC3526_MODP_2048_G,
1856     MBEDTLS_DHM_RFC3526_MODP_3072_P, MBEDTLS_DHM_RFC3526_MODP_3072_G,
1857     MBEDTLS_DHM_RFC3526_MODP_4096_P, MBEDTLS_DHM_RFC3526_MODP_4096_G.
1858     Remove the deprecated file: include/mbedtls/net.h. Fixes #4282.
1859   * Remove MBEDTLS_SSL_MAX_CONTENT_LEN configuration option, since
1860     MBEDTLS_SSL_IN_CONTENT_LEN and MBEDTLS_SSL_OUT_CONTENT_LEN replace
1861     it. Fixes #4362.
1862   * Remove the MBEDTLS_SSL_RECORD_CHECKING option and enable by default its
1863     previous action. Fixes #4361.
1864   * Remove support for TLS 1.0, TLS 1.1 and DTLS 1.0, as well as support for
1865     CBC record splitting, fallback SCSV, and the ability to configure
1866     ciphersuites per version, which are no longer relevant. This removes the
1867     configuration options MBEDTLS_SSL_PROTO_TLS1,
1868     MBEDTLS_SSL_PROTO_TLS1_1, MBEDTLS_SSL_CBC_RECORD_SPLITTING and
1869     MBEDTLS_SSL_FALLBACK_SCSV as well as the functions
1870     mbedtls_ssl_conf_cbc_record_splitting(),
1871     mbedtls_ssl_get_key_exchange_md_ssl_tls(), mbedtls_ssl_conf_fallback(),
1872     and mbedtls_ssl_conf_ciphersuites_for_version(). Fixes #4286.
1873   * The RSA module no longer supports private-key operations with the public
1874     key and vice versa.
1875   * Remove the MBEDTLS_SSL_DTLS_BADMAC_LIMIT config.h option. Fixes #4403.
1876   * Remove all the 3DES ciphersuites:
1877     MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA,
1878     MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA,
1879     MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA,
1880     MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA,
1881     MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,
1882     MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA,
1883     MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA,
1884     MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA,
1885     MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA. Remove the
1886     MBEDTLS_REMOVE_3DES_CIPHERSUITES option which is no longer relevant.
1887     Fixes #4367.
1888   * Remove the MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3 option and let the code
1889     behave as if it was always disabled. Fixes #4386.
1890   * Remove MBEDTLS_ECDH_LEGACY_CONTEXT config option since this was purely for
1891     backward compatibility which is no longer supported. Addresses #4404.
1892   * Remove the following macros: MBEDTLS_CHECK_PARAMS,
1893     MBEDTLS_CHECK_PARAMS_ASSERT, MBEDTLS_PARAM_FAILED,
1894     MBEDTLS_PARAM_FAILED_ALT. Fixes #4313.
1895   * Remove the  MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION config.h
1896     option. The mbedtls_x509_crt_parse_der_with_ext_cb() is the way to go for
1897     migration path. Fixes #4378.
1898   * Remove the MBEDTLS_X509_CHECK_KEY_USAGE and
1899     MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE config.h options and let the code
1900     behave as if they were always enabled. Fixes #4405.
1901   * MBEDTLS_ECP_MAX_BITS is no longer a configuration option because it is
1902     now determined automatically based on supported curves.
1903   * Remove the following functions: mbedtls_timing_self_test(),
1904     mbedtls_hardclock_poll(), mbedtls_timing_hardclock() and
1905     mbedtls_set_alarm(). Fixes #4083.
1906   * The configuration option MBEDTLS_ECP_NO_INTERNAL_RNG has been removed as
1907     it no longer had any effect.
1908   * Remove all support for MD2, MD4, RC4, Blowfish and XTEA. This removes the
1909     corresponding modules and all their APIs and related configuration
1910     options. Fixes #4084.
1911   * Remove MBEDTLS_SSL_TRUNCATED_HMAC and also remove
1912     MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT config option. Users are better served by
1913     using a CCM-8 ciphersuite than a CBC ciphersuite with truncated HMAC.
1914     See issue #4341 for more details.
1915   * Remove the compile-time option
1916     MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE.
1917
1918Features
1919   * Add mbedtls_rsa_rsassa_pss_sign_ext() function allowing to generate a
1920     signature with a specific salt length. This function allows to validate
1921     test cases provided in the NIST's CAVP test suite. Contributed by Cédric
1922     Meuter in PR #3183.
1923   * Added support for built-in driver keys through the PSA opaque crypto
1924     driver interface. Refer to the documentation of
1925     MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS for more information.
1926   * Implement psa_sign_message() and psa_verify_message().
1927   * The multi-part GCM interface (mbedtls_gcm_update() or
1928     mbedtls_cipher_update()) no longer requires the size of partial inputs to
1929     be a multiple of 16.
1930   * The multi-part GCM interface now supports chunked associated data through
1931     multiple calls to mbedtls_gcm_update_ad().
1932   * The new function mbedtls_mpi_random() generates a random value in a
1933     given range uniformly.
1934   * Alternative implementations of the AES, DHM, ECJPAKE, ECP, RSA and timing
1935     modules had undocumented constraints on their context types. These
1936     constraints have been relaxed.
1937     See docs/architecture/alternative-implementations.md for the remaining
1938     constraints.
1939   * The new functions mbedtls_dhm_get_len() and mbedtls_dhm_get_bitlen()
1940     query the size of the modulus in a Diffie-Hellman context.
1941   * The new function mbedtls_dhm_get_value() copy a field out of a
1942     Diffie-Hellman context.
1943   * Use the new function mbedtls_ecjpake_set_point_format() to select the
1944     point format for ECJPAKE instead of accessing the point_format field
1945     directly, which is no longer supported.
1946   * Implement psa_mac_compute() and psa_mac_verify() as defined in the
1947     PSA Cryptograpy API 1.0.0 specification.
1948
1949Security
1950   * Fix a bias in the generation of finite-field Diffie-Hellman-Merkle (DHM)
1951     private keys and of blinding values for DHM and elliptic curves (ECP)
1952     computations. Reported by FlorianF89 in #4245.
1953   * Fix a potential side channel vulnerability in ECDSA ephemeral key generation.
1954     An adversary who is capable of very precise timing measurements could
1955     learn partial information about the leading bits of the nonce used for the
1956     signature, allowing the recovery of the private key after observing a
1957     large number of signature operations. This completes a partial fix in
1958     Mbed TLS 2.20.0.
1959   * Fix an issue where an adversary with access to precise enough information
1960     about memory accesses (typically, an untrusted operating system attacking
1961     a secure enclave) could recover an RSA private key after observing the
1962     victim performing a single private-key operation. Found and reported by
1963     Zili KOU, Wenjian HE, Sharad Sinha, and Wei ZHANG.
1964   * Fix an issue where an adversary with access to precise enough timing
1965     information (typically, a co-located process) could recover a Curve25519
1966     or Curve448 static ECDH key after inputting a chosen public key and
1967     observing the victim performing the corresponding private-key operation.
1968     Found and reported by Leila Batina, Lukas Chmielewski, Björn Haase, Niels
1969     Samwel and Peter Schwabe.
1970
1971Bugfix
1972   * Fix premature fopen() call in mbedtls_entropy_write_seed_file which may
1973     lead to the seed file corruption in case if the path to the seed file is
1974     equal to MBEDTLS_PLATFORM_STD_NV_SEED_FILE. Contributed by Victor
1975     Krasnoshchok in #3616.
1976   * PSA functions creating a key now return PSA_ERROR_INVALID_ARGUMENT rather
1977     than PSA_ERROR_INVALID_HANDLE when the identifier specified for the key
1978     to create is not valid, bringing them in line with version 1.0.0 of the
1979     specification. Fix #4271.
1980   * Add printf function attributes to mbedtls_debug_print_msg to ensure we
1981     get printf format specifier warnings.
1982   * PSA functions other than psa_open_key now return PSA_ERROR_INVALID_HANDLE
1983     rather than PSA_ERROR_DOES_NOT_EXIST for an invalid handle, bringing them
1984     in line with version 1.0.0 of the specification. Fix #4162.
1985   * Fix a bug in ECDSA that would cause it to fail when the hash is all-bits
1986     zero. Fixes #1792
1987   * Fix some cases in the bignum module where the library constructed an
1988     unintended representation of the value 0 which was not processed
1989     correctly by some bignum operations. This could happen when
1990     mbedtls_mpi_read_string() was called on "-0", or when
1991     mbedtls_mpi_mul_mpi() and mbedtls_mpi_mul_int() was called with one of
1992     the arguments being negative and the other being 0. Fixes #4643.
1993   * Fix a compilation error when MBEDTLS_ECP_RANDOMIZE_MXZ_ALT is
1994     defined. Fixes #4217.
1995   * Fix an incorrect error code when parsing a PKCS#8 private key.
1996   * In a TLS client, enforce the Diffie-Hellman minimum parameter size
1997     set with mbedtls_ssl_conf_dhm_min_bitlen() precisely. Before, the
1998     minimum size was rounded down to the nearest multiple of 8.
1999   * In library/net_sockets.c, _POSIX_C_SOURCE and _XOPEN_SOURCE are
2000     defined to specific values.  If the code is used in a context
2001     where these are already defined, this can result in a compilation
2002     error.  Instead, assume that if they are defined, the values will
2003     be adequate to build Mbed TLS.
2004   * With MBEDTLS_PSA_CRYPTO_C disabled, some functions were getting built
2005     nonetheless, resulting in undefined reference errors when building a
2006     shared library. Reported by Guillermo Garcia M. in #4411.
2007   * The cipher suite TLS-RSA-WITH-CAMELLIA-256-GCM-SHA384 was not available
2008     when SHA-1 was disabled and was offered when SHA-1 was enabled but SHA-384
2009     was disabled. Fix the dependency. Fixes #4472.
2010   * Do not offer SHA384 cipher suites when SHA-384 is disabled. Fixes #4499.
2011   * Fix test suite code on platforms where int32_t is not int, such as
2012     Arm Cortex-M. Fixes #4530.
2013   * Fix some issues affecting MBEDTLS_ARIA_ALT implementations: a misplaced
2014     directive in a header and a missing initialization in the self-test.
2015   * Fix a missing initialization in the Camellia self-test, affecting
2016     MBEDTLS_CAMELLIA_ALT implementations.
2017   * Restore the ability to configure PSA via Mbed TLS options to support RSA
2018     key pair operations but exclude RSA key generation. When MBEDTLS_GENPRIME
2019     is not defined PSA will no longer attempt to use mbedtls_rsa_gen_key().
2020     Fixes #4512.
2021   * Fix a regression introduced in 2.24.0 which broke (D)TLS CBC ciphersuites
2022     (when the encrypt-then-MAC extension is not in use) with some ALT
2023     implementations of the underlying hash (SHA-1, SHA-256, SHA-384), causing
2024     the affected side to wrongly reject valid messages. Fixes #4118.
2025   * Remove outdated check-config.h check that prevented implementing the
2026     timing module on Mbed OS. Fixes #4633.
2027   * Fix PSA_ALG_TLS12_PRF and PSA_ALG_TLS12_PSK_TO_MS being too permissive
2028     about missing inputs.
2029   * Fix mbedtls_net_poll() and mbedtls_net_recv_timeout() often failing with
2030     MBEDTLS_ERR_NET_POLL_FAILED on Windows. Fixes #4465.
2031   * Fix a resource leak in a test suite with an alternative AES
2032     implementation. Fixes #4176.
2033   * Fix a crash in mbedtls_mpi_debug_mpi on a bignum having 0 limbs. This
2034     could notably be triggered by setting the TLS debug level to 3 or above
2035     and using a Montgomery curve for the key exchange. Reported by lhuang04
2036     in #4578. Fixes #4608.
2037   * psa_verify_hash() was relying on implementation-specific behavior of
2038     mbedtls_rsa_rsassa_pss_verify() and was causing failures in some _ALT
2039     implementations. This reliance is now removed. Fixes #3990.
2040   * Disallow inputs of length different from the corresponding hash when
2041     signing or verifying with PSA_ALG_RSA_PSS (The PSA Crypto API mandates
2042     that PSA_ALG_RSA_PSS uses the same hash throughout the algorithm.)
2043   * Fix a null pointer dereference when mbedtls_mpi_exp_mod() was called with
2044     A=0 represented with 0 limbs. Up to and including Mbed TLS 2.26, this bug
2045     could not be triggered by code that constructed A with one of the
2046     mbedtls_mpi_read_xxx functions (including in particular TLS code) since
2047     those always built an mpi object with at least one limb.
2048     Credit to OSS-Fuzz. Fixes #4641.
2049   * Fix mbedtls_mpi_gcd(G,A,B) when the value of B is zero. This had no
2050     effect on Mbed TLS's internal use of mbedtls_mpi_gcd(), but may affect
2051     applications that call mbedtls_mpi_gcd() directly. Fixes #4642.
2052   * The PSA API no longer allows the creation or destruction of keys with a
2053     read-only lifetime. The persistence level PSA_KEY_PERSISTENCE_READ_ONLY
2054     can now only be used as intended, for keys that cannot be modified through
2055     normal use of the API.
2056   * When MBEDTLS_PSA_CRYPTO_SPM is enabled, crypto_spe.h was not included
2057     in all the right places. Include it from crypto_platform.h, which is
2058     the natural place. Fixes #4649.
2059   * Fix which alert is sent in some cases to conform to the
2060     applicable RFC: on an invalid Finished message value, an
2061     invalid max_fragment_length extension, or an
2062     unsupported extension used by the server.
2063   * Correct (change from 12 to 13 bytes) the value of the macro describing the
2064     maximum nonce length returned by psa_aead_generate_nonce().
2065
2066Changes
2067   * Fix the setting of the read timeout in the DTLS sample programs.
2068   * Add extra printf compiler warning flags to builds.
2069   * Fix memsan build false positive in x509_crt.c with clang 11
2070   * Alternative implementations of CMAC may now opt to not support 3DES as a
2071     CMAC block cipher, and still pass the CMAC self test.
2072   * Remove the AES sample application programs/aes/aescrypt2 which shows
2073     bad cryptographic practice. Fix #1906.
2074   * Remove configs/config-psa-crypto.h, which no longer had any intended
2075     differences from the default configuration, but had accidentally diverged.
2076   * When building the test suites with GNU make, invoke python3 or python, not
2077     python2, which is no longer supported upstream.
2078   * fix build failure on MinGW toolchain when __USE_MING_ANSI_STDIO is on.
2079     When that flag is on, standard GNU C printf format specifiers
2080     should be used.
2081   * Replace MBEDTLS_SSL_CID_PADDING_GRANULARITY and
2082     MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY with a new single unified option
2083     MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY. Fixes #4335.
2084   * Reduce the default value of MBEDTLS_ECP_WINDOW_SIZE. This reduces RAM usage
2085     during ECC operations at a negligible performance cost.
2086   * mbedtls_mpi_read_binary(), mbedtls_mpi_read_binary_le() and
2087     mbedtls_mpi_read_string() now construct an mbedtls_mpi object with 0 limbs
2088     when their input has length 0. Note that this is an implementation detail
2089     and can change at any time, so this change should be transparent, but it
2090     may result in mbedtls_mpi_write_binary() or mbedtls_mpi_write_string()
2091     now writing an empty string where it previously wrote one or more
2092     zero digits when operating from values constructed with an mpi_read
2093     function and some mpi operations.
2094   * Add CMake package config generation for CMake projects consuming Mbed TLS.
2095   * config.h has been split into build_info.h and mbedtls_config.h
2096     build_info.h is intended to be included from C code directly, while
2097     mbedtls_config.h is intended to be edited by end users wishing to
2098     change the build configuration, and should generally only be included from
2099     build_info.h.
2100   * The handling of MBEDTLS_CONFIG_FILE has been moved into build_info.h.
2101   * A config file version symbol, MBEDTLS_CONFIG_VERSION was introduced.
2102     Defining it to a particular value will ensure that Mbed TLS interprets
2103     the config file in a way that's compatible with the config file format
2104     used by the Mbed TLS release whose MBEDTLS_VERSION_NUMBER has the same
2105     value.
2106     The only value supported by Mbed TLS 3.0.0 is 0x03000000.
2107   * Various changes to which alert and/or error code may be returned
2108   * during the TLS handshake.
2109   * Implicitly add PSA_KEY_USAGE_SIGN_MESSAGE key usage policy flag when
2110     PSA_KEY_USAGE_SIGN_HASH flag is set and PSA_KEY_USAGE_VERIFY_MESSAGE flag
2111     when PSA_KEY_USAGE_VERIFY_HASH flag is set. This usage flag extension
2112     is also applied when loading a key from storage.
2113
2114= mbed TLS 2.26.0 branch released 2021-03-08
2115
2116API changes
2117   * Renamed the PSA Crypto API output buffer size macros to bring them in line
2118     with version 1.0.0 of the specification.
2119   * The API glue function mbedtls_ecc_group_of_psa() now takes the curve size
2120     in bits rather than bytes, with an additional flag to indicate if the
2121     size may have been rounded up to a whole number of bytes.
2122   * Renamed the PSA Crypto API AEAD tag length macros to bring them in line
2123     with version 1.0.0 of the specification.
2124
2125Default behavior changes
2126   * In mbedtls_rsa_context objects, the ver field was formerly documented
2127     as always 0. It is now reserved for internal purposes and may take
2128     different values.
2129
2130New deprecations
2131   * PSA_KEY_EXPORT_MAX_SIZE, PSA_HASH_SIZE, PSA_MAC_FINAL_SIZE,
2132     PSA_BLOCK_CIPHER_BLOCK_SIZE, PSA_MAX_BLOCK_CIPHER_BLOCK_SIZE and
2133     PSA_ALG_TLS12_PSK_TO_MS_MAX_PSK_LEN have been renamed, and the old names
2134     deprecated.
2135   * PSA_ALG_AEAD_WITH_DEFAULT_TAG_LENGTH and PSA_ALG_AEAD_WITH_TAG_LENGTH
2136     have been renamed, and the old names deprecated.
2137
2138Features
2139   * The PSA crypto subsystem can now use HMAC_DRBG instead of CTR_DRBG.
2140     CTR_DRBG is used by default if it is available, but you can override
2141     this choice by setting MBEDTLS_PSA_HMAC_DRBG_MD_TYPE at compile time.
2142     Fix #3354.
2143   * Automatic fallback to a software implementation of ECP when
2144     MBEDTLS_ECP_xxx_ALT accelerator hooks are in use can now be turned off
2145     through setting the new configuration flag MBEDTLS_ECP_NO_FALLBACK.
2146   * The PSA crypto subsystem can now be configured to use less static RAM by
2147     tweaking the setting for the maximum amount of keys simultaneously in RAM.
2148     MBEDTLS_PSA_KEY_SLOT_COUNT sets the maximum number of volatile keys that
2149     can exist simultaneously. It has a sensible default if not overridden.
2150   * Partial implementation of the PSA crypto driver interface: Mbed TLS can
2151     now use an external random generator instead of the library's own
2152     entropy collection and DRBG code. Enable MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
2153     and see the documentation of mbedtls_psa_external_get_random() for details.
2154   * Applications using both mbedtls_xxx and psa_xxx functions (for example,
2155     applications using TLS and MBEDTLS_USE_PSA_CRYPTO) can now use the PSA
2156     random generator with mbedtls_xxx functions. See the documentation of
2157     mbedtls_psa_get_random() for details.
2158   * In the PSA API, the policy for a MAC or AEAD algorithm can specify a
2159     minimum MAC or tag length thanks to the new wildcards
2160     PSA_ALG_AT_LEAST_THIS_LENGTH_MAC and
2161     PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG.
2162
2163Security
2164   * Fix a security reduction in CTR_DRBG when the initial seeding obtained a
2165     nonce from entropy. Applications were affected if they called
2166     mbedtls_ctr_drbg_set_nonce_len(), if they called
2167     mbedtls_ctr_drbg_set_entropy_len() with a size that was 3/2 times the key
2168     length, or when the entropy module uses SHA-256 and CTR_DRBG uses AES-256.
2169     In such cases, a random nonce was necessary to achieve the advertised
2170     security strength, but the code incorrectly used a constant instead of
2171     entropy from the nonce.
2172     Found by John Stroebel in #3819 and fixed in #3973.
2173   * Fix a buffer overflow in mbedtls_mpi_sub_abs() when calculating
2174     |A| - |B| where |B| is larger than |A| and has more limbs (so the
2175     function should return MBEDTLS_ERR_MPI_NEGATIVE_VALUE). Only
2176     applications calling mbedtls_mpi_sub_abs() directly are affected:
2177     all calls inside the library were safe since this function is
2178     only called with |A| >= |B|. Reported by Guido Vranken in #4042.
2179   * Fix an errorneous estimation for an internal buffer in
2180     mbedtls_pk_write_key_pem(). If MBEDTLS_MPI_MAX_SIZE is set to an odd
2181     value the function might fail to write a private RSA keys of the largest
2182     supported size.
2183     Found by Daniel Otte, reported in #4093 and fixed in #4094.
2184   * Fix a stack buffer overflow with mbedtls_net_poll() and
2185     mbedtls_net_recv_timeout() when given a file descriptor that is
2186     beyond FD_SETSIZE. Reported by FigBug in #4169.
2187   * Guard against strong local side channel attack against base64 tables by
2188     making access aceess to them use constant flow code.
2189
2190Bugfix
2191   * Fix use-after-scope error in programs/ssl/ssl_client2.c and ssl_server2.c
2192   * Fix memory leak that occured when calling psa_close_key() on a
2193     wrapped key with MBEDTLS_PSA_CRYPTO_SE_C defined.
2194   * Fix an incorrect error code if an RSA private operation glitched.
2195   * Fix a memory leak in an error case in psa_generate_derived_key_internal().
2196   * Fix a resource leak in CTR_DRBG and HMAC_DRBG when MBEDTLS_THREADING_C
2197     is enabled, on platforms where initializing a mutex allocates resources.
2198     This was a regression introduced in the previous release. Reported in
2199     #4017, #4045 and #4071.
2200   * Ensure that calling mbedtls_rsa_free() or mbedtls_entropy_free()
2201     twice is safe. This happens for RSA when some Mbed TLS library functions
2202     fail. Such a double-free was not safe when MBEDTLS_THREADING_C was
2203     enabled on platforms where freeing a mutex twice is not safe.
2204   * Fix a resource leak in a bad-arguments case of mbedtls_rsa_gen_key()
2205     when MBEDTLS_THREADING_C is enabled on platforms where initializing
2206     a mutex allocates resources.
2207   * Fixes a bug where, if the library was configured to include support for
2208     both the old SE interface and the new PSA driver interface, external keys were
2209     not loaded from storage. This was fixed by #3996.
2210   * This change makes 'mbedtls_x509write_crt_set_basic_constraints'
2211     consistent with RFC 5280 4.2.1.9 which says: "Conforming CAs MUST
2212     include this extension in all CA certificates that contain public keys
2213     used to validate digital signatures on certificates and MUST mark the
2214     extension as critical in such certificates." Previous to this change,
2215     the extension was always marked as non-critical. This was fixed by
2216     #3698.
2217
2218Changes
2219   * A new library C file psa_crypto_client.c has been created to contain
2220     the PSA code needed by a PSA crypto client when the PSA crypto
2221     implementation is not included into the library.
2222   * On recent enough versions of FreeBSD and DragonFlyBSD, the entropy module
2223     now uses the getrandom syscall instead of reading from /dev/urandom.
2224
2225= mbed TLS 2.25.0 branch released 2020-12-11
2226
2227API changes
2228   * The numerical values of the PSA Crypto API macros have been updated to
2229     conform to version 1.0.0 of the specification.
2230   * PSA_ALG_STREAM_CIPHER replaces PSA_ALG_CHACHA20 and PSA_ALG_ARC4.
2231     The underlying stream cipher is determined by the key type
2232     (PSA_KEY_TYPE_CHACHA20 or PSA_KEY_TYPE_ARC4).
2233   * The functions mbedtls_cipher_auth_encrypt() and
2234     mbedtls_cipher_auth_decrypt() no longer accept NIST_KW contexts,
2235     as they have no way to check if the output buffer is large enough.
2236     Please use mbedtls_cipher_auth_encrypt_ext() and
2237     mbedtls_cipher_auth_decrypt_ext() instead. Credit to OSS-Fuzz and
2238     Cryptofuzz. Fixes #3665.
2239
2240Requirement changes
2241   * Update the minimum required CMake version to 2.8.12.  This silences a
2242     warning on CMake 3.19.0. #3801
2243
2244New deprecations
2245   * PSA_ALG_CHACHA20 and PSA_ALG_ARC4 have been deprecated.
2246     Use PSA_ALG_STREAM_CIPHER instead.
2247   * The functions mbedtls_cipher_auth_encrypt() and
2248     mbedtls_cipher_auth_decrypt() are deprecated in favour of the new
2249     functions mbedtls_cipher_auth_encrypt_ext() and
2250     mbedtls_cipher_auth_decrypt_ext(). Please note that with AEAD ciphers,
2251     these new functions always append the tag to the ciphertext, and include
2252     the tag in the ciphertext length.
2253
2254Features
2255   * Partial implementation of the new PSA Crypto accelerator APIs. (Symmetric
2256     ciphers, asymmetric signing/verification and key generation, validate_key
2257     entry point, and export_public_key interface.)
2258   * Add support for ECB to the PSA cipher API.
2259   * In PSA, allow using a key declared with a base key agreement algorithm
2260     in combined key agreement and derivation operations, as long as the key
2261     agreement algorithm in use matches the algorithm the key was declared with.
2262     This is currently non-standard behaviour, but expected to make it into a
2263     future revision of the PSA Crypto standard.
2264   * Add MBEDTLS_TARGET_PREFIX CMake variable, which is prefixed to the mbedtls,
2265     mbedcrypto, mbedx509 and apidoc CMake target names. This can be used by
2266     external CMake projects that include this one to avoid CMake target name
2267     clashes.  The default value of this variable is "", so default target names
2268     are unchanged.
2269   * Add support for DTLS-SRTP as defined in RFC 5764. Contributed by Johan
2270     Pascal, improved by Ron Eldor.
2271   * In the PSA API, it is no longer necessary to open persistent keys:
2272     operations now accept the key identifier. The type psa_key_handle_t is now
2273     identical to psa_key_id_t instead of being platform-defined. This bridges
2274     the last major gap to compliance with the PSA Cryptography specification
2275     version 1.0.0. Opening persistent keys is still supported for backward
2276     compatibility, but will be deprecated and later removed in future
2277     releases.
2278   * PSA_AEAD_NONCE_LENGTH, PSA_AEAD_NONCE_MAX_SIZE, PSA_CIPHER_IV_LENGTH and
2279     PSA_CIPHER_IV_MAX_SIZE macros have been added as defined in version
2280     1.0.0 of the PSA Crypto API specification.
2281
2282Security
2283   * The functions mbedtls_cipher_auth_encrypt() and
2284     mbedtls_cipher_auth_decrypt() would write past the minimum documented
2285     size of the output buffer when used with NIST_KW. As a result, code using
2286     those functions as documented with NIST_KW could have a buffer overwrite
2287     of up to 15 bytes, with consequences ranging up to arbitrary code
2288     execution depending on the location of the output buffer.
2289   * Limit the size of calculations performed by mbedtls_mpi_exp_mod to
2290     MBEDTLS_MPI_MAX_SIZE to prevent a potential denial of service when
2291     generating Diffie-Hellman key pairs. Credit to OSS-Fuzz.
2292   * A failure of the random generator was ignored in mbedtls_mpi_fill_random(),
2293     which is how most uses of randomization in asymmetric cryptography
2294     (including key generation, intermediate value randomization and blinding)
2295     are implemented. This could cause failures or the silent use of non-random
2296     values. A random generator can fail if it needs reseeding and cannot not
2297     obtain entropy, or due to an internal failure (which, for Mbed TLS's own
2298     CTR_DRBG or HMAC_DRBG, can only happen due to a misconfiguration).
2299   * Fix a compliance issue whereby we were not checking the tag on the
2300     algorithm parameters (only the size) when comparing the signature in the
2301     description part of the cert to the real signature. This meant that a
2302     NULL algorithm parameters entry would look identical to an array of REAL
2303     (size zero) to the library and thus the certificate would be considered
2304     valid. However, if the parameters do not match in *any* way then the
2305     certificate should be considered invalid, and indeed OpenSSL marks these
2306     certs as invalid when mbedtls did not.
2307     Many thanks to guidovranken who found this issue via differential fuzzing
2308     and reported it in #3629.
2309   * Zeroising of local buffers and variables which are used for calculations
2310     in mbedtls_pkcs5_pbkdf2_hmac(), mbedtls_internal_sha*_process(),
2311     mbedtls_internal_md*_process() and mbedtls_internal_ripemd160_process()
2312     functions to erase sensitive data from memory. Reported by
2313     Johan Malmgren and Johan Uppman Bruce from Sectra.
2314
2315Bugfix
2316   * Fix an invalid (but nonzero) return code from mbedtls_pk_parse_subpubkey()
2317     when the input has trailing garbage. Fixes #2512.
2318   * Fix build failure in configurations where MBEDTLS_USE_PSA_CRYPTO is
2319     enabled but ECDSA is disabled. Contributed by jdurkop. Fixes #3294.
2320   * Include the psa_constant_names generated source code in the source tree
2321     instead of generating it at build time. Fixes #3524.
2322   * Fix rsa_prepare_blinding() to retry when the blinding value is not
2323     invertible (mod N), instead of returning MBEDTLS_ERR_RSA_RNG_FAILED. This
2324     addresses a regression but is rare in practice (approx. 1 in 2/sqrt(N)).
2325     Found by Synopsys Coverity, fix contributed by Peter Kolbus (Garmin).
2326     Fixes #3647.
2327   * Use socklen_t on Android and other POSIX-compliant system
2328   * Fix the build when the macro _GNU_SOURCE is defined to a non-empty value.
2329     Fix #3432.
2330   * Consistently return PSA_ERROR_INVALID_ARGUMENT on invalid cipher input
2331     sizes (instead of PSA_ERROR_BAD_STATE in some cases) to make the
2332     psa_cipher_* functions compliant with the PSA Crypto API specification.
2333   * mbedtls_ecp_curve_list() now lists Curve25519 and Curve448 under the names
2334     "x25519" and "x448". These curves support ECDH but not ECDSA. If you need
2335     only the curves that support ECDSA, filter the list with
2336     mbedtls_ecdsa_can_do().
2337   * Fix psa_generate_key() returning an error when asked to generate
2338     an ECC key pair on Curve25519 or secp244k1.
2339   * Fix psa_key_derivation_output_key() to allow the output of a combined key
2340     agreement and subsequent key derivation operation to be used as a key
2341     inside of the PSA Crypto core.
2342   * Fix handling of EOF against 0xff bytes and on platforms with unsigned
2343     chars. Fixes a build failure on platforms where char is unsigned. Fixes
2344     #3794.
2345   * Fix an off-by-one error in the additional data length check for
2346     CCM, which allowed encryption with a non-standard length field.
2347     Fixes #3719.
2348   * Correct the default IV size for mbedtls_cipher_info_t structures using
2349     MBEDTLS_MODE_ECB to 0, since ECB mode ciphers don't use IVs.
2350   * Make arc4random_buf available on NetBSD and OpenBSD when _POSIX_C_SOURCE is
2351     defined. Fix contributed in #3571.
2352   * Fix conditions for including string.h in error.c. Fixes #3866.
2353   * psa_set_key_id() now also sets the lifetime to persistent for keys located
2354     in a secure element.
2355   * Attempting to create a volatile key with a non-zero key identifier now
2356     fails. Previously the key identifier was just ignored when creating a
2357     volatile key.
2358   * Attempting to create or register a key with a key identifier in the vendor
2359     range now fails.
2360   * Fix build failures on GCC 11. Fixes #3782.
2361   * Add missing arguments of debug message in mbedtls_ssl_decrypt_buf.
2362   * Fix a memory leak in mbedtls_mpi_sub_abs() when the result was negative
2363     (an error condition) and the second operand was aliased to the result.
2364   * Fix a case in elliptic curve arithmetic where an out-of-memory condition
2365     could go undetected, resulting in an incorrect result.
2366   * In CTR_DRBG and HMAC_DRBG, don't reset the reseed interval in seed().
2367     Fixes #2927.
2368   * In PEM writing functions, fill the trailing part of the buffer with null
2369     bytes. This guarantees that the corresponding parsing function can read
2370     the buffer back, which was the case for mbedtls_x509write_{crt,csr}_pem
2371     until this property was inadvertently broken in Mbed TLS 2.19.0.
2372     Fixes #3682.
2373   * Fix a build failure that occurred with the MBEDTLS_AES_SETKEY_DEC_ALT
2374     option on. In this configuration key management methods that are required
2375     for MBEDTLS_CIPHER_MODE_XTS were excluded from the build and made it fail.
2376     Fixes #3818. Reported by John Stroebel.
2377
2378Changes
2379   * Reduce stack usage significantly during sliding window exponentiation.
2380     Reported in #3591 and fix contributed in #3592 by Daniel Otte.
2381   * The PSA persistent storage format is updated to always store the key bits
2382     attribute. No automatic upgrade path is provided. Previously stored keys
2383     must be erased, or manually upgraded based on the key storage format
2384     specification (docs/architecture/mbed-crypto-storage-specification.md).
2385     Fixes #3740.
2386   * Remove the zeroization of a pointer variable in AES rounds. It was valid
2387     but spurious and misleading since it looked like a mistaken attempt to
2388     zeroize the pointed-to buffer. Reported by Antonio de la Piedra, CEA
2389     Leti, France.
2390
2391= mbed TLS 2.24.0 branch released 2020-09-01
2392
2393API changes
2394   * In the PSA API, rename the types of elliptic curve and Diffie-Hellman
2395     group families to psa_ecc_family_t and psa_dh_family_t, in line with the
2396     PSA Crypto API specification version 1.0.0.
2397     Rename associated macros as well:
2398     PSA_ECC_CURVE_xxx renamed to PSA_ECC_FAMILY_xxx
2399     PSA_DH_GROUP_xxx renamed to PSA_DH_FAMILY_xxx
2400     PSA_KEY_TYPE_GET_CURVE renamed to to PSA_KEY_TYPE_ECC_GET_FAMILY
2401     PSA_KEY_TYPE_GET_GROUP renamed to PSA_KEY_TYPE_DH_GET_FAMILY
2402
2403Default behavior changes
2404   * Stop storing persistent information about externally stored keys created
2405     through PSA Crypto with a volatile lifetime. Reported in #3288 and
2406     contributed by Steven Cooreman in #3382.
2407
2408Features
2409   * The new function mbedtls_ecp_write_key() exports private ECC keys back to
2410     a byte buffer. It is the inverse of the existing mbedtls_ecp_read_key().
2411   * Support building on e2k (Elbrus) architecture: correctly enable
2412     -Wformat-signedness, and fix the code that causes signed-one-bit-field
2413     and sign-compare warnings. Contributed by makise-homura (Igor Molchanov)
2414     <akemi_homura@kurisa.ch>.
2415
2416Security
2417   * Fix a vulnerability in the verification of X.509 certificates when
2418     matching the expected common name (the cn argument of
2419     mbedtls_x509_crt_verify()) with the actual certificate name: when the
2420     subjecAltName extension is present, the expected name was compared to any
2421     name in that extension regardless of its type. This means that an
2422     attacker could for example impersonate a 4-bytes or 16-byte domain by
2423     getting a certificate for the corresponding IPv4 or IPv6 (this would
2424     require the attacker to control that IP address, though). Similar attacks
2425     using other subjectAltName name types might be possible. Found and
2426     reported by kFYatek in #3498.
2427   * When checking X.509 CRLs, a certificate was only considered as revoked if
2428     its revocationDate was in the past according to the local clock if
2429     available. In particular, on builds without MBEDTLS_HAVE_TIME_DATE,
2430     certificates were never considered as revoked. On builds with
2431     MBEDTLS_HAVE_TIME_DATE, an attacker able to control the local clock (for
2432     example, an untrusted OS attacking a secure enclave) could prevent
2433     revocation of certificates via CRLs. Fixed by no longer checking the
2434     revocationDate field, in accordance with RFC 5280. Reported by
2435     yuemonangong in #3340. Reported independently and fixed by
2436     Raoul Strackx and Jethro Beekman in #3433.
2437   * In (D)TLS record decryption, when using a CBC ciphersuites without the
2438     Encrypt-then-Mac extension, use constant code flow memory access patterns
2439     to extract and check the MAC. This is an improvement to the existing
2440     countermeasure against Lucky 13 attacks. The previous countermeasure was
2441     effective against network-based attackers, but less so against local
2442     attackers. The new countermeasure defends against local attackers, even
2443     if they have access to fine-grained measurements. In particular, this
2444     fixes a local Lucky 13 cache attack found and reported by Tuba Yavuz,
2445     Farhaan Fowze, Ken (Yihan) Bai, Grant Hernandez, and Kevin Butler
2446     (University of Florida) and Dave Tian (Purdue University).
2447   * Fix side channel in RSA private key operations and static (finite-field)
2448     Diffie-Hellman. An adversary with precise enough timing and memory access
2449     information (typically an untrusted operating system attacking a secure
2450     enclave) could bypass an existing counter-measure (base blinding) and
2451     potentially fully recover the private key.
2452   * Fix a 1-byte buffer overread in mbedtls_x509_crl_parse_der().
2453     Credit to OSS-Fuzz for detecting the problem and to Philippe Antoine
2454     for pinpointing the problematic code.
2455   * Zeroising of plaintext buffers in mbedtls_ssl_read() to erase unused
2456     application data from memory. Reported in #689 by
2457     Johan Uppman Bruce of Sectra.
2458
2459Bugfix
2460   * Library files installed after a CMake build no longer have execute
2461     permission.
2462   * Use local labels in mbedtls_padlock_has_support() to fix an invalid symbol
2463     redefinition if the function is inlined.
2464     Reported in #3451 and fix contributed in #3452 by okhowang.
2465   * Fix the endianness of Curve25519 keys imported/exported through the PSA
2466     APIs. psa_import_key and psa_export_key will now correctly expect/output
2467     Montgomery keys in little-endian as defined by RFC7748. Contributed by
2468     Steven Cooreman in #3425.
2469   * Fix build errors when the only enabled elliptic curves are Montgomery
2470     curves. Raised by signpainter in #941 and by Taiki-San in #1412. This
2471     also fixes missing declarations reported by Steven Cooreman in #1147.
2472   * Fix self-test failure when the only enabled short Weierstrass elliptic
2473     curve is secp192k1. Fixes #2017.
2474   * PSA key import will now correctly import a Curve25519/Curve448 public key
2475     instead of erroring out. Contributed by Steven Cooreman in #3492.
2476   * Use arc4random_buf on NetBSD instead of rand implementation with cyclical
2477     lower bits. Fix contributed in #3540.
2478   * Fix a memory leak in mbedtls_md_setup() when using HMAC under low memory
2479     conditions. Reported and fix suggested by Guido Vranken in #3486.
2480   * Fix bug in redirection of unit test outputs on platforms where stdout is
2481     defined as a macro. First reported in #2311 and fix contributed in #3528.
2482
2483Changes
2484   * Only pass -Wformat-signedness to versions of GCC that support it. Reported
2485     in #3478 and fix contributed in #3479 by okhowang.
2486   * Reduce the stack consumption of mbedtls_x509write_csr_der() which
2487     previously could lead to stack overflow on constrained devices.
2488     Contributed by Doru Gucea and Simon Leet in #3464.
2489   * Undefine the ASSERT macro before defining it locally, in case it is defined
2490     in a platform header. Contributed by Abdelatif Guettouche in #3557.
2491   * Update copyright notices to use Linux Foundation guidance. As a result,
2492     the copyright of contributors other than Arm is now acknowledged, and the
2493     years of publishing are no longer tracked in the source files. This also
2494     eliminates the need for the lines declaring the files to be part of
2495     MbedTLS. Fixes #3457.
2496   * Add the command line parameter key_pwd to the ssl_client2 and ssl_server2
2497     example applications which allows to provide a password for the key file
2498     specified through the existing key_file argument. This allows the use of
2499     these applications with password-protected key files. Analogously but for
2500     ssl_server2 only, add the command line parameter key_pwd2 which allows to
2501     set a password for the key file provided through the existing key_file2
2502     argument.
2503
2504= mbed TLS 2.23.0 branch released 2020-07-01
2505
2506Default behavior changes
2507   * In the experimental PSA secure element interface, change the encoding of
2508     key lifetimes to encode a persistence level and the location. Although C
2509     prototypes do not effectively change, code calling
2510     psa_register_se_driver() must be modified to pass the driver's location
2511     instead of the keys' lifetime. If the library is upgraded on an existing
2512     device, keys created with the old lifetime value will not be readable or
2513     removable through Mbed TLS after the upgrade.
2514
2515Features
2516   * New functions in the error module return constant strings for
2517     high- and low-level error codes, complementing mbedtls_strerror()
2518     which constructs a string for any error code, including compound
2519     ones, but requires a writable buffer. Contributed by Gaurav Aggarwal
2520     in #3176.
2521   * The new utility programs/ssl/ssl_context_info prints a human-readable
2522     dump of an SSL context saved with mbedtls_ssl_context_save().
2523   * Add support for midipix, a POSIX layer for Microsoft Windows.
2524   * Add new mbedtls_x509_crt_parse_der_with_ext_cb() routine which allows
2525     parsing unsupported certificate extensions via user provided callback.
2526     Contributed by Nicola Di Lieto <nicola.dilieto@gmail.com> in #3243 as
2527     a solution to #3241.
2528   * Pass the "certificate policies" extension to the callback supplied to
2529     mbedtls_x509_crt_parse_der_with_ext_cb() if it contains unsupported
2530     policies (#3419).
2531   * Added support to entropy_poll for the kern.arandom syscall supported on
2532     some BSD systems. Contributed by Nia Alarie in #3423.
2533   * Add support for Windows 2000 in net_sockets. Contributed by opatomic. #3239
2534
2535Security
2536   * Fix a side channel vulnerability in modular exponentiation that could
2537     reveal an RSA private key used in a secure enclave. Noticed by Sangho Lee,
2538     Ming-Wei Shih, Prasun Gera, Taesoo Kim and Hyesoon Kim (Georgia Institute
2539     of Technology); and Marcus Peinado (Microsoft Research). Reported by Raoul
2540     Strackx (Fortanix) in #3394.
2541   * Fix side channel in mbedtls_ecp_check_pub_priv() and
2542     mbedtls_pk_parse_key() / mbedtls_pk_parse_keyfile() (when loading a
2543     private key that didn't include the uncompressed public key), as well as
2544     mbedtls_ecp_mul() / mbedtls_ecp_mul_restartable() when called with a NULL
2545     f_rng argument. An attacker with access to precise enough timing and
2546     memory access information (typically an untrusted operating system
2547     attacking a secure enclave) could fully recover the ECC private key.
2548     Found and reported by Alejandro Cabrera Aldaya and Billy Brumley.
2549   * Fix issue in Lucky 13 counter-measure that could make it ineffective when
2550     hardware accelerators were used (using one of the MBEDTLS_SHAxxx_ALT
2551     macros). This would cause the original Lucky 13 attack to be possible in
2552     those configurations, allowing an active network attacker to recover
2553     plaintext after repeated timing measurements under some conditions.
2554     Reported and fix suggested by Luc Perneel in #3246.
2555
2556Bugfix
2557   * Fix the Visual Studio Release x64 build configuration for mbedtls itself.
2558     Completes a previous fix in Mbed TLS 2.19 that only fixed the build for
2559     the example programs. Reported in #1430 and fix contributed by irwir.
2560   * Fix undefined behavior in X.509 certificate parsing if the
2561     pathLenConstraint basic constraint value is equal to INT_MAX.
2562     The actual effect with almost every compiler is the intended
2563     behavior, so this is unlikely to be exploitable anywhere. #3192
2564   * Fix issue with a detected HW accelerated record error not being exposed
2565     due to shadowed variable. Contributed by Sander Visser in #3310.
2566   * Avoid NULL pointer dereferencing if mbedtls_ssl_free() is called with a
2567     NULL pointer argument. Contributed by Sander Visser in #3312.
2568   * Fix potential linker errors on dual world platforms by inlining
2569     mbedtls_gcc_group_to_psa(). This allows the pk.c module to link separately
2570     from psa_crypto.c. Fixes #3300.
2571   * Remove dead code in X.509 certificate parsing. Contributed by irwir in
2572     #2855.
2573   * Include asn1.h in error.c. Fixes #3328 reported by David Hu.
2574   * Fix potential memory leaks in ecp_randomize_jac() and ecp_randomize_mxz()
2575     when PRNG function fails. Contributed by Jonas Lejeune in #3318.
2576   * Remove unused macros from MSVC projects. Reported in #3297 and fix
2577     submitted in #3333 by irwir.
2578   * Add additional bounds checks in ssl_write_client_hello() preventing
2579     output buffer overflow if the configuration declared a buffer that was
2580     too small.
2581   * Set _POSIX_C_SOURCE to at least 200112L in C99 code. Reported in #3420 and
2582     fix submitted in #3421 by Nia Alarie.
2583   * Fix building library/net_sockets.c and the ssl_mail_client program on
2584     NetBSD. Contributed by Nia Alarie in #3422.
2585   * Fix false positive uninitialised variable reported by cpp-check.
2586     Contributed by Sander Visser in #3311.
2587   * Update iv and len context pointers manually when reallocating buffers
2588     using the MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH feature. This caused issues
2589     when receiving a connection with CID, when these fields were shifted
2590     in ssl_parse_record_header().
2591
2592Changes
2593   * Fix warnings about signedness issues in format strings. The build is now
2594     clean of -Wformat-signedness warnings. Contributed by Kenneth Soerensen
2595     in #3153.
2596   * Fix minor performance issue in operations on Curve25519 caused by using a
2597     suboptimal modular reduction in one place. Found and fix contributed by
2598     Aurelien Jarno in #3209.
2599   * Combine identical cases in switch statements in md.c. Contributed
2600     by irwir in #3208.
2601   * Simplify a bounds check in ssl_write_certificate_request(). Contributed
2602     by irwir in #3150.
2603   * Unify the example programs termination to call mbedtls_exit() instead of
2604     using a return command. This has been done to enable customization of the
2605     behavior in bare metal environments.
2606   * Fix mbedtls_x509_dn_gets to escape non-ASCII characters as "?".
2607     Contributed by Koh M. Nakagawa in #3326.
2608   * Use FindPython3 when cmake version >= 3.15.0
2609   * Abort the ClientHello writing function as soon as some extension doesn't
2610     fit into the record buffer. Previously, such extensions were silently
2611     dropped. As a consequence, the TLS handshake now fails when the output
2612     buffer is not large enough to hold the ClientHello.
2613   * The unit tests now rely on header files in tests/include/test and source
2614     files in tests/src. When building with make or cmake, the files in
2615     tests/src are compiled and the resulting object linked into each test
2616     executable.
2617   * The ECP module, enabled by `MBEDTLS_ECP_C`, now depends on
2618     `MBEDTLS_CTR_DRBG_C` or `MBEDTLS_HMAC_DRBG_C` for some side-channel
2619     coutermeasures. If side channels are not a concern, this dependency can
2620     be avoided by enabling the new option `MBEDTLS_ECP_NO_INTERNAL_RNG`.
2621   * Align MSVC error flag with GCC and Clang. Contributed by Carlos Gomes
2622     Martinho. #3147
2623   * Remove superfluous assignment in mbedtls_ssl_parse_certificate(). Reported
2624     in #3182 and fix submitted by irwir. #3217
2625   * Fix typo in XTS tests. Reported and fix submitted by Kxuan. #3319
2626
2627= mbed TLS 2.22.0 branch released 2020-04-14
2628
2629New deprecations
2630   * Deprecate MBEDTLS_SSL_HW_RECORD_ACCEL that enables function hooks in the
2631     SSL module for hardware acceleration of individual records.
2632   * Deprecate mbedtls_ssl_get_max_frag_len() in favour of
2633     mbedtls_ssl_get_output_max_frag_len() and
2634     mbedtls_ssl_get_input_max_frag_len() to be more precise about which max
2635     fragment length is desired.
2636
2637Security
2638   * Fix issue in DTLS handling of new associations with the same parameters
2639     (RFC 6347 section 4.2.8): an attacker able to send forged UDP packets to
2640     the server could cause it to drop established associations with
2641     legitimate clients, resulting in a Denial of Service. This could only
2642     happen when MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE was enabled in config.h
2643     (which it is by default).
2644   * Fix side channel in ECC code that allowed an adversary with access to
2645     precise enough timing and memory access information (typically an
2646     untrusted operating system attacking a secure enclave) to fully recover
2647     an ECDSA private key. Found and reported by Alejandro Cabrera Aldaya,
2648     Billy Brumley and Cesar Pereida Garcia. CVE-2020-10932
2649   * Fix a potentially remotely exploitable buffer overread in a
2650     DTLS client when parsing the Hello Verify Request message.
2651
2652Features
2653   * The new build option MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH automatically
2654     resizes the I/O buffers before and after handshakes, reducing the memory
2655     consumption during application data transfer.
2656
2657Bugfix
2658   * Fix compilation failure when both MBEDTLS_SSL_PROTO_DTLS and
2659     MBEDTLS_SSL_HW_RECORD_ACCEL are enabled.
2660   * Remove a spurious check in ssl_parse_client_psk_identity that triggered
2661     a warning with some compilers. Fix contributed by irwir in #2856.
2662   * Fix a function name in a debug message. Contributed by Ercan Ozturk in
2663     #3013.
2664
2665Changes
2666   * Mbed Crypto is no longer a Git submodule. The crypto part of the library
2667     is back directly in the present repository.
2668   * Split mbedtls_ssl_get_max_frag_len() into
2669     mbedtls_ssl_get_output_max_frag_len() and
2670     mbedtls_ssl_get_input_max_frag_len() to ensure that a sufficient input
2671     buffer is allocated by the server (if MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2672     is defined), regardless of what MFL was configured for it.
2673
2674= mbed TLS 2.21.0 branch released 2020-02-20
2675
2676New deprecations
2677   * Deprecate MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO that enables parsing
2678     SSLv2 ClientHello messages.
2679   * Deprecate MBEDTLS_SSL_PROTO_SSL3 that enables support for SSLv3.
2680   * Deprecate for MBEDTLS_PKCS11_C, the wrapper around the pkcs11-helper
2681     library which allows TLS authentication to use keys stored in a
2682     PKCS#11 token such as a smartcard.
2683
2684Security
2685   * Fix potential memory overread when performing an ECDSA signature
2686     operation. The overread only happens with cryptographically low
2687     probability (of the order of 2^-n where n is the bitsize of the curve)
2688     unless the RNG is broken, and could result in information disclosure or
2689     denial of service (application crash or extra resource consumption).
2690     Found by Auke Zeilstra and Peter Schwabe, using static analysis.
2691   * To avoid a side channel vulnerability when parsing an RSA private key,
2692     read all the CRT parameters from the DER structure rather than
2693     reconstructing them. Found by Alejandro Cabrera Aldaya and Billy Bob
2694     Brumley. Reported and fix contributed by Jack Lloyd.
2695     ARMmbed/mbed-crypto#352
2696
2697Features
2698   * The new build option MBEDTLS_SHA512_NO_SHA384 allows building SHA-512
2699     support without SHA-384.
2700
2701API changes
2702   * Change the encoding of key types and curves in the PSA API. The new
2703     values are aligned with the upcoming release of the PSA Crypto API
2704     specification version 1.0.0. The main change which may break some
2705     existing code is that elliptic curve key types no longer encode the
2706     exact curve: a psa_ecc_curve_t or psa_key_type_t value only encodes
2707     a curve family and the key size determines the exact curve (for example,
2708     PSA_ECC_CURVE_SECP_R1 with 256 bits is P256R1). ARMmbed/mbed-crypto#330
2709
2710Bugfix
2711   * Fix an unchecked call to mbedtls_md() in the x509write module.
2712   * Fix build failure with MBEDTLS_ZLIB_SUPPORT enabled. Reported by
2713     Jack Lloyd in #2859. Fix submitted by jiblime in #2963.
2714   * Fix some false-positive uninitialized variable warnings in X.509. Fix
2715     contributed by apple-ihack-geek in #2663.
2716   * Fix a possible error code mangling in psa_mac_verify_finish() when
2717     a cryptographic accelerator fails. ARMmbed/mbed-crypto#345
2718   * Fix a bug in mbedtls_pk_parse_key() that would cause it to accept some
2719     RSA keys that would later be rejected by functions expecting private
2720     keys. Found by Catena cyber using oss-fuzz (issue 20467).
2721   * Fix a bug in mbedtls_pk_parse_key() that would cause it to
2722     accept some RSA keys with invalid values by silently fixing those values.
2723
2724= mbed TLS 2.20.0 branch released 2020-01-15
2725
2726Default behavior changes
2727   * The initial seeding of a CTR_DRBG instance makes a second call to the
2728     entropy function to obtain entropy for a nonce if the entropy size is less
2729     than 3/2 times the key size. In case you want to disable the extra call to
2730     grab entropy, you can call mbedtls_ctr_drbg_set_nonce_len() to force the
2731     nonce length to 0.
2732
2733Security
2734   * Enforce that mbedtls_entropy_func() gathers a total of
2735     MBEDTLS_ENTROPY_BLOCK_SIZE bytes or more from strong sources. In the
2736     default configuration, on a platform with a single entropy source, the
2737     entropy module formerly only grabbed 32 bytes, which is good enough for
2738     security if the source is genuinely strong, but less than the expected 64
2739     bytes (size of the entropy accumulator).
2740   * Zeroize local variables in mbedtls_internal_aes_encrypt() and
2741     mbedtls_internal_aes_decrypt() before exiting the function. The value of
2742     these variables can be used to recover the last round key. To follow best
2743     practice and to limit the impact of buffer overread vulnerabilities (like
2744     Heartbleed) we need to zeroize them before exiting the function.
2745     Issue reported by Tuba Yavuz, Farhaan Fowze, Ken (Yihang) Bai,
2746     Grant Hernandez, and Kevin Butler (University of Florida) and
2747     Dave Tian (Purdue University).
2748   * Fix side channel vulnerability in ECDSA. Our bignum implementation is not
2749     constant time/constant trace, so side channel attacks can retrieve the
2750     blinded value, factor it (as it is smaller than RSA keys and not guaranteed
2751     to have only large prime factors), and then, by brute force, recover the
2752     key. Reported by Alejandro Cabrera Aldaya and Billy Brumley.
2753   * Fix side channel vulnerability in ECDSA key generation. Obtaining precise
2754     timings on the comparison in the key generation enabled the attacker to
2755     learn leading bits of the ephemeral key used during ECDSA signatures and to
2756     recover the private key. Reported by Jeremy Dubeuf.
2757   * Catch failure of AES functions in mbedtls_ctr_drbg_random(). Uncaught
2758     failures could happen with alternative implementations of AES. Bug
2759     reported and fix proposed by Johan Uppman Bruce and Christoffer Lauri,
2760     Sectra.
2761
2762Features
2763   * Key derivation inputs in the PSA API can now either come from a key object
2764     or from a buffer regardless of the step type.
2765   * The CTR_DRBG module can grab a nonce from the entropy source during the
2766     initial seeding. The default nonce length is chosen based on the key size
2767     to achieve the security strength defined by NIST SP 800-90A. You can
2768     change it with mbedtls_ctr_drbg_set_nonce_len().
2769   * Add ENUMERATED tag support to the ASN.1 module. Contributed by
2770     msopiha-linaro in ARMmbed/mbed-crypto#307.
2771
2772API changes
2773   * In the PSA API, forbid zero-length keys. To pass a zero-length input to a
2774     key derivation function, use a buffer instead (this is now always
2775     possible).
2776   * Rename psa_asymmetric_sign() to psa_sign_hash() and
2777     psa_asymmetric_verify() to psa_verify_hash().
2778
2779Bugfix
2780   * Fix an incorrect size in a debugging message. Reported and fix
2781     submitted by irwir. Fixes #2717.
2782   * Fix an unused variable warning when compiling without DTLS.
2783     Reported and fix submitted by irwir. Fixes #2800.
2784   * Remove a useless assignment. Reported and fix submitted by irwir.
2785     Fixes #2801.
2786   * Fix a buffer overflow in the PSA HMAC code when using a long key with an
2787     unsupported algorithm. Fixes ARMmbed/mbed-crypto#254.
2788   * Fix mbedtls_asn1_get_int to support any number of leading zeros. Credit
2789     to OSS-Fuzz for finding a bug in an intermediate version of the fix.
2790   * Fix mbedtls_asn1_get_bitstring_null to correctly parse bitstrings of at
2791     most 2 bytes.
2792   * mbedtls_ctr_drbg_set_entropy_len() and
2793     mbedtls_hmac_drbg_set_entropy_len() now work if you call them before
2794     mbedtls_ctr_drbg_seed() or mbedtls_hmac_drbg_seed().
2795
2796Changes
2797   * Remove the technical possibility to define custom mbedtls_md_info
2798     structures, which was exposed only in an internal header.
2799   * psa_close_key(0) and psa_destroy_key(0) now succeed (doing nothing, as
2800     before).
2801   * Variables containing error codes are now initialized to an error code
2802     rather than success, so that coding mistakes or memory corruption tends to
2803     cause functions to return this error code rather than a success. There are
2804     no known instances where this changes the behavior of the library: this is
2805     merely a robustness improvement. ARMmbed/mbed-crypto#323
2806   * Remove a useless call to mbedtls_ecp_group_free(). Contributed by
2807     Alexander Krizhanovsky in ARMmbed/mbed-crypto#210.
2808   * Speed up PBKDF2 by caching the digest calculation. Contributed by Jack
2809     Lloyd and Fortanix Inc in ARMmbed/mbed-crypto#277.
2810   * Small performance improvement of mbedtls_mpi_div_mpi(). Contributed by
2811     Alexander Krizhanovsky in ARMmbed/mbed-crypto#308.
2812
2813= mbed TLS 2.19.1 branch released 2019-09-16
2814
2815Features
2816   * Declare include headers as PUBLIC to propagate to CMake project consumers
2817     Contributed by Zachary J. Fields in PR #2949.
2818   * Add nss_keylog to ssl_client2 and ssl_server2, enabling easier analysis of
2819     TLS sessions with tools like Wireshark.
2820
2821API Changes
2822   * Make client_random and server_random const in
2823     mbedtls_ssl_export_keys_ext_t, so that the key exporter is discouraged
2824     from modifying the client/server hello.
2825
2826Bugfix
2827   * Fix some false-positive uninitialized variable warnings in crypto. Fix
2828     contributed by apple-ihack-geek in #2663.
2829
2830= mbed TLS 2.19.0 branch released 2019-09-06
2831
2832Security
2833   * Fix a missing error detection in ECJPAKE. This could have caused a
2834     predictable shared secret if a hardware accelerator failed and the other
2835     side of the key exchange had a similar bug.
2836   * When writing a private EC key, use a constant size for the private
2837     value, as specified in RFC 5915. Previously, the value was written
2838     as an ASN.1 INTEGER, which caused the size of the key to leak
2839     about 1 bit of information on average and could cause the value to be
2840     1 byte too large for the output buffer.
2841   * The deterministic ECDSA calculation reused the scheme's HMAC-DRBG to
2842     implement blinding. Because of this for the same key and message the same
2843     blinding value was generated. This reduced the effectiveness of the
2844     countermeasure and leaked information about the private key through side
2845     channels. Reported by Jack Lloyd.
2846
2847Features
2848   * Add new API functions mbedtls_ssl_session_save() and
2849     mbedtls_ssl_session_load() to allow serializing a session, for example to
2850     store it in non-volatile storage, and later using it for TLS session
2851     resumption.
2852   * Add a new API function mbedtls_ssl_check_record() to allow checking that
2853     an incoming record is valid, authentic and has not been seen before. This
2854     feature can be used alongside Connection ID and SSL context serialisation.
2855     The feature is enabled at compile-time by MBEDTLS_SSL_RECORD_CHECKING
2856     option.
2857   * New implementation of X25519 (ECDH using Curve25519) from Project Everest
2858     (https://project-everest.github.io/). It can be enabled at compile time
2859     with MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED. This implementation is formally
2860     verified and significantly faster, but is only supported on x86 platforms
2861     (32-bit and 64-bit) using GCC, Clang or Visual Studio. Contributed by
2862     Christoph Wintersteiger from Microsoft Research.
2863   * Add mbedtls_net_close(), enabling the building of forking servers where
2864     the parent process closes the client socket and continue accepting, and
2865     the child process closes the listening socket and handles the client
2866     socket. Contributed by Robert Larsen in #2803.
2867
2868API Changes
2869   * Add DER-encoded test CRTs to library/certs.c, allowing
2870     the example programs ssl_server2 and ssl_client2 to be run
2871     if MBEDTLS_FS_IO and MBEDTLS_PEM_PARSE_C are unset. Fixes #2254.
2872   * The HAVEGE state type now uses uint32_t elements instead of int.
2873   * The functions mbedtls_ecp_curve_list() and mbedtls_ecp_grp_id_list() now
2874     list all curves for which at least one of ECDH or ECDSA is supported, not
2875     just curves for which both are supported. Call mbedtls_ecdsa_can_do() or
2876     mbedtls_ecdh_can_do() on each result to check whether each algorithm is
2877     supported.
2878   * The new function mbedtls_ecdsa_sign_det_ext() is similar to
2879     mbedtls_ecdsa_sign_det() but allows passing an external RNG for the
2880     purpose of blinding.
2881
2882New deprecations
2883   * Deprecate mbedtls_ecdsa_sign_det() in favor of a functions that can take an
2884     RNG function as an input.
2885   * Calling mbedtls_ecdsa_write_signature() with NULL as the f_rng argument
2886     is now deprecated.
2887
2888Bugfix
2889   * Fix missing bounds checks in X.509 parsing functions that could
2890     lead to successful parsing of ill-formed X.509 CRTs. Fixes #2437.
2891   * Fix multiple X.509 functions previously returning ASN.1 low-level error
2892     codes to always wrap these codes into X.509 high level error codes before
2893     returning. Fixes #2431.
2894   * Fix to allow building test suites with any warning that detects unused
2895     functions. Fixes #1628.
2896   * Fix typo in net_would_block(). Fixes #528 reported by github-monoculture.
2897   * Remove redundant include file in timing.c. Fixes #2640 reported by irwir.
2898   * Fix build failure when building with mingw on Windows by including
2899     stdarg.h where needed. Fixes #2656.
2900   * Fix Visual Studio Release x64 build configuration by inheriting
2901     PlatformToolset from the project configuration. Fixes #1430 reported by
2902     irwir.
2903   * Enable Suite B with subset of ECP curves. Make sure the code compiles even
2904     if some curves are not defined. Fixes #1591 reported by dbedev.
2905   * Fix misuse of signed arithmetic in the HAVEGE module. #2598
2906   * Avoid use of statically sized stack buffers for certificate writing.
2907     This previously limited the maximum size of DER encoded certificates
2908     in mbedtls_x509write_crt_der() to 2Kb. Reported by soccerGB in #2631.
2909   * Fix partial zeroing in x509_get_other_name. Found and fixed by ekse, #2716.
2910   * Update test certificates that were about to expire. Reported by
2911     Bernhard M. Wiedemann in #2357.
2912   * Fix the build on ARMv5TE in ARM mode to not use assembly instructions
2913     that are only available in Thumb mode. Fix contributed by Aurelien Jarno
2914     in #2169.
2915   * Fix propagation of restart contexts in restartable EC operations.
2916     This could previously lead to segmentation faults in builds using an
2917     address-sanitizer and enabling but not using MBEDTLS_ECP_RESTARTABLE.
2918   * Fix memory leak in in mpi_miller_rabin(). Contributed by
2919     Jens Wiklander <jens.wiklander@linaro.org> in #2363
2920   * Improve code clarity in x509_crt module, removing false-positive
2921     uninitialized variable warnings on some recent toolchains (GCC8, etc).
2922     Discovered and fixed by Andy Gross (Linaro), #2392.
2923   * Fix bug in endianness conversion in bignum module. This lead to
2924     functionally incorrect code on bigendian systems which don't have
2925     __BYTE_ORDER__ defined. Reported by Brendan Shanks. Fixes #2622.
2926
2927Changes
2928   * Replace multiple uses of MD2 by SHA-256 in X.509 test suite. Fixes #821.
2929   * Make it easier to define MBEDTLS_PARAM_FAILED as assert (which config.h
2930     suggests). #2671
2931   * Make `make clean` clean all programs always. Fixes #1862.
2932   * Add a Dockerfile and helper scripts (all-in-docker.sh, basic-in-docker.sh,
2933     docker-env.sh) to simplify running test suites on a Linux host. Contributed
2934     by Peter Kolbus (Garmin).
2935   * Add `reproducible` option to `ssl_client2` and `ssl_server2` to enable
2936     test runs without variability. Contributed by Philippe Antoine (Catena
2937     cyber) in #2681.
2938   * Extended .gitignore to ignore Visual Studio artifacts. Fixed by ConfusedSushi.
2939   * Adds fuzz targets, especially for continuous fuzzing with OSS-Fuzz.
2940     Contributed by Philippe Antoine (Catena cyber).
2941   * Remove the crypto part of the library from Mbed TLS. The crypto
2942     code and tests are now only available via Mbed Crypto, which
2943     Mbed TLS references as a Git submodule.
2944
2945= mbed TLS 2.18.1 branch released 2019-07-12
2946
2947Bugfix
2948   * Fix build failure when building with mingw on Windows by including
2949     stdarg.h where needed. Fixes #2656.
2950
2951Changes
2952   * Enable building of Mbed TLS as a CMake subproject. Suggested and fixed by
2953     Ashley Duncan in #2609.
2954
2955= mbed TLS 2.18.0 branch released 2019-06-11
2956
2957Features
2958   * Add the Any Policy certificate policy oid, as defined in
2959     rfc 5280 section 4.2.1.4.
2960   * It is now possible to use NIST key wrap mode via the mbedtls_cipher API.
2961     Contributed by Jack Lloyd and Fortanix Inc.
2962   * Add the Wi-SUN Field Area Network (FAN) device extended key usage.
2963   * Add the oid certificate policy x509 extension.
2964   * It is now possible to perform RSA PKCS v1.5 signatures with RIPEMD-160 digest.
2965     Contributed by Jack Lloyd and Fortanix Inc.
2966   * Extend the MBEDTLS_SSL_EXPORT_KEYS to export the handshake randbytes,
2967     and the used tls-prf.
2968   * Add public API for tls-prf function, according to requested enum.
2969   * Add support for parsing otherName entries in the Subject Alternative Name
2970     X.509 certificate extension, specifically type hardware module name,
2971     as defined in RFC 4108 section 5.
2972   * Add support for parsing certificate policies extension, as defined in
2973     RFC 5280 section 4.2.1.4. Currently, only the "Any Policy" policy is
2974     supported.
2975   * List all SAN types in the subject_alt_names field of the certificate.
2976     Resolves #459.
2977   * Add support for draft-05 of the Connection ID extension, as specified
2978     in https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05.
2979     The Connection ID extension allows to keep DTLS connections beyond the
2980     lifetime of the underlying transport by adding a connection identifier
2981     to the DTLS record header. This identifier can be used to associated an
2982     incoming record with the correct connection data even after the peer has
2983     changed its IP or port. The feature is enabled at compile-time by setting
2984     MBEDTLS_SSL_DTLS_CONNECTION_ID (disabled by default), and at run-time
2985     through the new APIs mbedtls_ssl_conf_cid() and mbedtls_ssl_set_cid().
2986
2987
2988API Changes
2989   * Extend the MBEDTLS_SSL_EXPORT_KEYS to export the handshake randbytes,
2990     and the used tls-prf.
2991   * Add public API for tls-prf function, according to requested enum.
2992
2993Bugfix
2994   * Fix private key DER output in the key_app_writer example. File contents
2995     were shifted by one byte, creating an invalid ASN.1 tag. Fixed by
2996     Christian Walther in #2239.
2997   * Fix potential memory leak in X.509 self test. Found and fixed by
2998     Junhwan Park, #2106.
2999   * Reduce stack usage of hkdf tests. Fixes #2195.
3000   * Fix 1-byte buffer overflow in mbedtls_mpi_write_string() when
3001     used with negative inputs. Found by Guido Vranken in #2404. Credit to
3002     OSS-Fuzz.
3003   * Fix bugs in the AEAD test suite which would be exposed by ciphers which
3004     either used both encrypt and decrypt key schedules, or which perform padding.
3005     GCM and CCM were not affected. Fixed by Jack Lloyd.
3006   * Fix incorrect default port number in ssl_mail_client example's usage.
3007     Found and fixed by irwir. #2337
3008   * Add psa_util.h to test/cpp_dummy_build to fix build_default_make_gcc_and_cxx.
3009     Fixed by Peter Kolbus (Garmin). #2579
3010   * Add missing parentheses around parameters in the definition of the
3011     public macro MBEDTLS_X509_ID_FLAG. This could lead to invalid evaluation
3012     in case operators binding less strongly than subtraction were used
3013     for the parameter.
3014   * Add a check for MBEDTLS_X509_CRL_PARSE_C in ssl_server2, guarding the crl
3015     sni entry parameter. Reported by inestlerode in #560.
3016   * Set the next sequence of the subject_alt_name to NULL when deleting
3017     sequence on failure. Found and fix suggested by Philippe Antoine.
3018     Credit to OSS-Fuzz.
3019
3020Changes
3021   * Server's RSA certificate in certs.c was SHA-1 signed. In the default
3022     mbedTLS configuration only SHA-2 signed certificates are accepted.
3023     This certificate is used in the demo server programs, which lead the
3024     client programs to fail at the peer's certificate verification
3025     due to an unacceptable hash signature. The certificate has been
3026     updated to one that is SHA-256 signed. Fix contributed by
3027     Illya Gerasymchuk.
3028   * Return from various debugging routines immediately if the
3029     provided SSL context is unset.
3030   * Remove dead code from bignum.c in the default configuration.
3031     Found by Coverity, reported and fixed by Peter Kolbus (Garmin). Fixes #2309.
3032   * Add test for minimal value of MBEDTLS_MPI_WINDOW_SIZE to all.sh.
3033     Contributed by Peter Kolbus (Garmin).
3034   * Change wording in the `mbedtls_ssl_conf_max_frag_len()`'s documentation to
3035     improve clarity. Fixes #2258.
3036
3037= mbed TLS 2.17.0 branch released 2019-03-19
3038
3039Features
3040   * Add a new X.509 API call `mbedtls_x509_parse_der_nocopy()`
3041     which allows copy-less parsing of DER encoded X.509 CRTs,
3042     at the cost of additional lifetime constraints on the input
3043     buffer, but at the benefit of reduced RAM consumption.
3044   * Add a new function mbedtls_asn1_write_named_bitstring() to write ASN.1
3045     named bitstring in DER as required by RFC 5280 Appendix B.
3046   * Add MBEDTLS_REMOVE_3DES_CIPHERSUITES to allow removing 3DES ciphersuites
3047     from the default list (enabled by default). See
3048     https://sweet32.info/SWEET32_CCS16.pdf.
3049
3050API Changes
3051   * Add a new X.509 API call `mbedtls_x509_parse_der_nocopy()`.
3052     See the Features section for more information.
3053   * Allow to opt in to the removal the API mbedtls_ssl_get_peer_cert()
3054     for the benefit of saving RAM, by disabling the new compile-time
3055     option MBEDTLS_SSL_KEEP_PEER_CERTIFICATE (enabled by default for
3056     API stability). Disabling this option makes mbedtls_ssl_get_peer_cert()
3057     always return NULL, and removes the peer_cert field from the
3058     mbedtls_ssl_session structure which otherwise stores the peer's
3059     certificate.
3060
3061Security
3062   * Make mbedtls_ecdh_get_params return an error if the second key
3063     belongs to a different group from the first. Before, if an application
3064     passed keys that belonged to different group, the first key's data was
3065     interpreted according to the second group, which could lead to either
3066     an error or a meaningless output from mbedtls_ecdh_get_params. In the
3067     latter case, this could expose at most 5 bits of the private key.
3068
3069Bugfix
3070   * Fix a compilation issue with mbedtls_ecp_restart_ctx not being defined
3071     when MBEDTLS_ECP_ALT is defined. Reported by jwhui. Fixes #2242.
3072   * Run the AD too long test only if MBEDTLS_CCM_ALT is not defined.
3073     Raised as a comment in #1996.
3074   * Reduce the stack consumption of mbedtls_mpi_fill_random() which could
3075     previously lead to a stack overflow on constrained targets.
3076   * Add `MBEDTLS_SELF_TEST` for the mbedtls_self_test functions
3077     in the header files, which missed the precompilation check. #971
3078   * Fix returning the value 1 when mbedtls_ecdsa_genkey failed.
3079   * Remove a duplicate #include in a sample program. Fixed by Masashi Honma #2326.
3080   * Remove the mbedtls namespacing from the header file, to fix a "file not found"
3081     build error. Fixed by Haijun Gu #2319.
3082   * Fix signed-to-unsigned integer conversion warning
3083     in X.509 module. Fixes #2212.
3084   * Reduce stack usage of `mpi_write_hlp()` by eliminating recursion.
3085     Fixes #2190.
3086   * Fix false failure in all.sh when backup files exist in include/mbedtls
3087     (e.g. config.h.bak). Fixed by Peter Kolbus (Garmin) #2407.
3088   * Ensure that unused bits are zero when writing ASN.1 bitstrings when using
3089     mbedtls_asn1_write_bitstring().
3090   * Fix issue when writing the named bitstrings in KeyUsage and NsCertType
3091     extensions in CSRs and CRTs that caused these bitstrings to not be encoded
3092     correctly as trailing zeroes were not accounted for as unused bits in the
3093     leading content octet. Fixes #1610.
3094
3095Changes
3096   * Reduce RAM consumption during session renegotiation by not storing
3097     the peer CRT chain and session ticket twice.
3098   * Include configuration file in all header files that use configuration,
3099     instead of relying on other header files that they include.
3100     Inserted as an enhancement for #1371
3101   * Add support for alternative CSR headers, as used by Microsoft and defined
3102     in RFC 7468. Found by Michael Ernst. Fixes #767.
3103   * Correct many misspellings. Fixed by MisterDA #2371.
3104   * Provide an abstraction of vsnprintf to allow alternative implementations
3105     for platforms that don't provide it. Based on contributions by Joris Aerts
3106     and Nathaniel Wesley Filardo.
3107   * Fix clobber list in MIPS assembly for large integer multiplication.
3108     Previously, this could lead to functionally incorrect assembly being
3109     produced by some optimizing compilers, showing up as failures in
3110     e.g. RSA or ECC signature operations. Reported in #1722, fix suggested
3111     by Aurelien Jarno and submitted by Jeffrey Martin.
3112   * Reduce the complexity of the timing tests. They were assuming more than the
3113     underlying OS actually guarantees.
3114   * Fix configuration queries in ssl-opt.h. #2030
3115   * Ensure that ssl-opt.h can be run in OS X. #2029
3116   * Re-enable certain interoperability tests in ssl-opt.sh which had previously
3117     been disabled for lack of a sufficiently recent version of GnuTLS on the CI.
3118   * Ciphersuites based on 3DES now have the lowest priority by default when
3119     they are enabled.
3120
3121= mbed TLS 2.16.0 branch released 2018-12-21
3122
3123Features
3124   * Add a new config.h option of MBEDTLS_CHECK_PARAMS that enables validation
3125     of parameters in the API. This allows detection of obvious misuses of the
3126     API, such as passing NULL pointers. The API of existing functions hasn't
3127     changed, but requirements on parameters have been made more explicit in
3128     the documentation. See the corresponding API documentation for each
3129     function to see for which parameter values it is defined. This feature is
3130     disabled by default. See its API documentation in config.h for additional
3131     steps you have to take when enabling it.
3132
3133API Changes
3134   * The following functions in the random generator modules have been
3135     deprecated and replaced as shown below. The new functions change
3136     the return type from void to int to allow returning error codes when
3137     using MBEDTLS_<MODULE>_ALT for the underlying AES or message digest
3138     primitive. Fixes #1798.
3139     mbedtls_ctr_drbg_update() -> mbedtls_ctr_drbg_update_ret()
3140     mbedtls_hmac_drbg_update() -> mbedtls_hmac_drbg_update_ret()
3141   * Extend ECDH interface to enable alternative implementations.
3142   * Deprecate error codes of the form MBEDTLS_ERR_xxx_INVALID_KEY_LENGTH for
3143     ARIA, CAMELLIA and Blowfish. These error codes will be replaced by
3144     the more generic per-module error codes MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
3145   * Additional parameter validation checks have been added for the following
3146     modules - AES, ARIA, Blowfish, CAMELLIA, CCM, GCM, DHM, ECP, ECDSA, ECDH,
3147     ECJPAKE, SHA, Chacha20 and Poly1305, cipher, pk, RSA, and MPI.
3148     Where modules have had parameter validation added, existing parameter
3149     checks may have changed. Some modules, such as Chacha20 had existing
3150     parameter validation whereas other modules had little. This has now been
3151     changed so that the same level of validation is present in all modules, and
3152     that it is now optional with the MBEDTLS_CHECK_PARAMS flag which by default
3153     is off. That means that checks which were previously present by default
3154     will no longer be.
3155
3156New deprecations
3157   * Deprecate mbedtls_ctr_drbg_update and mbedtls_hmac_drbg_update
3158     in favor of functions that can return an error code.
3159
3160Bugfix
3161   * Fix for Clang, which was reporting a warning for the bignum.c inline
3162     assembly for AMD64 targets creating string literals greater than those
3163     permitted by the ISO C99 standard. Found by Aaron Jones. Fixes #482.
3164   * Fix runtime error in `mbedtls_platform_entropy_poll()` when run
3165     through qemu user emulation. Reported and fix suggested by randombit
3166     in #1212. Fixes #1212.
3167   * Fix an unsafe bounds check when restoring an SSL session from a ticket.
3168     This could lead to a buffer overflow, but only in case ticket authentication
3169     was broken. Reported and fix suggested by Guido Vranken in #659.
3170   * Add explicit integer to enumeration type casts to example program
3171     programs/pkey/gen_key which previously led to compilation failure
3172     on some toolchains. Reported by phoenixmcallister. Fixes #2170.
3173   * Fix double initialization of ECC hardware that made some accelerators
3174     hang.
3175   * Clarify documentation of mbedtls_ssl_set_own_cert() regarding the absence
3176     of check for certificate/key matching. Reported by Attila Molnar, #507.
3177
3178 = mbed TLS 2.15.1 branch released 2018-11-30
3179
3180 Changes
3181    * Update the Mbed Crypto submodule to version 0.1.0b2.
3182
3183 = mbed TLS 2.15.0 branch released 2018-11-23
3184
3185 Features
3186    * Add an experimental build option, USE_CRYPTO_SUBMODULE, to enable use of
3187      Mbed Crypto as the source of the cryptography implementation.
3188    * Add an experimental configuration option, MBEDTLS_PSA_CRYPTO_C, to enable
3189      the PSA Crypto API from Mbed Crypto when additionally used with the
3190      USE_CRYPTO_SUBMODULE build option.
3191
3192 Changes
3193    * Add unit tests for AES-GCM when called through mbedtls_cipher_auth_xxx()
3194      from the cipher abstraction layer. Fixes #2198.
3195
3196= mbed TLS 2.14.1 branch released 2018-11-30
3197
3198Security
3199   * Fix timing variations and memory access variations in RSA PKCS#1 v1.5
3200     decryption that could lead to a Bleichenbacher-style padding oracle
3201     attack. In TLS, this affects servers that accept ciphersuites based on
3202     RSA decryption (i.e. ciphersuites whose name contains RSA but not
3203     (EC)DH(E)). Discovered by Eyal Ronen (Weizmann Institute),  Robert Gillham
3204     (University of Adelaide), Daniel Genkin (University of Michigan),
3205     Adi Shamir (Weizmann Institute), David Wong (NCC Group), and Yuval Yarom
3206     (University of Adelaide, Data61). The attack is described in more detail
3207     in the paper available here: http://cat.eyalro.net/cat.pdf  CVE-2018-19608
3208   * In mbedtls_mpi_write_binary(), don't leak the exact size of the number
3209     via branching and memory access patterns. An attacker who could submit
3210     a plaintext for RSA PKCS#1 v1.5 decryption but only observe the timing
3211     of the decryption and not its result could nonetheless decrypt RSA
3212     plaintexts and forge RSA signatures. Other asymmetric algorithms may
3213     have been similarly vulnerable. Reported by Eyal Ronen, Robert Gillham,
3214     Daniel Genkin, Adi Shamir, David Wong and Yuval Yarom.
3215   * Wipe sensitive buffers on the stack in the CTR_DRBG and HMAC_DRBG
3216     modules.
3217
3218API Changes
3219   * The new functions mbedtls_ctr_drbg_update_ret() and
3220     mbedtls_hmac_drbg_update_ret() are similar to mbedtls_ctr_drbg_update()
3221     and mbedtls_hmac_drbg_update() respectively, but the new functions
3222     report errors whereas the old functions return void. We recommend that
3223     applications use the new functions.
3224
3225= mbed TLS 2.14.0 branch released 2018-11-19
3226
3227Security
3228   * Fix overly strict DN comparison when looking for CRLs belonging to a
3229     particular CA. This previously led to ignoring CRLs when the CRL's issuer
3230     name and the CA's subject name differed in their string encoding (e.g.,
3231     one using PrintableString and the other UTF8String) or in the choice of
3232     upper and lower case. Reported by Henrik Andersson of Bosch GmbH in issue
3233     #1784.
3234   * Fix a flawed bounds check in server PSK hint parsing. In case the
3235     incoming message buffer was placed within the first 64KiB of address
3236     space and a PSK-(EC)DHE ciphersuite was used, this allowed an attacker
3237     to trigger a memory access up to 64KiB beyond the incoming message buffer,
3238     potentially leading to an application crash or information disclosure.
3239   * Fix mbedtls_mpi_is_prime() to use more rounds of probabilistic testing. The
3240     previous settings for the number of rounds made it practical for an
3241     adversary to construct non-primes that would be erroneously accepted as
3242     primes with high probability. This does not have an impact on the
3243     security of TLS, but can matter in other contexts with numbers chosen
3244     potentially by an adversary that should be prime and can be validated.
3245     For example, the number of rounds was enough to securely generate RSA key
3246     pairs or Diffie-Hellman parameters, but was insufficient to validate
3247     Diffie-Hellman parameters properly.
3248     See "Prime and Prejudice" by by Martin R. Albrecht and Jake Massimo and
3249     Kenneth G. Paterson and Juraj Somorovsky.
3250
3251Features
3252   * Add support for temporarily suspending expensive ECC computations after
3253     some configurable amount of operations. This is intended to be used in
3254     constrained, single-threaded systems where ECC is time consuming and can
3255     block other operations until they complete. This is disabled by default,
3256     but can be enabled by MBEDTLS_ECP_RESTARTABLE at compile time and
3257     configured by mbedtls_ecp_set_max_ops() at runtime. It applies to the new
3258     xxx_restartable functions in ECP, ECDSA, PK and X.509 (CRL not supported
3259     yet), and to existing functions in ECDH and SSL (currently only
3260     implemented client-side, for ECDHE-ECDSA ciphersuites in TLS 1.2,
3261     including client authentication).
3262   * Add support for Arm CPU DSP extensions to accelerate asymmetric key
3263     operations. On CPUs where the extensions are available, they can accelerate
3264     MPI multiplications used in ECC and RSA cryptography. Contributed by
3265     Aurelien Jarno.
3266   * Extend RSASSA-PSS signature to allow a smaller salt size. Previously, PSS
3267     signature always used a salt with the same length as the hash, and returned
3268     an error if this was not possible. Now the salt size may be up to two bytes
3269     shorter. This allows the library to support all hash and signature sizes
3270     that comply with FIPS 186-4, including SHA-512 with a 1024-bit key.
3271   * Add support for 128-bit keys in CTR_DRBG. Note that using keys shorter
3272     than 256 bits limits the security of generated material to 128 bits.
3273
3274API Changes
3275   * Add a common error code of `MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED` for
3276     a feature that is not supported by underlying alternative
3277     implementations implementing cryptographic primitives. This is useful for
3278     hardware accelerators that don't implement all options or features.
3279
3280New deprecations
3281   * All module specific errors following the form
3282     MBEDTLS_ERR_XXX_FEATURE_UNAVAILABLE that indicate a feature is not
3283     supported are deprecated and are now replaced by the new equivalent
3284     platform error.
3285   * All module specific generic hardware acceleration errors following the
3286     form MBEDTLS_ERR_XXX_HW_ACCEL_FAILED that are deprecated and are replaced
3287     by the equivalent plaform error.
3288   * Deprecate the function mbedtls_mpi_is_prime() in favor of
3289     mbedtls_mpi_is_prime_ext() which allows specifying the number of
3290     Miller-Rabin rounds.
3291
3292Bugfix
3293   * Fix wrong order of freeing in programs/ssl/ssl_server2 example
3294     application leading to a memory leak in case both
3295     MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE are set.
3296     Fixes #2069.
3297   * Fix a bug in the update function for SSL ticket keys which previously
3298     invalidated keys of a lifetime of less than a 1s. Fixes #1968.
3299   * Fix failure in hmac_drbg in the benchmark sample application, when
3300     MBEDTLS_THREADING_C is defined. Found by TrinityTonic, #1095
3301   * Fix a bug in the record decryption routine ssl_decrypt_buf()
3302     which lead to accepting properly authenticated but improperly
3303     padded records in case of CBC ciphersuites using Encrypt-then-MAC.
3304   * Fix memory leak and freeing without initialization in the example
3305     program programs/x509/cert_write. Fixes #1422.
3306   * Ignore IV in mbedtls_cipher_set_iv() when the cipher mode is
3307     MBEDTLS_MODE_ECB. Found by ezdevelop. Fixes #1091.
3308   * Zeroize memory used for buffering or reassembling handshake messages
3309     after use.
3310   * Use `mbedtls_platform_zeroize()` instead of `memset()` for zeroization
3311     of sensitive data in the example programs aescrypt2 and crypt_and_hash.
3312   * Change the default string format used for various X.509 DN attributes to
3313     UTF8String. Previously, the use of the PrintableString format led to
3314     wildcards and non-ASCII characters being unusable in some DN attributes.
3315     Reported by raprepo in #1860 and by kevinpt in #468. Fix contributed by
3316     Thomas-Dee.
3317   * Fix compilation failure for configurations which use compile time
3318     replacements of standard calloc/free functions through the macros
3319     MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO.
3320     Reported by ole-de and ddhome2006. Fixes #882, #1642 and #1706.
3321
3322Changes
3323   * Removed support for Yotta as a build tool.
3324   * Add tests for session resumption in DTLS.
3325   * Close a test gap in (D)TLS between the client side and the server side:
3326     test the handling of large packets and small packets on the client side
3327     in the same way as on the server side.
3328   * Change the dtls_client and dtls_server samples to work by default over
3329     IPv6 and optionally by a build option over IPv4.
3330   * Change the use of Windows threading to use Microsoft Visual C++ runtime
3331     calls, rather than Win32 API calls directly. This is necessary to avoid
3332     conflict with C runtime usage. Found and fixed by irwir.
3333   * Remember the string format of X.509 DN attributes when replicating
3334     X.509 DNs. Previously, DN attributes were always written in their default
3335     string format (mostly PrintableString), which could lead to CRTs being
3336     created which used PrintableStrings in the issuer field even though the
3337     signing CA used UTF8Strings in its subject field; while X.509 compliant,
3338     such CRTs were rejected in some applications, e.g. some versions of
3339     Firefox, curl and GnuTLS. Reported in #1033 by Moschn. Fix contributed by
3340     Thomas-Dee.
3341   * Improve documentation of mbedtls_ssl_get_verify_result().
3342     Fixes #517 reported by github-monoculture.
3343   * Add MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR flag to mbedtls_mpi_gen_prime() and
3344     use it to reduce error probability in RSA key generation to levels mandated
3345     by FIPS-186-4.
3346
3347= mbed TLS 2.13.1 branch released 2018-09-06
3348
3349API Changes
3350   * Extend the platform module with an abstraction mbedtls_platform_gmtime_r()
3351     whose implementation should behave as a thread-safe version of gmtime().
3352     This allows users to configure such an implementation at compile time when
3353     the target system cannot be deduced automatically, by setting the option
3354     MBEDTLS_PLATFORM_GMTIME_R_ALT. At this stage Mbed TLS is only able to
3355     automatically select implementations for Windows and POSIX C libraries.
3356
3357Bugfix
3358   * Fix build failures on platforms where only gmtime() is available but
3359     neither gmtime_r() nor gmtime_s() are present. Fixes #1907.
3360
3361= mbed TLS 2.13.0 branch released 2018-08-31
3362
3363Security
3364   * Fix an issue in the X.509 module which could lead to a buffer overread
3365     during certificate extensions parsing. In case of receiving malformed
3366     input (extensions length field equal to 0), an illegal read of one byte
3367     beyond the input buffer is made. Found and analyzed by Nathan Crandall.
3368
3369Features
3370   * Add support for fragmentation of outgoing DTLS handshake messages. This
3371     is controlled by the maximum fragment length as set locally or negotiated
3372     with the peer, as well as by a new per-connection MTU option, set using
3373     mbedtls_ssl_set_mtu().
3374   * Add support for auto-adjustment of MTU to a safe value during the
3375     handshake when flights do not get through (RFC 6347, section 4.1.1.1,
3376     last paragraph).
3377   * Add support for packing multiple records within a single datagram,
3378     enabled by default.
3379   * Add support for buffering out-of-order handshake messages in DTLS.
3380     The maximum amount of RAM used for this can be controlled by the
3381     compile-time constant MBEDTLS_SSL_DTLS_MAX_BUFFERING defined
3382     in mbedtls/config.h.
3383
3384API Changes
3385   * Add function mbedtls_ssl_set_datagram_packing() to configure
3386     the use of datagram packing (enabled by default).
3387
3388Bugfix
3389   * Fix a potential memory leak in mbedtls_ssl_setup() function. An allocation
3390     failure in the function could lead to other buffers being leaked.
3391   * Fixes an issue with MBEDTLS_CHACHAPOLY_C which would not compile if
3392     MBEDTLS_ARC4_C and MBEDTLS_CIPHER_NULL_CIPHER weren't also defined. #1890
3393   * Fix a memory leak in ecp_mul_comb() if ecp_precompute_comb() fails.
3394     Fix contributed by Espressif Systems.
3395   * Add ecc extensions only if an ecc based ciphersuite is used.
3396     This improves compliance to RFC 4492, and as a result, solves
3397     interoperability issues with BouncyCastle. Raised by milenamil in #1157.
3398   * Replace printf with mbedtls_printf in the ARIA module. Found by
3399     TrinityTonic in #1908.
3400   * Fix potential use-after-free in mbedtls_ssl_get_max_frag_len()
3401     and mbedtls_ssl_get_record_expansion() after a session reset. Fixes #1941.
3402   * Fix a bug that caused SSL/TLS clients to incorrectly abort the handshake
3403     with TLS versions 1.1 and earlier when the server requested authentication
3404     without providing a list of CAs. This was due to an overly strict bounds
3405     check in parsing the CertificateRequest message,
3406     introduced in Mbed TLS 2.12.0. Fixes #1954.
3407   * Fix a miscalculation of the maximum record expansion in
3408     mbedtls_ssl_get_record_expansion() in case of ChachaPoly ciphersuites,
3409     or CBC ciphersuites in (D)TLS versions 1.1 or higher. Fixes #1913, #1914.
3410   * Fix undefined shifts with negative values in certificates parsing
3411     (found by Catena cyber using oss-fuzz)
3412   * Fix memory leak and free without initialization in pk_encrypt
3413     and pk_decrypt example programs. Reported by Brace Stout. Fixes #1128.
3414   * Remove redundant else statement. Raised by irwir. Fixes #1776.
3415
3416Changes
3417   * Copy headers preserving timestamps when doing a "make install".
3418     Contributed by xueruini.
3419   * Allow the forward declaration of public structs. Contributed by Dawid
3420     Drozd. Fixes #1215 raised by randombit.
3421   * Improve compatibility with some alternative CCM implementations by using
3422     CCM test vectors from RAM.
3423   * Add support for buffering of out-of-order handshake messages.
3424   * Add warnings to the documentation of the HKDF module to reduce the risk
3425     of misusing the mbedtls_hkdf_extract() and mbedtls_hkdf_expand()
3426     functions. Fixes #1775. Reported by Brian J. Murray.
3427
3428= mbed TLS 2.12.0 branch released 2018-07-25
3429
3430Security
3431   * Fix a vulnerability in TLS ciphersuites based on CBC and using SHA-384,
3432     in (D)TLS 1.0 to 1.2, that allowed an active network attacker to
3433     partially recover the plaintext of messages under some conditions by
3434     exploiting timing measurements. With DTLS, the attacker could perform
3435     this recovery by sending many messages in the same connection. With TLS
3436     or if mbedtls_ssl_conf_dtls_badmac_limit() was used, the attack only
3437     worked if the same secret (for example a HTTP Cookie) has been repeatedly
3438     sent over connections manipulated by the attacker. Connections using GCM
3439     or CCM instead of CBC, using hash sizes other than SHA-384, or using
3440     Encrypt-then-Mac (RFC 7366) were not affected. The vulnerability was
3441     caused by a miscalculation (for SHA-384) in a countermeasure to the
3442     original Lucky 13 attack. Found by Kenny Paterson, Eyal Ronen and Adi
3443     Shamir.
3444   * Fix a vulnerability in TLS ciphersuites based on CBC, in (D)TLS 1.0 to
3445     1.2, that allowed a local attacker, able to execute code on the local
3446     machine as well as manipulate network packets, to partially recover the
3447     plaintext of messages under some conditions by using a cache attack
3448     targeting an internal MD/SHA buffer. With TLS or if
3449     mbedtls_ssl_conf_dtls_badmac_limit() was used, the attack only worked if
3450     the same secret (for example a HTTP Cookie) has been repeatedly sent over
3451     connections manipulated by the attacker. Connections using GCM or CCM
3452     instead of CBC or using Encrypt-then-Mac (RFC 7366) were not affected.
3453     Found by Kenny Paterson, Eyal Ronen and Adi Shamir.
3454   * Add a counter-measure against a vulnerability in TLS ciphersuites based
3455     on CBC, in (D)TLS 1.0 to 1.2, that allowed a local attacker, able to
3456     execute code on the local machine as well as manipulate network packets,
3457     to partially recover the plaintext of messages under some conditions (see
3458     previous entry) by using a cache attack targeting the SSL input record
3459     buffer. Connections using GCM or CCM instead of CBC or using
3460     Encrypt-then-Mac (RFC 7366) were not affected. Found by Kenny Paterson,
3461     Eyal Ronen and Adi Shamir.
3462
3463Features
3464   * Add new crypto primitives from RFC 7539: stream cipher Chacha20, one-time
3465     authenticator Poly1305 and AEAD construct Chacha20-Poly1305. Contributed
3466     by Daniel King.
3467   * Add support for CHACHA20-POLY1305 ciphersuites from RFC 7905.
3468   * Add platform support for the Haiku OS. (https://www.haiku-os.org).
3469     Contributed by Augustin Cavalier.
3470   * Make the receive and transmit buffers independent sizes, for situations
3471     where the outgoing buffer can be fixed at a smaller size than the incoming
3472     buffer, which can save some RAM. If buffer lengths are kept equal, there
3473     is no functional difference. Contributed by Angus Gratton, and also
3474     independently contributed again by Paul Sokolovsky.
3475   * Add support for key wrapping modes based on AES as defined by
3476     NIST SP 800-38F algorithms KW and KWP and by RFC 3394 and RFC 5649.
3477
3478Bugfix
3479   * Fix the key_app_writer example which was writing a leading zero byte which
3480     was creating an invalid ASN.1 tag. Found by Aryeh R. Fixes #1257.
3481   * Fix compilation error on C++, because of a variable named new.
3482     Found and fixed by Hirotaka Niisato in #1783.
3483   * Fix "no symbols" warning issued by ranlib when building on Mac OS X. Fix
3484     contributed by tabascoeye.
3485   * Clarify documentation for mbedtls_ssl_write() to include 0 as a valid
3486     return value. Found by @davidwu2000. #839
3487   * Fix a memory leak in mbedtls_x509_csr_parse(), found by catenacyber,
3488     Philippe Antoine. Fixes #1623.
3489   * Remove unused headers included in x509.c. Found by Chris Hanson and fixed
3490     by Brendan Shanks. Part of a fix for #992.
3491   * Fix compilation error when MBEDTLS_ARC4_C is disabled and
3492     MBEDTLS_CIPHER_NULL_CIPHER is enabled. Found by TrinityTonic in #1719.
3493   * Added length checks to some TLS parsing functions. Found and fixed by
3494     Philippe Antoine from Catena cyber. #1663.
3495   * Fix the inline assembly for the MPI multiply helper function for i386 and
3496     i386 with SSE2. Found by László Langó. Fixes #1550
3497   * Fix namespacing in header files. Remove the `mbedtls` namespacing in
3498     the `#include` in the header files. Resolves #857
3499   * Fix compiler warning of 'use before initialisation' in
3500     mbedtls_pk_parse_key(). Found by Martin Boye Petersen and fixed by Dawid
3501     Drozd. #1098
3502   * Fix decryption for zero length messages (which contain all padding) when a
3503     CBC based ciphersuite is used together with Encrypt-then-MAC. Previously,
3504     such a message was wrongly reported as an invalid record and therefore lead
3505     to the connection being terminated. Seen most often with OpenSSL using
3506     TLS 1.0. Reported by @kFYatek and by Conor Murphy on the forum. Fix
3507     contributed by Espressif Systems. Fixes #1632
3508   * Fix ssl_client2 example to send application data with 0-length content
3509     when the request_size argument is set to 0 as stated in the documentation.
3510     Fixes #1833.
3511   * Correct the documentation for `mbedtls_ssl_get_session()`. This API has
3512     deep copy of the session, and the peer certificate is not lost. Fixes #926.
3513   * Fix build using -std=c99. Fixed by Nick Wilson.
3514
3515Changes
3516   * Fail when receiving a TLS alert message with an invalid length, or invalid
3517     zero-length messages when using TLS 1.2. Contributed by Espressif Systems.
3518   * Change the default behaviour of mbedtls_hkdf_extract() to return an error
3519     when calling with a NULL salt and non-zero salt_len. Contributed by
3520     Brian J Murray
3521   * Change the shebang line in Perl scripts to look up perl in the PATH.
3522     Contributed by fbrosson.
3523   * Allow overriding the time on Windows via the platform-time abstraction.
3524     Fixed by Nick Wilson.
3525   * Use gmtime_r/gmtime_s for thread-safety. Fixed by Nick Wilson.
3526
3527= mbed TLS 2.11.0 branch released 2018-06-18
3528
3529Features
3530   * Add additional block mode, OFB (Output Feedback), to the AES module and
3531     cipher abstraction module.
3532   * Implement the HMAC-based extract-and-expand key derivation function
3533     (HKDF) per RFC 5869. Contributed by Thomas Fossati.
3534   * Add support for the CCM* block cipher mode as defined in IEEE Std. 802.15.4.
3535   * Add support for the XTS block cipher mode with AES (AES-XTS).
3536     Contributed by Aorimn in pull request #414.
3537   * In TLS servers, support offloading private key operations to an external
3538     cryptoprocessor. Private key operations can be asynchronous to allow
3539     non-blocking operation of the TLS server stack.
3540
3541Bugfix
3542   * Fix the cert_write example to handle certificates signed with elliptic
3543     curves as well as RSA. Fixes #777 found by dbedev.
3544   * Fix for redefinition of _WIN32_WINNT to avoid overriding a definition
3545     used by user applications. Found and fixed by Fabio Alessandrelli.
3546   * Fix compilation warnings with IAR toolchain, on 32 bit platform.
3547     Reported by rahmanih in #683
3548   * Fix braces in mbedtls_memory_buffer_alloc_status(). Found by sbranden, #552.
3549
3550Changes
3551   * Changed CMake defaults for IAR to treat all compiler warnings as errors.
3552   * Changed the Clang parameters used in the CMake build files to work for
3553     versions later than 3.6. Versions of Clang earlier than this may no longer
3554     work. Fixes #1072
3555
3556= mbed TLS 2.10.0 branch released 2018-06-06
3557
3558Features
3559   * Add support for ARIA cipher (RFC 5794) and associated TLS ciphersuites
3560     (RFC 6209). Disabled by default, see MBEDTLS_ARIA_C in config.h
3561
3562API Changes
3563   * Extend the platform module with a util component that contains
3564     functionality shared by multiple Mbed TLS modules. At this stage
3565     platform_util.h (and its associated platform_util.c) only contain
3566     mbedtls_platform_zeroize(), which is a critical function from a security
3567     point of view. mbedtls_platform_zeroize() needs to be regularly tested
3568     against compilers to ensure that calls to it are not removed from the
3569     output binary as part of redundant code elimination optimizations.
3570     Therefore, mbedtls_platform_zeroize() is moved to the platform module to
3571     facilitate testing and maintenance.
3572
3573Bugfix
3574   * Fix an issue with MicroBlaze support in bn_mul.h which was causing the
3575     build to fail. Found by zv-io. Fixes #1651.
3576
3577Changes
3578   * Support TLS testing in out-of-source builds using cmake. Fixes #1193.
3579   * Fix redundant declaration of mbedtls_ssl_list_ciphersuites. Raised by
3580     TrinityTonic. #1359.
3581
3582= mbed TLS 2.9.0 branch released 2018-04-30
3583
3584Security
3585   * Fix an issue in the X.509 module which could lead to a buffer overread
3586     during certificate validation. Additionally, the issue could also lead to
3587     unnecessary callback checks being made or to some validation checks to be
3588     omitted. The overread could be triggered remotely, while the other issues
3589     would require a non DER-compliant certificate to be correctly signed by a
3590     trusted CA, or a trusted CA with a non DER-compliant certificate. Found by
3591     luocm. Fixes #825.
3592   * Fix the buffer length assertion in the ssl_parse_certificate_request()
3593     function which led to an arbitrary overread of the message buffer. The
3594     overreads could be caused by receiving a malformed message at the point
3595     where an optional signature algorithms list is expected when the signature
3596     algorithms section is too short. In builds with debug output, the overread
3597     data is output with the debug data.
3598   * Fix a client-side bug in the validation of the server's ciphersuite choice
3599     which could potentially lead to the client accepting a ciphersuite it didn't
3600     offer or a ciphersuite that cannot be used with the TLS or DTLS version
3601     chosen by the server. This could lead to corruption of internal data
3602     structures for some configurations.
3603
3604Features
3605   * Add an option, MBEDTLS_AES_FEWER_TABLES, to dynamically compute smaller AES
3606     tables during runtime, thereby reducing the RAM/ROM footprint by ~6KiB.
3607     Suggested and contributed by jkivilin in pull request #394.
3608   * Add initial support for Curve448 (RFC 7748). Only mbedtls_ecp_mul() and
3609     ECDH primitive functions (mbedtls_ecdh_gen_public(),
3610     mbedtls_ecdh_compute_shared()) are supported for now. Contributed by
3611     Nicholas Wilson in pull request #348.
3612
3613API Changes
3614   * Extend the public API with the function of mbedtls_net_poll() to allow user
3615     applications to wait for a network context to become ready before reading
3616     or writing.
3617   * Add function mbedtls_ssl_check_pending() to the public API to allow
3618     a check for whether more more data is pending to be processed in the
3619     internal message buffers.
3620     This function is necessary to determine when it is safe to idle on the
3621     underlying transport in case event-driven IO is used.
3622
3623Bugfix
3624   * Fix a spurious uninitialized variable warning in cmac.c. Fix independently
3625     contributed by Brian J Murray and David Brown.
3626   * Add missing dependencies in test suites that led to build failures
3627     in configurations that omit certain hashes or public-key algorithms.
3628     Fixes #1040.
3629   * Fix C89 incompatibility in benchmark.c. Contributed by Brendan Shanks.
3630     #1353
3631   * Add missing dependencies for MBEDTLS_HAVE_TIME_DATE and
3632     MBEDTLS_VERSION_FEATURES in some test suites. Contributed by
3633     Deomid Ryabkov. Fixes #1299, #1475.
3634   * Fix the Makefile build process for building shared libraries on Mac OS X.
3635     Fixed by mnacamura.
3636   * Fix parsing of PKCS#8 encoded Elliptic Curve keys. Previously Mbed TLS was
3637     unable to parse keys which had only the optional parameters field of the
3638     ECPrivateKey structure. Found by Jethro Beekman, fixed in #1379.
3639   * Return the plaintext data more quickly on unpadded CBC decryption, as
3640     stated in the mbedtls_cipher_update() documentation. Contributed by
3641     Andy Leiserson.
3642   * Fix overriding and ignoring return values when parsing and writing to
3643     a file in pk_sign program. Found by kevlut in #1142.
3644   * Restrict usage of error code MBEDTLS_ERR_SSL_WANT_READ to situations
3645     where data needs to be fetched from the underlying transport in order
3646     to make progress. Previously, this error code was also occasionally
3647     returned when unexpected messages were being discarded, ignoring that
3648     further messages could potentially already be pending to be processed
3649     in the internal buffers; these cases led to deadlocks when event-driven
3650     I/O was used. Found and reported by Hubert Mis in #772.
3651   * Fix buffer length assertions in the ssl_parse_certificate_request()
3652     function which leads to a potential one byte overread of the message
3653     buffer.
3654   * Fix invalid buffer sizes passed to zlib during record compression and
3655     decompression.
3656   * Fix the soversion of libmbedcrypto to match the soversion of the
3657     maintained 2.7 branch. The soversion was increased in Mbed TLS
3658     version 2.7.1 to reflect breaking changes in that release, but the
3659     increment was missed in 2.8.0 and later releases outside of the 2.7 branch.
3660
3661Changes
3662   * Remove some redundant code in bignum.c. Contributed by Alexey Skalozub.
3663   * Support cmake builds where Mbed TLS is a subproject. Fix contributed
3664     independently by Matthieu Volat and Arne Schwabe.
3665   * Improve testing in configurations that omit certain hashes or
3666     public-key algorithms. Includes contributions by Gert van Dijk.
3667   * Improve negative testing of X.509 parsing.
3668   * Do not define global mutexes around readdir() and gmtime() in
3669     configurations where the feature is disabled. Found and fixed by Gergely
3670     Budai.
3671   * Harden the function mbedtls_ssl_config_free() against misuse, so that it
3672     doesn't leak memory if the user doesn't use mbedtls_ssl_conf_psk() and
3673     instead incorrectly manipulates the configuration structure directly.
3674     Found and fix submitted by junyeonLEE in #1220.
3675   * Provide an empty implementation of mbedtls_pkcs5_pbes2() when
3676     MBEDTLS_ASN1_PARSE_C is not enabled. This allows the use of PBKDF2
3677     without PBES2. Fixed by Marcos Del Sol Vives.
3678   * Add the order of the base point as N in the mbedtls_ecp_group structure
3679     for Curve25519 (other curves had it already). Contributed by Nicholas
3680     Wilson #481
3681   * Improve the documentation of mbedtls_net_accept(). Contributed by Ivan
3682     Krylov.
3683   * Improve the documentation of mbedtls_ssl_write(). Suggested by
3684     Paul Sokolovsky in #1356.
3685   * Add an option in the Makefile to support ar utilities where the operation
3686     letter must not be prefixed by '-', such as LLVM. Found and fixed by
3687     Alex Hixon.
3688   * Allow configuring the shared library extension by setting the DLEXT
3689     environment variable when using the project makefiles.
3690   * Optimize unnecessary zeroing in mbedtls_mpi_copy. Based on a contribution
3691     by Alexey Skalozub in #405.
3692   * In the SSL module, when f_send, f_recv or f_recv_timeout report
3693     transmitting more than the required length, return an error. Raised by
3694     Sam O'Connor in #1245.
3695   * Improve robustness of mbedtls_ssl_derive_keys against the use of
3696     HMAC functions with non-HMAC ciphersuites. Independently contributed
3697     by Jiayuan Chen in #1377. Fixes #1437.
3698   * Improve security of RSA key generation by including criteria from
3699     FIPS 186-4. Contributed by Jethro Beekman. #1380
3700   * Declare functions in header files even when an alternative implementation
3701     of the corresponding module is activated by defining the corresponding
3702     MBEDTLS_XXX_ALT macro. This means that alternative implementations do
3703     not need to copy the declarations, and ensures that they will have the
3704     same API.
3705   * Add platform setup and teardown calls in test suites.
3706
3707= mbed TLS 2.8.0 branch released 2018-03-16
3708
3709Default behavior changes
3710   * The truncated HMAC extension now conforms to RFC 6066. This means
3711     that when both sides of a TLS connection negotiate the truncated
3712     HMAC extension, Mbed TLS can now interoperate with other
3713     compliant implementations, but this breaks interoperability with
3714     prior versions of Mbed TLS. To restore the old behavior, enable
3715     the (deprecated) option MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT in
3716     config.h. Found by Andreas Walz (ivESK, Offenburg University of
3717     Applied Sciences).
3718
3719Security
3720   * Fix implementation of the truncated HMAC extension. The previous
3721     implementation allowed an offline 2^80 brute force attack on the
3722     HMAC key of a single, uninterrupted connection (with no
3723     resumption of the session).
3724   * Verify results of RSA private key operations to defend
3725     against Bellcore glitch attack.
3726   * Fix a buffer overread in ssl_parse_server_key_exchange() that could cause
3727     a crash on invalid input.
3728   * Fix a buffer overread in ssl_parse_server_psk_hint() that could cause a
3729     crash on invalid input.
3730   * Fix CRL parsing to reject CRLs containing unsupported critical
3731     extensions. Found by Falko Strenzke and Evangelos Karatsiolis.
3732
3733Features
3734   * Extend PKCS#8 interface by introducing support for the entire SHA
3735     algorithms family when encrypting private keys using PKCS#5 v2.0.
3736     This allows reading encrypted PEM files produced by software that
3737     uses PBKDF2-SHA2, such as OpenSSL 1.1. Submitted by Antonio Quartulli,
3738     OpenVPN Inc. Fixes #1339
3739   * Add support for public keys encoded in PKCS#1 format. #1122
3740
3741New deprecations
3742   * Deprecate support for record compression (configuration option
3743     MBEDTLS_ZLIB_SUPPORT).
3744
3745Bugfix
3746   * Fix the name of a DHE parameter that was accidentally changed in 2.7.0.
3747     Fixes #1358.
3748   * Fix test_suite_pk to work on 64-bit ILP32 systems. #849
3749   * Fix mbedtls_x509_crt_profile_suiteb, which used to reject all certificates
3750     with flag MBEDTLS_X509_BADCERT_BAD_PK even when the key type was correct.
3751     In the context of SSL, this resulted in handshake failure. Reported by
3752     daniel in the Mbed TLS forum. #1351
3753   * Fix Windows x64 builds with the included mbedTLS.sln file. #1347
3754   * Fix setting version TLSv1 as minimal version, even if TLS 1
3755     is not enabled. Set MBEDTLS_SSL_MIN_MAJOR_VERSION
3756     and MBEDTLS_SSL_MIN_MINOR_VERSION instead of
3757     MBEDTLS_SSL_MAJOR_VERSION_3 and MBEDTLS_SSL_MINOR_VERSION_1. #664
3758   * Fix compilation error on Mingw32 when _TRUNCATE is defined. Use _TRUNCATE
3759     only if __MINGW32__ not defined. Fix suggested by Thomas Glanzmann and
3760     Nick Wilson on issue #355
3761   * In test_suite_pk, pass valid parameters when testing for hash length
3762     overflow. #1179
3763   * Fix memory allocation corner cases in memory_buffer_alloc.c module. Found
3764     by Guido Vranken. #639
3765   * Log correct number of ciphersuites used in Client Hello message. #918
3766   * Fix X509 CRT parsing that would potentially accept an invalid tag when
3767     parsing the subject alternative names.
3768   * Fix a possible arithmetic overflow in ssl_parse_server_key_exchange()
3769     that could cause a key exchange to fail on valid data.
3770   * Fix a possible arithmetic overflow in ssl_parse_server_psk_hint() that
3771     could cause a key exchange to fail on valid data.
3772   * Don't define mbedtls_aes_decrypt and mbedtls_aes_encrypt under
3773     MBEDTLS_DEPRECATED_REMOVED. #1388
3774   * Fix a 1-byte heap buffer overflow (read-only) during private key parsing.
3775     Found through fuzz testing.
3776
3777Changes
3778   * Fix tag lengths and value ranges in the documentation of CCM encryption.
3779     Contributed by Mathieu Briand.
3780   * Fix typo in a comment ctr_drbg.c. Contributed by Paul Sokolovsky.
3781   * Remove support for the library reference configuration for picocoin.
3782   * MD functions deprecated in 2.7.0 are no longer inline, to provide
3783     a migration path for those depending on the library's ABI.
3784   * Clarify the documentation of mbedtls_ssl_setup.
3785   * Use (void) when defining functions with no parameters. Contributed by
3786     Joris Aerts. #678
3787
3788= mbed TLS 2.7.0 branch released 2018-02-03
3789
3790Security
3791   * Fix a heap corruption issue in the implementation of the truncated HMAC
3792     extension. When the truncated HMAC extension is enabled and CBC is used,
3793     sending a malicious application packet could be used to selectively corrupt
3794     6 bytes on the peer's heap, which could potentially lead to crash or remote
3795     code execution. The issue could be triggered remotely from either side in
3796     both TLS and DTLS. CVE-2018-0488
3797   * Fix a buffer overflow in RSA-PSS verification when the hash was too large
3798     for the key size, which could potentially lead to crash or remote code
3799     execution. Found by Seth Terashima, Qualcomm Product Security Initiative,
3800     Qualcomm Technologies Inc. CVE-2018-0487
3801   * Fix buffer overflow in RSA-PSS verification when the unmasked data is all
3802     zeros.
3803   * Fix an unsafe bounds check in ssl_parse_client_psk_identity() when adding
3804     64 KiB to the address of the SSL buffer and causing a wrap around.
3805   * Fix a potential heap buffer overflow in mbedtls_ssl_write(). When the (by
3806     default enabled) maximum fragment length extension is disabled in the
3807     config and the application data buffer passed to mbedtls_ssl_write
3808     is larger than the internal message buffer (16384 bytes by default), the
3809     latter overflows. The exploitability of this issue depends on whether the
3810     application layer can be forced into sending such large packets. The issue
3811     was independently reported by Tim Nordell via e-mail and by Florin Petriuc
3812     and sjorsdewit on GitHub. Fix proposed by Florin Petriuc in #1022.
3813     Fixes #707.
3814   * Add a provision to prevent compiler optimizations breaking the time
3815     constancy of mbedtls_ssl_safer_memcmp().
3816   * Ensure that buffers are cleared after use if they contain sensitive data.
3817     Changes were introduced in multiple places in the library.
3818   * Set PEM buffer to zero before freeing it, to avoid decoded private keys
3819     being leaked to memory after release.
3820   * Fix dhm_check_range() failing to detect trivial subgroups and potentially
3821     leaking 1 bit of the private key. Reported by prashantkspatil.
3822   * Make mbedtls_mpi_read_binary() constant-time with respect to the input
3823     data. Previously, trailing zero bytes were detected and omitted for the
3824     sake of saving memory, but potentially leading to slight timing
3825     differences. Reported by Marco Macchetti, Kudelski Group.
3826   * Wipe stack buffer temporarily holding EC private exponent
3827     after keypair generation.
3828   * Fix a potential heap buffer over-read in ALPN extension parsing
3829     (server-side). Could result in application crash, but only if an ALPN
3830     name larger than 16 bytes had been configured on the server.
3831   * Change default choice of DHE parameters from untrustworthy RFC 5114
3832     to RFC 3526 containing parameters generated in a nothing-up-my-sleeve
3833     manner.
3834
3835Features
3836   * Allow comments in test data files.
3837   * The selftest program can execute a subset of the tests based on command
3838     line arguments.
3839   * New unit tests for timing. Improve the self-test to be more robust
3840     when run on a heavily-loaded machine.
3841   * Add alternative implementation support for CCM and CMAC (MBEDTLS_CCM_ALT,
3842     MBEDTLS_CMAC_ALT). Submitted by Steven Cooreman, Silicon Labs.
3843   * Add support for alternative implementations of GCM, selected by the
3844     configuration flag MBEDTLS_GCM_ALT.
3845   * Add support for alternative implementations for ECDSA, controlled by new
3846     configuration flags MBEDTLS_ECDSA_SIGN_ALT, MBEDTLS_ECDSA_VERIFY_ALT and
3847     MBEDTLS_ECDSDA_GENKEY_AT in config.h.
3848     The following functions from the ECDSA module can be replaced
3849     with alternative implementation:
3850     mbedtls_ecdsa_sign(), mbedtls_ecdsa_verify() and mbedtls_ecdsa_genkey().
3851   * Add support for alternative implementation of ECDH, controlled by the
3852     new configuration flags MBEDTLS_ECDH_COMPUTE_SHARED_ALT and
3853     MBEDTLS_ECDH_GEN_PUBLIC_ALT in config.h.
3854     The following functions from the ECDH module can be replaced
3855     with an alternative implementation:
3856     mbedtls_ecdh_gen_public() and mbedtls_ecdh_compute_shared().
3857   * Add support for alternative implementation of ECJPAKE, controlled by
3858     the new configuration flag MBEDTLS_ECJPAKE_ALT.
3859   * Add mechanism to provide alternative implementation of the DHM module.
3860
3861API Changes
3862   * Extend RSA interface by multiple functions allowing structure-
3863     independent setup and export of RSA contexts. Most notably,
3864     mbedtls_rsa_import() and mbedtls_rsa_complete() are introduced for setting
3865     up RSA contexts from partial key material and having them completed to the
3866     needs of the implementation automatically. This allows to setup private RSA
3867     contexts from keys consisting of N,D,E only, even if P,Q are needed for the
3868     purpose or CRT and/or blinding.
3869   * The configuration option MBEDTLS_RSA_ALT can be used to define alternative
3870     implementations of the RSA interface declared in rsa.h.
3871   * The following functions in the message digest modules (MD2, MD4, MD5,
3872     SHA1, SHA256, SHA512) have been deprecated and replaced as shown below.
3873     The new functions change the return type from void to int to allow
3874     returning error codes when using MBEDTLS_<MODULE>_ALT.
3875     mbedtls_<MODULE>_starts() -> mbedtls_<MODULE>_starts_ret()
3876     mbedtls_<MODULE>_update() -> mbedtls_<MODULE>_update_ret()
3877     mbedtls_<MODULE>_finish() -> mbedtls_<MODULE>_finish_ret()
3878     mbedtls_<MODULE>_process() -> mbedtls_internal_<MODULE>_process()
3879
3880New deprecations
3881   * Deprecate usage of RSA primitives with non-matching key-type
3882     (e.g. signing with a public key).
3883   * Direct manipulation of structure fields of RSA contexts is deprecated.
3884     Users are advised to use the extended RSA API instead.
3885   * Deprecate usage of message digest functions that return void
3886     (mbedtls_<MODULE>_starts, mbedtls_<MODULE>_update,
3887     mbedtls_<MODULE>_finish and mbedtls_<MODULE>_process where <MODULE> is
3888     any of MD2, MD4, MD5, SHA1, SHA256, SHA512) in favor of functions
3889     that can return an error code.
3890   * Deprecate untrustworthy DHE parameters from RFC 5114. Superseded by
3891     parameters from RFC 3526 or the newly added parameters from RFC 7919.
3892   * Deprecate hex string DHE constants MBEDTLS_DHM_RFC3526_MODP_2048_P etc.
3893     Supserseded by binary encoded constants MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN
3894     etc.
3895   * Deprecate mbedtls_ssl_conf_dh_param() for setting default DHE parameters
3896     from hex strings. Superseded by mbedtls_ssl_conf_dh_param_bin()
3897     accepting DHM parameters in binary form, matching the new constants.
3898
3899Bugfix
3900   * Fix ssl_parse_record_header() to silently discard invalid DTLS records
3901     as recommended in RFC 6347 Section 4.1.2.7.
3902   * Fix memory leak in mbedtls_ssl_set_hostname() when called multiple times.
3903     Found by projectgus and Jethro Beekman, #836.
3904   * Fix usage help in ssl_server2 example. Found and fixed by Bei Lin.
3905   * Parse signature algorithm extension when renegotiating. Previously,
3906     renegotiated handshakes would only accept signatures using SHA-1
3907     regardless of the peer's preferences, or fail if SHA-1 was disabled.
3908   * Fix leap year calculation in x509_date_is_valid() to ensure that invalid
3909     dates on leap years with 100 and 400 intervals are handled correctly. Found
3910     by Nicholas Wilson. #694
3911   * Fix some invalid RSA-PSS signatures with keys of size 8N+1 that were
3912     accepted. Generating these signatures required the private key.
3913   * Fix out-of-memory problem when parsing 4096-bit PKCS8-encrypted RSA keys.
3914     Found independently by Florian in the mbed TLS forum and by Mishamax.
3915     #878, #1019.
3916   * Fix variable used before assignment compilation warnings with IAR
3917     toolchain. Found by gkerrien38.
3918   * Fix unchecked return codes from AES, DES and 3DES functions in
3919     pem_aes_decrypt(), pem_des_decrypt() and pem_des3_decrypt() respectively.
3920     If a call to one of the functions of the cryptographic primitive modules
3921     failed, the error may not be noticed by the function
3922     mbedtls_pem_read_buffer() causing it to return invalid values. Found by
3923     Guido Vranken. #756
3924   * Include configuration file in md.h, to fix compilation warnings.
3925     Reported by aaronmdjones in #1001
3926   * Correct extraction of signature-type from PK instance in X.509 CRT and CSR
3927     writing routines that prevented these functions to work with alternative
3928     RSA implementations. Raised by J.B. in the Mbed TLS forum. Fixes #1011.
3929   * Don't print X.509 version tag for v1 CRT's, and omit extensions for
3930     non-v3 CRT's.
3931   * Fix bugs in RSA test suite under MBEDTLS_NO_PLATFORM_ENTROPY. #1023 #1024
3932   * Fix net_would_block() to avoid modification by errno through fcntl() call.
3933     Found by nkolban. Fixes #845.
3934   * Fix handling of handshake messages in mbedtls_ssl_read() in case
3935     MBEDTLS_SSL_RENEGOTIATION is disabled. Found by erja-gp.
3936   * Add a check for invalid private parameters in mbedtls_ecdsa_sign().
3937     Reported by Yolan Romailler.
3938   * Fix word size check in in pk.c to not depend on MBEDTLS_HAVE_INT64.
3939   * Fix incorrect unit in benchmark output. #850
3940   * Add size-checks for record and handshake message content, securing
3941     fragile yet non-exploitable code-paths.
3942   * Fix crash when calling mbedtls_ssl_cache_free() twice. Found by
3943     MilenkoMitrovic, #1104
3944   * Fix mbedtls_timing_alarm(0) on Unix and MinGW.
3945   * Fix use of uninitialized memory in mbedtls_timing_get_timer() when reset=1.
3946   * Fix possible memory leaks in mbedtls_gcm_self_test().
3947   * Added missing return code checks in mbedtls_aes_self_test().
3948   * Fix issues in RSA key generation program programs/x509/rsa_genkey and the
3949     RSA test suite where the failure of CTR DRBG initialization lead to
3950     freeing an RSA context and several MPI's without proper initialization
3951     beforehand.
3952   * Fix error message in programs/pkey/gen_key.c. Found and fixed by Chris Xue.
3953   * Fix programs/pkey/dh_server.c so that it actually works with dh_client.c.
3954     Found and fixed by Martijn de Milliano.
3955   * Fix an issue in the cipher decryption with the mode
3956     MBEDTLS_PADDING_ONE_AND_ZEROS that sometimes accepted invalid padding.
3957     Note, this padding mode is not used by the TLS protocol. Found and fixed by
3958     Micha Kraus.
3959   * Fix the entropy.c module to not call mbedtls_sha256_starts() or
3960     mbedtls_sha512_starts() in the mbedtls_entropy_init() function.
3961   * Fix the entropy.c module to ensure that mbedtls_sha256_init() or
3962     mbedtls_sha512_init() is called before operating on the relevant context
3963     structure. Do not assume that zeroizing a context is a correct way to
3964     reset it. Found independently by ccli8 on Github.
3965   * In mbedtls_entropy_free(), properly free the message digest context.
3966   * Fix status handshake status message in programs/ssl/dtls_client.c. Found
3967     and fixed by muddog.
3968
3969Changes
3970   * Extend cert_write example program by options to set the certificate version
3971     and the message digest. Further, allow enabling/disabling of authority
3972     identifier, subject identifier and basic constraints extensions.
3973   * Only check for necessary RSA structure fields in `mbedtls_rsa_private`. In
3974     particular, don't require P,Q if neither CRT nor blinding are
3975     used. Reported and fix proposed independently by satur9nine and sliai
3976     on GitHub.
3977   * Only run AES-192 self-test if AES-192 is available. Fixes #963.
3978   * Tighten the RSA PKCS#1 v1.5 signature verification code and remove the
3979     undeclared dependency of the RSA module on the ASN.1 module.
3980   * Update all internal usage of deprecated message digest functions to the
3981     new ones with return codes. In particular, this modifies the
3982     mbedtls_md_info_t structure. Propagate errors from these functions
3983     everywhere except some locations in the ssl_tls.c module.
3984   * Improve CTR_DRBG error handling by propagating underlying AES errors.
3985   * Add MBEDTLS_ERR_XXX_HW_ACCEL_FAILED error codes for all cryptography
3986     modules where the software implementation can be replaced by a hardware
3987     implementation.
3988   * Add explicit warnings for the use of MD2, MD4, MD5, SHA-1, DES and ARC4
3989     throughout the library.
3990
3991= mbed TLS 2.6.0 branch released 2017-08-10
3992
3993Security
3994   * Fix authentication bypass in SSL/TLS: when authmode is set to optional,
3995     mbedtls_ssl_get_verify_result() would incorrectly return 0 when the peer's
3996     X.509 certificate chain had more than MBEDTLS_X509_MAX_INTERMEDIATE_CA
3997     (default: 8) intermediates, even when it was not trusted. This could be
3998     triggered remotely from either side. (With authmode set to 'required'
3999     (the default), the handshake was correctly aborted).
4000   * Reliably wipe sensitive data after use in the AES example applications
4001     programs/aes/aescrypt2 and programs/aes/crypt_and_hash.
4002     Found by Laurent Simon.
4003
4004Features
4005   * Add the functions mbedtls_platform_setup() and mbedtls_platform_teardown()
4006     and the context struct mbedtls_platform_context to perform
4007     platform-specific setup and teardown operations. The macro
4008     MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT allows the functions to be overridden
4009     by the user in a platform_alt.h file. These new functions are required in
4010     some embedded environments to provide a means of initialising underlying
4011     cryptographic acceleration hardware.
4012
4013API Changes
4014   * Reverted API/ABI breaking changes introduced in mbed TLS 2.5.1, to make the
4015     API consistent with mbed TLS 2.5.0. Specifically removed the inline
4016     qualifier from the functions mbedtls_aes_decrypt, mbedtls_aes_encrypt,
4017     mbedtls_ssl_ciphersuite_uses_ec and mbedtls_ssl_ciphersuite_uses_psk. Found
4018     by James Cowgill. #978
4019   * Certificate verification functions now set flags to -1 in case the full
4020     chain was not verified due to an internal error (including in the verify
4021     callback) or chain length limitations.
4022   * With authmode set to optional, the TLS handshake is now aborted if the
4023     verification of the peer's certificate failed due to an overlong chain or
4024     a fatal error in the verify callback.
4025
4026Bugfix
4027   * Add a check if iv_len is zero in GCM, and return an error if it is zero.
4028     Reported by roberto. #716
4029   * Replace preprocessor condition from #if defined(MBEDTLS_THREADING_PTHREAD)
4030     to #if defined(MBEDTLS_THREADING_C) as the library cannot assume they will
4031     always be implemented by pthread support. #696
4032   * Fix a resource leak on Windows platforms in mbedtls_x509_crt_parse_path(),
4033     in the case of an error. Found by redplait. #590
4034   * Add MBEDTLS_MPI_CHK to check for error value of mbedtls_mpi_fill_random.
4035     Reported and fix suggested by guidovranken. #740
4036   * Fix conditional preprocessor directives in bignum.h to enable 64-bit
4037     compilation when using ARM Compiler 6.
4038   * Fix a potential integer overflow in the version verification for DER
4039     encoded X.509 CRLs. The overflow could enable maliciously constructed CRLs
4040     to bypass the version verification check. Found by Peng Li/Yueh-Hsun Lin,
4041     KNOX Security, Samsung Research America
4042   * Fix potential integer overflow in the version verification for DER
4043     encoded X.509 CSRs. The overflow could enable maliciously constructed CSRs
4044     to bypass the version verification check. Found by Peng Li/Yueh-Hsun Lin,
4045     KNOX Security, Samsung Research America
4046   * Fix a potential integer overflow in the version verification for DER
4047     encoded X.509 certificates. The overflow could enable maliciously
4048     constructed certificates to bypass the certificate verification check.
4049   * Fix a call to the libc function time() to call the platform abstraction
4050     function mbedtls_time() instead. Found by wairua. #666
4051   * Avoid shadowing of time and index functions through mbed TLS function
4052     arguments. Found by inestlerode. #557.
4053
4054Changes
4055   * Added config.h option MBEDTLS_NO_UDBL_DIVISION, to prevent the use of
4056     64-bit division. This is useful on embedded platforms where 64-bit division
4057     created a dependency on external libraries. #708
4058   * Removed mutexes from ECP hardware accelerator code. Now all hardware
4059     accelerator code in the library leaves concurrency handling to the
4060     platform. Reported by Steven Cooreman. #863
4061   * Define the macro MBEDTLS_AES_ROM_TABLES in the configuration file
4062     config-no-entropy.h to reduce the RAM footprint.
4063   * Added a test script that can be hooked into git that verifies commits
4064     before they are pushed.
4065   * Improve documentation of PKCS1 decryption functions.
4066
4067= mbed TLS 2.5.1 released 2017-06-21
4068
4069Security
4070   * Fixed unlimited overread of heap-based buffer in mbedtls_ssl_read().
4071     The issue could only happen client-side with renegotiation enabled.
4072     Could result in DoS (application crash) or information leak
4073     (if the application layer sent data read from mbedtls_ssl_read()
4074     back to the server or to a third party). Can be triggered remotely.
4075   * Removed SHA-1 and RIPEMD-160 from the default hash algorithms for
4076     certificate verification. SHA-1 can be turned back on with a compile-time
4077     option if needed.
4078   * Fixed offset in FALLBACK_SCSV parsing that caused TLS server to fail to
4079     detect it sometimes. Reported by Hugo Leisink. #810
4080   * Tighten parsing of RSA PKCS#1 v1.5 signatures, to avoid a
4081     potential Bleichenbacher/BERserk-style attack.
4082
4083Bugfix
4084   * Remove size zero arrays from ECJPAKE test suite. Size zero arrays are not
4085     valid C and they prevented the test from compiling in Visual Studio 2015
4086     and with GCC using the -Wpedantic compilation option.
4087   * Fix insufficient support for signature-hash-algorithm extension,
4088     resulting in compatibility problems with Chrome. Found by hfloyrd. #823
4089   * Fix behaviour that hid the original cause of fatal alerts in some cases
4090     when sending the alert failed. The fix makes sure not to hide the error
4091     that triggered the alert.
4092   * Fix SSLv3 renegotiation behaviour and stop processing data received from
4093     peer after sending a fatal alert to refuse a renegotiation attempt.
4094     Previous behaviour was to keep processing data even after the alert has
4095     been sent.
4096   * Accept empty trusted CA chain in authentication mode
4097     MBEDTLS_SSL_VERIFY_OPTIONAL. Found by Jethro Beekman. #864
4098   * Fix implementation of mbedtls_ssl_parse_certificate() to not annihilate
4099     fatal errors in authentication mode MBEDTLS_SSL_VERIFY_OPTIONAL and to
4100     reflect bad EC curves within verification result.
4101   * Fix bug that caused the modular inversion function to accept the invalid
4102     modulus 1 and therefore to hang. Found by blaufish. #641.
4103   * Fix incorrect sign computation in modular exponentiation when the base is
4104     a negative MPI. Previously the result was always negative. Found by Guido
4105     Vranken.
4106   * Fix a numerical underflow leading to stack overflow in mpi_read_file()
4107     that was triggered uppon reading an empty line. Found by Guido Vranken.
4108
4109Changes
4110   * Send fatal alerts in more cases. The previous behaviour was to skip
4111     sending the fatal alert and just drop the connection.
4112   * Clarify ECDSA documentation and improve the sample code to avoid
4113     misunderstanding and potentially dangerous use of the API. Pointed out
4114     by Jean-Philippe Aumasson.
4115
4116= mbed TLS 2.5.0 branch released 2017-05-17
4117
4118Security
4119   * Wipe stack buffers in RSA private key operations
4120     (rsa_rsaes_pkcs1_v15_decrypt(), rsa_rsaes_oaep_decrypt). Found by Laurent
4121     Simon.
4122   * Add exponent blinding to RSA private operations as a countermeasure
4123     against side-channel attacks like the cache attack described in
4124     https://arxiv.org/abs/1702.08719v2.
4125     Found and fix proposed by Michael Schwarz, Samuel Weiser, Daniel Gruss,
4126     Clémentine Maurice and Stefan Mangard.
4127
4128Features
4129   * Add hardware acceleration support for the Elliptic Curve Point module.
4130     This involved exposing parts of the internal interface to enable
4131     replacing the core functions and adding and alternative, module level
4132     replacement support for enabling the extension of the interface.
4133   * Add a new configuration option to 'mbedtls_ssl_config' to enable
4134     suppressing the CA list in Certificate Request messages. The default
4135     behaviour has not changed, namely every configured CAs name is included.
4136
4137API Changes
4138   * The following functions in the AES module have been deprecated and replaced
4139     by the functions shown below. The new functions change the return type from
4140     void to int to allow returning error codes when using MBEDTLS_AES_ALT,
4141     MBEDTLS_AES_DECRYPT_ALT or MBEDTLS_AES_ENCRYPT_ALT.
4142     mbedtls_aes_decrypt() -> mbedtls_internal_aes_decrypt()
4143     mbedtls_aes_encrypt() -> mbedtls_internal_aes_encrypt()
4144
4145Bugfix
4146   * Remove macros from compat-1.3.h that correspond to deleted items from most
4147     recent versions of the library. Found by Kyle Keen.
4148   * Fixed issue in the Threading module that prevented mutexes from
4149     initialising. Found by sznaider. #667 #843
4150   * Add checks in the PK module for the RSA functions on 64-bit systems.
4151     The PK and RSA modules use different types for passing hash length and
4152     without these checks the type cast could lead to data loss. Found by Guido
4153     Vranken.
4154
4155= mbed TLS 2.4.2 branch released 2017-03-08
4156
4157Security
4158   * Add checks to prevent signature forgeries for very large messages while
4159     using RSA through the PK module in 64-bit systems. The issue was caused by
4160     some data loss when casting a size_t to an unsigned int value in the
4161     functions rsa_verify_wrap(), rsa_sign_wrap(), rsa_alt_sign_wrap() and
4162     mbedtls_pk_sign(). Found by Jean-Philippe Aumasson.
4163   * Fixed potential livelock during the parsing of a CRL in PEM format in
4164     mbedtls_x509_crl_parse(). A string containing a CRL followed by trailing
4165     characters after the footer could result in the execution of an infinite
4166     loop. The issue can be triggered remotely. Found by Greg Zaverucha,
4167     Microsoft.
4168   * Removed MD5 from the allowed hash algorithms for CertificateRequest and
4169     CertificateVerify messages, to prevent SLOTH attacks against TLS 1.2.
4170     Introduced by interoperability fix for #513.
4171   * Fixed a bug that caused freeing a buffer that was allocated on the stack,
4172     when verifying the validity of a key on secp224k1. This could be
4173     triggered remotely for example with a maliciously constructed certificate
4174     and potentially could lead to remote code execution on some platforms.
4175     Reported independently by rongsaws and Aleksandar Nikolic, Cisco Talos
4176     team. #569 CVE-2017-2784
4177
4178Bugfix
4179   * Fix output certificate verification flags set by x509_crt_verify_top() when
4180     traversing a chain of trusted CA. The issue would cause both flags,
4181     MBEDTLS_X509_BADCERT_NOT_TRUSTED and MBEDTLS_X509_BADCERT_EXPIRED, to be
4182     set when the verification conditions are not met regardless of the cause.
4183     Found by Harm Verhagen and inestlerode. #665 #561
4184   * Fix the redefinition of macro ssl_set_bio to an undefined symbol
4185     mbedtls_ssl_set_bio_timeout in compat-1.3.h, by removing it.
4186     Found by omlib-lin. #673
4187   * Fix unused variable/function compilation warnings in pem.c, x509_crt.c and
4188     x509_csr.c that are reported when building mbed TLS with a config.h that
4189     does not define MBEDTLS_PEM_PARSE_C. Found by omnium21. #562
4190   * Fix incorrect renegotiation condition in ssl_check_ctr_renegotiate() that
4191     would compare 64 bits of the record counter instead of 48 bits as indicated
4192     in RFC 6347 Section 4.3.1. This could cause the execution of the
4193     renegotiation routines at unexpected times when the protocol is DTLS. Found
4194     by wariua. #687
4195   * Fixed multiple buffer overreads in mbedtls_pem_read_buffer() when parsing
4196     the input string in PEM format to extract the different components. Found
4197     by Eyal Itkin.
4198   * Fixed potential arithmetic overflow in mbedtls_ctr_drbg_reseed() that could
4199     cause buffer bound checks to be bypassed. Found by Eyal Itkin.
4200   * Fixed potential arithmetic overflows in mbedtls_cipher_update() that could
4201     cause buffer bound checks to be bypassed. Found by Eyal Itkin.
4202   * Fixed potential arithmetic overflow in mbedtls_md2_update() that could
4203     cause buffer bound checks to be bypassed. Found by Eyal Itkin.
4204   * Fixed potential arithmetic overflow in mbedtls_base64_decode() that could
4205     cause buffer bound checks to be bypassed. Found by Eyal Itkin.
4206   * Fixed heap overreads in mbedtls_x509_get_time(). Found by Peng
4207     Li/Yueh-Hsun Lin, KNOX Security, Samsung Research America.
4208   * Fix potential memory leak in mbedtls_x509_crl_parse(). The leak was caused
4209     by missing calls to mbedtls_pem_free() in cases when a
4210     MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT error was encountered. Found and
4211     fix proposed by Guido Vranken. #722
4212   * Fixed the templates used to generate project and solution files for Visual
4213     Studio 2015 as well as the files themselves, to remove a build warning
4214     generated in Visual Studio 2015. Reported by Steve Valliere. #742
4215   * Fix a resource leak in ssl_cookie, when using MBEDTLS_THREADING_C.
4216     Raised and fix suggested by Alan Gillingham in the mbed TLS forum. #771
4217   * Fix 1 byte buffer overflow in mbedtls_mpi_write_string() when the MPI
4218     number to write in hexadecimal is negative and requires an odd number of
4219     digits. Found and fixed by Guido Vranken.
4220   * Fix unlisted DES configuration dependency in some pkparse test cases. Found
4221     by inestlerode. #555
4222
4223= mbed TLS 2.4.1 branch released 2016-12-13
4224
4225Changes
4226   * Update to CMAC test data, taken from - NIST Special Publication 800-38B -
4227     Recommendation for Block Cipher Modes of Operation: The CMAC Mode for
4228     Authentication – October  2016
4229
4230= mbed TLS 2.4.0 branch released 2016-10-17
4231
4232Security
4233   * Removed the MBEDTLS_SSL_AEAD_RANDOM_IV option, because it was not compliant
4234     with RFC-5116 and could lead to session key recovery in very long TLS
4235     sessions. "Nonce-Disrespecting Adversaries Practical Forgery Attacks on GCM in
4236     TLS" - H. Bock, A. Zauner, S. Devlin, J. Somorovsky, P. Jovanovic.
4237     https://eprint.iacr.org/2016/475.pdf
4238   * Fixed potential stack corruption in mbedtls_x509write_crt_der() and
4239     mbedtls_x509write_csr_der() when the signature is copied to the buffer
4240     without checking whether there is enough space in the destination. The
4241     issue cannot be triggered remotely. Found by Jethro Beekman.
4242
4243Features
4244   * Added support for CMAC for AES and 3DES and AES-CMAC-PRF-128, as defined by
4245     NIST SP 800-38B, RFC-4493 and RFC-4615.
4246   * Added hardware entropy selftest to verify that the hardware entropy source
4247     is functioning correctly.
4248   * Added a script to print build environment info for diagnostic use in test
4249     scripts, which is also now called by all.sh.
4250   * Added the macro MBEDTLS_X509_MAX_FILE_PATH_LEN that enables the user to
4251     configure the maximum length of a file path that can be buffered when
4252     calling mbedtls_x509_crt_parse_path().
4253   * Added a configuration file config-no-entropy.h that configures the subset of
4254     library features that do not require an entropy source.
4255   * Added the macro MBEDTLS_ENTROPY_MIN_HARDWARE in config.h. This allows users
4256     to configure the minimum number of bytes for entropy sources using the
4257     mbedtls_hardware_poll() function.
4258
4259Bugfix
4260   * Fix for platform time abstraction to avoid dependency issues where a build
4261     may need time but not the standard C library abstraction, and added
4262     configuration consistency checks to check_config.h
4263   * Fix dependency issue in Makefile to allow parallel builds.
4264   * Fix incorrect handling of block lengths in crypt_and_hash.c sample program,
4265     when GCM is used. Found by udf2457. #441
4266   * Fix for key exchanges based on ECDH-RSA or ECDH-ECDSA which weren't
4267     enabled unless others were also present. Found by David Fernandez. #428
4268   * Fix for out-of-tree builds using CMake. Found by jwurzer, and fix based on
4269     a contribution from Tobias Tangemann. #541
4270   * Fixed cert_app.c sample program for debug output and for use when no root
4271     certificates are provided.
4272   * Fix conditional statement that would cause a 1 byte overread in
4273     mbedtls_asn1_get_int(). Found and fixed by Guido Vranken. #599
4274   * Fixed pthread implementation to avoid unintended double initialisations
4275     and double frees. Found by Niklas Amnebratt.
4276   * Fixed the sample applications gen_key.c, cert_req.c and cert_write.c for
4277     builds where the configuration MBEDTLS_PEM_WRITE_C is not defined. Found
4278     by inestlerode. #559.
4279   * Fix mbedtls_x509_get_sig() to update the ASN1 type in the mbedtls_x509_buf
4280     data structure until after error checks are successful. Found by
4281     subramanyam-c. #622
4282   * Fix documentation and implementation missmatch for function arguments of
4283     mbedtls_gcm_finish(). Found by cmiatpaar. #602
4284   * Guarantee that P>Q at RSA key generation. Found by inestlerode. #558
4285   * Fix potential byte overread when verifying malformed SERVER_HELLO in
4286     ssl_parse_hello_verify_request() for DTLS. Found by Guido Vranken.
4287   * Fix check for validity of date when parsing in mbedtls_x509_get_time().
4288     Found by subramanyam-c. #626
4289   * Fix compatibility issue with Internet Explorer client authentication,
4290     where the limited hash choices prevented the client from sending its
4291     certificate. Found by teumas. #513
4292   * Fix compilation without MBEDTLS_SELF_TEST enabled.
4293
4294Changes
4295   * Extended test coverage of special cases, and added new timing test suite.
4296   * Removed self-tests from the basic-built-test.sh script, and added all
4297     missing self-tests to the test suites, to ensure self-tests are only
4298     executed once.
4299   * Added support for 3 and 4 byte lengths to mbedtls_asn1_write_len().
4300   * Added support for a Yotta specific configuration file -
4301     through the symbol YOTTA_CFG_MBEDTLS_TARGET_CONFIG_FILE.
4302   * Added optimization for code space for X.509/OID based on configured
4303     features. Contributed by Aviv Palivoda.
4304   * Renamed source file library/net.c to library/net_sockets.c to avoid
4305     naming collision in projects which also have files with the common name
4306     net.c. For consistency, the corresponding header file, net.h, is marked as
4307     deprecated, and its contents moved to net_sockets.h.
4308   * Changed the strategy for X.509 certificate parsing and validation, to no
4309     longer disregard certificates with unrecognised fields.
4310
4311= mbed TLS 2.3.0 branch released 2016-06-28
4312
4313Security
4314   * Fix missing padding length check in mbedtls_rsa_rsaes_pkcs1_v15_decrypt
4315     required by PKCS1 v2.2
4316   * Fix potential integer overflow to buffer overflow in
4317     mbedtls_rsa_rsaes_pkcs1_v15_encrypt and mbedtls_rsa_rsaes_oaep_encrypt
4318     (not triggerable remotely in (D)TLS).
4319   * Fix a potential integer underflow to buffer overread in
4320     mbedtls_rsa_rsaes_oaep_decrypt. It is not triggerable remotely in
4321     SSL/TLS.
4322
4323Features
4324   * Support for platform abstraction of the standard C library time()
4325     function.
4326
4327Bugfix
4328   * Fix bug in mbedtls_mpi_add_mpi() that caused wrong results when the three
4329     arguments where the same (in-place doubling). Found and fixed by Janos
4330     Follath. #309
4331   * Fix potential build failures related to the 'apidoc' target, introduced
4332     in the previous patch release. Found by Robert Scheck. #390 #391
4333   * Fix issue in Makefile that prevented building using armar. #386
4334   * Fix memory leak that occurred only when ECJPAKE was enabled and ECDHE and
4335     ECDSA was disabled in config.h . The leak didn't occur by default.
4336   * Fix an issue that caused valid certificates to be rejected whenever an
4337     expired or not yet valid certificate was parsed before a valid certificate
4338     in the trusted certificate list.
4339   * Fix bug in mbedtls_x509_crt_parse that caused trailing extra data in the
4340     buffer after DER certificates to be included in the raw representation.
4341   * Fix issue that caused a hang when generating RSA keys of odd bitlength
4342   * Fix bug in mbedtls_rsa_rsaes_pkcs1_v15_encrypt that made null pointer
4343     dereference possible.
4344   * Fix issue that caused a crash if invalid curves were passed to
4345     mbedtls_ssl_conf_curves. #373
4346   * Fix issue in ssl_fork_server which was preventing it from functioning. #429
4347   * Fix memory leaks in test framework
4348   * Fix test in ssl-opt.sh that does not run properly with valgrind
4349   * Fix unchecked calls to mmbedtls_md_setup(). Fix by Brian Murray. #502
4350
4351Changes
4352   * On ARM platforms, when compiling with -O0 with GCC, Clang or armcc5,
4353     don't use the optimized assembly for bignum multiplication. This removes
4354     the need to pass -fomit-frame-pointer to avoid a build error with -O0.
4355   * Disabled SSLv3 in the default configuration.
4356   * Optimized mbedtls_mpi_zeroize() for MPI integer size. (Fix by Alexey
4357     Skalozub).
4358   * Fix non-compliance server extension handling. Extensions for SSLv3 are now
4359     ignored, as required by RFC6101.
4360
4361= mbed TLS 2.2.1 released 2016-01-05
4362
4363Security
4364   * Fix potential double free when mbedtls_asn1_store_named_data() fails to
4365     allocate memory. Only used for certificate generation, not triggerable
4366     remotely in SSL/TLS. Found by Rafał Przywara. #367
4367   * Disable MD5 handshake signatures in TLS 1.2 by default to prevent the
4368     SLOTH attack on TLS 1.2 server authentication (other attacks from the
4369     SLOTH paper do not apply to any version of mbed TLS or PolarSSL).
4370     https://www.mitls.org/pages/attacks/SLOTH
4371
4372Bugfix
4373   * Fix over-restrictive length limit in GCM. Found by Andreas-N. #362
4374   * Fix bug in certificate validation that caused valid chains to be rejected
4375     when the first intermediate certificate has pathLenConstraint=0. Found by
4376     Nicholas Wilson. Introduced in mbed TLS 2.2.0. #280
4377   * Removed potential leak in mbedtls_rsa_rsassa_pkcs1_v15_sign(), found by
4378     JayaraghavendranK. #372
4379   * Fix suboptimal handling of unexpected records that caused interop issues
4380     with some peers over unreliable links. Avoid dropping an entire DTLS
4381     datagram if a single record in a datagram is unexpected, instead only
4382     drop the record and look at subsequent records (if any are present) in
4383     the same datagram. Found by jeannotlapin. #345
4384
4385= mbed TLS 2.2.0 released 2015-11-04
4386
4387Security
4388   * Fix potential double free if mbedtls_ssl_conf_psk() is called more than
4389     once and some allocation fails. Cannot be forced remotely. Found by Guido
4390     Vranken, Intelworks.
4391   * Fix potential heap corruption on Windows when
4392     mbedtls_x509_crt_parse_path() is passed a path longer than 2GB. Cannot be
4393     triggered remotely. Found by Guido Vranken, Intelworks.
4394   * Fix potential buffer overflow in some asn1_write_xxx() functions.
4395     Cannot be triggered remotely unless you create X.509 certificates based
4396     on untrusted input or write keys of untrusted origin. Found by Guido
4397     Vranken, Intelworks.
4398   * The X509 max_pathlen constraint was not enforced on intermediate
4399     certificates. Found by Nicholas Wilson, fix and tests provided by
4400     Janos Follath. #280 and #319
4401
4402Features
4403   * Experimental support for EC J-PAKE as defined in Thread 1.0.0.
4404     Disabled by default as the specification might still change.
4405   * Added a key extraction callback to accees the master secret and key
4406     block. (Potential uses include EAP-TLS and Thread.)
4407
4408Bugfix
4409   * Self-signed certificates were not excluded from pathlen counting,
4410     resulting in some valid X.509 being incorrectly rejected. Found and fix
4411     provided by Janos Follath. #319
4412   * Fix build error with configurations where ECDHE-PSK is the only key
4413     exchange. Found and fix provided by Chris Hammond. #270
4414   * Fix build error with configurations where RSA, RSA-PSK, ECDH-RSA or
4415     ECHD-ECDSA if the only key exchange. Multiple reports. #310
4416   * Fixed a bug causing some handshakes to fail due to some non-fatal alerts
4417     not being properly ignored. Found by mancha and Kasom Koht-arsa, #308
4418   * mbedtls_x509_crt_verify(_with_profile)() now also checks the key type and
4419     size/curve against the profile. Before that, there was no way to set a
4420     minimum key size for end-entity certificates with RSA keys. Found by
4421     Matthew Page of Scannex Electronics Ltd.
4422   * Fix failures in MPI on Sparc(64) due to use of bad assembly code.
4423     Found by Kurt Danielson. #292
4424   * Fix typo in name of the extKeyUsage OID. Found by inestlerode, #314
4425   * Fix bug in ASN.1 encoding of booleans that caused generated CA
4426     certificates to be rejected by some applications, including OS X
4427     Keychain. Found and fixed by Jonathan Leroy, Inikup.
4428
4429Changes
4430   * Improved performance of mbedtls_ecp_muladd() when one of the scalars is 1
4431     or -1.
4432
4433= mbed TLS 2.1.2 released 2015-10-06
4434
4435Security
4436   * Added fix for CVE-2015-5291 to prevent heap corruption due to buffer
4437     overflow of the hostname or session ticket. Found by Guido Vranken,
4438     Intelworks.
4439   * Fix potential double-free if mbedtls_ssl_set_hs_psk() is called more than
4440     once in the same handhake and mbedtls_ssl_conf_psk() was used.
4441     Found and patch provided by Guido Vranken, Intelworks. Cannot be forced
4442     remotely.
4443   * Fix stack buffer overflow in pkcs12 decryption (used by
4444     mbedtls_pk_parse_key(file)() when the password is > 129 bytes.
4445     Found by Guido Vranken, Intelworks. Not triggerable remotely.
4446   * Fix potential buffer overflow in mbedtls_mpi_read_string().
4447     Found by Guido Vranken, Intelworks. Not exploitable remotely in the context
4448     of TLS, but might be in other uses. On 32 bit machines, requires reading a
4449     string of close to or larger than 1GB to exploit; on 64 bit machines, would
4450     require reading a string of close to or larger than 2^62 bytes.
4451   * Fix potential random memory allocation in mbedtls_pem_read_buffer()
4452     on crafted PEM input data. Found and fix provided by Guido Vranken,
4453     Intelworks. Not triggerable remotely in TLS. Triggerable remotely if you
4454     accept PEM data from an untrusted source.
4455   * Fix possible heap buffer overflow in base64_encoded() when the input
4456     buffer is 512MB or larger on 32-bit platforms. Found by Guido Vranken,
4457     Intelworks. Not trigerrable remotely in TLS.
4458   * Fix potential double-free if mbedtls_conf_psk() is called repeatedly on
4459     the same mbedtls_ssl_config object and memory allocation fails. Found by
4460     Guido Vranken, Intelworks. Cannot be forced remotely.
4461   * Fix potential heap buffer overflow in servers that perform client
4462     authentication against a crafted CA cert. Cannot be triggered remotely
4463     unless you allow third parties to pick trust CAs for client auth.
4464     Found by Guido Vranken, Intelworks.
4465
4466Bugfix
4467   * Fix compile error in net.c with musl libc. Found and patch provided by
4468     zhasha (#278).
4469   * Fix macroization of 'inline' keyword when building as C++. (#279)
4470
4471Changes
4472   * Added checking of hostname length in mbedtls_ssl_set_hostname() to ensure
4473     domain names are compliant with RFC 1035.
4474   * Fixed paths for check_config.h in example config files. (Found by bachp)
4475     (#291)
4476
4477= mbed TLS 2.1.1 released 2015-09-17
4478
4479Security
4480   * Add countermeasure against Lenstra's RSA-CRT attack for PKCS#1 v1.5
4481     signatures. (Found by Florian Weimer, Red Hat.)
4482     https://securityblog.redhat.com/2015/09/02/factoring-rsa-keys-with-tls-perfect-forward-secrecy/
4483   * Fix possible client-side NULL pointer dereference (read) when the client
4484     tries to continue the handshake after it failed (a misuse of the API).
4485     (Found and patch provided by Fabian Foerg, Gotham Digital Science using
4486     afl-fuzz.)
4487
4488Bugfix
4489   * Fix warning when using a 64bit platform. (found by embedthis) (#275)
4490   * Fix off-by-one error in parsing Supported Point Format extension that
4491     caused some handshakes to fail.
4492
4493Changes
4494   * Made X509 profile pointer const in mbedtls_ssl_conf_cert_profile() to allow
4495     use of mbedtls_x509_crt_profile_next. (found by NWilson)
4496   * When a client initiates a reconnect from the same port as a live
4497     connection, if cookie verification is available
4498     (MBEDTLS_SSL_DTLS_HELLO_VERIFY defined in config.h, and usable cookie
4499     callbacks set with mbedtls_ssl_conf_dtls_cookies()), this will be
4500     detected and mbedtls_ssl_read() will return
4501     MBEDTLS_ERR_SSL_CLIENT_RECONNECT - it is then possible to start a new
4502     handshake with the same context. (See RFC 6347 section 4.2.8.)
4503
4504= mbed TLS 2.1.0 released 2015-09-04
4505
4506Features
4507   * Added support for yotta as a build system.
4508   * Primary open source license changed to Apache 2.0 license.
4509
4510Bugfix
4511   * Fix segfault in the benchmark program when benchmarking DHM.
4512   * Fix build error with CMake and pre-4.5 versions of GCC (found by Hugo
4513     Leisink).
4514   * Fix bug when parsing a ServerHello without extensions (found by David
4515     Sears).
4516   * Fix bug in CMake lists that caused libmbedcrypto.a not to be installed
4517     (found by Benoit Lecocq).
4518   * Fix bug in Makefile that caused libmbedcrypto and libmbedx509 not to be
4519     installed (found by Rawi666).
4520   * Fix compile error with armcc 5 with --gnu option.
4521   * Fix bug in Makefile that caused programs not to be installed correctly
4522     (found by robotanarchy) (#232).
4523   * Fix bug in Makefile that prevented from installing without building the
4524     tests (found by robotanarchy) (#232).
4525   * Fix missing -static-libgcc when building shared libraries for Windows
4526     with make.
4527   * Fix link error when building shared libraries for Windows with make.
4528   * Fix error when loading libmbedtls.so.
4529   * Fix bug in mbedtls_ssl_conf_default() that caused the default preset to
4530     be always used (found by dcb314) (#235)
4531   * Fix bug in mbedtls_rsa_public() and mbedtls_rsa_private() that could
4532     result trying to unlock an unlocked mutex on invalid input (found by
4533     Fredrik Axelsson) (#257)
4534   * Fix -Wshadow warnings (found by hnrkp) (#240)
4535   * Fix memory corruption on client with overlong PSK identity, around
4536     SSL_MAX_CONTENT_LEN or higher - not triggerrable remotely (found by
4537     Aleksandrs Saveljevs) (#238)
4538   * Fix unused function warning when using MBEDTLS_MDx_ALT or
4539     MBEDTLS_SHAxxx_ALT (found by Henrik) (#239)
4540   * Fix memory corruption in pkey programs (found by yankuncheng) (#210)
4541
4542Changes
4543   * The PEM parser now accepts a trailing space at end of lines (#226).
4544   * It is now possible to #include a user-provided configuration file at the
4545     end of the default config.h by defining MBEDTLS_USER_CONFIG_FILE on the
4546     compiler's command line.
4547   * When verifying a certificate chain, if an intermediate certificate is
4548     trusted, no later cert is checked. (suggested by hannes-landeholm)
4549     (#220).
4550   * Prepend a "thread identifier" to debug messages (issue pointed out by
4551     Hugo Leisink) (#210).
4552   * Add mbedtls_ssl_get_max_frag_len() to query the current maximum fragment
4553     length.
4554
4555= mbed TLS 2.0.0 released 2015-07-13
4556
4557Features
4558   * Support for DTLS 1.0 and 1.2 (RFC 6347).
4559   * Ability to override core functions from MDx, SHAx, AES and DES modules
4560     with custom implementation (eg hardware accelerated), complementing the
4561     ability to override the whole module.
4562   * New server-side implementation of session tickets that rotate keys to
4563     preserve forward secrecy, and allows sharing across multiple contexts.
4564   * Added a concept of X.509 cerificate verification profile that controls
4565     which algorithms and key sizes (curves for ECDSA) are acceptable.
4566   * Expanded configurability of security parameters in the SSL module with
4567     mbedtls_ssl_conf_dhm_min_bitlen() and mbedtls_ssl_conf_sig_hashes().
4568   * Introduced a concept of presets for SSL security-relevant configuration
4569     parameters.
4570
4571API Changes
4572   * The library has been split into libmbedcrypto, libmbedx509, libmbedtls.
4573     You now need to link to all of them if you use TLS for example.
4574   * All public identifiers moved to the mbedtls_* or MBEDTLS_* namespace.
4575     Some names have been further changed to make them more consistent.
4576     Migration helpers scripts/rename.pl and include/mbedtls/compat-1.3.h are
4577     provided. Full list of renamings in scripts/data_files/rename-1.3-2.0.txt
4578   * Renamings of fields inside structures, not covered by the previous list:
4579     mbedtls_cipher_info_t.key_length -> key_bitlen
4580     mbedtls_cipher_context_t.key_length -> key_bitlen
4581     mbedtls_ecp_curve_info.size -> bit_size
4582   * Headers are now found in the 'mbedtls' directory (previously 'polarssl').
4583   * The following _init() functions that could return errors have
4584     been split into an _init() that returns void and another function that
4585     should generally be the first function called on this context after init:
4586     mbedtls_ssl_init() -> mbedtls_ssl_setup()
4587     mbedtls_ccm_init() -> mbedtls_ccm_setkey()
4588     mbedtls_gcm_init() -> mbedtls_gcm_setkey()
4589     mbedtls_hmac_drbg_init() -> mbedtls_hmac_drbg_seed(_buf)()
4590     mbedtls_ctr_drbg_init()  -> mbedtls_ctr_drbg_seed()
4591     Note that for mbedtls_ssl_setup(), you need to be done setting up the
4592     ssl_config structure before calling it.
4593   * Most ssl_set_xxx() functions (all except ssl_set_bio(), ssl_set_hostname(),
4594     ssl_set_session() and ssl_set_client_transport_id(), plus
4595     ssl_legacy_renegotiation()) have been renamed to mbedtls_ssl_conf_xxx()
4596     (see rename.pl and compat-1.3.h above) and their first argument's type
4597     changed from ssl_context to ssl_config.
4598   * ssl_set_bio() changed signature (contexts merged, order switched, one
4599     additional callback for read-with-timeout).
4600   * The following functions have been introduced and must be used in callback
4601     implementations (SNI, PSK) instead of their *conf counterparts:
4602     mbedtls_ssl_set_hs_own_cert()
4603     mbedtls_ssl_set_hs_ca_chain()
4604     mbedtls_ssl_set_hs_psk()
4605   * mbedtls_ssl_conf_ca_chain() lost its last argument (peer_cn), now set
4606     using mbedtls_ssl_set_hostname().
4607   * mbedtls_ssl_conf_session_cache() changed prototype (only one context
4608     pointer, parameters reordered).
4609   * On server, mbedtls_ssl_conf_session_tickets_cb() must now be used in
4610     place of mbedtls_ssl_conf_session_tickets() to enable session tickets.
4611   * The SSL debug callback gained two new arguments (file name, line number).
4612   * Debug modes were removed.
4613   * mbedtls_ssl_conf_truncated_hmac() now returns void.
4614   * mbedtls_memory_buffer_alloc_init() now returns void.
4615   * X.509 verification flags are now an uint32_t. Affect the signature of:
4616     mbedtls_ssl_get_verify_result()
4617     mbedtls_x509_ctr_verify_info()
4618     mbedtls_x509_crt_verify() (flags, f_vrfy -> needs to be updated)
4619     mbedtls_ssl_conf_verify() (f_vrfy -> needs to be updated)
4620   * The following functions changed prototype to avoid an in-out length
4621     parameter:
4622     mbedtls_base64_encode()
4623     mbedtls_base64_decode()
4624     mbedtls_mpi_write_string()
4625     mbedtls_dhm_calc_secret()
4626   * In the NET module, all "int" and "int *" arguments for file descriptors
4627     changed type to "mbedtls_net_context *".
4628   * net_accept() gained new arguments for the size of the client_ip buffer.
4629   * In the threading layer, mbedtls_mutex_init() and mbedtls_mutex_free() now
4630     return void.
4631   * ecdsa_write_signature() gained an additional md_alg argument and
4632     ecdsa_write_signature_det() was deprecated.
4633   * pk_sign() no longer accepts md_alg == POLARSSL_MD_NONE with ECDSA.
4634   * Last argument of x509_crt_check_key_usage() and
4635     mbedtls_x509write_crt_set_key_usage() changed from int to unsigned.
4636   * test_ca_list (from certs.h) is renamed to test_cas_pem and is only
4637     available if POLARSSL_PEM_PARSE_C is defined (it never worked without).
4638   * Test certificates in certs.c are no longer guaranteed to be nul-terminated
4639     strings; use the new *_len variables instead of strlen().
4640   * Functions mbedtls_x509_xxx_parse(), mbedtls_pk_parse_key(),
4641     mbedtls_pk_parse_public_key() and mbedtls_dhm_parse_dhm() now expect the
4642     length parameter to include the terminating null byte for PEM input.
4643   * Signature of mpi_mul_mpi() changed to make the last argument unsigned
4644   * calloc() is now used instead of malloc() everywhere. API of platform
4645     layer and the memory_buffer_alloc module changed accordingly.
4646     (Thanks to Mansour Moufid for helping with the replacement.)
4647   * Change SSL_DISABLE_RENEGOTIATION config.h flag to SSL_RENEGOTIATION
4648     (support for renegotiation now needs explicit enabling in config.h).
4649   * Split MBEDTLS_HAVE_TIME into MBEDTLS_HAVE_TIME and MBEDTLS_HAVE_TIME_DATE
4650     in config.h
4651   * net_connect() and net_bind() have a new 'proto' argument to choose
4652     between TCP and UDP, using the macros NET_PROTO_TCP or NET_PROTO_UDP.
4653     Their 'port' argument type is changed to a string.
4654   * Some constness fixes
4655
4656Removals
4657   * Removed mbedtls_ecp_group_read_string(). Only named groups are supported.
4658   * Removed mbedtls_ecp_sub() and mbedtls_ecp_add(), use
4659     mbedtls_ecp_muladd().
4660   * Removed individual mdX_hmac, shaX_hmac, mdX_file and shaX_file functions
4661     (use generic functions from md.h)
4662   * Removed mbedtls_timing_msleep(). Use mbedtls_net_usleep() or a custom
4663     waiting function.
4664   * Removed test DHM parameters from the test certs module.
4665   * Removed the PBKDF2 module (use PKCS5).
4666   * Removed POLARSSL_ERROR_STRERROR_BC (use mbedtls_strerror()).
4667   * Removed compat-1.2.h (helper for migrating from 1.2 to 1.3).
4668   * Removed openssl.h (very partial OpenSSL compatibility layer).
4669   * Configuration options POLARSSL_HAVE_LONGLONG was removed (now always on).
4670   * Configuration options POLARSSL_HAVE_INT8 and POLARSSL_HAVE_INT16 have
4671     been removed (compiler is required to support 32-bit operations).
4672   * Configuration option POLARSSL_HAVE_IPV6 was removed (always enabled).
4673   * Removed test program o_p_test, the script compat.sh does more.
4674   * Removed test program ssl_test, superseded by ssl-opt.sh.
4675   * Removed helper script active-config.pl
4676
4677New deprecations
4678   * md_init_ctx() is deprecated in favour of md_setup(), that adds a third
4679     argument (allowing memory savings if HMAC is not used)
4680
4681Semi-API changes (technically public, morally private)
4682   * Renamed a few headers to include _internal in the name. Those headers are
4683     not supposed to be included by users.
4684   * Changed md_info_t into an opaque structure (use md_get_xxx() accessors).
4685   * Changed pk_info_t into an opaque structure.
4686   * Changed cipher_base_t into an opaque structure.
4687   * Removed sig_oid2 and rename sig_oid1 to sig_oid in x509_crt and x509_crl.
4688   * x509_crt.key_usage changed from unsigned char to unsigned int.
4689   * Removed r and s from ecdsa_context
4690   * Removed mode from des_context and des3_context
4691
4692Default behavior changes
4693   * The default minimum TLS version is now TLS 1.0.
4694   * RC4 is now blacklisted by default in the SSL/TLS layer, and excluded from the
4695     default ciphersuite list returned by ssl_list_ciphersuites()
4696   * Support for receiving SSLv2 ClientHello is now disabled by default at
4697     compile time.
4698   * The default authmode for SSL/TLS clients is now REQUIRED.
4699   * Support for RSA_ALT contexts in the PK layer is now optional. Since is is
4700     enabled in the default configuration, this is only noticeable if using a
4701     custom config.h
4702   * Default DHM parameters server-side upgraded from 1024 to 2048 bits.
4703   * A minimum RSA key size of 2048 bits is now enforced during ceritificate
4704     chain verification.
4705   * Negotiation of truncated HMAC is now disabled by default on server too.
4706   * The following functions are now case-sensitive:
4707     mbedtls_cipher_info_from_string()
4708     mbedtls_ecp_curve_info_from_name()
4709     mbedtls_md_info_from_string()
4710     mbedtls_ssl_ciphersuite_from_string()
4711     mbedtls_version_check_feature()
4712
4713Requirement changes
4714   * The minimum MSVC version required is now 2010 (better C99 support).
4715   * The NET layer now unconditionnaly relies on getaddrinfo() and select().
4716   * Compiler is required to support C99 types such as long long and uint32_t.
4717
4718API changes from the 1.4 preview branch
4719   * ssl_set_bio_timeout() was removed, split into mbedtls_ssl_set_bio() with
4720     new prototype, and mbedtls_ssl_set_read_timeout().
4721   * The following functions now return void:
4722     mbedtls_ssl_conf_transport()
4723     mbedtls_ssl_conf_max_version()
4724     mbedtls_ssl_conf_min_version()
4725   * DTLS no longer hard-depends on TIMING_C, but uses a callback interface
4726     instead, see mbedtls_ssl_set_timer_cb(), with the Timing module providing
4727     an example implementation, see mbedtls_timing_delay_context and
4728     mbedtls_timing_set/get_delay().
4729   * With UDP sockets, it is no longer necessary to call net_bind() again
4730     after a successful net_accept().
4731
4732Changes
4733   * mbedtls_ctr_drbg_random() and mbedtls_hmac_drbg_random() are now
4734     thread-safe if MBEDTLS_THREADING_C is enabled.
4735   * Reduced ROM fooprint of SHA-256 and added an option to reduce it even
4736     more (at the expense of performance) MBEDTLS_SHA256_SMALLER.
4737
4738= mbed TLS 1.3 branch
4739
4740Security
4741   * With authmode set to SSL_VERIFY_OPTIONAL, verification of keyUsage and
4742     extendedKeyUsage on the leaf certificate was lost (results not accessible
4743     via ssl_get_verify_results()).
4744   * Add countermeasure against "Lucky 13 strikes back" cache-based attack,
4745     https://dl.acm.org/citation.cfm?id=2714625
4746
4747Features
4748   * Improve ECC performance by using more efficient doubling formulas
4749     (contributed by Peter Dettman).
4750   * Add x509_crt_verify_info() to display certificate verification results.
4751   * Add support for reading DH parameters with privateValueLength included
4752     (contributed by Daniel Kahn Gillmor).
4753   * Add support for bit strings in X.509 names (request by Fredrik Axelsson).
4754   * Add support for id-at-uniqueIdentifier in X.509 names.
4755   * Add support for overriding snprintf() (except on Windows) and exit() in
4756     the platform layer.
4757   * Add an option to use macros instead of function pointers in the platform
4758     layer (helps get rid of unwanted references).
4759   * Improved Makefiles for Windows targets by fixing library targets and making
4760     cross-compilation easier (thanks to Alon Bar-Lev).
4761   * The benchmark program also prints heap usage for public-key primitives
4762     if POLARSSL_MEMORY_BUFFER_ALLOC_C and POLARSSL_MEMORY_DEBUG are defined.
4763   * New script ecc-heap.sh helps measuring the impact of ECC parameters on
4764     speed and RAM (heap only for now) usage.
4765   * New script memory.sh helps measuring the ROM and RAM requirements of two
4766     reduced configurations (PSK-CCM and NSA suite B).
4767   * Add config flag POLARSSL_DEPRECATED_WARNING (off by default) to produce
4768     warnings on use of deprecated functions (with GCC and Clang only).
4769   * Add config flag POLARSSL_DEPRECATED_REMOVED (off by default) to produce
4770     errors on use of deprecated functions.
4771
4772Bugfix
4773   * Fix compile errors with PLATFORM_NO_STD_FUNCTIONS.
4774   * Fix compile error with PLATFORM_EXIT_ALT (thanks to Rafał Przywara).
4775   * Fix bug in entropy.c when THREADING_C is also enabled that caused
4776     entropy_free() to crash (thanks to Rafał Przywara).
4777   * Fix memory leak when gcm_setkey() and ccm_setkey() are used more than
4778     once on the same context.
4779   * Fix bug in ssl_mail_client when password is longer that username (found
4780     by Bruno Pape).
4781   * Fix undefined behaviour (memcmp( NULL, NULL, 0 );) in X.509 modules
4782     (detected by Clang's 3.6 UBSan).
4783   * mpi_size() and mpi_msb() would segfault when called on an mpi that is
4784     initialized but not set (found by pravic).
4785   * Fix detection of support for getrandom() on Linux (reported by syzzer) by
4786     doing it at runtime (using uname) rather that compile time.
4787   * Fix handling of symlinks by "make install" (found by Gaël PORTAY).
4788   * Fix potential NULL pointer dereference (not trigerrable remotely) when
4789     ssl_write() is called before the handshake is finished (introduced in
4790     1.3.10) (first reported by Martin Blumenstingl).
4791   * Fix bug in pk_parse_key() that caused some valid private EC keys to be
4792     rejected.
4793   * Fix bug in Via Padlock support (found by Nikos Mavrogiannopoulos).
4794   * Fix thread safety bug in RSA operations (found by Fredrik Axelsson).
4795   * Fix hardclock() (only used in the benchmarking program) with some
4796     versions of mingw64 (found by kxjhlele).
4797   * Fix warnings from mingw64 in timing.c (found by kxjklele).
4798   * Fix potential unintended sign extension in asn1_get_len() on 64-bit
4799     platforms.
4800   * Fix potential memory leak in ssl_set_psk() (found by Mansour Moufid).
4801   * Fix compile error when POLARSSL_SSL_DISABLE_RENEGOTATION and
4802     POLARSSL_SSL_SSESSION_TICKETS where both enabled in config.h (introduced
4803     in 1.3.10).
4804   * Add missing extern "C" guard in aesni.h (reported by amir zamani).
4805   * Add missing dependency on SHA-256 in some x509 programs (reported by
4806     Gergely Budai).
4807   * Fix bug related to ssl_set_curves(): the client didn't check that the
4808     curve picked by the server was actually allowed.
4809
4810Changes
4811   * Remove bias in mpi_gen_prime (contributed by Pascal Junod).
4812   * Remove potential sources of timing variations (some contributed by Pascal
4813     Junod).
4814   * Options POLARSSL_HAVE_INT8 and POLARSSL_HAVE_INT16 are deprecated.
4815   * Enabling POLARSSL_NET_C without POLARSSL_HAVE_IPV6 is deprecated.
4816   * compat-1.2.h and openssl.h are deprecated.
4817   * Adjusting/overriding CFLAGS and LDFLAGS with the make build system is now
4818     more flexible (warning: OFLAGS is not used any more) (see the README)
4819     (contributed by Alon Bar-Lev).
4820   * ssl_set_own_cert() no longer calls pk_check_pair() since the
4821     performance impact was bad for some users (this was introduced in 1.3.10).
4822   * Move from SHA-1 to SHA-256 in example programs using signatures
4823     (suggested by Thorsten Mühlfelder).
4824   * Remove some unneeded inclusions of header files from the standard library
4825     "minimize" others (eg use stddef.h if only size_t is needed).
4826   * Change #include lines in test files to use double quotes instead of angle
4827     brackets for uniformity with the rest of the code.
4828   * Remove dependency on sscanf() in X.509 parsing modules.
4829
4830= mbed TLS 1.3.10 released 2015-02-09
4831Security
4832   * NULL pointer dereference in the buffer-based allocator when the buffer is
4833     full and polarssl_free() is called (found by Mark Hasemeyer)
4834     (only possible if POLARSSL_MEMORY_BUFFER_ALLOC_C is enabled, which it is
4835     not by default).
4836   * Fix remotely-triggerable uninitialised pointer dereference caused by
4837     crafted X.509 certificate (TLS server is not affected if it doesn't ask for a
4838     client certificate) (found using Codenomicon Defensics).
4839   * Fix remotely-triggerable memory leak caused by crafted X.509 certificates
4840     (TLS server is not affected if it doesn't ask for a client certificate)
4841     (found using Codenomicon Defensics).
4842   * Fix potential stack overflow while parsing crafted X.509 certificates
4843     (TLS server is not affected if it doesn't ask for a client certificate)
4844     (found using Codenomicon Defensics).
4845   * Fix timing difference that could theoretically lead to a
4846     Bleichenbacher-style attack in the RSA and RSA-PSK key exchanges
4847     (reported by Sebastian Schinzel).
4848
4849Features
4850   * Add support for FALLBACK_SCSV (draft-ietf-tls-downgrade-scsv).
4851   * Add support for Extended Master Secret (draft-ietf-tls-session-hash).
4852   * Add support for Encrypt-then-MAC (RFC 7366).
4853   * Add function pk_check_pair() to test if public and private keys match.
4854   * Add x509_crl_parse_der().
4855   * Add compile-time option POLARSSL_X509_MAX_INTERMEDIATE_CA to limit the
4856     length of an X.509 verification chain.
4857   * Support for renegotiation can now be disabled at compile-time
4858   * Support for 1/n-1 record splitting, a countermeasure against BEAST.
4859   * Certificate selection based on signature hash, preferring SHA-1 over SHA-2
4860     for pre-1.2 clients when multiple certificates are available.
4861   * Add support for getrandom() syscall on recent Linux kernels with Glibc or
4862     a compatible enough libc (eg uClibc).
4863   * Add ssl_set_arc4_support() to make it easier to disable RC4 at runtime
4864     while using the default ciphersuite list.
4865   * Added new error codes and debug messages about selection of
4866     ciphersuite/certificate.
4867
4868Bugfix
4869   * Stack buffer overflow if ctr_drbg_update() is called with too large
4870     add_len (found by Jean-Philippe Aumasson) (not triggerable remotely).
4871   * Possible buffer overflow of length at most POLARSSL_MEMORY_ALIGN_MULTIPLE
4872     if memory_buffer_alloc_init() was called with buf not aligned and len not
4873     a multiple of POLARSSL_MEMORY_ALIGN_MULTIPLE (not triggerable remotely).
4874   * User set CFLAGS were ignored by Cmake with gcc (introduced in 1.3.9, found
4875     by Julian Ospald).
4876   * Fix potential undefined behaviour in Camellia.
4877   * Fix potential failure in ECDSA signatures when POLARSSL_ECP_MAX_BITS is a
4878     multiple of 8 (found by Gergely Budai).
4879   * Fix unchecked return code in x509_crt_parse_path() on Windows (found by
4880     Peter Vaskovic).
4881   * Fix assembly selection for MIPS64 (thanks to James Cowgill).
4882   * ssl_get_verify_result() now works even if the handshake was aborted due
4883     to a failed verification (found by Fredrik Axelsson).
4884   * Skip writing and parsing signature_algorithm extension if none of the
4885     key exchanges enabled needs certificates. This fixes a possible interop
4886     issue with some servers when a zero-length extension was sent. (Reported
4887     by Peter Dettman.)
4888   * On a 0-length input, base64_encode() did not correctly set output length
4889     (found by Hendrik van den Boogaard).
4890
4891Changes
4892   * Use deterministic nonces for AEAD ciphers in TLS by default (possible to
4893     switch back to random with POLARSSL_SSL_AEAD_RANDOM_IV in config.h).
4894   * Blind RSA private operations even when POLARSSL_RSA_NO_CRT is defined.
4895   * ssl_set_own_cert() now returns an error on key-certificate mismatch.
4896   * Forbid repeated extensions in X.509 certificates.
4897   * debug_print_buf() now prints a text view in addition to hexadecimal.
4898   * A specific error is now returned when there are ciphersuites in common
4899     but none of them is usable due to external factors such as no certificate
4900     with a suitable (extended)KeyUsage or curve or no PSK set.
4901   * It is now possible to disable negotiation of truncated HMAC server-side
4902     at runtime with ssl_set_truncated_hmac().
4903   * Example programs for SSL client and server now disable SSLv3 by default.
4904   * Example programs for SSL client and server now disable RC4 by default.
4905   * Use platform.h in all test suites and programs.
4906
4907= PolarSSL 1.3.9 released 2014-10-20
4908Security
4909   * Lowest common hash was selected from signature_algorithms extension in
4910     TLS 1.2 (found by Darren Bane) (introduced in 1.3.8).
4911   * Remotely-triggerable memory leak when parsing some X.509 certificates
4912     (server is not affected if it doesn't ask for a client certificate)
4913     (found using Codenomicon Defensics).
4914   * Remotely-triggerable memory leak when parsing crafted ClientHello
4915     (not affected if ECC support was compiled out) (found using Codenomicon
4916     Defensics).
4917
4918Bugfix
4919   * Support escaping of commas in x509_string_to_names()
4920   * Fix compile error in ssl_pthread_server (found by Julian Ospald).
4921   * Fix net_accept() regarding non-blocking sockets (found by Luca Pesce).
4922   * Don't print uninitialised buffer in ssl_mail_client (found by Marc Abel).
4923   * Fix warnings from Clang's scan-build (contributed by Alfred Klomp).
4924   * Fix compile error in timing.c when POLARSSL_NET_C and POLARSSL_SELFTEST
4925     are defined but not POLARSSL_HAVE_TIME (found by Stephane Di Vito).
4926   * Remove non-existent file from VS projects (found by Peter Vaskovic).
4927   * ssl_read() could return non-application data records on server while
4928     renegotation was pending, and on client when a HelloRequest was received.
4929   * Server-initiated renegotiation would fail with non-blocking I/O if the
4930     write callback returned WANT_WRITE when requesting renegotiation.
4931   * ssl_close_notify() could send more than one message in some circumstances
4932     with non-blocking I/O.
4933   * Fix compiler warnings on iOS (found by Sander Niemeijer).
4934   * x509_crt_parse() did not increase total_failed on PEM error
4935   * Fix compile error with armcc in mpi_is_prime()
4936   * Fix potential bad read in parsing ServerHello (found by Adrien
4937     Vialletelle).
4938
4939Changes
4940   * Ciphersuites using SHA-256 or SHA-384 now require TLS 1.x (there is no
4941     standard defining how to use SHA-2 with SSL 3.0).
4942   * Ciphersuites using RSA-PSK key exchange new require TLS 1.x (the spec is
4943     ambiguous on how to encode some packets with SSL 3.0).
4944   * Made buffer size in pk_write_(pub)key_pem() more dynamic, eg smaller if
4945     RSA is disabled, larger if POLARSSL_MPI_MAX_SIZE is larger.
4946   * ssl_read() now returns POLARSSL_ERR_NET_WANT_READ rather than
4947     POLARSSL_ERR_SSL_UNEXPECTED_MESSAGE on harmless alerts.
4948   * POLARSSL_MPI_MAX_SIZE now defaults to 1024 in order to allow 8192 bits
4949     RSA keys.
4950   * Accept spaces at end of line or end of buffer in base64_decode().
4951   * X.509 certificates with more than one AttributeTypeAndValue per
4952     RelativeDistinguishedName are not accepted any more.
4953
4954= PolarSSL 1.3.8 released 2014-07-11
4955Security
4956   * Fix length checking for AEAD ciphersuites (found by Codenomicon).
4957     It was possible to crash the server (and client) using crafted messages
4958     when a GCM suite was chosen.
4959
4960Features
4961   * Add CCM module and cipher mode to Cipher Layer
4962   * Support for CCM and CCM_8 ciphersuites
4963   * Support for parsing and verifying RSASSA-PSS signatures in the X.509
4964     modules (certificates, CRLs and CSRs).
4965   * Blowfish in the cipher layer now supports variable length keys.
4966   * Add example config.h for PSK with CCM, optimized for low RAM usage.
4967   * Optimize for RAM usage in example config.h for NSA Suite B profile.
4968   * Add POLARSSL_REMOVE_ARC4_CIPHERSUITES to allow removing RC4 ciphersuites
4969     from the default list (inactive by default).
4970   * Add server-side enforcement of sent renegotiation requests
4971     (ssl_set_renegotiation_enforced())
4972   * Add SSL_CIPHERSUITES config.h flag to allow specifying a list of
4973     ciphersuites to use and save some memory if the list is small.
4974
4975Changes
4976   * Add LINK_WITH_PTHREAD option in CMake for explicit linking that is
4977     required on some platforms (e.g. OpenBSD)
4978   * Migrate zeroizing of data to polarssl_zeroize() instead of memset()
4979     against unwanted compiler optimizations
4980   * md_list() now returns hashes strongest first
4981   * Selection of hash for signing ServerKeyExchange in TLS 1.2 now picks
4982     strongest offered by client.
4983   * All public contexts have _init() and _free() functions now for simpler
4984     usage pattern
4985
4986Bugfix
4987   * Fix in debug_print_msg()
4988   * Enforce alignment in the buffer allocator even if buffer is not aligned
4989   * Remove less-than-zero checks on unsigned numbers
4990   * Stricter check on SSL ClientHello internal sizes compared to actual packet
4991     size (found by TrustInSoft)
4992   * Fix WSAStartup() return value check (found by Peter Vaskovic)
4993   * Other minor issues (found by Peter Vaskovic)
4994   * Fix symlink command for cross compiling with CMake (found by Andre
4995     Heinecke)
4996   * Fix DER output of gen_key app (found by Gergely Budai)
4997   * Very small records were incorrectly rejected when truncated HMAC was in
4998     use with some ciphersuites and versions (RC4 in all versions, CBC with
4999     versions < TLS 1.1).
5000   * Very large records using more than 224 bytes of padding were incorrectly
5001     rejected with CBC-based ciphersuites and TLS >= 1.1
5002   * Very large records using less padding could cause a buffer overread of up
5003     to 32 bytes with CBC-based ciphersuites and TLS >= 1.1
5004   * Restore ability to use a v1 cert as a CA if trusted locally. (This had
5005     been removed in 1.3.6.)
5006   * Restore ability to locally trust a self-signed cert that is not a proper
5007     CA for use as an end entity certificate. (This had been removed in
5008     1.3.6.)
5009   * Fix preprocessor checks for bn_mul PPC asm (found by Barry K. Nathan).
5010   * Use \n\t rather than semicolons for bn_mul asm, since some assemblers
5011     interpret semicolons as comment delimiters (found by Barry K. Nathan).
5012   * Fix off-by-one error in parsing Supported Point Format extension that
5013     caused some handshakes to fail.
5014   * Fix possible miscomputation of the premaster secret with DHE-PSK key
5015     exchange that caused some handshakes to fail with other implementations.
5016     (Failure rate <= 1/255 with common DHM moduli.)
5017   * Disable broken Sparc64 bn_mul assembly (found by Florian Obser).
5018   * Fix base64_decode() to return and check length correctly (in case of
5019     tight buffers)
5020   * Fix mpi_write_string() to write "00" as hex output for empty MPI (found
5021     by Hui Dong)
5022
5023= PolarSSL 1.3.7 released on 2014-05-02
5024Features
5025   * debug_set_log_mode() added to determine raw or full logging
5026   * debug_set_threshold() added to ignore messages over threshold level
5027   * version_check_feature() added to check for compile-time options at
5028     run-time
5029
5030Changes
5031   * POLARSSL_CONFIG_OPTIONS has been removed. All values are individually
5032     checked and filled in the relevant module headers
5033   * Debug module only outputs full lines instead of parts
5034   * Better support for the different Attribute Types from IETF PKIX (RFC 5280)
5035   * AES-NI now compiles with "old" assemblers too
5036   * Ciphersuites based on RC4 now have the lowest priority by default
5037
5038Bugfix
5039   * Only iterate over actual certificates in ssl_write_certificate_request()
5040     (found by Matthew Page)
5041   * Typos in platform.c and pkcs11.c (found by Daniel Phillips and Steffan
5042     Karger)
5043   * cert_write app should use subject of issuer certificate as issuer of cert
5044   * Fix false reject in padding check in ssl_decrypt_buf() for CBC
5045     ciphersuites, for full SSL frames of data.
5046   * Improve interoperability by not writing extension length in ClientHello /
5047     ServerHello when no extensions are present (found by Matthew Page)
5048   * rsa_check_pubkey() now allows an E up to N
5049   * On OpenBSD, use arc4random_buf() instead of rand() to prevent warnings
5050   * mpi_fill_random() was creating numbers larger than requested on
5051     big-endian platform when size was not an integer number of limbs
5052   * Fix dependencies issues in X.509 test suite.
5053   * Some parts of ssl_tls.c were compiled even when the module was disabled.
5054   * Fix detection of DragonflyBSD in net.c (found by Markus Pfeiffer)
5055   * Fix detection of Clang on some Apple platforms with CMake
5056     (found by Barry K. Nathan)
5057
5058= PolarSSL 1.3.6 released on 2014-04-11
5059
5060Features
5061   * Support for the ALPN SSL extension
5062   * Add option 'use_dev_random' to gen_key application
5063   * Enable verification of the keyUsage extension for CA and leaf
5064     certificates (POLARSSL_X509_CHECK_KEY_USAGE)
5065   * Enable verification of the extendedKeyUsage extension
5066     (POLARSSL_X509_CHECK_EXTENDED_KEY_USAGE)
5067
5068Changes
5069   * x509_crt_info() now prints information about parsed extensions as well
5070   * pk_verify() now returns a specific error code when the signature is valid
5071     but shorter than the supplied length.
5072   * Use UTC time to check certificate validity.
5073   * Reject certificates with times not in UTC, per RFC 5280.
5074
5075Security
5076   * Avoid potential timing leak in ecdsa_sign() by blinding modular division.
5077     (Found by Watson Ladd.)
5078   * The notAfter date of some certificates was no longer checked since 1.3.5.
5079     This affects certificates in the user-supplied chain except the top
5080     certificate. If the user-supplied chain contains only one certificates,
5081     it is not affected (ie, its notAfter date is properly checked).
5082   * Prevent potential NULL pointer dereference in ssl_read_record() (found by
5083     TrustInSoft)
5084
5085Bugfix
5086   * The length of various ClientKeyExchange messages was not properly checked.
5087   * Some example server programs were not sending the close_notify alert.
5088   * Potential memory leak in mpi_exp_mod() when error occurs during
5089     calculation of RR.
5090   * Fixed malloc/free default #define in platform.c (found by Gergely Budai).
5091   * Fixed type which made POLARSSL_ENTROPY_FORCE_SHA256 uneffective (found by
5092     Gergely Budai).
5093   * Fix #include path in ecdsa.h which wasn't accepted by some compilers.
5094     (found by Gergely Budai)
5095   * Fix compile errors when POLARSSL_ERROR_STRERROR_BC is undefined (found by
5096     Shuo Chen).
5097   * oid_get_numeric_string() used to truncate the output without returning an
5098     error if the output buffer was just 1 byte too small.
5099   * dhm_parse_dhm() (hence dhm_parse_dhmfile()) did not set dhm->len.
5100   * Calling pk_debug() on an RSA-alt key would segfault.
5101   * pk_get_size() and pk_get_len() were off by a factor 8 for RSA-alt keys.
5102   * Potential buffer overwrite in pem_write_buffer() because of low length
5103     indication (found by Thijs Alkemade)
5104   * EC curves constants, which should be only in ROM since 1.3.3, were also
5105     stored in RAM due to missing 'const's (found by Gergely Budai).
5106
5107= PolarSSL 1.3.5 released on 2014-03-26
5108Features
5109   * HMAC-DRBG as a separate module
5110   * Option to set the Curve preference order (disabled by default)
5111   * Single Platform compatilibity layer (for memory / printf / fprintf)
5112   * Ability to provide alternate timing implementation
5113   * Ability to force the entropy module to use SHA-256 as its basis
5114     (POLARSSL_ENTROPY_FORCE_SHA256)
5115   * Testing script ssl-opt.sh added for testing 'live' ssl option
5116     interoperability against OpenSSL and PolarSSL
5117   * Support for reading EC keys that use SpecifiedECDomain in some cases.
5118   * Entropy module now supports seed writing and reading
5119
5120Changes
5121   * Deprecated the Memory layer
5122   * entropy_add_source(), entropy_update_manual() and entropy_gather()
5123     now thread-safe if POLARSSL_THREADING_C defined
5124   * Improvements to the CMake build system, contributed by Julian Ospald.
5125   * Work around a bug of the version of Clang shipped by Apple with Mavericks
5126     that prevented bignum.c from compiling. (Reported by Rafael Baptista.)
5127   * Revamped the compat.sh interoperatibility script to include support for
5128     testing against GnuTLS
5129   * Deprecated ssl_set_own_cert_rsa() and ssl_set_own_cert_rsa_alt()
5130   * Improvements to tests/Makefile, contributed by Oden Eriksson.
5131
5132Security
5133   * Forbid change of server certificate during renegotiation to prevent
5134     "triple handshake" attack when authentication mode is 'optional' (the
5135     attack was already impossible when authentication is required).
5136   * Check notBefore timestamp of certificates and CRLs from the future.
5137   * Forbid sequence number wrapping
5138   * Fixed possible buffer overflow with overlong PSK
5139   * Possible remotely-triggered out-of-bounds memory access fixed (found by
5140     TrustInSoft)
5141
5142Bugfix
5143   * ecp_gen_keypair() does more tries to prevent failure because of
5144     statistics
5145   * Fixed bug in RSA PKCS#1 v1.5 "reversed" operations
5146   * Fixed testing with out-of-source builds using cmake
5147   * Fixed version-major intolerance in server
5148   * Fixed CMake symlinking on out-of-source builds
5149   * Fixed dependency issues in test suite
5150   * Programs rsa_sign_pss and rsa_verify_pss were not using PSS since 1.3.0
5151   * Bignum's MIPS-32 assembly was used on MIPS-64, causing chaos. (Found by
5152     Alex Wilson.)
5153   * ssl_cache was creating entries when max_entries=0 if TIMING_C was enabled.
5154   * m_sleep() was sleeping twice too long on most Unix platforms.
5155   * Fixed bug with session tickets and non-blocking I/O in the unlikely case
5156     send() would return an EAGAIN error when sending the ticket.
5157   * ssl_cache was leaking memory when reusing a timed out entry containing a
5158     client certificate.
5159   * ssl_srv was leaking memory when client presented a timed out ticket
5160     containing a client certificate
5161   * ssl_init() was leaving a dirty pointer in ssl_context if malloc of
5162     out_ctr failed
5163   * ssl_handshake_init() was leaving dirty pointers in subcontexts if malloc
5164     of one of them failed
5165   * Fix typo in rsa_copy() that impacted PKCS#1 v2 contexts
5166   * x509_get_current_time() uses localtime_r() to prevent thread issues
5167
5168= PolarSSL 1.3.4 released on 2014-01-27
5169Features
5170   * Support for the Koblitz curves: secp192k1, secp224k1, secp256k1
5171   * Support for RIPEMD-160
5172   * Support for AES CFB8 mode
5173   * Support for deterministic ECDSA (RFC 6979)
5174
5175Bugfix
5176   * Potential memory leak in bignum_selftest()
5177   * Replaced expired test certificate
5178   * ssl_mail_client now terminates lines with CRLF, instead of LF
5179   * net module handles timeouts on blocking sockets better (found by Tilman
5180     Sauerbeck)
5181   * Assembly format fixes in bn_mul.h
5182
5183Security
5184   * Missing MPI_CHK calls added around unguarded mpi calls (found by
5185     TrustInSoft)
5186
5187= PolarSSL 1.3.3 released on 2013-12-31
5188Features
5189   * EC key generation support in gen_key app
5190   * Support for adhering to client ciphersuite order preference
5191     (POLARSSL_SSL_SRV_RESPECT_CLIENT_PREFERENCE)
5192   * Support for Curve25519
5193   * Support for ECDH-RSA and ECDH-ECDSA key exchanges and ciphersuites
5194   * Support for IPv6 in the NET module
5195   * AES-NI support for AES, AES-GCM and AES key scheduling
5196   * SSL Pthread-based server example added (ssl_pthread_server)
5197
5198Changes
5199   * gen_prime() speedup
5200   * Speedup of ECP multiplication operation
5201   * Relaxed some SHA2 ciphersuite's version requirements
5202   * Dropped use of readdir_r() instead of readdir() with threading support
5203   * More constant-time checks in the RSA module
5204   * Split off curves from ecp.c into ecp_curves.c
5205   * Curves are now stored fully in ROM
5206   * Memory usage optimizations in ECP module
5207   * Removed POLARSSL_THREADING_DUMMY
5208
5209Bugfix
5210   * Fixed bug in mpi_set_bit() on platforms where t_uint is wider than int
5211   * Fixed X.509 hostname comparison (with non-regular characters)
5212   * SSL now gracefully handles missing RNG
5213   * Missing defines / cases for RSA_PSK key exchange
5214   * crypt_and_hash app checks MAC before final decryption
5215   * Potential memory leak in ssl_ticket_keys_init()
5216   * Memory leak in benchmark application
5217   * Fixed x509_crt_parse_path() bug on Windows platforms
5218   * Added missing MPI_CHK() around some statements in mpi_div_mpi() (found by
5219     TrustInSoft)
5220   * Fixed potential overflow in certificate size verification in
5221     ssl_write_certificate() (found by TrustInSoft)
5222
5223Security
5224   * Possible remotely-triggered out-of-bounds memory access fixed (found by
5225     TrustInSoft)
5226
5227= PolarSSL 1.3.2 released on 2013-11-04
5228Features
5229   * PK tests added to test framework
5230   * Added optional optimization for NIST MODP curves (POLARSSL_ECP_NIST_OPTIM)
5231   * Support for Camellia-GCM mode and ciphersuites
5232
5233Changes
5234   * Padding checks in cipher layer are now constant-time
5235   * Value comparisons in SSL layer are now constant-time
5236   * Support for serialNumber, postalAddress and postalCode in X509 names
5237   * SSL Renegotiation was refactored
5238
5239Bugfix
5240   * More stringent checks in cipher layer
5241   * Server does not send out extensions not advertised by client
5242   * Prevent possible alignment warnings on casting from char * to 'aligned *'
5243   * Misc fixes and additions to dependency checks
5244   * Const correctness
5245   * cert_write with selfsign should use issuer_name as subject_name
5246   * Fix ECDSA corner case: missing reduction mod N (found by DualTachyon)
5247   * Defines to handle UEFI environment under MSVC
5248   * Server-side initiated renegotiations send HelloRequest
5249
5250= PolarSSL 1.3.1 released on 2013-10-15
5251Features
5252   * Support for Brainpool curves and TLS ciphersuites (RFC 7027)
5253   * Support for ECDHE-PSK key-exchange and ciphersuites
5254   * Support for RSA-PSK key-exchange and ciphersuites
5255
5256Changes
5257   * RSA blinding locks for a smaller amount of time
5258   * TLS compression only allocates working buffer once
5259   * Introduced POLARSSL_HAVE_READDIR_R for systems without it
5260   * config.h is more script-friendly
5261
5262Bugfix
5263   * Missing MSVC defines added
5264   * Compile errors with POLARSSL_RSA_NO_CRT
5265   * Header files with 'polarssl/'
5266   * Const correctness
5267   * Possible naming collision in dhm_context
5268   * Better support for MSVC
5269   * threading_set_alt() name
5270   * Added missing x509write_crt_set_version()
5271
5272= PolarSSL 1.3.0 released on 2013-10-01
5273Features
5274   * Elliptic Curve Cryptography module added
5275   * Elliptic Curve Diffie Hellman module added
5276   * Ephemeral Elliptic Curve Diffie Hellman support for SSL/TLS
5277    (ECDHE-based ciphersuites)
5278   * Ephemeral Elliptic Curve Digital Signature Algorithm support for SSL/TLS
5279    (ECDSA-based ciphersuites)
5280   * Ability to specify allowed ciphersuites based on the protocol version.
5281   * PSK and DHE-PSK based ciphersuites added
5282   * Memory allocation abstraction layer added
5283   * Buffer-based memory allocator added (no malloc() / free() / HEAP usage)
5284   * Threading abstraction layer added (dummy / pthread / alternate)
5285   * Public Key abstraction layer added
5286   * Parsing Elliptic Curve keys
5287   * Parsing Elliptic Curve certificates
5288   * Support for max_fragment_length extension (RFC 6066)
5289   * Support for truncated_hmac extension (RFC 6066)
5290   * Support for zeros-and-length (ANSI X.923) padding, one-and-zeros
5291     (ISO/IEC 7816-4) padding and zero padding in the cipher layer
5292   * Support for session tickets (RFC 5077)
5293   * Certificate Request (CSR) generation with extensions (key_usage,
5294     ns_cert_type)
5295   * X509 Certificate writing with extensions (basic_constraints,
5296     issuer_key_identifier, etc)
5297   * Optional blinding for RSA, DHM and EC
5298   * Support for multiple active certificate / key pairs in SSL servers for
5299     the same host (Not to be confused with SNI!)
5300
5301Changes
5302   * Ability to enable / disable SSL v3 / TLS 1.0 / TLS 1.1 / TLS 1.2
5303     individually
5304   * Introduced separate SSL Ciphersuites module that is based on
5305     Cipher and MD information
5306   * Internals for SSL module adapted to have separate IV pointer that is
5307     dynamically set (Better support for hardware acceleration)
5308   * Moved all OID functionality to a separate module. RSA function
5309     prototypes for the RSA sign and verify functions changed as a result
5310   * Split up the GCM module into a starts/update/finish cycle
5311   * Client and server now filter sent and accepted ciphersuites on minimum
5312     and maximum protocol version
5313   * Ability to disable server_name extension (RFC 6066)
5314   * Renamed error_strerror() to the less conflicting polarssl_strerror()
5315     (Ability to keep old as well with POLARSSL_ERROR_STRERROR_BC)
5316   * SHA2 renamed to SHA256, SHA4 renamed to SHA512 and functions accordingly
5317   * All RSA operations require a random generator for blinding purposes
5318   * X509 core refactored
5319   * x509_crt_verify() now case insensitive for cn (RFC 6125 6.4)
5320   * Also compiles / runs without time-based functions (!POLARSSL_HAVE_TIME)
5321   * Support faulty X509 v1 certificates with extensions
5322     (POLARSSL_X509_ALLOW_EXTENSIONS_NON_V3)
5323
5324Bugfix
5325   * Fixed parse error in ssl_parse_certificate_request()
5326   * zlib compression/decompression skipped on empty blocks
5327   * Support for AIX header locations in net.c module
5328   * Fixed file descriptor leaks
5329
5330Security
5331   * RSA blinding on CRT operations to counter timing attacks
5332     (found by Cyril Arnaud and Pierre-Alain Fouque)
5333
5334
5335= Version 1.2.14 released 2015-05-??
5336
5337Security
5338   * Fix potential invalid memory read in the server, that allows a client to
5339     crash it remotely (found by Caj Larsson).
5340   * Fix potential invalid memory read in certificate parsing, that allows a
5341     client to crash the server remotely if client authentication is enabled
5342     (found using Codenomicon Defensics).
5343   * Add countermeasure against "Lucky 13 strikes back" cache-based attack,
5344     https://dl.acm.org/citation.cfm?id=2714625
5345
5346Bugfix
5347   * Fix bug in Via Padlock support (found by Nikos Mavrogiannopoulos).
5348   * Fix hardclock() (only used in the benchmarking program) with some
5349     versions of mingw64 (found by kxjhlele).
5350   * Fix warnings from mingw64 in timing.c (found by kxjklele).
5351   * Fix potential unintended sign extension in asn1_get_len() on 64-bit
5352     platforms (found with Coverity Scan).
5353
5354= Version 1.2.13 released 2015-02-16
5355Note: Although PolarSSL has been renamed to mbed TLS, no changes reflecting
5356      this will be made in the 1.2 branch at this point.
5357
5358Security
5359   * Fix remotely-triggerable uninitialised pointer dereference caused by
5360     crafted X.509 certificate (TLS server is not affected if it doesn't ask
5361     for a client certificate) (found using Codenomicon Defensics).
5362   * Fix remotely-triggerable memory leak caused by crafted X.509 certificates
5363     (TLS server is not affected if it doesn't ask for a client certificate)
5364     (found using Codenomicon Defensics).
5365   * Fix potential stack overflow while parsing crafted X.509 certificates
5366     (TLS server is not affected if it doesn't ask for a client certificate)
5367     found using Codenomicon Defensics).
5368   * Fix buffer overread of size 1 when parsing crafted X.509 certificates
5369     (TLS server is not affected if it doesn't ask for a client certificate).
5370
5371Bugfix
5372   * Fix potential undefined behaviour in Camellia.
5373   * Fix memory leaks in PKCS#5 and PKCS#12.
5374   * Stack buffer overflow if ctr_drbg_update() is called with too large
5375     add_len (found by Jean-Philippe Aumasson) (not triggerable remotely).
5376   * Fix bug in MPI/bignum on s390/s390x (reported by Dan Horák) (introduced
5377     in 1.2.12).
5378   * Fix unchecked return code in x509_crt_parse_path() on Windows (found by
5379     Peter Vaskovic).
5380   * Fix assembly selection for MIPS64 (thanks to James Cowgill).
5381   * ssl_get_verify_result() now works even if the handshake was aborted due
5382     to a failed verification (found by Fredrik Axelsson).
5383   * Skip writing and parsing signature_algorithm extension if none of the
5384     key exchanges enabled needs certificates. This fixes a possible interop
5385     issue with some servers when a zero-length extension was sent. (Reported
5386     by Peter Dettman.)
5387   * On a 0-length input, base64_encode() did not correctly set output length
5388     (found by Hendrik van den Boogaard).
5389
5390Changes
5391   * Blind RSA private operations even when POLARSSL_RSA_NO_CRT is defined.
5392   * Forbid repeated extensions in X.509 certificates.
5393   * Add compile-time option POLARSSL_X509_MAX_INTERMEDIATE_CA to limit the
5394     length of an X.509 verification chain (default = 8).
5395= Version 1.2.12 released 2014-10-24
5396
5397Security
5398   * Remotely-triggerable memory leak when parsing some X.509 certificates
5399     (server is not affected if it doesn't ask for a client certificate).
5400     (Found using Codenomicon Defensics.)
5401
5402Bugfix
5403   * Fix potential bad read in parsing ServerHello (found by Adrien
5404     Vialletelle).
5405   * ssl_close_notify() could send more than one message in some circumstances
5406     with non-blocking I/O.
5407   * x509_crt_parse() did not increase total_failed on PEM error
5408   * Fix compiler warnings on iOS (found by Sander Niemeijer).
5409   * Don't print uninitialised buffer in ssl_mail_client (found by Marc Abel).
5410   * Fix net_accept() regarding non-blocking sockets (found by Luca Pesce).
5411   * ssl_read() could return non-application data records on server while
5412     renegotation was pending, and on client when a HelloRequest was received.
5413   * Fix warnings from Clang's scan-build (contributed by Alfred Klomp).
5414
5415Changes
5416   * X.509 certificates with more than one AttributeTypeAndValue per
5417     RelativeDistinguishedName are not accepted any more.
5418   * ssl_read() now returns POLARSSL_ERR_NET_WANT_READ rather than
5419     POLARSSL_ERR_SSL_UNEXPECTED_MESSAGE on harmless alerts.
5420   * Accept spaces at end of line or end of buffer in base64_decode().
5421
5422= Version 1.2.11 released 2014-07-11
5423Features
5424   * Entropy module now supports seed writing and reading
5425
5426Changes
5427   * Introduced POLARSSL_HAVE_READDIR_R for systems without it
5428   * Improvements to the CMake build system, contributed by Julian Ospald.
5429   * Work around a bug of the version of Clang shipped by Apple with Mavericks
5430     that prevented bignum.c from compiling. (Reported by Rafael Baptista.)
5431   * Improvements to tests/Makefile, contributed by Oden Eriksson.
5432   * Use UTC time to check certificate validity.
5433   * Reject certificates with times not in UTC, per RFC 5280.
5434   * Migrate zeroizing of data to polarssl_zeroize() instead of memset()
5435     against unwanted compiler optimizations
5436
5437Security
5438   * Forbid change of server certificate during renegotiation to prevent
5439     "triple handshake" attack when authentication mode is optional (the
5440     attack was already impossible when authentication is required).
5441   * Check notBefore timestamp of certificates and CRLs from the future.
5442   * Forbid sequence number wrapping
5443   * Prevent potential NULL pointer dereference in ssl_read_record() (found by
5444     TrustInSoft)
5445   * Fix length checking for AEAD ciphersuites (found by Codenomicon).
5446     It was possible to crash the server (and client) using crafted messages
5447     when a GCM suite was chosen.
5448
5449Bugfix
5450   * Fixed X.509 hostname comparison (with non-regular characters)
5451   * SSL now gracefully handles missing RNG
5452   * crypt_and_hash app checks MAC before final decryption
5453   * Fixed x509_crt_parse_path() bug on Windows platforms
5454   * Added missing MPI_CHK() around some statements in mpi_div_mpi() (found by
5455     TrustInSoft)
5456   * Fixed potential overflow in certificate size verification in
5457     ssl_write_certificate() (found by TrustInSoft)
5458   * Fix ASM format in bn_mul.h
5459   * Potential memory leak in bignum_selftest()
5460   * Replaced expired test certificate
5461   * ssl_mail_client now terminates lines with CRLF, instead of LF
5462   * Fix bug in RSA PKCS#1 v1.5 "reversed" operations
5463   * Fixed testing with out-of-source builds using cmake
5464   * Fixed version-major intolerance in server
5465   * Fixed CMake symlinking on out-of-source builds
5466   * Bignum's MIPS-32 assembly was used on MIPS-64, causing chaos. (Found by
5467     Alex Wilson.)
5468   * ssl_init() was leaving a dirty pointer in ssl_context if malloc of
5469     out_ctr failed
5470   * ssl_handshake_init() was leaving dirty pointers in subcontexts if malloc
5471     of one of them failed
5472   * x509_get_current_time() uses localtime_r() to prevent thread issues
5473   * Some example server programs were not sending the close_notify alert.
5474   * Potential memory leak in mpi_exp_mod() when error occurs during
5475     calculation of RR.
5476   * Improve interoperability by not writing extension length in ClientHello
5477     when no extensions are present (found by Matthew Page)
5478   * rsa_check_pubkey() now allows an E up to N
5479   * On OpenBSD, use arc4random_buf() instead of rand() to prevent warnings
5480   * mpi_fill_random() was creating numbers larger than requested on
5481     big-endian platform when size was not an integer number of limbs
5482   * Fix detection of DragonflyBSD in net.c (found by Markus Pfeiffer)
5483   * Stricter check on SSL ClientHello internal sizes compared to actual packet
5484     size (found by TrustInSoft)
5485   * Fix preprocessor checks for bn_mul PPC asm (found by Barry K. Nathan).
5486   * Use \n\t rather than semicolons for bn_mul asm, since some assemblers
5487     interpret semicolons as comment delimiters (found by Barry K. Nathan).
5488   * Disable broken Sparc64 bn_mul assembly (found by Florian Obser).
5489   * Fix base64_decode() to return and check length correctly (in case of
5490     tight buffers)
5491
5492= Version 1.2.10 released 2013-10-07
5493Changes
5494   * Changed RSA blinding to a slower but thread-safe version
5495
5496Bugfix
5497   * Fixed memory leak in RSA as a result of introduction of blinding
5498   * Fixed ssl_pkcs11_decrypt() prototype
5499   * Fixed MSVC project files
5500
5501= Version 1.2.9 released 2013-10-01
5502Changes
5503   * x509_verify() now case insensitive for cn (RFC 6125 6.4)
5504
5505Bugfix
5506   * Fixed potential memory leak when failing to resume a session
5507   * Fixed potential file descriptor leaks (found by Remi Gacogne)
5508   * Minor fixes
5509
5510Security
5511   * Fixed potential heap buffer overflow on large hostname setting
5512   * Fixed potential negative value misinterpretation in load_file()
5513   * RSA blinding on CRT operations to counter timing attacks
5514     (found by Cyril Arnaud and Pierre-Alain Fouque)
5515
5516= Version 1.2.8 released 2013-06-19
5517Features
5518   * Parsing of PKCS#8 encrypted private key files
5519   * PKCS#12 PBE and derivation functions
5520   * Centralized module option values in config.h to allow user-defined
5521     settings without editing header files by using POLARSSL_CONFIG_OPTIONS
5522
5523Changes
5524   * HAVEGE random generator disabled by default
5525   * Internally split up x509parse_key() into a (PEM) handler function
5526     and specific DER parser functions for the PKCS#1 and unencrypted
5527     PKCS#8 private key formats
5528   * Added mechanism to provide alternative implementations for all
5529     symmetric cipher and hash algorithms (e.g. POLARSSL_AES_ALT in
5530     config.h)
5531   * PKCS#5 module added. Moved PBKDF2 functionality inside and deprecated
5532     old PBKDF2 module
5533
5534Bugfix
5535   * Secure renegotiation extension should only be sent in case client
5536     supports secure renegotiation
5537   * Fixed offset for cert_type list in ssl_parse_certificate_request()
5538   * Fixed const correctness issues that have no impact on the ABI
5539   * x509parse_crt() now better handles PEM error situations
5540   * ssl_parse_certificate() now calls x509parse_crt_der() directly
5541     instead of the x509parse_crt() wrapper that can also parse PEM
5542     certificates
5543   * x509parse_crtpath() is now reentrant and uses more portable stat()
5544   * Fixed bignum.c and bn_mul.h to support Thumb2 and LLVM compiler
5545   * Fixed values for 2-key Triple DES in cipher layer
5546   * ssl_write_certificate_request() can handle empty ca_chain
5547
5548Security
5549   * A possible DoS during the SSL Handshake, due to faulty parsing of
5550     PEM-encoded certificates has been fixed (found by Jack Lloyd)
5551
5552= Version 1.2.7 released 2013-04-13
5553Features
5554   * Ability to specify allowed ciphersuites based on the protocol version.
5555
5556Changes
5557   * Default Blowfish keysize is now 128-bits
5558   * Test suites made smaller to accommodate Raspberry Pi
5559
5560Bugfix
5561   * Fix for MPI assembly for ARM
5562   * GCM adapted to support sizes > 2^29
5563
5564= Version 1.2.6 released 2013-03-11
5565Bugfix
5566   * Fixed memory leak in ssl_free() and ssl_reset() for active session
5567   * Corrected GCM counter incrementation to use only 32-bits instead of
5568     128-bits (found by Yawning Angel)
5569   * Fixes for 64-bit compilation with MS Visual Studio
5570   * Fixed net_bind() for specified IP addresses on little endian systems
5571   * Fixed assembly code for ARM (Thumb and regular) for some compilers
5572
5573Changes
5574   * Internally split up rsa_pkcs1_encrypt(), rsa_pkcs1_decrypt(),
5575     rsa_pkcs1_sign() and rsa_pkcs1_verify() to separate PKCS#1 v1.5 and
5576     PKCS#1 v2.1 functions
5577   * Added support for custom labels when using rsa_rsaes_oaep_encrypt()
5578     or rsa_rsaes_oaep_decrypt()
5579   * Re-added handling for SSLv2 Client Hello when the define
5580     POLARSSL_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO is set
5581   * The SSL session cache module (ssl_cache) now also retains peer_cert
5582     information (not the entire chain)
5583
5584Security
5585   * Removed further timing differences during SSL message decryption in
5586     ssl_decrypt_buf()
5587   * Removed timing differences due to bad padding from
5588     rsa_rsaes_pkcs1_v15_decrypt() and rsa_pkcs1_decrypt() for PKCS#1 v1.5
5589     operations
5590
5591= Version 1.2.5 released 2013-02-02
5592Changes
5593   * Allow enabling of dummy error_strerror() to support some use-cases
5594   * Debug messages about padding errors during SSL message decryption are
5595     disabled by default and can be enabled with POLARSSL_SSL_DEBUG_ALL
5596   * Sending of security-relevant alert messages that do not break
5597     interoperability can be switched on/off with the flag
5598     POLARSSL_SSL_ALL_ALERT_MESSAGES
5599
5600Security
5601   * Removed timing differences during SSL message decryption in
5602     ssl_decrypt_buf() due to badly formatted padding
5603
5604= Version 1.2.4 released 2013-01-25
5605Changes
5606   * More advanced SSL ciphersuite representation and moved to more dynamic
5607     SSL core
5608   * Added ssl_handshake_step() to allow single stepping the handshake process
5609
5610Bugfix
5611   * Memory leak when using RSA_PKCS_V21 operations fixed
5612   * Handle future version properly in ssl_write_certificate_request()
5613   * Correctly handle CertificateRequest message in client for <= TLS 1.1
5614     without DN list
5615
5616= Version 1.2.3 released 2012-11-26
5617Bugfix
5618   * Server not always sending correct CertificateRequest message
5619
5620= Version 1.2.2 released 2012-11-24
5621Changes
5622   * Added p_hw_data to ssl_context for context specific hardware acceleration
5623     data
5624   * During verify trust-CA is only checked for expiration and CRL presence
5625
5626Bugfixes
5627   * Fixed client authentication compatibility
5628   * Fixed dependency on POLARSSL_SHA4_C in SSL modules
5629
5630= Version 1.2.1 released 2012-11-20
5631Changes
5632   * Depth that the certificate verify callback receives is now numbered
5633     bottom-up (Peer cert depth is 0)
5634
5635Bugfixes
5636   * Fixes for MSVC6
5637   * Moved mpi_inv_mod() outside POLARSSL_GENPRIME
5638   * Allow R and A to point to same mpi in mpi_div_mpi (found by Manuel
5639     Pégourié-Gonnard)
5640   * Fixed possible segfault in mpi_shift_r() (found by Manuel
5641     Pégourié-Gonnard)
5642   * Added max length check for rsa_pkcs1_sign with PKCS#1 v2.1
5643
5644= Version 1.2.0 released 2012-10-31
5645Features
5646   * Added support for NULL cipher (POLARSSL_CIPHER_NULL_CIPHER) and weak
5647     ciphersuites (POLARSSL_ENABLE_WEAK_CIPHERSUITES). They are disabled by
5648     default!
5649   * Added support for wildcard certificates
5650   * Added support for multi-domain certificates through the X509 Subject
5651     Alternative Name extension
5652   * Added preliminary ASN.1 buffer writing support
5653   * Added preliminary X509 Certificate Request writing support
5654   * Added key_app_writer example application
5655   * Added cert_req example application
5656   * Added base Galois Counter Mode (GCM) for AES
5657   * Added TLS 1.2 support (RFC 5246)
5658   * Added GCM suites to TLS 1.2 (RFC 5288)
5659   * Added commandline error code convertor (util/strerror)
5660   * Added support for Hardware Acceleration hooking in SSL/TLS
5661   * Added OpenSSL / PolarSSL compatibility script (tests/compat.sh) and
5662     example application (programs/ssl/o_p_test) (requires OpenSSL)
5663   * Added X509 CA Path support
5664   * Added Thumb assembly optimizations
5665   * Added DEFLATE compression support as per RFC3749 (requires zlib)
5666   * Added blowfish algorithm (Generic and cipher layer)
5667   * Added PKCS#5 PBKDF2 key derivation function
5668   * Added Secure Renegotiation (RFC 5746)
5669   * Added predefined DHM groups from RFC 5114
5670   * Added simple SSL session cache implementation
5671   * Added ServerName extension parsing (SNI) at server side
5672   * Added option to add minimum accepted SSL/TLS protocol version
5673
5674Changes
5675   * Removed redundant POLARSSL_DEBUG_MSG define
5676   * AES code only check for Padlock once
5677   * Fixed const-correctness mpi_get_bit()
5678   * Documentation for mpi_lsb() and mpi_msb()
5679   * Moved out_msg to out_hdr + 32 to support hardware acceleration
5680   * Changed certificate verify behaviour to comply with RFC 6125 section 6.3
5681     to not match CN if subjectAltName extension is present (Closes ticket #56)
5682   * Cipher layer cipher_mode_t POLARSSL_MODE_CFB128 is renamed to
5683     POLARSSL_MODE_CFB, to also handle different block size CFB modes.
5684   * Removed handling for SSLv2 Client Hello (as per RFC 5246 recommendation)
5685   * Revamped session resumption handling
5686   * Generalized external private key implementation handling (like PKCS#11)
5687     in SSL/TLS
5688   * Revamped x509_verify() and the SSL f_vrfy callback implementations
5689   * Moved from unsigned long to fixed width uint32_t types throughout code
5690   * Renamed ciphersuites naming scheme to IANA reserved names
5691
5692Bugfix
5693   * Fixed handling error in mpi_cmp_mpi() on longer B values (found by
5694     Hui Dong)
5695   * Fixed potential heap corruption in x509_name allocation
5696   * Fixed single RSA test that failed on Big Endian systems (Closes ticket #54)
5697   * mpi_exp_mod() now correctly handles negative base numbers (Closes ticket
5698     #52)
5699   * Handle encryption with private key and decryption with public key as per
5700     RFC 2313
5701   * Handle empty certificate subject names
5702   * Prevent reading over buffer boundaries on X509 certificate parsing
5703   * mpi_add_abs() now correctly handles adding short numbers to long numbers
5704     with carry rollover (found by Ruslan Yushchenko)
5705   * Handle existence of OpenSSL Trust Extensions at end of X.509 DER blob
5706   * Fixed MPI assembly for SPARC64 platform
5707
5708Security
5709   * Fixed potential memory zeroization on miscrafted RSA key (found by Eloi
5710     Vanderbeken)
5711
5712= Version 1.1.8 released on 2013-10-01
5713Bugfix
5714   * Fixed potential memory leak when failing to resume a session
5715   * Fixed potential file descriptor leaks
5716
5717Security
5718   * Potential buffer-overflow for ssl_read_record() (independently found by
5719     both TrustInSoft and Paul Brodeur of Leviathan Security Group)
5720   * Potential negative value misinterpretation in load_file()
5721   * Potential heap buffer overflow on large hostname setting
5722
5723= Version 1.1.7 released on 2013-06-19
5724Changes
5725   * HAVEGE random generator disabled by default
5726
5727Bugfix
5728   * x509parse_crt() now better handles PEM error situations
5729   * ssl_parse_certificate() now calls x509parse_crt_der() directly
5730     instead of the x509parse_crt() wrapper that can also parse PEM
5731     certificates
5732   * Fixed values for 2-key Triple DES in cipher layer
5733   * ssl_write_certificate_request() can handle empty ca_chain
5734
5735Security
5736   * A possible DoS during the SSL Handshake, due to faulty parsing of
5737     PEM-encoded certificates has been fixed (found by Jack Lloyd)
5738
5739= Version 1.1.6 released on 2013-03-11
5740Bugfix
5741   * Fixed net_bind() for specified IP addresses on little endian systems
5742
5743Changes
5744   * Allow enabling of dummy error_strerror() to support some use-cases
5745   * Debug messages about padding errors during SSL message decryption are
5746     disabled by default and can be enabled with POLARSSL_SSL_DEBUG_ALL
5747
5748Security
5749   * Removed timing differences during SSL message decryption in
5750     ssl_decrypt_buf()
5751   * Removed timing differences due to bad padding from
5752     rsa_rsaes_pkcs1_v15_decrypt() and rsa_pkcs1_decrypt() for PKCS#1 v1.5
5753     operations
5754
5755= Version 1.1.5 released on 2013-01-16
5756Bugfix
5757   * Fixed MPI assembly for SPARC64 platform
5758   * Handle existence of OpenSSL Trust Extensions at end of X.509 DER blob
5759   * mpi_add_abs() now correctly handles adding short numbers to long numbers
5760     with carry rollover
5761   * Moved mpi_inv_mod() outside POLARSSL_GENPRIME
5762   * Prevent reading over buffer boundaries on X509 certificate parsing
5763   * mpi_exp_mod() now correctly handles negative base numbers (Closes ticket
5764     #52)
5765   * Fixed possible segfault in mpi_shift_r() (found by Manuel
5766     Pégourié-Gonnard)
5767   * Allow R and A to point to same mpi in mpi_div_mpi (found by Manuel
5768     Pégourié-Gonnard)
5769   * Added max length check for rsa_pkcs1_sign with PKCS#1 v2.1
5770   * Memory leak when using RSA_PKCS_V21 operations fixed
5771   * Handle encryption with private key and decryption with public key as per
5772     RFC 2313
5773   * Fixes for MSVC6
5774
5775Security
5776   * Fixed potential memory zeroization on miscrafted RSA key (found by Eloi
5777     Vanderbeken)
5778
5779= Version 1.1.4 released on 2012-05-31
5780Bugfix
5781   * Correctly handle empty SSL/TLS packets (Found by James Yonan)
5782   * Fixed potential heap corruption in x509_name allocation
5783   * Fixed single RSA test that failed on Big Endian systems (Closes ticket #54)
5784
5785= Version 1.1.3 released on 2012-04-29
5786Bugfix
5787   * Fixed random MPI generation to not generate more size than requested.
5788
5789= Version 1.1.2 released on 2012-04-26
5790Bugfix
5791   * Fixed handling error in mpi_cmp_mpi() on longer B values (found by
5792     Hui Dong)
5793
5794Security
5795   * Fixed potential memory corruption on miscrafted client messages (found by
5796     Frama-C team at CEA LIST)
5797   * Fixed generation of DHM parameters to correct length (found by Ruslan
5798     Yushchenko)
5799
5800= Version 1.1.1 released on 2012-01-23
5801Bugfix
5802   * Check for failed malloc() in ssl_set_hostname() and x509_get_entries()
5803     (Closes ticket #47, found by Hugo Leisink)
5804   * Fixed issues with Intel compiler on 64-bit systems (Closes ticket #50)
5805   * Fixed multiple compiler warnings for VS6 and armcc
5806   * Fixed bug in CTR_CRBG selftest
5807
5808= Version 1.1.0 released on 2011-12-22
5809Features
5810   * Added ssl_session_reset() to allow better multi-connection pools of
5811     SSL contexts without needing to set all non-connection-specific
5812     data and pointers again. Adapted ssl_server to use this functionality.
5813   * Added ssl_set_max_version() to allow clients to offer a lower maximum
5814     supported version to a server to help buggy server implementations.
5815     (Closes ticket #36)
5816   * Added cipher_get_cipher_mode() and cipher_get_cipher_operation()
5817     introspection functions (Closes ticket #40)
5818   * Added CTR_DRBG based on AES-256-CTR (NIST SP 800-90) random generator
5819   * Added a generic entropy accumulator that provides support for adding
5820     custom entropy sources and added some generic and platform dependent
5821     entropy sources
5822
5823Changes
5824   * Documentation for AES and Camellia in modes CTR and CFB128 clarified.
5825   * Fixed rsa_encrypt and rsa_decrypt examples to use public key for
5826     encryption and private key for decryption. (Closes ticket #34)
5827   * Inceased maximum size of ASN1 length reads to 32-bits.
5828   * Added an EXPLICIT tag number parameter to x509_get_ext()
5829   * Added a separate CRL entry extension parsing function
5830   * Separated the ASN.1 parsing code from the X.509 specific parsing code.
5831     So now there is a module that is controlled with POLARSSL_ASN1_PARSE_C.
5832   * Changed the defined key-length of DES ciphers in cipher.h to include the
5833     parity bits, to prevent mistakes in copying data. (Closes ticket #33)
5834   * Loads of minimal changes to better support WINCE as a build target
5835     (Credits go to Marco Lizza)
5836   * Added POLARSSL_MPI_WINDOW_SIZE definition to allow easier time to memory
5837     trade-off
5838   * Introduced POLARSSL_MPI_MAX_SIZE and POLARSSL_MPI_MAX_BITS for MPI size
5839     management (Closes ticket #44)
5840   * Changed the used random function pointer to more flexible format. Renamed
5841     havege_rand() to havege_random() to prevent mistakes. Lots of changes as
5842     a consequence in library code and programs
5843   * Moved all examples programs to use the new entropy and CTR_DRBG
5844   * Added permissive certificate parsing to x509parse_crt() and
5845     x509parse_crtfile(). With permissive parsing the parsing does not stop on
5846     encountering a parse-error. Beware that the meaning of return values has
5847     changed!
5848   * All error codes are now negative. Even on mermory failures and IO errors.
5849
5850Bugfix
5851   * Fixed faulty HMAC-MD2 implementation. Found by dibac. (Closes
5852     ticket #37)
5853   * Fixed a bug where the CRL parser expected an EXPLICIT ASN.1 tag
5854     before version numbers
5855   * Allowed X509 key usage parsing to accept 4 byte values instead of the
5856     standard 1 byte version sometimes used by Microsoft. (Closes ticket #38)
5857   * Fixed incorrect behaviour in case of RSASSA-PSS with a salt length
5858     smaller than the hash length. (Closes ticket #41)
5859   * If certificate serial is longer than 32 octets, serial number is now
5860     appended with '....' after first 28 octets
5861   * Improved build support for s390x and sparc64 in bignum.h
5862   * Fixed MS Visual C++ name clash with int64 in sha4.h
5863   * Corrected removal of leading "00:" in printing serial numbers in
5864     certificates and CRLs
5865
5866= Version 1.0.0 released on 2011-07-27
5867Features
5868   * Expanded cipher layer with support for CFB128 and CTR mode
5869   * Added rsa_encrypt and rsa_decrypt simple example programs.
5870
5871Changes
5872   * The generic cipher and message digest layer now have normal error
5873     codes instead of integers
5874
5875Bugfix
5876   * Undid faulty bug fix in ssl_write() when flushing old data (Ticket
5877     #18)
5878
5879= Version 0.99-pre5 released on 2011-05-26
5880Features
5881   * Added additional Cipher Block Modes to symmetric ciphers
5882     (AES CTR, Camellia CTR, XTEA CBC) including the option to
5883     enable and disable individual modes when needed
5884   * Functions requiring File System functions can now be disabled
5885     by undefining POLARSSL_FS_IO
5886   * A error_strerror function() has been added to translate between
5887     error codes and their description.
5888   * Added mpi_get_bit() and mpi_set_bit() individual bit setter/getter
5889     functions.
5890   * Added ssl_mail_client and ssl_fork_server as example programs.
5891
5892Changes
5893   * Major argument / variable rewrite. Introduced use of size_t
5894     instead of int for buffer lengths and loop variables for
5895     better unsigned / signed use. Renamed internal bigint types
5896     t_int and t_dbl to t_uint and t_udbl in the process
5897   * mpi_init() and mpi_free() now only accept a single MPI
5898     argument and do not accept variable argument lists anymore.
5899   * The error codes have been remapped and combining error codes
5900     is now done with a PLUS instead of an OR as error codes
5901     used are negative.
5902   * Changed behaviour of net_read(), ssl_fetch_input() and ssl_recv().
5903     net_recv() now returns 0 on EOF instead of
5904     POLARSSL_ERR_NET_CONN_RESET. ssl_fetch_input() returns
5905     POLARSSL_ERR_SSL_CONN_EOF on an EOF from its f_recv() function.
5906     ssl_read() returns 0 if a POLARSSL_ERR_SSL_CONN_EOF is received
5907     after the handshake.
5908   * Network functions now return POLARSSL_ERR_NET_WANT_READ or
5909     POLARSSL_ERR_NET_WANT_WRITE instead of the ambiguous
5910     POLARSSL_ERR_NET_TRY_AGAIN
5911
5912= Version 0.99-pre4 released on 2011-04-01
5913Features
5914   * Added support for PKCS#1 v2.1 encoding and thus support
5915     for the RSAES-OAEP and RSASSA-PSS operations.
5916   * Reading of Public Key files incorporated into default x509
5917     functionality as well.
5918   * Added mpi_fill_random() for centralized filling of big numbers
5919     with random data (Fixed ticket #10)
5920
5921Changes
5922   * Debug print of MPI now removes leading zero octets and
5923     displays actual bit size of the value.
5924   * x509parse_key() (and as a consequence x509parse_keyfile())
5925     does not zeroize memory in advance anymore. Use rsa_init()
5926     before parsing a key or keyfile!
5927
5928Bugfix
5929   * Debug output of MPI's now the same independent of underlying
5930     platform (32-bit / 64-bit) (Fixes ticket #19, found by Mads
5931     Kiilerich and Mihai Militaru)
5932   * Fixed bug in ssl_write() when flushing old data (Fixed ticket
5933     #18, found by Nikolay Epifanov)
5934   * Fixed proper handling of RSASSA-PSS verification with variable
5935     length salt lengths
5936
5937= Version 0.99-pre3 released on 2011-02-28
5938This release replaces version 0.99-pre2 which had possible copyright issues.
5939Features
5940   * Parsing PEM private keys encrypted with DES and AES
5941     are now supported as well (Fixes ticket #5)
5942   * Added crl_app program to allow easy reading and
5943     printing of X509 CRLs from file
5944
5945Changes
5946   * Parsing of PEM files moved to separate module (Fixes
5947     ticket #13). Also possible to remove PEM support for
5948     systems only using DER encoding
5949
5950Bugfixes
5951   * Corrected parsing of UTCTime dates before 1990 and
5952     after 1950
5953   * Support more exotic OID's when parsing certificates
5954     (found by Mads Kiilerich)
5955   * Support more exotic name representations when parsing
5956     certificates (found by Mads Kiilerich)
5957   * Replaced the expired test certificates
5958   * Do not bail out if no client certificate specified. Try
5959     to negotiate anonymous connection (Fixes ticket #12,
5960     found by Boris Krasnovskiy)
5961
5962Security fixes
5963   * Fixed a possible Man-in-the-Middle attack on the
5964     Diffie Hellman key exchange (thanks to Larry Highsmith,
5965     Subreption LLC)
5966
5967= Version 0.99-pre1 released on 2011-01-30
5968Features
5969Note: Most of these features have been donated by Fox-IT
5970   * Added Doxygen source code documentation parts
5971   * Added reading of DHM context from memory and file
5972   * Improved X509 certificate parsing to include extended
5973     certificate fields, including Key Usage
5974   * Improved certificate verification and verification
5975     against the available CRLs
5976   * Detection for DES weak keys and parity bits added
5977   * Improvements to support integration in other
5978     applications:
5979       + Added generic message digest and cipher wrapper
5980       + Improved information about current capabilities,
5981         status, objects and configuration
5982       + Added verification callback on certificate chain
5983         verification to allow external blacklisting
5984       + Additional example programs to show usage
5985   * Added support for PKCS#11 through the use of the
5986     libpkcs11-helper library
5987
5988Changes
5989   * x509parse_time_expired() checks time in addition to
5990     the existing date check
5991   * The ciphers member of ssl_context and the cipher member
5992     of ssl_session have been renamed to ciphersuites and
5993     ciphersuite respectively. This clarifies the difference
5994     with the generic cipher layer and is better naming
5995     altogether
5996
5997= Version 0.14.0 released on 2010-08-16
5998Features
5999   * Added support for SSL_EDH_RSA_AES_128_SHA and
6000     SSL_EDH_RSA_CAMELLIA_128_SHA ciphersuites
6001   * Added compile-time and run-time version information
6002   * Expanded ssl_client2 arguments for more flexibility
6003   * Added support for TLS v1.1
6004
6005Changes
6006   * Made Makefile cleaner
6007   * Removed dependency on rand() in rsa_pkcs1_encrypt().
6008     Now using random fuction provided to function and
6009     changed the prototype of rsa_pkcs1_encrypt(),
6010     rsa_init() and rsa_gen_key().
6011   * Some SSL defines were renamed in order to avoid
6012     future confusion
6013
6014Bug fixes
6015   * Fixed CMake out of source build for tests (found by
6016     kkert)
6017   * rsa_check_private() now supports PKCS1v2 keys as well
6018   * Fixed deadlock in rsa_pkcs1_encrypt() on failing random
6019     generator
6020
6021= Version 0.13.1 released on 2010-03-24
6022Bug fixes
6023   * Fixed Makefile in library that was mistakenly merged
6024   * Added missing const string fixes
6025
6026= Version 0.13.0 released on 2010-03-21
6027Features
6028   * Added option parsing for host and port selection to
6029     ssl_client2
6030   * Added support for GeneralizedTime in X509 parsing
6031   * Added cert_app program to allow easy reading and
6032     printing of X509 certificates from file or SSL
6033     connection.
6034
6035Changes
6036   * Added const correctness for main code base
6037   * X509 signature algorithm determination is now
6038     in a function to allow easy future expansion
6039   * Changed symmetric cipher functions to
6040     identical interface (returning int result values)
6041   * Changed ARC4 to use separate input/output buffer
6042   * Added reset function for HMAC context as speed-up
6043     for specific use-cases
6044
6045Bug fixes
6046   * Fixed bug resulting in failure to send the last
6047     certificate in the chain in ssl_write_certificate() and
6048     ssl_write_certificate_request() (found by fatbob)
6049   * Added small fixes for compiler warnings on a Mac
6050     (found by Frank de Brabander)
6051   * Fixed algorithmic bug in mpi_is_prime() (found by
6052     Smbat Tonoyan)
6053
6054= Version 0.12.1 released on 2009-10-04
6055Changes
6056   * Coverage test definitions now support 'depends_on'
6057     tagging system.
6058   * Tests requiring specific hashing algorithms now honor
6059     the defines.
6060
6061Bug fixes
6062   * Changed typo in #ifdef in x509parse.c (found
6063     by Eduardo)
6064
6065= Version 0.12.0 released on 2009-07-28
6066Features
6067   * Added CMake makefiles as alternative to regular Makefiles.
6068   * Added preliminary Code Coverage tests for AES, ARC4,
6069     Base64, MPI, SHA-family, MD-family, HMAC-SHA-family,
6070     Camellia, DES, 3-DES, RSA PKCS#1, XTEA, Diffie-Hellman
6071     and X509parse.
6072
6073Changes
6074   * Error codes are not (necessarily) negative. Keep
6075     this is mind when checking for errors.
6076   * RSA_RAW renamed to SIG_RSA_RAW for consistency.
6077   * Fixed typo in name of POLARSSL_ERR_RSA_OUTPUT_TOO_LARGE.
6078   * Changed interface for AES and Camellia setkey functions
6079     to indicate invalid key lengths.
6080
6081Bug fixes
6082   * Fixed include location of endian.h on FreeBSD (found by
6083     Gabriel)
6084   * Fixed include location of endian.h and name clash on
6085     Apples (found by Martin van Hensbergen)
6086   * Fixed HMAC-MD2 by modifying md2_starts(), so that the
6087     required HMAC ipad and opad variables are not cleared.
6088     (found by code coverage tests)
6089   * Prevented use of long long in bignum if
6090     POLARSSL_HAVE_LONGLONG not defined (found by Giles
6091     Bathgate).
6092   * Fixed incorrect handling of negative strings in
6093     mpi_read_string() (found by code coverage tests).
6094   * Fixed segfault on handling empty rsa_context in
6095     rsa_check_pubkey() and rsa_check_privkey() (found by
6096     code coverage tests).
6097   * Fixed incorrect handling of one single negative input
6098     value in mpi_add_abs() (found by code coverage tests).
6099   * Fixed incorrect handling of negative first input
6100     value in mpi_sub_abs() (found by code coverage tests).
6101   * Fixed incorrect handling of negative first input
6102     value in mpi_mod_mpi() and mpi_mod_int(). Resulting
6103     change also affects mpi_write_string() (found by code
6104     coverage tests).
6105   * Corrected is_prime() results for 0, 1 and 2 (found by
6106     code coverage tests).
6107   * Fixed Camellia and XTEA for 64-bit Windows systems.
6108
6109= Version 0.11.1 released on 2009-05-17
6110   * Fixed missing functionality for SHA-224, SHA-256, SHA384,
6111     SHA-512 in rsa_pkcs1_sign()
6112
6113= Version 0.11.0 released on 2009-05-03
6114   * Fixed a bug in mpi_gcd() so that it also works when both
6115     input numbers are even and added testcases to check
6116     (found by Pierre Habouzit).
6117   * Added support for SHA-224, SHA-256, SHA-384 and SHA-512
6118     one way hash functions with the PKCS#1 v1.5 signing and
6119     verification.
6120   * Fixed minor bug regarding mpi_gcd located within the
6121     POLARSSL_GENPRIME block.
6122   * Fixed minor memory leak in x509parse_crt() and added better
6123     handling of 'full' certificate chains (found by Mathias
6124     Olsson).
6125   * Centralized file opening and reading for x509 files into
6126     load_file()
6127   * Made definition of net_htons() endian-clean for big endian
6128     systems (Found by Gernot).
6129   * Undefining POLARSSL_HAVE_ASM now also handles prevents asm in
6130     padlock and timing code.
6131   * Fixed an off-by-one buffer allocation in ssl_set_hostname()
6132     responsible for crashes and unwanted behaviour.
6133   * Added support for Certificate Revocation List (CRL) parsing.
6134   * Added support for CRL revocation to x509parse_verify() and
6135     SSL/TLS code.
6136   * Fixed compatibility of XTEA and Camellia on a 64-bit system
6137     (found by Felix von Leitner).
6138
6139= Version 0.10.0 released on 2009-01-12
6140   * Migrated XySSL to PolarSSL
6141   * Added XTEA symmetric cipher
6142   * Added Camellia symmetric cipher
6143   * Added support for ciphersuites: SSL_RSA_CAMELLIA_128_SHA,
6144     SSL_RSA_CAMELLIA_256_SHA and SSL_EDH_RSA_CAMELLIA_256_SHA
6145   * Fixed dangerous bug that can cause a heap overflow in
6146     rsa_pkcs1_decrypt (found by Christophe Devine)
6147
6148================================================================
6149XySSL ChangeLog
6150
6151= Version 0.9 released on 2008-03-16
6152
6153    * Added support for ciphersuite: SSL_RSA_AES_128_SHA
6154    * Enabled support for large files by default in aescrypt2.c
6155    * Preliminary openssl wrapper contributed by David Barrett
6156    * Fixed a bug in ssl_write() that caused the same payload to
6157      be sent twice in non-blocking mode when send returns EAGAIN
6158    * Fixed ssl_parse_client_hello(): session id and challenge must
6159      not be swapped in the SSLv2 ClientHello (found by Greg Robson)
6160    * Added user-defined callback debug function (Krystian Kolodziej)
6161    * Before freeing a certificate, properly zero out all cert. data
6162    * Fixed the "mode" parameter so that encryption/decryption are
6163      not swapped on PadLock; also fixed compilation on older versions
6164      of gcc (bug reported by David Barrett)
6165    * Correctly handle the case in padlock_xcryptcbc() when input or
6166      output data is non-aligned by falling back to the software
6167      implementation, as VIA Nehemiah cannot handle non-aligned buffers
6168    * Fixed a memory leak in x509parse_crt() which was reported by Greg
6169      Robson-Garth; some x509write.c fixes by Pascal Vizeli, thanks to
6170      Matthew Page who reported several bugs
6171    * Fixed x509_get_ext() to accept some rare certificates which have
6172      an INTEGER instead of a BOOLEAN for BasicConstraints::cA.
6173    * Added support on the client side for the TLS "hostname" extension
6174      (patch contributed by David Patino)
6175    * Make x509parse_verify() return BADCERT_CN_MISMATCH when an empty
6176      string is passed as the CN (bug reported by spoofy)
6177    * Added an option to enable/disable the BN assembly code
6178    * Updated rsa_check_privkey() to verify that (D*E) = 1 % (P-1)*(Q-1)
6179    * Disabled obsolete hash functions by default (MD2, MD4); updated
6180      selftest and benchmark to not test ciphers that have been disabled
6181    * Updated x509parse_cert_info() to correctly display byte 0 of the
6182      serial number, setup correct server port in the ssl client example
6183    * Fixed a critical denial-of-service with X.509 cert. verification:
6184      peer may cause xyssl to loop indefinitely by sending a certificate
6185      for which the RSA signature check fails (bug reported by Benoit)
6186    * Added test vectors for: AES-CBC, AES-CFB, DES-CBC and 3DES-CBC,
6187      HMAC-MD5, HMAC-SHA1, HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512
6188    * Fixed HMAC-SHA-384 and HMAC-SHA-512 (thanks to Josh Sinykin)
6189    * Modified ssl_parse_client_key_exchange() to protect against
6190      Daniel Bleichenbacher attack on PKCS#1 v1.5 padding, as well
6191      as the Klima-Pokorny-Rosa extension of Bleichenbacher's attack
6192    * Updated rsa_gen_key() so that ctx->N is always nbits in size
6193    * Fixed assembly PPC compilation errors on Mac OS X, thanks to
6194      David Barrett and Dusan Semen
6195
6196= Version 0.8 released on 2007-10-20
6197
6198    * Modified the HMAC functions to handle keys larger
6199      than 64 bytes, thanks to Stephane Desneux and gary ng
6200    * Fixed ssl_read_record() to properly update the handshake
6201      message digests, which fixes IE6/IE7 client authentication
6202    * Cleaned up the XYSSL* #defines, suggested by Azriel Fasten
6203    * Fixed net_recv(), thanks to Lorenz Schori and Egon Kocjan
6204    * Added user-defined callbacks for handling I/O and sessions
6205    * Added lots of debugging output in the SSL/TLS functions
6206    * Added preliminary X.509 cert. writing by Pascal Vizeli
6207    * Added preliminary support for the VIA PadLock routines
6208    * Added AES-CFB mode of operation, contributed by chmike
6209    * Added an SSL/TLS stress testing program (ssl_test.c)
6210    * Updated the RSA PKCS#1 code to allow choosing between
6211      RSA_PUBLIC and RSA_PRIVATE, as suggested by David Barrett
6212    * Updated ssl_read() to skip 0-length records from OpenSSL
6213    * Fixed the make install target to comply with *BSD make
6214    * Fixed a bug in mpi_read_binary() on 64-bit platforms
6215    * mpi_is_prime() speedups, thanks to Kevin McLaughlin
6216    * Fixed a long standing memory leak in mpi_is_prime()
6217    * Replaced realloc with malloc in mpi_grow(), and set
6218      the sign of zero as positive in mpi_init() (reported
6219      by Jonathan M. McCune)
6220
6221= Version 0.7 released on 2007-07-07
6222
6223    * Added support for the MicroBlaze soft-core processor
6224    * Fixed a bug in ssl_tls.c which sometimes prevented SSL
6225      connections from being established with non-blocking I/O
6226    * Fixed a couple bugs in the VS6 and UNIX Makefiles
6227    * Fixed the "PIC register ebx clobbered in asm" bug
6228    * Added HMAC starts/update/finish support functions
6229    * Added the SHA-224, SHA-384 and SHA-512 hash functions
6230    * Fixed the net_set_*block routines, thanks to Andreas
6231    * Added a few demonstration programs: md5sum, sha1sum,
6232      dh_client, dh_server, rsa_genkey, rsa_sign, rsa_verify
6233    * Added new bignum import and export helper functions
6234    * Rewrote README.txt in program/ssl/ca to better explain
6235      how to create a test PKI
6236
6237= Version 0.6 released on 2007-04-01
6238
6239    * Ciphers used in SSL/TLS can now be disabled at compile
6240      time, to reduce the memory footprint on embedded systems
6241    * Added multiply assembly code for the TriCore and modified
6242      havege_struct for this processor, thanks to David Patiño
6243    * Added multiply assembly code for 64-bit PowerPCs,
6244      thanks to Peking University and the OSU Open Source Lab
6245    * Added experimental support of Quantum Cryptography
6246    * Added support for autoconf, contributed by Arnaud Cornet
6247    * Fixed "long long" compilation issues on IA-64 and PPC64
6248    * Fixed a bug introduced in xyssl-0.5/timing.c: hardclock
6249      was not being correctly defined on ARM and MIPS
6250
6251= Version 0.5 released on 2007-03-01
6252
6253    * Added multiply assembly code for SPARC and Alpha
6254    * Added (beta) support for non-blocking I/O operations
6255    * Implemented session resuming and client authentication
6256    * Fixed some portability issues on WinCE, MINIX 3, Plan9
6257      (thanks to Benjamin Newman), HP-UX, FreeBSD and Solaris
6258    * Improved the performance of the EDH key exchange
6259    * Fixed a bug that caused valid packets with a payload
6260      size of 16384 bytes to be rejected
6261
6262= Version 0.4 released on 2007-02-01
6263
6264    * Added support for Ephemeral Diffie-Hellman key exchange
6265    * Added multiply asm code for SSE2, ARM, PPC, MIPS and M68K
6266    * Various improvement to the modular exponentiation code
6267    * Rewrote the headers to generate the API docs with doxygen
6268    * Fixed a bug in ssl_encrypt_buf (incorrect padding was
6269      generated) and in ssl_parse_client_hello (max. client
6270      version was not properly set), thanks to Didier Rebeix
6271    * Fixed another bug in ssl_parse_client_hello: clients with
6272      cipherlists larger than 96 bytes were incorrectly rejected
6273    * Fixed a couple memory leak in x509_read.c
6274
6275= Version 0.3 released on 2007-01-01
6276
6277    * Added server-side SSLv3 and TLSv1.0 support
6278    * Multiple fixes to enhance the compatibility with g++,
6279      thanks to Xosé Antón Otero Ferreira
6280    * Fixed a bug in the CBC code, thanks to dowst; also,
6281      the bignum code is no longer dependent on long long
6282    * Updated rsa_pkcs1_sign to handle arbitrary large inputs
6283    * Updated timing.c for improved compatibility with i386
6284      and 486 processors, thanks to Arnaud Cornet
6285
6286= Version 0.2 released on 2006-12-01
6287
6288    * Updated timing.c to support ARM and MIPS arch
6289    * Updated the MPI code to support 8086 on MSVC 1.5
6290    * Added the copyright notice at the top of havege.h
6291    * Fixed a bug in sha2_hmac, thanks to newsoft/Wenfang Zhang
6292    * Fixed a bug reported by Adrian Rüegsegger in x509_read_key
6293    * Fixed a bug reported by Torsten Lauter in ssl_read_record
6294    * Fixed a bug in rsa_check_privkey that would wrongly cause
6295      valid RSA keys to be dismissed (thanks to oldwolf)
6296    * Fixed a bug in mpi_is_prime that caused some primes to fail
6297      the Miller-Rabin primality test
6298
6299    I'd also like to thank Younès Hafri for the CRUX linux port,
6300    Khalil Petit who added XySSL into pkgsrc and Arnaud Cornet
6301    who maintains the Debian package :-)
6302
6303= Version 0.1 released on 2006-11-01
6304