src/main/java/org/onap/aai/modelloader/config/ModelLoaderConfig.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright (c) 2017-2019 European Software Marketing Ltd.
   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.aai.modelloader.config;
  23
  24 import java.io.File;
  25 import java.nio.file.Path;
  26 import java.nio.file.Paths;
  27 import java.util.ArrayList;
  28 import java.util.Arrays;
  29 import java.util.List;
  30 import java.util.Properties;
  31 import org.apache.commons.lang3.StringUtils;
  32 import org.eclipse.jetty.util.security.Password;
  33 import org.onap.sdc.api.consumer.IConfiguration;
  34 import org.springframework.core.env.Environment;
  35
  36 /**
  37  * Properties for the Model Loader
  38  *
  39  */
  40 public class ModelLoaderConfig implements IConfiguration {
  41
  42     // Configuration file structure
  43     public static final String PREFIX_MODEL_LOADER_CONFIG = "ml";
  44     public static final String PREFIX_DISTRIBUTION_CLIENT = PREFIX_MODEL_LOADER_CONFIG + ".distribution.";
  45     public static final String PREFIX_AAI = PREFIX_MODEL_LOADER_CONFIG + ".aai.";
  46     public static final String PREFIX_BABEL = PREFIX_MODEL_LOADER_CONFIG + ".babel.";
  47     public static final String PREFIX_DEBUG = PREFIX_MODEL_LOADER_CONFIG + ".debug.";
  48
  49     private static final String SUFFIX_KEYSTORE_FILE = "KEYSTORE_FILE";
  50     private static final String SUFFIX_KEYSTORE_PASS = "KEYSTORE_PASSWORD";
  51
  52     private static final String SUFFIX_TRUSTSTORE_FILE = "TRUSTSTORE_FILE";
  53     private static final String SUFFIX_TRUSTSTORE_PASS = "TRUSTSTORE_PASSWORD";
  54
  55     // Configuration file properties
  56     protected static final String PROP_ML_DISTRIBUTION_ACTIVE_SERVER_TLS_AUTH =
  57             PREFIX_DISTRIBUTION_CLIENT + "ACTIVE_SERVER_TLS_AUTH";
  58     protected static final String PROP_ML_DISTRIBUTION_ASDC_CONNECTION_DISABLED =
  59             PREFIX_DISTRIBUTION_CLIENT + "ASDC_CONNECTION_DISABLE";
  60     protected static final String PROP_ML_DISTRIBUTION_ASDC_ADDRESS = PREFIX_DISTRIBUTION_CLIENT + "ASDC_ADDRESS";
  61     protected static final String PROP_ML_DISTRIBUTION_ASDC_USE_HTTPS = PREFIX_DISTRIBUTION_CLIENT + "ASDC_USE_HTTPS";
  62     protected static final String PROP_ML_DISTRIBUTION_CONSUMER_GROUP = PREFIX_DISTRIBUTION_CLIENT + "CONSUMER_GROUP";
  63     protected static final String PROP_ML_DISTRIBUTION_CONSUMER_ID = PREFIX_DISTRIBUTION_CLIENT + "CONSUMER_ID";
  64     protected static final String PROP_ML_DISTRIBUTION_ENVIRONMENT_NAME =
  65             PREFIX_DISTRIBUTION_CLIENT + "ENVIRONMENT_NAME";
  66     protected static final String PROP_ML_DISTRIBUTION_KEYSTORE_PASSWORD =
  67             PREFIX_DISTRIBUTION_CLIENT + SUFFIX_KEYSTORE_PASS;
  68     protected static final String PROP_ML_DISTRIBUTION_KEYSTORE_FILE =
  69             PREFIX_DISTRIBUTION_CLIENT + SUFFIX_KEYSTORE_FILE;
  70     protected static final String PROP_ML_DISTRIBUTION_PASSWORD = PREFIX_DISTRIBUTION_CLIENT + "PASSWORD";
  71     protected static final String PROP_ML_DISTRIBUTION_POLLING_INTERVAL =
  72             PREFIX_DISTRIBUTION_CLIENT + "POLLING_INTERVAL";
  73     protected static final String PROP_ML_DISTRIBUTION_POLLING_TIMEOUT = PREFIX_DISTRIBUTION_CLIENT + "POLLING_TIMEOUT";
  74     protected static final String PROP_ML_DISTRIBUTION_USER = PREFIX_DISTRIBUTION_CLIENT + "USER";
  75     protected static final String PROP_ML_DISTRIBUTION_ARTIFACT_TYPES = PREFIX_DISTRIBUTION_CLIENT + "ARTIFACT_TYPES";
  76     protected static final String PROP_ML_DISTRIBUTION_HTTP_PROXY_HOST = PREFIX_DISTRIBUTION_CLIENT + "HTTP_PROXY_HOST";
  77     protected static final String PROP_ML_DISTRIBUTION_HTTP_PROXY_PORT = PREFIX_DISTRIBUTION_CLIENT + "HTTP_PROXY_PORT";
  78     protected static final String PROP_ML_DISTRIBUTION_HTTPS_PROXY_HOST = PREFIX_DISTRIBUTION_CLIENT + "HTTPS_PROXY_HOST";
  79     protected static final String PROP_ML_DISTRIBUTION_HTTPS_PROXY_PORT = PREFIX_DISTRIBUTION_CLIENT + "HTTPS_PROXY_PORT";
  80     protected static final String PROP_AAI_BASE_URL = PREFIX_AAI + "BASE_URL";
  81     protected static final String PROP_AAI_KEYSTORE_FILE = PREFIX_AAI + SUFFIX_KEYSTORE_FILE;
  82     protected static final String PROP_AAI_KEYSTORE_PASSWORD = PREFIX_AAI + SUFFIX_KEYSTORE_PASS;
  83     protected static final String PROP_AAI_MODEL_RESOURCE_URL = PREFIX_AAI + "MODEL_URL";
  84     protected static final String PROP_AAI_NAMED_QUERY_RESOURCE_URL = PREFIX_AAI + "NAMED_QUERY_URL";
  85     protected static final String PROP_AAI_VNF_IMAGE_RESOURCE_URL = PREFIX_AAI + "VNF_IMAGE_URL";
  86     protected static final String PROP_AAI_AUTHENTICATION_USER = PREFIX_AAI + "AUTH_USER";
  87     protected static final String PROP_AAI_AUTHENTICATION_PASSWORD = PREFIX_AAI + "AUTH_PASSWORD";
  88     protected static final String PROP_AAI_USE_GIZMO = PREFIX_AAI + "USE_GIZMO";
  89     protected static final String PROP_AAI_USE_HTTPS = PREFIX_AAI + "USE_HTTPS";
  90     protected static final String PROP_BABEL_BASE_URL = PREFIX_BABEL + "BASE_URL";
  91     protected static final String PROP_BABEL_KEYSTORE_FILE = PREFIX_BABEL + SUFFIX_KEYSTORE_FILE;
  92     protected static final String PROP_BABEL_KEYSTORE_PASSWORD = PREFIX_BABEL + SUFFIX_KEYSTORE_PASS;
  93     protected static final String PROP_BABEL_TRUSTSTORE_FILE = PREFIX_BABEL + SUFFIX_TRUSTSTORE_FILE;
  94     protected static final String PROP_BABEL_TRUSTSTORE_PASSWORD = PREFIX_BABEL + SUFFIX_TRUSTSTORE_PASS;
  95     protected static final String PROP_BABEL_GENERATE_RESOURCE_URL = PREFIX_BABEL + "GENERATE_ARTIFACTS_URL";
  96     protected static final String PROP_BABEL_USE_HTTPS = PREFIX_BABEL + "USE_HTTPS";
  97     protected static final String PROP_DEBUG_INGEST_SIMULATOR = PREFIX_DEBUG + "INGEST_SIMULATOR";
  98     protected static final String FILESEP =
  99             (System.getProperty("file.separator") == null) ? "/" : System.getProperty("file.separator");
 100
 101     private static String configHome;
 102     private Properties modelLoaderProperties = null;
 103     private String certLocation = ".";
 104     private final List<String> artifactTypes = new ArrayList<>();
 105     private String modelVersion = null;
 106
 107     public ModelLoaderConfig(Properties configProperties) {
 108         this(configProperties, ModelLoaderConfig.configHome + FILESEP + "auth" + FILESEP);
 109     }
 110
 111     /**
 112      * Original constructor
 113      *
 114      * @param modelLoaderProperties
 115      *            properties needed to be configured for the model loader
 116      * @param certLocation
 117      *            location of the certificate
 118      */
 119     public ModelLoaderConfig(Properties modelLoaderProperties, String certLocation) {
 120         this.modelLoaderProperties = modelLoaderProperties;
 121         this.certLocation = certLocation;
 122
 123         // Get list of artifact types
 124         String types = get(PROP_ML_DISTRIBUTION_ARTIFACT_TYPES);
 125         if (types != null) {
 126             artifactTypes.addAll(Arrays.asList(types.split(",")));
 127         }
 128     }
 129
 130     public static void setConfigHome(String configHome) {
 131         ModelLoaderConfig.configHome = configHome;
 132     }
 133
 134     public static Path propertiesFile() {
 135         return Paths.get(configHome, "model-loader.properties");
 136     }
 137
 138     @Override
 139     public boolean activateServerTLSAuth() {
 140         String value = get(PROP_ML_DISTRIBUTION_ACTIVE_SERVER_TLS_AUTH);
 141         return Boolean.parseBoolean(value);
 142     }
 143
 144     @Override
 145     public String getSdcAddress() {
 146         return get(PROP_ML_DISTRIBUTION_ASDC_ADDRESS);
 147     }
 148
 149     @Override
 150     public Boolean isUseHttpsWithSDC() {
 151         /* if PROP_ML_DISTRIBUTION_ASDC_USE_HTTPS is null, https will be used, as before */
 152         String value = get(PROP_ML_DISTRIBUTION_ASDC_USE_HTTPS);
 153         if (value == null) {
 154           return true;
 155         }
 156         return Boolean.parseBoolean(value);
 157     }
 158
 159     @Override
 160     public String getConsumerGroup() {
 161         return get(PROP_ML_DISTRIBUTION_CONSUMER_GROUP);
 162     }
 163
 164     @Override
 165     public String getConsumerID() {
 166         return get(PROP_ML_DISTRIBUTION_CONSUMER_ID);
 167     }
 168
 169     @Override
 170     public String getEnvironmentName() {
 171         return get(PROP_ML_DISTRIBUTION_ENVIRONMENT_NAME);
 172     }
 173
 174     @Override
 175     public String getKeyStorePassword() {
 176         return getDeobfuscatedValue(get(PROP_ML_DISTRIBUTION_KEYSTORE_PASSWORD));
 177     }
 178
 179     @Override
 180     public String getKeyStorePath() {
 181         return certLocation + get(PROP_ML_DISTRIBUTION_KEYSTORE_FILE);
 182     }
 183
 184     @Override
 185     public String getPassword() {
 186         return getDeobfuscatedValue(get(PROP_ML_DISTRIBUTION_PASSWORD));
 187     }
 188
 189     @Override
 190     public int getPollingInterval() {
 191         return Integer.parseInt(get(PROP_ML_DISTRIBUTION_POLLING_INTERVAL));
 192     }
 193
 194     @Override
 195     public int getPollingTimeout() {
 196         return Integer.parseInt(get(PROP_ML_DISTRIBUTION_POLLING_TIMEOUT));
 197     }
 198
 199     @Override
 200     public List<String> getRelevantArtifactTypes() {
 201         return artifactTypes;
 202     }
 203
 204     @Override
 205     public String getUser() {
 206         return get(PROP_ML_DISTRIBUTION_USER);
 207     }
 208
 209     @Override
 210     public boolean isFilterInEmptyResources() {
 211         return false;
 212     }
 213
 214     @Override
 215     public String getHttpProxyHost() {
 216         return getPropertyOrNull(PROP_ML_DISTRIBUTION_HTTP_PROXY_HOST);
 217     }
 218
 219     @Override
 220     public int getHttpProxyPort() {
 221         return getIntegerPropertyOrZero(PROP_ML_DISTRIBUTION_HTTP_PROXY_PORT);
 222     }
 223
 224     @Override
 225     public String getHttpsProxyHost() {
 226         return getPropertyOrNull(PROP_ML_DISTRIBUTION_HTTPS_PROXY_HOST);
 227     }
 228
 229     @Override
 230     public int getHttpsProxyPort() {
 231         return getIntegerPropertyOrZero(PROP_ML_DISTRIBUTION_HTTPS_PROXY_PORT);
 232     }
 233
 234     public String getAaiKeyStorePath() {
 235         return certLocation + File.separator + modelLoaderProperties.getProperty(PROP_AAI_KEYSTORE_FILE);
 236     }
 237
 238     public String getBabelKeyStorePath() {
 239         String filename = get(PROP_BABEL_KEYSTORE_FILE);
 240         if (filename == null) {
 241             return null;
 242         } else {
 243             return certLocation + File.separator + filename;
 244         }
 245     }
 246
 247     public String getAaiKeyStorePassword() {
 248         return getDeobfuscatedValue(get(PROP_AAI_KEYSTORE_PASSWORD));
 249     }
 250
 251     public String getBabelKeyStorePassword() {
 252         return getDeobfuscatedValue(get(PROP_BABEL_KEYSTORE_PASSWORD));
 253     }
 254
 255     public String getBabelTrustStorePath() {
 256         String filename = get(PROP_BABEL_TRUSTSTORE_FILE);
 257         if (filename == null) {
 258             return null;
 259         } else {
 260             return certLocation + File.separator + filename;
 261         }
 262     }
 263
 264     public String getBabelTrustStorePassword() {
 265         return getDeobfuscatedValue(get(PROP_BABEL_TRUSTSTORE_PASSWORD));
 266     }
 267
 268     public String getAaiBaseUrl() {
 269         return get(PROP_AAI_BASE_URL);
 270     }
 271
 272     public String getBabelBaseUrl() {
 273         return get(PROP_BABEL_BASE_URL);
 274     }
 275
 276     public String getBabelGenerateArtifactsUrl() {
 277         return get(PROP_BABEL_GENERATE_RESOURCE_URL);
 278     }
 279
 280     public String getAaiModelUrl(String version) {
 281         setModelVersion(version);
 282         return updatePropertyOXMVersion(PROP_AAI_MODEL_RESOURCE_URL, version);
 283     }
 284
 285     public String getAaiNamedQueryUrl(String version) {
 286         return updatePropertyOXMVersion(PROP_AAI_NAMED_QUERY_RESOURCE_URL, version);
 287     }
 288
 289     public String getAaiVnfImageUrl() {
 290         return updatePropertyOXMVersion(PROP_AAI_VNF_IMAGE_RESOURCE_URL, getModelVersion());
 291     }
 292
 293     public String getAaiAuthenticationUser() {
 294         return get(PROP_AAI_AUTHENTICATION_USER);
 295     }
 296
 297     public String getModelVersion() {
 298         return modelVersion;
 299     }
 300
 301     public void setModelVersion(String modelVersion) {
 302         this.modelVersion = modelVersion;
 303     }
 304
 305     public boolean useGizmo() {
 306         String useGizmo = get(PROP_AAI_USE_GIZMO);
 307         return useGizmo != null && useGizmo.equalsIgnoreCase("true");
 308     }
 309
 310     public boolean useHttpsWithAAI() {
 311         String useHttps = get(PROP_AAI_USE_HTTPS);
 312         return useHttps != null && useHttps.equalsIgnoreCase("true");
 313     }
 314
 315     public boolean useHttpsWithBabel() {
 316         String useHttps = get(PROP_BABEL_USE_HTTPS);
 317         return useHttps != null && useHttps.equalsIgnoreCase("true");
 318     }
 319
 320     /**
 321      * @return password for AAI authentication that has been reverse-engineered from its obfuscated form.
 322      */
 323     public String getAaiAuthenticationPassword() {
 324         String password = getDeobfuscatedValue(get(PROP_AAI_AUTHENTICATION_PASSWORD));
 325
 326         if (password != null && password.isEmpty()) {
 327             password = null;
 328         }
 329
 330         return password;
 331     }
 332
 333     /**
 334      * @return a boolean value indicating whether the simulator is enabled.
 335      */
 336     public boolean getIngestSimulatorEnabled() {
 337         String propValue = get(PROP_DEBUG_INGEST_SIMULATOR);
 338         return propValue != null && "enabled".equalsIgnoreCase(propValue);
 339     }
 340
 341     /**
 342      * Read the value of the property and replace any wildcard OXM version "v*" with the supplied default OXM version
 343      *
 344      * @param propertyName
 345      *            the name of the property storing the OXM version (possibly containing v*)
 346      * @param version
 347      *            the default OXM version
 348      * @return the String value of the defined property (with any wildcard OXM version defaulted)
 349      */
 350     private String updatePropertyOXMVersion(String propertyName, String version) {
 351         String value = get(propertyName);
 352         if (version != null && value != null) {
 353             value = value.replace("v*", version);
 354         }
 355         return value;
 356     }
 357
 358     /**
 359      * @return a boolean value indicating whether model loader is connected to ASDC.
 360      */
 361     public boolean getASDCConnectionDisabled() {
 362         String propValue = get(PROP_ML_DISTRIBUTION_ASDC_CONNECTION_DISABLED);
 363         return propValue != null && "true".equalsIgnoreCase(propValue);
 364     }
 365
 366     private String getDeobfuscatedValue(String property) {
 367         if (property != null && property.startsWith("OBF:")) {
 368             return Password.deobfuscate(property);
 369         }
 370         return property;
 371     }
 372
 373     private String get(String key) {
 374         String value = modelLoaderProperties.getProperty(key);
 375
 376         if (value != null && value.startsWith("ENV:")) {
 377             value = System.getenv(StringUtils.removeStart(value, "ENV:"));
 378         }
 379         return value;
 380     }
 381
 382     public String getPropertyOrNull(String propertyName) {
 383         String value = modelLoaderProperties.getProperty(propertyName);
 384         if (value == null || "NULL".equals(value) || value.isEmpty()) {
 385             return null;
 386         } else {
 387             return value;
 388         }
 389     }
 390
 391     public int getIntegerPropertyOrZero(String propertyName) {
 392         String property = modelLoaderProperties.getProperty(propertyName);
 393         if (property == null || "NULL".equals(property) || property.isEmpty()) {
 394             return 0;
 395         } else {
 396             try {
 397                 return Integer.parseInt(property);
 398             } catch (NumberFormatException e) {
 399                 return 0;
 400             }
 401         }
 402     }
 403
 404 }