Skip to content

Commit bfa4e7a

Browse files
committed
Document that xds uses grpc-netty-shaded
For clarity, also extract grpc-netty-shaded to a separate paragraph. Closes: #7869.
1 parent 14332d2 commit bfa4e7a

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

SECURITY.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,7 @@ Security.insertProviderAt(Conscrypt.newProvider(), 1);
5555
JDK versions prior to Java 9 do not support ALPN and are either missing AES GCM
5656
support or have 2% the performance of OpenSSL.
5757

58-
We recommend most users use grpc-netty-shaded, which includes netty-tcnative on
59-
BoringSSL. It includes pre-built libraries for 64 bit Windows, OS X, and 64 bit
60-
Linux. For 32 bit Windows, Conscrypt is an option. For all other platforms, Java
61-
9+ is required.
58+
We recommend most users use [grpc-netty-shaded](#tls-with-grpc-netty-shaded).
6259

6360
For users of grpc-netty we recommend [netty-tcnative with
6461
BoringSSL](#tls-with-netty-tcnative-on-boringssl), although using the built-in
@@ -72,6 +69,17 @@ wrapper around OpenSSL/BoringSSL/LibreSSL.
7269
We recommend BoringSSL for its simplicitly and low occurrence of security
7370
vulnerabilities relative to OpenSSL. BoringSSL is used by Conscrypt as well.
7471

72+
### TLS with grpc-netty-shaded
73+
74+
Grpc-netty-shaded includes netty-tcnative on
75+
BoringSSL. It includes pre-built libraries for 64 bit Windows, OS X, and 64 bit
76+
Linux. For 32 bit Windows, Conscrypt is an option. For all other platforms, Java
77+
9+ is required.
78+
79+
For users of xDS management protocol, the grpc-netty-shaded transport is
80+
particularly appropriate since it is already used internally for the xDS
81+
protocol and is a runtime dependency of grpc-xds.
82+
7583
### TLS with netty-tcnative on BoringSSL
7684

7785
Netty-tcnative with BoringSSL includes BoringSSL statically linked in the

0 commit comments

Comments
 (0)