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