rest-services/cbs-client/src/main/java/org/onap/dcaegen2/services/sdk/rest/services/cbs/client/model/CbsClientConfiguration.java

   1 /*
   2  * ============LICENSE_START====================================
   3  * DCAEGEN2-SERVICES-SDK
   4  * =========================================================
   5  * Copyright (C) 2019-2021 Nokia. All rights reserved.
   6  * Copyright (C) 2021 Wipro Limited.
   7  * =========================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=====================================
  20  */
  21
  22 package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model;
  23
  24 import org.immutables.value.Value;
  25 import org.jetbrains.annotations.Nullable;
  26 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.exceptions.CbsClientConfigurationException;
  27 import org.onap.dcaegen2.services.sdk.security.ssl.ImmutableTrustStoreKeys;
  28 import org.onap.dcaegen2.services.sdk.security.ssl.Passwords;
  29 import org.onap.dcaegen2.services.sdk.security.ssl.SecurityKeysStore;
  30 import org.onap.dcaegen2.services.sdk.security.ssl.TrustStoreKeys;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 import java.nio.file.Files;
  35 import java.nio.file.Paths;
  36 import java.util.Optional;
  37
  38 /**
  39  * Immutable object which helps with construction of cloudRequestObject for specified Client. For usage take a look in
  40  * CloudConfigurationClient.class
  41  *
  42  * @author <a href="mailto:przemyslaw.wasala@nokia.com">Przemysław Wąsala</a> on 11/16/18
  43  * @version 1.0.0 can be passed to ReactiveCloudConfigurationProvider, can be constructed out of
  44  * org.onap.dcaegen2.services.sdk library.
  45  * @since 1.0.0
  46  */
  47 @Value.Immutable(prehash = true)
  48 public interface CbsClientConfiguration {
  49     Logger LOGGER = LoggerFactory.getLogger(CbsClientConfiguration.class);
  50
  51     String TRUST_JKS = "trust.jks";
  52     String TRUST_PASS = "trust.pass";
  53     Integer PORT_FOR_CBS_OVER_TLS = 10443;
  54
  55     /**
  56      * Name of environment variable containing path to the cacert.pem file.
  57      */
  58     String DCAE_CA_CERT_PATH = "DCAE_CA_CERTPATH";
  59
  60     /**
  61      * Name of environment variable containing Config Binding Service network hostname.
  62      */
  63     String ENV_CBS_HOSTNAME = "CONFIG_BINDING_SERVICE";
  64
  65     /**
  66      * Name of environment variable containing Config Binding Service network port.
  67      */
  68     String ENV_CBS_PORT = "CONFIG_BINDING_SERVICE_SERVICE_PORT";
  69
  70     /**
  71      * Name of environment variable containing current application name.
  72      */
  73     String ENV_APP_NAME = "HOSTNAME";
  74
  75
  76     /**
  77      * Name of environment variable containing Consul host name.
  78      *
  79      * @deprecated CBS lookup in Consul service should not be needed,
  80      * instead {@link #ENV_CBS_HOSTNAME} should be used directly.
  81      */
  82     @Deprecated
  83     String ENV_CONSUL_HOST = "CONSUL_HOST";
  84
  85     /**
  86      * Name of environment variable containing Config Binding Service <em>service name</em> as registered in Consul
  87      * services API.
  88      *
  89      * @deprecated CBS lookup in Consul service should not be needed,
  90      * instead {@link #ENV_CBS_HOSTNAME} should be used directly.
  91      */
  92     @Deprecated
  93     String ENV_CBS_NAME = "CONFIG_BINDING_SERVICE";
  94
  95     @Value.Parameter
  96     @Nullable
  97     String hostname();
  98
  99     @Value.Parameter
 100     @Nullable
 101     Integer port();
 102
 103     @Value.Parameter
 104     String appName();
 105
 106     @Value.Parameter
 107     @Nullable
 108     String protocol();
 109
 110     @Value.Default
 111     default @Nullable TrustStoreKeys trustStoreKeys() {
 112         return null;
 113     }
 114
 115     @Value.Default
 116     @Deprecated
 117     default String consulHost() {
 118         return "consul-server";
 119     }
 120     @Value.Default
 121     @Deprecated
 122     default Integer consulPort() {
 123         return 8500;
 124     }
 125     @Value.Default
 126     @Deprecated
 127     default String cbsName() {
 128         return "config-binding-service";
 129     }
 130     @Value.Default
 131     default String configMapFilePath() {
 132         return "/app-config/application_config.yaml";
 133     }
 134     @Value.Default
 135     default String policySyncFilePath() {
 136         return "/etc/policies/policies.json";
 137     }
 138
 139     /**
 140      * Creates CbsClientConfiguration from system environment variables.
 141      *
 142      * @return an instance of CbsClientConfiguration
 143      * @throws CbsClientConfigurationException when at least one of required parameters is missing
 144      */
 145     static CbsClientConfiguration fromEnvironment() {
 146         String pathToCaCert = System.getenv(DCAE_CA_CERT_PATH);
 147
 148         ImmutableCbsClientConfiguration.Builder configBuilder = ImmutableCbsClientConfiguration.builder()
 149                 .hostname(getEnv(ENV_CBS_HOSTNAME))
 150                 .appName(getEnv(ENV_APP_NAME));
 151         return Optional.ofNullable(pathToCaCert).filter(certPath -> !"".equals(certPath))
 152                 .map(certPath -> createSslHttpConfig(configBuilder, certPath))
 153                 .orElseGet(() -> createPlainHttpConfig(configBuilder));
 154     }
 155
 156     static CbsClientConfiguration createPlainHttpConfig(ImmutableCbsClientConfiguration.Builder configBuilder) {
 157         LOGGER.info("CBS client will use plain http protocol.");
 158         return configBuilder
 159                 .protocol("http")
 160                 .port(Integer.valueOf(getEnv(ENV_CBS_PORT)))
 161                 .build();
 162     }
 163
 164     static CbsClientConfiguration createSslHttpConfig(ImmutableCbsClientConfiguration.Builder configBuilder,
 165                                                       String pathToCaCert) {
 166         LOGGER.info("CBS client will use http over TLS.");
 167         return configBuilder
 168                 .trustStoreKeys(crateSecurityKeysFromEnvironment(createPathToJksFile(pathToCaCert)))
 169                 .port(PORT_FOR_CBS_OVER_TLS)
 170                 .protocol("https")
 171                 .build();
 172     }
 173
 174     static TrustStoreKeys crateSecurityKeysFromEnvironment(String pathToCerts) {
 175         LOGGER.info("Path to cert files: {}", pathToCerts + "/");
 176         validateIfFilesExist(pathToCerts);
 177         return ImmutableTrustStoreKeys.builder()
 178                 .trustStore(SecurityKeysStore.fromPath(Paths.get(pathToCerts + "/" + TRUST_JKS)))
 179                 .trustStorePassword(Passwords.fromPath(Paths.get(pathToCerts + "/" + TRUST_PASS)))
 180                 .build();
 181     }
 182
 183     static String createPathToJksFile(String pathToCaCertPemFile) {
 184         return pathToCaCertPemFile.substring(0, pathToCaCertPemFile.lastIndexOf("/"));
 185     }
 186
 187     static String getEnv(String envName) {
 188         String envValue = System.getenv(envName);
 189         validateEnv(envName, envValue);
 190         return envValue;
 191     }
 192
 193     static void validateEnv(String envName, String envValue) {
 194         if (envValue == null || "".equals(envValue)) {
 195             throw new CbsClientConfigurationException("Cannot read " + envName + " from environment.");
 196         }
 197     }
 198
 199     static void validateIfFilesExist(String pathToFile) {
 200         boolean areFilesExist = Files.exists(Paths.get(pathToFile + "/" + TRUST_JKS)) &&
 201                 Files.exists(Paths.get(pathToFile + "/" + TRUST_PASS));
 202
 203         if (!areFilesExist) {
 204             throw new CbsClientConfigurationException("Required files do not exist in " + pathToFile + " directory.");
 205         }
 206     }
 207 }