Skip to content

Document netty-tcnative SSL provider support #4285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gohri81-tech wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document netty-tcnative SSL provider support #4285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/modules/ROOT/pages/spring-cloud-gateway-server-webflux/tls-and-ssl.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,33 @@ spring:
close-notify-flush-timeout-millis: 3000
close-notify-read-timeout-millis: 0
----

[[ssl-provider]]
== SSL Provider and netty-tcnative

Both the gateway server and the gateway HTTP client use Reactor Netty for TLS, so the SSL
provider is chosen by Reactor Netty and not by the gateway itself.
If `netty-tcnative` is on the classpath, the native `OPENSSL` provider is used.
Otherwise, the `JDK` provider is used.
No gateway-specific configuration is required to enable it:

.pom.xml
[source,xml]
----
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-tcnative-boringssl-static</artifactId>
</dependency>
----

The version is managed by the Netty BOM that Spring Boot imports, so it can be omitted.
To force the JDK provider even when `netty-tcnative` is available, set
`-Dio.netty.handler.ssl.noOpenSsl=true`.

To verify which engine has been selected at runtime, enable `DEBUG` logging for
`io.netty.handler.ssl.OpenSsl` and `reactor.netty.tcp.SslProvider`.

TIP: See the Reactor Netty reference documentation for
https://projectreactor.io/docs/netty/release/reference/http-server.html#ssl-and-tls[server]
and https://projectreactor.io/docs/netty/release/reference/http-client.html#ssl-and-tls[client]
SSL and TLS configuration details.