Merge pull request #63 from xdev-software/changeable-keystore-entry-name

Added configurable keyStorePrivateKeyAlias

Author: JohannesRabauer

CHANGELOG.md

@@ -0,0 +1,5 @@
+# 1.0.2
+
+* The alias for the private key in the keystore is now configurable (
+  Properties: `certificate.keystore.private.key.alias` or
+  Code: `BzstDipConfigurationBuilder#setKeyStorePrivateKeyAlias`)

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/model/configuration/BzstDipConfiguration.java

@@ -40,6 +40,11 @@ public class BzstDipConfiguration
 	 * Defines the password for the certificate keystore that is used to decrypt the local keystore.
 	 */
 	private final String certificateKeystorePassword;
+	
+	/**
+	 * Defines the alias of the private key within the key store.
+	 */
+	private final String keyStorePrivateKeyAlias;
 	/**
 	 * Is used for identifying this client to the BZST API.
 	 * A valid issuer/clientId is defined by the BZST and must have been received from them.
@@ -146,6 +151,7 @@ public class BzstDipConfiguration
 	@SuppressWarnings("PMD.ExcessiveParameterList")
 	public BzstDipConfiguration(
 		final String certificateKeystorePassword,
+		final String keyStorePrivateKeyAlias,
 		final String clientId,
 		final String taxID,
 		final String taxNumber,
@@ -163,6 +169,7 @@ public BzstDipConfiguration(
 		final BzstDipAddressFix platformOperatorAddress)
 	{
 		this.certificateKeystorePassword = certificateKeystorePassword;
+		this.keyStorePrivateKeyAlias = keyStorePrivateKeyAlias;
 		this.clientId = clientId;
 		this.taxID = taxID;
 		this.taxNumber = taxNumber;
@@ -184,6 +191,12 @@ public String getCertificateKeystorePassword()
 	{
 		return this.certificateKeystorePassword;
 	}
+	
+	public String getKeyStorePrivateKeyAlias()
+	{
+		return this.keyStorePrivateKeyAlias;
+	}
+	
 	public String getClientId()
 	{
 		return this.clientId;

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/model/configuration/BzstDipConfigurationBuilder.java

@@ -39,6 +39,10 @@ public class BzstDipConfigurationBuilder
 	 * @see BzstDipConfiguration#getCertificateKeystorePassword()
 	 */
 	private String certificateKeystorePassword;
+	/**
+	 * @see BzstDipConfiguration#getKeyStorePrivateKeyAlias()
+	 */
+	private String keyStorePrivateKeyAlias;
 	/**
 	 * @see BzstDipConfiguration#getClientId()
 	 */
@@ -128,6 +132,16 @@ public BzstDipConfigurationBuilder setCertificateKeystorePassword(final String c
 		return this;
 	}
 
+	/**
+	 * @param keyStorePrivateKeyAlias {@link #keyStorePrivateKeyAlias}
+	 * @return itself
+	 */
+	public BzstDipConfigurationBuilder setKeyStorePrivateKeyAlias(final String keyStorePrivateKeyAlias)
+	{
+		this.keyStorePrivateKeyAlias = keyStorePrivateKeyAlias;
+		return this;
+	}
+	
 	/**
 	 * @param clientId {@link #clientId}
 	 * @return itself
@@ -310,6 +324,10 @@ public BzstDipConfiguration buildAndValidate()
 				this.certificateKeystorePassword,
 				PropertiesSupplier.PROPERTY_NAME_CERTIFICATE_KEYSTORE_PASSWORD,
 				""),
+			this.getSetPropertyOrReadFromFile(
+				this.keyStorePrivateKeyAlias,
+				PropertiesSupplier.PROPERTY_NAME_KEYSTORE_PRIVATE_KEY_ALIAS,
+				"certificate"),
 			this.getSetPropertyOrReadFromFile(this.clientId, PropertiesSupplier.PROPERTY_NAME_CLIENT_ID),
 			this.getSetPropertyOrReadFromFile(this.taxID, PropertiesSupplier.PROPERTY_NAME_TAX_ID),
 			this.getSetPropertyOrReadFromFile(this.taxNumber, PropertiesSupplier.PROPERTY_NAME_TAX_NUMBER),

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/model/configuration/PropertiesSupplier.java

@@ -30,6 +30,7 @@
 public class PropertiesSupplier
 {
 	public static final String PROPERTY_NAME_CERTIFICATE_KEYSTORE_PASSWORD = "certificate.keystore.password";
+	public static final String PROPERTY_NAME_KEYSTORE_PRIVATE_KEY_ALIAS = "certificate.keystore.private.key.alias";
 	public static final String PROPERTY_NAME_CERTIFICATE_KEYSTORE_FILE = "certificate.keystore.file";
 	public static final String PROPERTY_NAME_CLIENT_ID = "client.id";
 	public static final String PROPERTY_NAME_TAX_ID = "tax.id";

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/util/SigningUtil.java

@@ -101,6 +101,7 @@ public static String signXMLDocument(final String unsignedXmlString, final BzstD
 			final KeyStore.PrivateKeyEntry privateKeyEntry =
 				getPrivateKeyEntry(
 					keystoreInputStream,
+					configuration.getKeyStorePrivateKeyAlias(),
 					configuration.getCertificateKeystorePassword(),
 					KEYSTORE_TYPE
 				);
@@ -222,6 +223,7 @@ private static boolean validateSignature(
 	 */
 	public static KeyStore.PrivateKeyEntry getPrivateKeyEntry(
 		final InputStream keyStoreInputStream,
+		final String keystorePrivateKeyEntryAlias,
 		final String keyStorePassword,
 		final String type)
 	{
@@ -232,7 +234,7 @@ public static KeyStore.PrivateKeyEntry getPrivateKeyEntry(
 			ks.load(keyStoreInputStream, keyStorePassword.toCharArray());
 
 			final KeyStore.PrivateKeyEntry certificate = (KeyStore.PrivateKeyEntry)ks.getEntry(
-				"certificate",
+				keystorePrivateKeyEntryAlias,
 				new KeyStore.PasswordProtection(keyStorePassword.toCharArray()));
 
 			if(certificate == null)

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/util/WebClientUtil.java

@@ -65,6 +65,7 @@ public static String createRequestToken(final BzstDipConfiguration configuration
 		{
 			final KeyStore.PrivateKeyEntry privateKeyEntry = SigningUtil.getPrivateKeyEntry(
 				keystoreInputStream,
+				configuration.getKeyStorePrivateKeyAlias(),
 				configuration.getCertificateKeystorePassword(),
 				SigningUtil.KEYSTORE_TYPE
 			);