From 102a411b2c6ac3e88fdc4552182b305619277fb9 Mon Sep 17 00:00:00 2001 From: pwielebs Date: Mon, 17 Feb 2020 12:43:31 +0100 Subject: Add functionality for reading ENV variables Issue-ID: AAF-996 Signed-off-by: pwielebs Change-Id: If216040d59390f0956bae7f747c8cb6bce2a7f9f --- certServiceClient/pom.xml | 6 +- .../aaf/certservice/client/CertServiceClient.java | 1 + .../client/common/ClientConfigurationEnvs.java | 28 +++++ .../client/common/CsrConfigurationEnvs.java | 31 +++++ .../aaf/certservice/client/common/EnvProvider.java | 29 +++++ .../client/common/EnvValidationUtils.java | 68 +++++++++++ .../certservice/client/common/EnvsForClient.java | 53 +++++++++ .../aaf/certservice/client/common/EnvsForCsr.java | 71 ++++++++++++ .../exceptions/ClientConfigurationException.java | 28 +++++ .../exceptions/CsrConfigurationException.java | 28 +++++ .../client/model/AbstractConfigurationFactory.java | 25 ++++ .../client/model/ClientConfiguration.java | 75 ++++++++++++ .../client/model/ClientConfigurationFactory.java | 64 +++++++++++ .../client/model/ConfigurationModel.java | 24 ++++ .../certservice/client/model/CsrConfiguration.java | 97 ++++++++++++++++ .../client/model/CsrConfigurationFactory.java | 75 ++++++++++++ .../model/ClientConfigurationFactoryTest.java | 126 +++++++++++++++++++++ .../client/model/CsrConfigurationFactoryTest.java | 109 ++++++++++++++++++ 18 files changed, 936 insertions(+), 2 deletions(-) create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/ClientConfigurationEnvs.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/CsrConfigurationEnvs.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvProvider.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvValidationUtils.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForClient.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForCsr.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/ClientConfigurationException.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/CsrConfigurationException.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/AbstractConfigurationFactory.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfiguration.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactory.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ConfigurationModel.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfiguration.java create mode 100644 certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactory.java create mode 100644 certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactoryTest.java create mode 100644 certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactoryTest.java (limited to 'certServiceClient') diff --git a/certServiceClient/pom.xml b/certServiceClient/pom.xml index 84c33c72..5ffc6268 100644 --- a/certServiceClient/pom.xml +++ b/certServiceClient/pom.xml @@ -33,6 +33,10 @@ org.mockito mockito-junit-jupiter + + org.slf4j + slf4j-api + org.junit.jupiter junit-jupiter-engine @@ -45,8 +49,6 @@ org.assertj assertj-core - - \ No newline at end of file diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/CertServiceClient.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/CertServiceClient.java index e5f1a6a0..4416d0ec 100644 --- a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/CertServiceClient.java +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/CertServiceClient.java @@ -16,6 +16,7 @@ * limitations under the License. * ============LICENSE_END========================================================= */ + package org.onap.aaf.certservice.client; public class CertServiceClient { diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/ClientConfigurationEnvs.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/ClientConfigurationEnvs.java new file mode 100644 index 00000000..57e46be9 --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/ClientConfigurationEnvs.java @@ -0,0 +1,28 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.common; + +public enum ClientConfigurationEnvs { + REQUEST_URL, + REQUEST_TIMEOUT, + OUTPUT_PATH, + CA_NAME +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/CsrConfigurationEnvs.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/CsrConfigurationEnvs.java new file mode 100644 index 00000000..5913b73b --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/CsrConfigurationEnvs.java @@ -0,0 +1,31 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.common; + +public enum CsrConfigurationEnvs { + COMMON_NAME, + ORGANIZATION, + ORGANIZATION_UNIT, + LOCATION, + STATE, + COUNTRY, + SANS +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvProvider.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvProvider.java new file mode 100644 index 00000000..fce2568b --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvProvider.java @@ -0,0 +1,29 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.common; + +import org.onap.aaf.certservice.client.exceptions.ClientConfigurationException; + +public class EnvProvider { + public String readEnvVariable(String envVariable) throws ClientConfigurationException { + return System.getProperty(envVariable); + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvValidationUtils.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvValidationUtils.java new file mode 100644 index 00000000..bd71c3cd --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvValidationUtils.java @@ -0,0 +1,68 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.common; + +import java.util.regex.Pattern; + +public final class EnvValidationUtils { + + private EnvValidationUtils() {} + + public static Boolean isPathValid(String path) { + return path.matches("^/|(/[a-zA-Z0-9_-]+)+$"); + } + + public static Boolean isAlphaNumeric(String caName) { + return caName.matches("^[a-zA-Z0-9]*$"); + } + + public static Boolean isEnvExists(String envValue) { + return envValue != null && !"".equals(envValue); + } + + public static Boolean isCountryValid(String country) { + return country.matches("^([A-Z][A-Z])$"); + } + + public static Boolean isCommonNameValid(String commonName) { + return !isSpecialCharsPresent(commonName) && + !isHttpProtocolsPresent(commonName) && + !isIpAddressPresent(commonName) && + !isPortNumberPresent(commonName); + } + + static Boolean isPortNumberPresent(String stringToCheck) { + return Pattern.compile(":[0-9]{1,5}").matcher(stringToCheck).find(); + } + + static Boolean isIpAddressPresent(String stringToCheck) { + return Pattern.compile("[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}").matcher(stringToCheck).find(); + } + + static Boolean isHttpProtocolsPresent(String stringToCheck) { + return Pattern.compile("[h][t][t][p][:][/][/]|[h][t][t][p][s][:][/][/]").matcher(stringToCheck).find(); + } + + + public static Boolean isSpecialCharsPresent(String stringToCheck) { + return Pattern.compile("[~#@*$+%!()?/{}<>\\|_^]").matcher(stringToCheck).find(); + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForClient.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForClient.java new file mode 100644 index 00000000..1ba32a3f --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForClient.java @@ -0,0 +1,53 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.common; + +public class EnvsForClient { + + private String urlToCertService; + private String requestTimeOut; + private String outputPath; + private String caName; + + EnvsForClient() { + EnvProvider envProvider = new EnvProvider(); + this.urlToCertService = envProvider.readEnvVariable(ClientConfigurationEnvs.REQUEST_URL.toString()); + this.requestTimeOut = envProvider.readEnvVariable(ClientConfigurationEnvs.REQUEST_TIMEOUT.toString()); + this.outputPath = envProvider.readEnvVariable(ClientConfigurationEnvs.OUTPUT_PATH.toString()); + this.caName = envProvider.readEnvVariable(ClientConfigurationEnvs.CA_NAME.toString()); + } + + public String getUrlToCertService() { + return urlToCertService; + } + + public String getRequestTimeOut() { + return requestTimeOut; + } + + public String getOutputPath() { + return outputPath; + } + + public String getCaName() { + return caName; + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForCsr.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForCsr.java new file mode 100644 index 00000000..1f6c9c96 --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/common/EnvsForCsr.java @@ -0,0 +1,71 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.common; + +public class EnvsForCsr { + private String commonName; + private String organization; + private String organizationUnit; + private String location; + private String state; + private String country; + private String subjectAlternativesName; + + EnvsForCsr() { + EnvProvider envProvider = new EnvProvider(); + this.commonName = envProvider.readEnvVariable(CsrConfigurationEnvs.COMMON_NAME.toString()); + this.organization = envProvider.readEnvVariable(CsrConfigurationEnvs.ORGANIZATION.toString()); + this.organizationUnit = envProvider.readEnvVariable(CsrConfigurationEnvs.ORGANIZATION_UNIT.toString()); + this.location = envProvider.readEnvVariable(CsrConfigurationEnvs.LOCATION.toString()); + this.state = envProvider.readEnvVariable(CsrConfigurationEnvs.STATE.toString()); + this.country = envProvider.readEnvVariable(CsrConfigurationEnvs.COUNTRY.toString()); + this.subjectAlternativesName = envProvider.readEnvVariable(CsrConfigurationEnvs.SANS.toString()); + } + + public String getCommonName() { + return commonName; + } + + public String getOrganization() { + return organization; + } + + public String getOrganizationUnit() { + return organizationUnit; + } + + public String getLocation() { + return location; + } + + public String getState() { + return state; + } + + public String getCountry() { + return country; + } + + + public String getSubjectAlternativesName() { + return subjectAlternativesName; + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/ClientConfigurationException.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/ClientConfigurationException.java new file mode 100644 index 00000000..c895e176 --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/ClientConfigurationException.java @@ -0,0 +1,28 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.exceptions; + + +public class ClientConfigurationException extends RuntimeException { + public ClientConfigurationException(String message) { + super(message); + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/CsrConfigurationException.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/CsrConfigurationException.java new file mode 100644 index 00000000..83e38c32 --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/exceptions/CsrConfigurationException.java @@ -0,0 +1,28 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.exceptions; + + +public class CsrConfigurationException extends RuntimeException { + public CsrConfigurationException(String message) { + super(message); + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/AbstractConfigurationFactory.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/AbstractConfigurationFactory.java new file mode 100644 index 00000000..6adbc038 --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/AbstractConfigurationFactory.java @@ -0,0 +1,25 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + +public interface AbstractConfigurationFactory { + T create(); +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfiguration.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfiguration.java new file mode 100644 index 00000000..4dda61ea --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfiguration.java @@ -0,0 +1,75 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + +public class ClientConfiguration implements ConfigurationModel{ + + Integer DEFAULT_TIMEOUT_MS = 30000; + String DEFAULT_REQUEST_URL = "http://cert-service:8080/v1/certificate/"; + + private String urlToCertService; + private Integer requestTimeout; + private String certsOutputPath; + private String caName; + + + public ClientConfiguration() { + urlToCertService = DEFAULT_REQUEST_URL; + requestTimeout = DEFAULT_TIMEOUT_MS; + } + + + public String getUrlToCertService() { + return urlToCertService; + } + + public ClientConfiguration setUrlToCertService(String urlToCertService) { + this.urlToCertService = urlToCertService; + return this; + } + + public Integer getRequestTimeout() { + return requestTimeout; + } + + public ClientConfiguration setRequestTimeout(Integer requestTimeout) { + this.requestTimeout = requestTimeout; + return this; + } + + public String getCertsOutputPath() { + return certsOutputPath; + } + + public ClientConfiguration setCertsOutputPath(String certsOutputPath) { + this.certsOutputPath = certsOutputPath; + return this; + } + + public String getCaName() { + return caName; + } + + public ClientConfiguration setCaName(String caName) { + this.caName = caName; + return this; + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactory.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactory.java new file mode 100644 index 00000000..43c6838c --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactory.java @@ -0,0 +1,64 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + +import org.onap.aaf.certservice.client.common.ClientConfigurationEnvs; +import org.onap.aaf.certservice.client.common.EnvValidationUtils; +import org.onap.aaf.certservice.client.common.EnvsForClient; +import org.onap.aaf.certservice.client.exceptions.ClientConfigurationException; + +import java.util.Optional; + +class ClientConfigurationFactory implements AbstractConfigurationFactory { + + private final EnvsForClient envsForClient; + + + ClientConfigurationFactory(EnvsForClient envsForClient) { + this.envsForClient = envsForClient; + } + + + @Override + public ClientConfiguration create() throws ClientConfigurationException { + + ClientConfiguration configuration = new ClientConfiguration(); + + Optional.ofNullable(envsForClient.getUrlToCertService()).filter(EnvValidationUtils::isEnvExists) + .map(configuration::setUrlToCertService); + + Optional.ofNullable(envsForClient.getRequestTimeOut()).filter(EnvValidationUtils::isEnvExists) + .map(timeout -> configuration.setRequestTimeout(Integer.valueOf(timeout))); + + Optional.ofNullable(envsForClient.getOutputPath()).filter(EnvValidationUtils::isEnvExists) + .filter(EnvValidationUtils::isPathValid) + .map(configuration::setCertsOutputPath) + .orElseThrow(() -> new ClientConfigurationException(ClientConfigurationEnvs.OUTPUT_PATH + " is invalid.")); + + Optional.ofNullable(envsForClient.getCaName()).filter(EnvValidationUtils::isEnvExists) + .filter(EnvValidationUtils::isAlphaNumeric) + .map(configuration::setCaName) + .orElseThrow(() -> new ClientConfigurationException(ClientConfigurationEnvs.CA_NAME + " is invalid.")); + + return configuration; + } +} + diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ConfigurationModel.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ConfigurationModel.java new file mode 100644 index 00000000..ca7deb72 --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/ConfigurationModel.java @@ -0,0 +1,24 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + +public interface ConfigurationModel { +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfiguration.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfiguration.java new file mode 100644 index 00000000..27b6d931 --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfiguration.java @@ -0,0 +1,97 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + + +public class CsrConfiguration implements ConfigurationModel { + + private String commonName; + private String organization; + private String state; + private String country; + private String organizationUnit; + private String location; + private String subjectAlternativeNames; + + + public String getCommonName() { + return commonName; + } + + public CsrConfiguration setCommonName(String commonName) { + this.commonName = commonName; + return this; + } + + public String getOrganization() { + return organization; + } + + public CsrConfiguration setOrganization(String organization) { + this.organization = organization; + return this; + } + + public String getState() { + return state; + } + + public CsrConfiguration setState(String state) { + this.state = state; + return this; + } + + public String getCountry() { + return country; + } + + public CsrConfiguration setCountry(String country) { + this.country = country; + return this; + } + + public String getOrganizationUnit() { + return organizationUnit; + } + + public CsrConfiguration setOrganizationUnit(String organizationUnit) { + this.organizationUnit = organizationUnit; + return this; + } + + public String getLocation() { + return location; + } + + public CsrConfiguration setLocation(String location) { + this.location = location; + return this; + } + + public String getSubjectAlternativeNames() { + return subjectAlternativeNames; + } + + public CsrConfiguration setSubjectAlternativeNames(String subjectAlternativeNames) { + this.subjectAlternativeNames = subjectAlternativeNames; + return this; + } +} diff --git a/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactory.java b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactory.java new file mode 100644 index 00000000..1b3a252b --- /dev/null +++ b/certServiceClient/src/main/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactory.java @@ -0,0 +1,75 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + +import org.onap.aaf.certservice.client.common.CsrConfigurationEnvs; +import org.onap.aaf.certservice.client.common.EnvValidationUtils; +import org.onap.aaf.certservice.client.common.EnvsForCsr; +import org.onap.aaf.certservice.client.exceptions.CsrConfigurationException; + +import java.util.Optional; + +class CsrConfigurationFactory implements AbstractConfigurationFactory { + + private final EnvsForCsr envsForCsr; + + + CsrConfigurationFactory(EnvsForCsr envsForCsr) { + this.envsForCsr = envsForCsr; + } + + + @Override + public CsrConfiguration create() throws CsrConfigurationException { + + CsrConfiguration configuration = new CsrConfiguration(); + + Optional.ofNullable(envsForCsr.getCommonName()).filter(EnvValidationUtils::isEnvExists) + .filter(EnvValidationUtils::isCommonNameValid) + .map(configuration::setCommonName) + .orElseThrow(() -> new CsrConfigurationException(CsrConfigurationEnvs.COMMON_NAME + " is invalid.")); + + Optional.ofNullable(envsForCsr.getOrganization()).filter(EnvValidationUtils::isEnvExists) + .filter(org -> !EnvValidationUtils.isSpecialCharsPresent(org)) + .map(configuration::setOrganization) + .orElseThrow(() -> new CsrConfigurationException(CsrConfigurationEnvs.ORGANIZATION + " is invalid.")); + + Optional.ofNullable(envsForCsr.getState()).filter(EnvValidationUtils::isEnvExists) + .map(configuration::setState) + .orElseThrow(() -> new CsrConfigurationException(CsrConfigurationEnvs.STATE + " is invalid.")); + + Optional.ofNullable(envsForCsr.getCountry()).filter(EnvValidationUtils::isEnvExists) + .filter(EnvValidationUtils::isCountryValid) + .map(configuration::setCountry) + .orElseThrow(() -> new CsrConfigurationException(CsrConfigurationEnvs.COUNTRY + " is invalid.")); + + Optional.ofNullable(envsForCsr.getOrganizationUnit()).filter(EnvValidationUtils::isEnvExists) + .map(configuration::setOrganizationUnit); + + Optional.ofNullable(envsForCsr.getLocation()).filter(EnvValidationUtils::isEnvExists) + .map(configuration::setLocation); + + Optional.ofNullable(envsForCsr.getSubjectAlternativesName()).filter(EnvValidationUtils::isEnvExists) + .map(configuration::setSubjectAlternativeNames); + + return configuration; + } +} diff --git a/certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactoryTest.java b/certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactoryTest.java new file mode 100644 index 00000000..e21f2510 --- /dev/null +++ b/certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/ClientConfigurationFactoryTest.java @@ -0,0 +1,126 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + +import org.junit.jupiter.api.Test; +import org.onap.aaf.certservice.client.common.ClientConfigurationEnvs; +import org.onap.aaf.certservice.client.common.EnvsForClient; +import org.onap.aaf.certservice.client.exceptions.ClientConfigurationException; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class ClientConfigurationFactoryTest { + + final String CA_NAME_VALID = "caaaftest2"; + final String TIME_OUT_VALID = "30000"; + final String OUTPUT_PATH_VALID = "/opt/app/osaaf"; + final String URL_TO_CERT_SERVICE_VALID = "http://cert-service:8080/v1/certificate/"; + final String CA_NAME_INVALID = "caaaftest2#$"; + final String OUTPUT_PATH_INVALID = "/opt//app/osaaf"; + + private EnvsForClient envsForClient = mock(EnvsForClient.class); + + + @Test + void create_shouldReturnSuccessWhenAllVariablesAreSetAndValid() { + // given + when(envsForClient.getCaName()).thenReturn(CA_NAME_VALID); + when(envsForClient.getOutputPath()).thenReturn(OUTPUT_PATH_VALID); + when(envsForClient.getRequestTimeOut()).thenReturn(TIME_OUT_VALID); + when(envsForClient.getUrlToCertService()).thenReturn(URL_TO_CERT_SERVICE_VALID); + + // when + ClientConfiguration configuration = new ClientConfigurationFactory(envsForClient).create(); + + // then + assertThat(configuration.getCaName()).isEqualTo(CA_NAME_VALID); + assertThat(configuration.getRequestTimeout()).isEqualTo(Integer.valueOf(TIME_OUT_VALID)); + assertThat(configuration.getCertsOutputPath()).isEqualTo(OUTPUT_PATH_VALID); + assertThat(configuration.getUrlToCertService()).isEqualTo(URL_TO_CERT_SERVICE_VALID); + } + + @Test + void create_shouldReturnSuccessWhenDefaultVariablesAreNotSet() { + // given + when(envsForClient.getCaName()).thenReturn(CA_NAME_VALID); + when(envsForClient.getOutputPath()).thenReturn(OUTPUT_PATH_VALID); + + // when + ClientConfiguration configuration = new ClientConfigurationFactory(envsForClient).create(); + + // then + assertThat(configuration.getCaName()).isEqualTo(CA_NAME_VALID); + assertThat(configuration.getRequestTimeout()).isEqualTo(Integer.valueOf(TIME_OUT_VALID)); + assertThat(configuration.getCertsOutputPath()).isEqualTo(OUTPUT_PATH_VALID); + assertThat(configuration.getUrlToCertService()).isEqualTo(URL_TO_CERT_SERVICE_VALID); + } + + @Test + void create_shouldReturnClientExceptionWhenRequiredVariableIsNotSet() { + // given + when(envsForClient.getOutputPath()).thenReturn(OUTPUT_PATH_VALID); + + // when + ClientConfigurationFactory configurationFactory = new ClientConfigurationFactory(envsForClient); + + // when/then + assertThatExceptionOfType(ClientConfigurationException.class) + .isThrownBy(configurationFactory::create) + .withMessageContaining(ClientConfigurationEnvs.CA_NAME + " is invalid."); + } + + @Test + void create_shouldReturnClientExceptionWhenCANameContainsSpecialCharacters() { + // given + when(envsForClient.getCaName()).thenReturn(CA_NAME_INVALID); + when(envsForClient.getOutputPath()).thenReturn(OUTPUT_PATH_VALID); + when(envsForClient.getRequestTimeOut()).thenReturn(TIME_OUT_VALID); + when(envsForClient.getUrlToCertService()).thenReturn(URL_TO_CERT_SERVICE_VALID); + + // when + ClientConfigurationFactory configurationFactory = new ClientConfigurationFactory(envsForClient); + + // when/then + assertThatExceptionOfType(ClientConfigurationException.class) + .isThrownBy(configurationFactory::create) + .withMessageContaining(ClientConfigurationEnvs.CA_NAME + " is invalid."); + } + + @Test + void create_shouldReturnClientExceptionWhenOutputPathContainsSpecialCharacters() { + // given + when(envsForClient.getCaName()).thenReturn(CA_NAME_VALID); + when(envsForClient.getOutputPath()).thenReturn(OUTPUT_PATH_INVALID); + when(envsForClient.getRequestTimeOut()).thenReturn(TIME_OUT_VALID); + when(envsForClient.getUrlToCertService()).thenReturn(URL_TO_CERT_SERVICE_VALID); + + // when + ClientConfigurationFactory configurationFactory = new ClientConfigurationFactory(envsForClient); + + // when/then + assertThatExceptionOfType(ClientConfigurationException.class) + .isThrownBy(configurationFactory::create) + .withMessageContaining(ClientConfigurationEnvs.OUTPUT_PATH + " is invalid."); + } +} diff --git a/certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactoryTest.java b/certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactoryTest.java new file mode 100644 index 00000000..39d44592 --- /dev/null +++ b/certServiceClient/src/test/java/org/onap/aaf/certservice/client/model/CsrConfigurationFactoryTest.java @@ -0,0 +1,109 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.aaf.certservice.client.model; + +import org.junit.jupiter.api.Test; +import org.onap.aaf.certservice.client.common.CsrConfigurationEnvs; +import org.onap.aaf.certservice.client.common.EnvsForCsr; +import org.onap.aaf.certservice.client.exceptions.CsrConfigurationException; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class CsrConfigurationFactoryTest { + + final String COMMON_NAME_VALID = "onap.org"; + final String SANS_VALID = "test-name"; + final String COUNTRY_VALID = "US"; + final String LOCATION_VALID = "San-Francisco"; + final String ORGANIZATION_VALID = "Linux-Foundation"; + final String ORGANIZATION_UNIT_VALID = "ONAP"; + final String STATE_VALID = "California"; + final String COMMON_NAME_INVALID = "onap.org*&"; + + private EnvsForCsr envsForCsr = mock(EnvsForCsr.class); + + + @Test + void create_shouldReturnSuccessWhenAllVariablesAreSetAndValid() { + // given + when(envsForCsr.getCommonName()).thenReturn(COMMON_NAME_VALID); + when(envsForCsr.getSubjectAlternativesName()).thenReturn(SANS_VALID); + when(envsForCsr.getCountry()).thenReturn(COUNTRY_VALID); + when(envsForCsr.getLocation()).thenReturn(LOCATION_VALID); + when(envsForCsr.getOrganization()).thenReturn(ORGANIZATION_VALID); + when(envsForCsr.getOrganizationUnit()).thenReturn(ORGANIZATION_UNIT_VALID); + when(envsForCsr.getState()).thenReturn(STATE_VALID); + + // when + CsrConfiguration configuration = new CsrConfigurationFactory(envsForCsr).create(); + + // then + assertThat(configuration.getCommonName()).isEqualTo(COMMON_NAME_VALID); + assertThat(configuration.getSubjectAlternativeNames()).isEqualTo(SANS_VALID); + assertThat(configuration.getCountry()).isEqualTo(COUNTRY_VALID); + assertThat(configuration.getLocation()).isEqualTo(LOCATION_VALID); + assertThat(configuration.getOrganization()).isEqualTo(ORGANIZATION_VALID); + assertThat(configuration.getOrganizationUnit()).isEqualTo(ORGANIZATION_UNIT_VALID); + assertThat(configuration.getState()).isEqualTo(STATE_VALID); + } + + @Test + void create_shouldReturnSuccessWhenNotRequiredVariablesAreNotSet() { + // given + when(envsForCsr.getCommonName()).thenReturn(COMMON_NAME_VALID); + when(envsForCsr.getState()).thenReturn(STATE_VALID); + when(envsForCsr.getCountry()).thenReturn(COUNTRY_VALID); + when(envsForCsr.getOrganization()).thenReturn(ORGANIZATION_VALID); + + // when + CsrConfiguration configuration = new CsrConfigurationFactory(envsForCsr).create(); + + // then + assertThat(configuration.getCommonName()).isEqualTo(COMMON_NAME_VALID); + assertThat(configuration.getCountry()).isEqualTo(COUNTRY_VALID); + assertThat(configuration.getOrganization()).isEqualTo(ORGANIZATION_VALID); + assertThat(configuration.getState()).isEqualTo(STATE_VALID); + } + + + @Test + void create_shouldReturnCsrConfigurationExceptionWhenCommonNameContainsSpecialCharacters() { + // given + when(envsForCsr.getCommonName()).thenReturn(COMMON_NAME_INVALID); + when(envsForCsr.getSubjectAlternativesName()).thenReturn(SANS_VALID); + when(envsForCsr.getCountry()).thenReturn(COUNTRY_VALID); + when(envsForCsr.getLocation()).thenReturn(LOCATION_VALID); + when(envsForCsr.getOrganization()).thenReturn(ORGANIZATION_VALID); + when(envsForCsr.getOrganizationUnit()).thenReturn(ORGANIZATION_UNIT_VALID); + when(envsForCsr.getState()).thenReturn(SANS_VALID); + + // when + CsrConfigurationFactory configurationFactory = new CsrConfigurationFactory(envsForCsr); + + // when/then + assertThatExceptionOfType(CsrConfigurationException.class) + .isThrownBy(configurationFactory::create) + .withMessageContaining(CsrConfigurationEnvs.COMMON_NAME + " is invalid."); + } +} -- cgit 1.2.3-korg