org.finos.tracdap.common.config.local.JksSecretLoader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tracdap-lib-common Show documentation
Show all versions of tracdap-lib-common Show documentation
TRAC D.A.P. common library, interfaces and utilities used across all TRAC components
/*
* Copyright 2022 Accenture Global Solutions Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.finos.tracdap.common.config.local;
import org.finos.tracdap.common.config.ConfigKeys;
import org.finos.tracdap.common.config.ConfigManager;
import org.finos.tracdap.common.config.CryptoHelpers;
import org.finos.tracdap.common.config.ISecretLoader;
import org.finos.tracdap.common.exception.*;
import org.finos.tracdap.common.startup.StartupLog;
import org.slf4j.event.Level;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.security.*;
import java.security.cert.CertificateException;
import java.util.Properties;
public class JksSecretLoader implements ISecretLoader {
public static final String DEFAULT_KEYSTORE_TYPE = "PKCS12";
private final Properties properties;
private KeyStore keystore;
private boolean ready;
String secretKey;
public JksSecretLoader(Properties properties) {
this.properties = properties;
this.keystore = null;
this.ready = false;
}
@Override
public void init(ConfigManager configManager) {
if (ready) {
StartupLog.log(this, Level.ERROR, "JKS secret loader initialized twice");
throw new EStartup("JKS secret loader initialized twice");
}
var keystoreType = properties.getProperty(ConfigKeys.SECRET_TYPE_KEY, DEFAULT_KEYSTORE_TYPE);
var keystoreUrl = properties.getProperty(ConfigKeys.SECRET_URL_KEY);
var keystoreKey = properties.getProperty(ConfigKeys.SECRET_KEY_KEY);
try {
StartupLog.log(this, Level.INFO, "Initializing JKS secret loader...");
if (keystoreUrl == null || keystoreUrl.isBlank()) {
var message = String.format("JKS secrets need %s in the main config file", ConfigKeys.SECRET_URL_KEY);
StartupLog.log(this, Level.ERROR, message);
throw new EStartup(message);
}
if (keystoreKey == null || keystoreKey.isBlank()) {
var template = "JKS secrets need a secret key, use --secret-key or set %s in the environment";
var message = String.format(template, ConfigKeys.SECRET_KEY_ENV);
StartupLog.log(this, Level.ERROR, message);
throw new EStartup(message);
}
this.keystore = KeyStore.getInstance(keystoreType);
var keystoreBytes = configManager.loadBinaryConfig(keystoreUrl);
try (var stream = new ByteArrayInputStream(keystoreBytes)) {
keystore.load(stream, keystoreKey.toCharArray());
ready = true;
this.secretKey = keystoreKey;
}
}
catch (KeyStoreException e) {
var message = String.format("Keystore type is not supported: [%s]", keystoreType);
StartupLog.log(this, Level.ERROR, message);
throw new EStartup(message);
}
catch (IOException e) {
// Inner error is more meaningful if keystore cannot be read
var error = e.getCause() != null ? e.getCause() : e;
var errorDetail = error.getMessage() + " (this normally means the secret key is wrong)";
var message = String.format("Failed to open keystore [%s]: %s", keystoreUrl, errorDetail);
StartupLog.log(this, Level.ERROR, message);
throw new EStartup(message);
}
catch (NoSuchAlgorithmException | CertificateException e) {
var message = String.format("Failed to open keystore [%s]: %s", keystoreUrl, e.getMessage());
StartupLog.log(this, Level.ERROR, message);
throw new EStartup(message);
}
}
@Override
public boolean hasSecret(String secretName) {
try {
return keystore.containsAlias(secretName);
}
catch (GeneralSecurityException e) {
var message = String.format("Secret could not be found in the key store: [%s] %s", secretName, e.getMessage());
StartupLog.log(this, Level.ERROR, message);
throw new EConfigLoad(message);
}
}
@Override
public String loadPassword(String secretName) {
try {
return CryptoHelpers.readTextEntry(keystore, secretKey, secretName);
}
catch (EConfigLoad e) {
var message = String.format("Password could not be retrieved from the key store: [%s] %s", secretName, e.getMessage());
StartupLog.log(this, Level.ERROR, message);
throw new EConfigLoad(message, e);
}
}
@Override
public boolean hasAttr(String secretName, String attrName) {
try {
return CryptoHelpers.containsAttribute(keystore, secretName, attrName);
}
catch (EConfigLoad e) {
var message = String.format("Password could not be retrieved from the key store: [%s, %s] %s",
secretName, attrName, e.getMessage());
StartupLog.log(this, Level.ERROR, message);
throw new EConfigLoad(message, e);
}
}
@Override
public String loadAttr(String secretName, String attrName) {
try {
return CryptoHelpers.readAttribute(keystore, secretKey, secretName, attrName);
}
catch (EConfigLoad e) {
var message = String.format("Attribute could not be retrieved from the key store: [%s, %s] %s",
secretName, attrName, e.getMessage());
StartupLog.log(this, Level.ERROR, message);
throw new EConfigLoad(message, e);
}
}
@Override
public PublicKey loadPublicKey(String secretName) {
try {
var base64 = CryptoHelpers.readTextEntry(keystore, secretKey, secretName);
return CryptoHelpers.decodePublicKey(base64, false);
}
catch (EConfigLoad e) {
var message = String.format("Public key could not be retrieved from the key store: [%s] %s", secretName, e.getMessage());
StartupLog.log(this, Level.ERROR, message);
throw new EConfigLoad(message, e);
}
}
@Override
public PrivateKey loadPrivateKey(String secretName) {
try {
var base64 = CryptoHelpers.readTextEntry(keystore, secretKey, secretName);
return CryptoHelpers.decodePrivateKey(base64, false);
}
catch (EConfigLoad e) {
var message = String.format("Private key could not be retrieved from the key store: [%s] %s", secretName, e.getMessage());
StartupLog.log(this, Level.ERROR, message);
throw new EConfigLoad(message, e);
}
}
}