From 55a0398d49c333a148a579f2c2666bb488775c93 Mon Sep 17 00:00:00 2001 From: Dennis Schubert Date: Fri, 7 Jul 2023 02:33:15 +0200 Subject: [PATCH] Correct mention of the `tls-native-tls` in the documentation. --- README.md | 6 +++--- src/lib.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 29cd8d6301..9f89cc8ce4 100644 --- a/README.md +++ b/README.md @@ -134,14 +134,14 @@ For the previous stable release, 0.6.3, see [the previous version of this docume # tokio (no TLS) sqlx = { version = "0.7", features = [ "runtime-tokio" ] } # tokio + native-tls -sqlx = { version = "0.7", features = [ "runtime-tokio", "tls-native" ] } +sqlx = { version = "0.7", features = [ "runtime-tokio", "tls-native-tls" ] } # tokio + rustls sqlx = { version = "0.7", features = [ "runtime-tokio", "tls-rustls" ] } # async-std (no TLS) sqlx = { version = "0.7", features = [ "runtime-async-std" ] } # async-std + native-tls -sqlx = { version = "0.7", features = [ "runtime-async-std", "tls-native" ] } +sqlx = { version = "0.7", features = [ "runtime-async-std", "tls-native-tls" ] } # async-std + rustls sqlx = { version = "0.7", features = [ "runtime-async-std", "tls-rustls" ] } ``` @@ -168,7 +168,7 @@ be removed in the future. - Actix-web is fully compatible with Tokio and so a separate runtime feature is no longer needed. -- `tls-native`: Use the `native-tls` TLS backend (OpenSSL on *nix, SChannel on Windows, Secure Transport on macOS). +- `tls-native-tls`: Use the `native-tls` TLS backend (OpenSSL on *nix, SChannel on Windows, Secure Transport on macOS). - `tls-rustls`: Use the `rustls` TLS backend (cross-platform backend, only supports TLS 1.2 and 1.3). diff --git a/src/lib.md b/src/lib.md index 30a8b76d2c..0eab5eeb64 100644 --- a/src/lib.md +++ b/src/lib.md @@ -30,16 +30,16 @@ internal management tasks. For securely communicating with SQL servers over an untrusted network connection such as the internet, you can enable Transport Layer Security (TLS) by enabling one of the following features: -* `tls-native`: Enables the [`native-tls`] backend which uses the OS-native TLS capabilities: +* `tls-native-tls`: Enables the [`native-tls`] backend which uses the OS-native TLS capabilities: * SecureTransport on macOS. * SChannel on Windows. * OpenSSL on all other platforms. * `tls-rustls`: Enables the [RusTLS] backend, a crossplatform TLS library. * Only supports TLS revisions 1.2 and 1.3. * If you get `HandshakeFailure` errors when using this feature, it likely means your database server does not support - these newer revisions. This might be resolved by enabling or switching to the `tls-native` feature. + these newer revisions. This might be resolved by enabling or switching to the `tls-native-tls` feature. -If more than one TLS feature is enabled, the `tls-native` feature takes precedent so that it is only necessary to enable +If more than one TLS feature is enabled, the `tls-native-tls` feature takes precedent so that it is only necessary to enable it to see if it resolves the `HandshakeFailure` error without disabling `tls-rustls`. Consult the user manual for your database to find the TLS versions it supports.