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