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