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