Skip to content

HBASE-30222 Avoid re-parsing HBase configuration on every CipherProvider construction #8354

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
haridsv wants to merge 1 commit into
base: master
Choose a base branch
from
+31 −4
Open

HBASE-30222 Avoid re-parsing HBase configuration on every CipherProvider construction #8354

Show file tree
Hide file tree
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
9 changes: 7 additions & 2 deletions hbase-common/src/main/java/org/apache/hadoop/hbase/io/crypto/CryptoCipherProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@
package org.apache.hadoop.hbase.io.crypto;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.HBaseConfiguration;
import org.apache.hadoop.hbase.HBaseInterfaceAudience;
import org.apache.hadoop.hbase.io.crypto.aes.CommonsCryptoAES;
import org.apache.yetus.audience.InterfaceAudience;

import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;

/**
* The default cipher provider. Supports AES via the Commons Crypto.
*/
Expand All @@ -30,6 +32,7 @@ public final class CryptoCipherProvider implements CipherProvider {

private static CryptoCipherProvider instance;

@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.UNITTEST)
@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "MS_EXPOSE_REP",
justification = "singleton pattern")
public static CryptoCipherProvider getInstance() {
Expand All @@ -40,14 +43,16 @@ public static CryptoCipherProvider getInstance() {
return instance;
}

private Configuration conf = HBaseConfiguration.create();
private Configuration conf; // set via setConf() before use

// Prevent instantiation
private CryptoCipherProvider() {
}

@Override
public Configuration getConf() {
Preconditions.checkState(conf != null,
"Configuration not set; call setConf() before using this provider");
return conf;
}

Expand Down
9 changes: 7 additions & 2 deletions hbase-common/src/main/java/org/apache/hadoop/hbase/io/crypto/DefaultCipherProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@
package org.apache.hadoop.hbase.io.crypto;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.HBaseConfiguration;
import org.apache.hadoop.hbase.HBaseInterfaceAudience;
import org.apache.hadoop.hbase.io.crypto.aes.AES;
import org.apache.yetus.audience.InterfaceAudience;

import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;

/**
* The default cipher provider. Supports AES via the JCE.
*/
Expand All @@ -30,6 +32,7 @@ public final class DefaultCipherProvider implements CipherProvider {

private static DefaultCipherProvider instance;

@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.UNITTEST)
@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "MS_EXPOSE_REP",
justification = "singleton pattern")
public static DefaultCipherProvider getInstance() {
Expand All @@ -40,14 +43,16 @@ public static DefaultCipherProvider getInstance() {
return instance;
}

private Configuration conf = HBaseConfiguration.create();
private Configuration conf; // set via setConf() before use

// Prevent instantiation
private DefaultCipherProvider() {
}

@Override
public Configuration getConf() {
Preconditions.checkState(conf != null,
"Configuration not set; call setConf() before using this provider");
return conf;
}

Expand Down
17 changes: 17 additions & 0 deletions hbase-common/src/test/java/org/apache/hadoop/hbase/io/crypto/TestCipherProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.IOException;
Expand Down Expand Up @@ -153,4 +154,20 @@ public void testDefaultProvider() {
assertEquals(AES.KEY_LENGTH, a.getKeyLength());
}

@Test
public void testDefaultProviderGetConfWithoutConf() {
// The singleton no longer eagerly parses a Configuration at construction; getConf() must fail
// loudly when called before setConf() rather than NPE-ing deep inside cipher construction.
DefaultCipherProvider provider = DefaultCipherProvider.getInstance();
provider.setConf(null);
assertThrows(IllegalStateException.class, provider::getConf);
}

@Test
public void testCryptoProviderGetConfWithoutConf() {
CryptoCipherProvider provider = CryptoCipherProvider.getInstance();
provider.setConf(null);
assertThrows(IllegalStateException.class, provider::getConf);
}

}