- rustls_is_cert_error now returns true for invalid certificate data (this was broken by v0.8.0). It also takes unsigned int as its input parameter instead of rustls_result (#227).
- rustls_verify_server_cert_callback now returns uint32_t instead of rustls_result (#227).
- rustls_session_store_get_callback and rustls_session_store_put_callback now return uint32_t (#227).
- Added arrays ALL_CIPHER_SUITES, DEFAULT_CIPHER_SUITES, ALL_VERSIONS, and DEFAULT_VERSIONS as more convenient alternatives to rustls_default_ciphersuites_get_entry(), etc.
- Add a feature, no_log_capture, which inhibits rustls from taking the global logger. Useful when built as a Rust dependency.
- Setting of ALPN protocols for client configs was broken in the 0.8.0 release. This release fixes it.
The package name has changed to "rustls-ffi" (from "crustls").
The header file (as installed by make DESTDIR=/path/ install)
is now rustls.h and the library is librustls.a. The old library and header
names are symlinked as part of the install process, to simplify upgrading to the
new version.
If you are importing this as a library from other Rust code, you should import rustls_ffi.
- rustls_client_config_builder_new_custom and rustls_server_config_builder_new_custom: start building a config, with ciphersuites and TLS versions set at initial construction.
- rustls_default_ciphersuites_get_entry() and rustls_default_ciphersuites_len(): get default ciphersuites as opposed to all ciphersuites (these happen to be the same today but might not always be).
rustls-ffinow importsrustlsversion 0.20, up from rustls 0.19. View the changelog.- Configuring ciphersuites and TLS versions. Previously these could be set using setter methods on the builder object. Now they have to be set at the beginning of the config builder process, by calling rustls_client_config_builder_new_custom().
- Reading of plaintext from a rustls_connection. When the internal plaintext buffer is empty, rustls_connection_read will return RUSTLS_RESULT_PLAINTEXT_EMPTY. That means no more plaintext can be read until additional TLS bytes are ingested via rustls_connection_read_tls, and rustls_connection_process_new_packets is called. Previously this condition was indicated by returning RUSTLS_RESULT_OK with out_n set to 0.
- Handling of unclean close and the close_notify TLS alert. Mirroring upstream changes, a rustls_connection now tracks TCP closed state like so: rustls_connection_read_tls considers a 0-length read from its callback to mean "TCP stream was closed by peer." If that happens before the peer sent close_notify, rustls_connection_read will return RUSTLS_RESULT_UNEXPECTED_EOF once the available plaintext bytes are exhausted. This is useful to protect against truncation attacks. Note: some TLS implementations don't send close_notify. If you are already getting length information from your protocol (e.g. Content-Length in HTTP) you may choose to ignore UNEXPECTED_EOF so long as the number of plaintext bytes was as expected.
rustls_versionreturns arustls_strthat points to a static string in memory, and the function no longer accepts a character buffer or length.rustls_errornow takes aunsigned intinstead of rustls_result directly. This is necessary to avoid undefined behavior if an invalid enum value is passed.- Some errors starting with RUSTLS_RESULT_CERT_ have been removed, and some renamed.
- rustls_client_config_builder_set_protocols is now rustls_client_config_builder_set_alpn_protocols.
- rustls_server_config_builder_set_protocols is now rustls_server_config_builder_set_alpn_protocols.
- rustls_server_config_builder_with_client_verifier and rustls_server_config_builder_with_client_verifier_optional are replaced by rustls_server_config_builder_set_client_verifier and rustls_server_config_builder_set_client_verifier_optional, which are setters rather than constructors.
- The documented lifetime for pointers returned by rustls_connection_get_peer_certificate and rustls_connection_get_alpn_protocol has been fixed - the pointers those functions provide are valid until the next mutating function call on that connection.
- rustls_client_config_builder_from_config and
rustls_server_config_builder_from_config have been removed. These were
incompatible with the changes to config builders. Previously the notion of
"config builder" in this library simply meant "A ClientConfig that hasn't yet
been wrapped in an Arc," so we could use
Cloneto get a copy of one. Now "config builder" corresponds to the underlyingConfigBuilderin rustls (plus some rustls-ffi internal state), so we can't useCloneon aClientConfigto get one. And we can't manually copy fields from a ClientConfig, since some of the necessary fields are private. - rustls_client_config_builder_set_versions and rustls_client_config_builder_set_ciphersuites are gone - for equivalent functionality, use rustls_client_config_builder_new_custom and rustls_server_config_builder_new_custom.
- Adds support for TLS client certificates (servers authenticating clients),
using the new
rustls_client_config_builder_set_certified_keyAPI. (rustls#128)
- Fix msvc build (#119, #120)
- Add licensing information (#117)
- Silence compiler warning in test client (#124, 125)
- rustls_connection_write_tls_vectored (#112)
- rustls_connection_set_log_callback (#107)
- rustls_client_config_builder methods (#108):
_from_config_free_use_roots_set_versions_set_ciphersuites
makeproduces optimized builds by default (#114). Use PROFILE=debug for debug builds.- As part of supporting logging, this library now has to be built with
custom RUSTFLAGS. Those flags are provided when built with
make.
- rustls_client_config_builder_load_native_roots (#110). This removes some linking requirements, e.g. for Security.framework on macOS.
- rustls_certificate_get_der to get bytes of certificate (#103)
- rustls_connection_get_peer_certificate was returning a dangling pointer. This is now fixed by having it return a reference that lives as long as the connection does. (#103)
- Add clone with OCSP for certified key (#85)
- Make userdata a per-session config (#86). This makes it so callbacks can receive data associated with a specific TLS connection, whereas before they would receive data associated with a connection config (which might be shared across multiple connections).
- The separate rustls_client_session and rustls_server_session types have been merged into a single rustls_connection type. Merging these reduces duplication in both the API and the implementation, and better reflects how the underlying rustls library works. The name change, from session to connection, reflects an upcoming change in the rustls library.
- The read_tls and write_tls methods now take a callback rather than
copying bytes into a buffer. This can simplify user code significantly
and in particular makes it harder for user code to accidentally drop
bytes from the buffer. This introduces a new rustls_io_error type that
is an alias for c_int. It wraps a value from
errno. Both the updated read/write functions and the callbacks they receive return rustls_io_error.
- ALPN support for clients (#84)
- Enumeration of ciphersuites (#79)
- Session storage (#64)
- TLS version numbers (#65)
- Reading plaintext can now return RUSTLS_RESULT_ALERT_CLOSE_NOTIFY. (#67)
- The rustls_cipher_signature_scheme name lookup. (#66)
- Expanded error handling: rustls_result has more variants. (#13)
- Allow configuring custom trusted roots. (#16)
- Use catch_unwind to prevent panicking across FFI. (#25)
- Support for TLS servers. (#30)
- Slice types: rustls_str, rustls_slice_bytes, rustls_slice_str, rustls_slice_slice_bytes, and rustls_slice_u16. (#54)
- Callback for custom certificate verifier. (#51)
- Callback for client hello inspection. (#50)
- By default, a rustls_client_config trusts no roots. (#13)
- Dependencies on
webpki-rootsandenv_logger - Defensive zeroing when receiving write buffers from C. C code needs to ensure write buffers are initialized before handing to crustls. (#57)