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