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