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