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