Skip to content

RANGER-5333:Configurable Master key name for Ranger KMS DB with Luna HSM #680

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

RANGER-5333:Configurable Master key name for Ranger KMS DB with Luna HSM #680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5ee2a9
RANGER-5333:Configurable Master key for Luna HSM
ChinmayHegde24 Sep 22, 2025
83ff229
RANGER-5333:Added default MK alias value to dbks-site.xml
ChinmayHegde24 Sep 30, 2025
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
6 changes: 6 additions & 0 deletions kms/config/kms-webapp/dbks-site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,12 @@
<value>false</value>
<description></description>
</property>

<property>
<name>ranger.ks.hsm.masterkey.alias</name>
<value>RangerKMSKey</value>
<description>Custom alias for Luna HSM master key</description>
</property>

<property>
<name>ranger.ks.hsm.partition.name</name>
Expand Down
17 changes: 10 additions & 7 deletions kms/src/main/java/org/apache/hadoop/crypto/key/RangerHSM.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,15 @@ public class RangerHSM implements RangerKMSMKI {

private static final String MK_CIPHER = "AES";
private static final int MK_KeySize = 128;
private static final String MK_ALIAS = "ranger.ks.hsm.masterkey.alias";
private static final String PARTITION_PASSWORD = "ranger.ks.hsm.partition.password";
private static final String PARTITION_NAME = "ranger.ks.hsm.partition.name";
private static final String HSM_TYPE = "ranger.ks.hsm.type";
private static final String ALIAS = "RangerKMSKey";
private static final String DEFAULT_ALIAS = "RangerKMSKey";

private KeyStore myStore;
private String hsmKeystore;
private String alias;

public RangerHSM() {
}
Expand All @@ -66,6 +68,7 @@ public RangerHSM(Configuration conf) {
String errorMsg = StringUtils.EMPTY;

hsmKeystore = conf.get(HSM_TYPE);
this.alias = conf.get(MK_ALIAS, DEFAULT_ALIAS);

try {
ByteArrayInputStream is1 = new ByteArrayInputStream(("tokenlabel:" + partitionName).getBytes());
Expand Down Expand Up @@ -98,7 +101,7 @@ public RangerHSM(Configuration conf) {
public boolean generateMasterKey(String password) throws Throwable {
logger.debug("==> RangerHSM.generateMasterKey()");

if (!this.myStore.containsAlias(ALIAS)) {
if (!this.myStore.containsAlias(alias)) {
try {
logger.info("Generating AES Master Key for '{}' HSM Provider", hsmKeystore);

Expand All @@ -108,14 +111,14 @@ public boolean generateMasterKey(String password) throws Throwable {

SecretKey aesKey = keyGen.generateKey();

myStore.setKeyEntry(ALIAS, aesKey, password.toCharArray(), (java.security.cert.Certificate[]) null);
myStore.setKeyEntry(alias, aesKey, password.toCharArray(), (java.security.cert.Certificate[]) null);

return true;
} catch (Exception e) {
logger.error("generateMasterKey : Exception during Ranger Master Key Generation - {}", e.getMessage());
}
} else {
logger.info("Master key with alias - '{}' already exists!", ALIAS);
logger.info("Master key with alias - '{}' already exists!", alias);
}

logger.debug("<== RangerHSM.generateMasterKey()");
Expand All @@ -131,12 +134,12 @@ public String getMasterKey(String password) throws Throwable {
try {
logger.debug("Searching for Ranger Master Key in Luna Keystore");

boolean result = myStore.containsAlias(ALIAS);
boolean result = myStore.containsAlias(alias);

if (result) {
logger.debug("Ranger Master Key is present in Keystore");

SecretKey key = (SecretKey) myStore.getKey(ALIAS, password.toCharArray());
SecretKey key = (SecretKey) myStore.getKey(alias, password.toCharArray());

return Base64.encode(key.getEncoded());
}
Expand All @@ -155,7 +158,7 @@ public boolean setMasterKey(String password, byte[] key) {
try {
Key aesKey = new SecretKeySpec(key, MK_CIPHER);

myStore.setKeyEntry(ALIAS, aesKey, password.toCharArray(), (java.security.cert.Certificate[]) null);
myStore.setKeyEntry(alias, aesKey, password.toCharArray(), (java.security.cert.Certificate[]) null);

return true;
} catch (KeyStoreException e) {
Expand Down