From 4f34110db72d7e7f29a0efc14e2f55965967e37d Mon Sep 17 00:00:00 2001 From: mharazin Date: Wed, 18 Mar 2020 10:06:22 +0100 Subject: Improve readability of logs for positive path Issue-ID: AAF-1107 Signed-off-by: Mateusz Harazin Change-Id: If6501ad59955cac6611bc233d3fcd4ef95829b66 --- certServiceClient/README.md | 1 - .../aaf/certservice/client/certification/CsrFactory.java | 14 ++++++++------ .../certservice/client/certification/KeyPairFactory.java | 1 + .../client/certification/PrivateKeyToPemEncoder.java | 6 +++--- .../certification/conversion/PKCS12FilesCreator.java | 6 +++--- .../certification/conversion/PemToPKCS12Converter.java | 10 +++++----- .../configuration/factory/ClientConfigurationFactory.java | 5 +++++ .../configuration/factory/CsrConfigurationFactory.java | 5 +++++ .../client/configuration/model/ClientConfiguration.java | 11 +++++++++++ .../client/configuration/model/CsrConfiguration.java | 14 ++++++++++++++ .../onap/aaf/certservice/client/httpclient/HttpClient.java | 5 ++--- 11 files changed, 57 insertions(+), 21 deletions(-) (limited to 'certServiceClient') diff --git a/certServiceClient/README.md b/certServiceClient/README.md index 111db8f8..12520218 100644 --- a/certServiceClient/README.md +++ b/certServiceClient/README.md @@ -76,4 +76,3 @@ docker logs aaf-certservice-client 6 Internal HTTP Client connection problem 7 Fail in PKCS12 conversion 8 Fail in Private Key to PEM Encoding -``` diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/CsrFactory.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/CsrFactory.java index b536127c..a7fb3f35 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/CsrFactory.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/CsrFactory.java @@ -54,7 +54,7 @@ import static org.onap.aaf.certservice.client.certification.EncryptionAlgorithmC public class CsrFactory { - private final Logger LOGGER = LoggerFactory.getLogger(CsrFactory.class); + private static final Logger LOGGER = LoggerFactory.getLogger(CsrFactory.class); private static final String SANS_DELIMITER = ":"; private final CsrConfiguration configuration; @@ -65,13 +65,14 @@ public class CsrFactory { public String createCsrInPem(KeyPair keyPair) throws CsrGenerationException { - PKCS10CertificationRequest request; + LOGGER.info("Creation of CSR has been started with following parameters: {}", configuration.toString()); String csrParameters = getMandatoryParameters().append(getOptionalParameters()).toString(); X500Principal subject = new X500Principal(csrParameters); - request = createPKCS10Csr(subject, keyPair); - return convertPKC10CsrToPem(request); - } + PKCS10CertificationRequest request = createPKCS10Csr(subject, keyPair); + LOGGER.info("Creation of CSR has been completed successfully"); + return convertPKCS10CsrToPem(request); + } private StringBuilder getMandatoryParameters() { return new StringBuilder(String.format("%s=%s, %s=%s, %s=%s, %s=%s", @@ -114,9 +115,10 @@ public class CsrFactory { return contentSigner; } - private String convertPKC10CsrToPem(PKCS10CertificationRequest request) throws CsrGenerationException { + private String convertPKCS10CsrToPem(PKCS10CertificationRequest request) throws CsrGenerationException { final StringWriter stringWriter = new StringWriter(); try (JcaPEMWriter pemWriter = new JcaPEMWriter(stringWriter)) { + LOGGER.info("Conversion of CSR to PEM has been started"); pemWriter.writeObject(request); } catch (IOException e) { LOGGER.error("Conversion to PEM failed, exception message: {}", e.getMessage()); diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/KeyPairFactory.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/KeyPairFactory.java index 5d56f08c..988d37d8 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/KeyPairFactory.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/KeyPairFactory.java @@ -39,6 +39,7 @@ public class KeyPairFactory { public KeyPair create() throws KeyPairGenerationException { try { + LOGGER.info("KeyPair generation started with algorithm: {} and key size: {}", encryptionAlgorithm, keySize); return createKeyPairGenerator().generateKeyPair(); } catch (NoSuchAlgorithmException e) { LOGGER.error("Generation of KeyPair failed, exception message: {}" , e.getMessage()); diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/PrivateKeyToPemEncoder.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/PrivateKeyToPemEncoder.java index 4e88a805..7391b119 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/PrivateKeyToPemEncoder.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/PrivateKeyToPemEncoder.java @@ -34,11 +34,11 @@ import org.slf4j.LoggerFactory; public class PrivateKeyToPemEncoder { - public static final String PEM_OBJECT_TYPE = "RSA PRIVATE KEY"; - private final Logger LOGGER = LoggerFactory.getLogger(PrivateKeyToPemEncoder.class); + private static final Logger LOGGER = LoggerFactory.getLogger(PrivateKeyToPemEncoder.class); + private static final String PEM_OBJECT_TYPE = "RSA PRIVATE KEY"; public String encodePrivateKeyToPem(PrivateKey pk) throws PkEncodingException { - LOGGER.info("Encoding PrivateKey to PEM"); + LOGGER.info("Attempt to encode private key to PEM"); StringWriter stringWriter = new StringWriter(); try (JcaPEMWriter pemWriter = new JcaPEMWriter(stringWriter)) { pemWriter.writeObject(new PemObject(PEM_OBJECT_TYPE, pk.getEncoded())); diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PKCS12FilesCreator.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PKCS12FilesCreator.java index 8e6fb89c..9b0cfb78 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PKCS12FilesCreator.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PKCS12FilesCreator.java @@ -29,6 +29,7 @@ import org.slf4j.LoggerFactory; class PKCS12FilesCreator { + private static final Logger LOGGER = LoggerFactory.getLogger(PKCS12FilesCreator.class); private static final String KEYSTORE_JKS = "keystore.jks"; private static final String KEYSTORE_PASS = "keystore.pass"; private static final String TRUSTSTORE_JKS = "truststore.jks"; @@ -37,7 +38,6 @@ class PKCS12FilesCreator { private final String keystorePassPath; private final String truststoreJksPath; private final String truststorePassPath; - private final Logger LOGGER = LoggerFactory.getLogger(PKCS12FilesCreator.class); PKCS12FilesCreator(String path) { @@ -48,7 +48,7 @@ class PKCS12FilesCreator { } void saveKeystoreData(byte[] keystoreData, String keystorePassword) throws PemToPKCS12ConverterException { - LOGGER.debug("Creating PKCS12 keystore files and saving data. Keystore path: {}", keystoreJksPath); + LOGGER.debug("Attempt to create PKCS12 keystore files and saving data. Keystore path: {}", keystoreJksPath); saveDataToLocation(keystoreData, keystoreJksPath); saveDataToLocation(keystorePassword.getBytes(), keystorePassPath); @@ -56,7 +56,7 @@ class PKCS12FilesCreator { void saveTruststoreData(byte[] truststoreData, String truststorePassword) throws PemToPKCS12ConverterException { - LOGGER.debug("Creating PKCS12 truststore files and saving data. Truststore path: {}", truststoreJksPath); + LOGGER.debug("Attempt to create PKCS12 truststore files and saving data. Truststore path: {}", truststoreJksPath); saveDataToLocation(truststoreData, truststoreJksPath); saveDataToLocation(truststorePassword.getBytes(), truststorePassPath); diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PemToPKCS12Converter.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PemToPKCS12Converter.java index 8c794e72..ef1666dc 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PemToPKCS12Converter.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/certification/conversion/PemToPKCS12Converter.java @@ -41,20 +41,20 @@ import org.slf4j.LoggerFactory; class PemToPKCS12Converter { - private final static String PKCS12 = "PKCS12"; - private final static String PASSWORD_ERROR_MSG = "Password should be min. 16 chars long and should contain only alphanumeric characters and special characters like Underscore (_), Dollar ($) and Pound (#)"; + private static final Logger LOGGER = LoggerFactory.getLogger(PemToPKCS12Converter.class); + private static final String PKCS12 = "PKCS12"; + private static final String PASSWORD_ERROR_MSG = "Password should be min. 16 chars long and should contain only alphanumeric characters and special characters like Underscore (_), Dollar ($) and Pound (#)"; private final LoadStoreParameter EMPTY_KEYSTORE_CONFIGURATION = null; - private final Logger LOGGER = LoggerFactory.getLogger(PemToPKCS12Converter.class); byte[] convertKeystore(List certificateChain, Password password, String alias, PrivateKey privateKey) throws PemToPKCS12ConverterException { - LOGGER.debug("Converting PEM certificates to PKCS12 keystore."); + LOGGER.info("Conversion of PEM certificates to PKCS12 keystore"); return convert(certificateChain, password, certs -> getKeyStore(alias, password, certs, privateKey)); } byte[] convertTruststore(List trustAnchors, Password password, String alias) throws PemToPKCS12ConverterException { - LOGGER.debug("Converting PEM certificates to PKCS12 truststore."); + LOGGER.info("Conversion of PEM certificates to PKCS12 truststore"); return convert(trustAnchors, password, certs -> getTrustStore(alias, certs)); } diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/ClientConfigurationFactory.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/ClientConfigurationFactory.java index 26a2b1b1..a03ded6c 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/ClientConfigurationFactory.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/ClientConfigurationFactory.java @@ -24,9 +24,12 @@ import org.onap.aaf.certservice.client.configuration.ClientConfigurationEnvs; import org.onap.aaf.certservice.client.configuration.EnvsForClient; import org.onap.aaf.certservice.client.configuration.exception.ClientConfigurationException; import org.onap.aaf.certservice.client.configuration.model.ClientConfiguration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class ClientConfigurationFactory extends AbstractConfigurationFactory { + private static final Logger LOGGER = LoggerFactory.getLogger(ClientConfigurationFactory.class); private final EnvsForClient envsForClient; public ClientConfigurationFactory(EnvsForClient envsForClient) { @@ -54,6 +57,8 @@ public class ClientConfigurationFactory extends AbstractConfigurationFactory new ClientConfigurationException(ClientConfigurationEnvs.CA_NAME + " is invalid.")); + LOGGER.info("Successful validation of Client configuration. Configuration data: {}", configuration.toString()); + return configuration; } } diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/CsrConfigurationFactory.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/CsrConfigurationFactory.java index a6e86187..a94c906f 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/CsrConfigurationFactory.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/configuration/factory/CsrConfigurationFactory.java @@ -24,9 +24,12 @@ import org.onap.aaf.certservice.client.configuration.CsrConfigurationEnvs; import org.onap.aaf.certservice.client.configuration.EnvsForCsr; import org.onap.aaf.certservice.client.configuration.exception.CsrConfigurationException; import org.onap.aaf.certservice.client.configuration.model.CsrConfiguration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class CsrConfigurationFactory extends AbstractConfigurationFactory { + private static final Logger LOGGER = LoggerFactory.getLogger(CsrConfigurationFactory.class); private final EnvsForCsr envsForCsr; @@ -67,6 +70,8 @@ public class CsrConfigurationFactory extends AbstractConfigurationFactory