Skip to content

HBASE-28122: Support TLSv1.3 cipher suites #5444

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

Merged
Apache9 merged 4 commits into from
Nov 9, 2023
Merged

HBASE-28122: Support TLSv1.3 cipher suites #5444

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f525946
Support TLSv1.3 cipher suites
charlesconnell Sep 29, 2023
86ddbda
spotless:apply
charlesconnell Sep 29, 2023
8ed2f16
Change Java version string parsing
charlesconnell Nov 7, 2023
e9ea1ab
add log line
charlesconnell Nov 8, 2023
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
48 changes: 24 additions & 24 deletions hbase-common/src/main/java/org/apache/hadoop/hbase/io/crypto/tls/X509Util.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ public final class X509Util {
"hbase.client.netty.tls.handshaketimeout";
public static final int DEFAULT_HANDSHAKE_DETECTION_TIMEOUT_MILLIS = 5000;

private static String[] getTls13Ciphers() {
return new String[] { "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384" };
}

private static String[] getGCMCiphers() {
return new String[] { "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
Expand All @@ -136,14 +140,17 @@ private static String[] getCBCCiphers() {
// Note that this performance assumption might not hold true for architectures other than x86_64.
private static final String[] DEFAULT_CIPHERS_JAVA9 =
ObjectArrays.concat(getGCMCiphers(), getCBCCiphers(), String.class);
private static final String[] DEFAULT_CIPHERS_JAVA11 =
ObjectArrays.concat(ObjectArrays.concat(getTls13Ciphers(), getGCMCiphers(), String.class),
getCBCCiphers(), String.class);

private static final String[] DEFAULT_CIPHERS_OPENSSL = getOpenSslFilteredDefaultCiphers();

/**
* Not all of our default ciphers are available in OpenSSL. Takes our default cipher lists and
* filters them to only those available in OpenSsl. Does GCM first, then CBC because GCM tends to
* be better and faster, and we don't need to worry about the java8 vs 9 performance issue if
* OpenSSL is handling it.
* filters them to only those available in OpenSsl. Prefers TLS 1.3, then GCM, then CBC because
* GCM tends to be better and faster, and we don't need to worry about the java8 vs 9 performance
* issue if OpenSSL is handling it.
*/
private static String[] getOpenSslFilteredDefaultCiphers() {
if (!OpenSsl.isAvailable()) {
Expand All @@ -152,16 +159,9 @@ private static String[] getOpenSslFilteredDefaultCiphers() {

Set<String> openSslSuites = OpenSsl.availableJavaCipherSuites();
List<String> defaultSuites = new ArrayList<>();
for (String cipher : getGCMCiphers()) {
if (openSslSuites.contains(cipher)) {
defaultSuites.add(cipher);
}
}
for (String cipher : getCBCCiphers()) {
if (openSslSuites.contains(cipher)) {
defaultSuites.add(cipher);
}
}
Arrays.stream(getTls13Ciphers()).filter(openSslSuites::contains).forEach(defaultSuites::add);
Arrays.stream(getGCMCiphers()).filter(openSslSuites::contains).forEach(defaultSuites::add);
Arrays.stream(getCBCCiphers()).filter(openSslSuites::contains).forEach(defaultSuites::add);
return defaultSuites.toArray(new String[0]);
}

Expand Down Expand Up @@ -219,17 +219,17 @@ static String[] getDefaultCipherSuites(boolean useOpenSsl) {

static String[] getDefaultCipherSuitesForJavaVersion(String javaVersion) {
Objects.requireNonNull(javaVersion);
if (javaVersion.matches("\\d+")) {
// Must be Java 9 or later
LOG.debug("Using Java9+ optimized cipher suites for Java version {}", javaVersion);
return DEFAULT_CIPHERS_JAVA9;
} else if (javaVersion.startsWith("1.")) {
// Must be Java 1.8 or earlier
LOG.debug("Using Java8 optimized cipher suites for Java version {}", javaVersion);
return DEFAULT_CIPHERS_JAVA8;
} else {
LOG.debug("Could not parse java version {}, using Java8 optimized cipher suites",
javaVersion);

try {
int javaVersionInt = Integer.parseInt(javaVersion);
if (javaVersionInt >= 11) {
return DEFAULT_CIPHERS_JAVA11;
} else if (javaVersionInt >= 9) {
return DEFAULT_CIPHERS_JAVA9;
} else {
return DEFAULT_CIPHERS_JAVA8;
}
} catch (NumberFormatException ignore) {
Copy link
Contributor

@Apache9 Apache9 Oct 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the old way for testing whether we could parse the java version, NumberFormatException is a RuntimeException, usually we should not consider catching a RuntimeException, just avoid throwing it.

Copy link
Contributor Author

@charlesconnell charlesconnell Oct 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't forgotten about this comment, just had some other stuff take priority.

Copy link
Contributor Author

@charlesconnell charlesconnell Nov 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is done now

return DEFAULT_CIPHERS_JAVA8;
}
}
Expand Down
8 changes: 4 additions & 4 deletions hbase-common/src/test/java/org/apache/hadoop/hbase/io/crypto/tls/TestX509Util.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,21 +379,21 @@ public void testGetDefaultCipherSuitesJava8() {
public void testGetDefaultCipherSuitesJava9() {
String[] cipherSuites = X509Util.getDefaultCipherSuitesForJavaVersion("9");
// Java 9+ default should have the GCM suites first
assertThat(cipherSuites[0], containsString("GCM"));
assertEquals(cipherSuites[0], "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256");
}

@Test
public void testGetDefaultCipherSuitesJava10() {
String[] cipherSuites = X509Util.getDefaultCipherSuitesForJavaVersion("10");
// Java 9+ default should have the GCM suites first
assertThat(cipherSuites[0], containsString("GCM"));
assertEquals(cipherSuites[0], "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256");
}

@Test
public void testGetDefaultCipherSuitesJava11() {
String[] cipherSuites = X509Util.getDefaultCipherSuitesForJavaVersion("11");
// Java 9+ default should have the GCM suites first
assertThat(cipherSuites[0], containsString("GCM"));
// Java 11+ default should have the TLSv1.3 suites first
assertThat(cipherSuites[0], containsString("TLS_AES_128_GCM"));
}

@Test
Expand Down