add Https support for distribution endpoints 02/74702/2
authorliboNet <libo.zhu@intel.com>
Tue, 18 Dec 2018 01:22:00 +0000 (09:22 +0800)
committerliboNet <libo.zhu@intel.com>
Wed, 19 Dec 2018 04:29:10 +0000 (12:29 +0800)
. add the https into the RestServerParameters interface
. update CommonTestData to support https interface
. add two cases for healthcheck and statistic https validation
. update the package script to use JVM properties
. add keystore and truststore to resources dir
. update the keystore path for consistency

Change-Id: I04b2a3e1afef84eafbb6a22e6fe2122a5a181883
Issue-ID: POLICY-1221
Signed-off-by: liboNet <libo.zhu@intel.com>
12 files changed:
main/src/main/java/org/onap/policy/distribution/main/parameters/RestServerParameters.java
main/src/main/java/org/onap/policy/distribution/main/rest/DistributionRestServer.java
main/src/test/java/org/onap/policy/distribution/main/parameters/CommonTestData.java
main/src/test/java/org/onap/policy/distribution/main/rest/TestHttpsDistributionRestServer.java [new file with mode: 0644]
main/src/test/java/org/onap/policy/distribution/main/rest/TestHttpsStatisticDistributionRestServer.java [new file with mode: 0644]
main/src/test/resources/parameters/DistributionConfigParameters_Https.json [new file with mode: 0644]
main/src/test/resources/ssl/policy-keystore [new file with mode: 0644]
packages/policy-distribution-docker/src/main/docker/Dockerfile
packages/policy-distribution-docker/src/main/docker/policy-dist.sh
packages/policy-distribution-tarball/src/main/resources/etc/defaultConfig.json
packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-keystore [new file with mode: 0644]
packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-truststore [new file with mode: 0644]

index 89a264a..4685b7d 100644 (file)
@@ -36,6 +36,7 @@ public class RestServerParameters implements ParameterGroup {
     private int port;
     private String userName;
     private String password;
+    private boolean https;
 
     /**
      * Constructor for instantiating RestServerParameters.
@@ -44,13 +45,16 @@ public class RestServerParameters implements ParameterGroup {
      * @param port the port
      * @param userName the user name
      * @param password the password
+     * @param https the https
      */
-    public RestServerParameters(final String host, final int port, final String userName, final String password) {
+    public RestServerParameters(final String host, final int port, final String userName, final String password,
+                                final boolean https) {
         super();
         this.host = host;
         this.port = port;
         this.userName = userName;
         this.password = password;
+        this.https = https;
     }
 
     /**
@@ -99,6 +103,15 @@ public class RestServerParameters implements ParameterGroup {
         return password;
     }
 
+    /**
+     * Return the https of this RestServerParameters instance.
+     *
+     * @return the password
+     */
+    public boolean isHttps() {
+        return https;
+    }
+
     /**
      * Set the name of this RestServerParameters instance.
      *
index 4e2c842..748d516 100644 (file)
@@ -91,6 +91,8 @@ public class DistributionRestServer implements Startable {
                 restServerParameters.getUserName());
         props.setProperty(HTTP_SERVER_SERVICES + SEPARATOR + restServerParameters.getName() + ".password",
                 restServerParameters.getPassword());
+        props.setProperty(HTTP_SERVER_SERVICES + SEPARATOR + restServerParameters.getName() + ".https",
+                String.valueOf(restServerParameters.isHttps()));
         return props;
     }
 
index 96ec9f9..334aa76 100644 (file)
@@ -48,6 +48,7 @@ public class CommonTestData {
     private static final String REST_SERVER_USER = "healthcheck";
     private static final int REST_SERVER_PORT = 6969;
     private static final String REST_SERVER_HOST = "0.0.0.0";
+    private static final boolean REST_SERVER_HTTPS = false;
     public static final String DISTRIBUTION_GROUP_NAME = "SDCDistributionGroup";
     public static final String DECODER_TYPE = "DummyDecoder";
     public static final String DECODER_CLASS_NAME = "org.onap.policy.distribution.main.testclasses.DummyDecoder";
@@ -82,9 +83,9 @@ public class CommonTestData {
         final RestServerParameters restServerParameters;
         if (!isEmpty) {
             restServerParameters = new RestServerParameters(REST_SERVER_HOST, REST_SERVER_PORT, REST_SERVER_USER,
-                    REST_SERVER_PASSWORD);
+                    REST_SERVER_PASSWORD, REST_SERVER_HTTPS);
         } else {
-            restServerParameters = new RestServerParameters(null, 0, null, null);
+            restServerParameters = new RestServerParameters(null, 0, null, null, false);
         }
         return restServerParameters;
     }
diff --git a/main/src/test/java/org/onap/policy/distribution/main/rest/TestHttpsDistributionRestServer.java b/main/src/test/java/org/onap/policy/distribution/main/rest/TestHttpsDistributionRestServer.java
new file mode 100644 (file)
index 0000000..604bdd9
--- /dev/null
@@ -0,0 +1,143 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2018 Intel. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.main.rest;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.security.KeyManagementException;
+import java.security.NoSuchAlgorithmException;
+import java.security.SecureRandom;
+import java.security.cert.X509Certificate;
+import java.util.Properties;
+
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.TrustManager;
+import javax.net.ssl.X509TrustManager;
+
+import javax.ws.rs.client.Client;
+import javax.ws.rs.client.ClientBuilder;
+import javax.ws.rs.client.Invocation;
+import javax.ws.rs.client.WebTarget;
+import javax.ws.rs.core.MediaType;
+
+import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature;
+import org.junit.Test;
+import org.onap.policy.common.endpoints.report.HealthCheckReport;
+import org.onap.policy.common.logging.flexlogger.FlexLogger;
+import org.onap.policy.common.logging.flexlogger.Logger;
+import org.onap.policy.distribution.main.PolicyDistributionException;
+import org.onap.policy.distribution.main.parameters.CommonTestData;
+import org.onap.policy.distribution.main.parameters.RestServerParameters;
+import org.onap.policy.distribution.main.startstop.Main;
+
+/**
+ * Class to perform unit test of HealthCheckMonitor.
+ *
+ * @author Libo Zhu (libo.zhu@intel.com)
+ */
+public class TestHttpsDistributionRestServer {
+
+    private static final Logger LOGGER = FlexLogger.getLogger(TestDistributionRestServer.class);
+    private static final String NOT_ALIVE = "not alive";
+    private static final String ALIVE = "alive";
+    private static final String SELF = "self";
+    private static final String NAME = "Policy SSD";
+    private static String KEYSTORE = System.getProperty("user.dir") + "/src/test/resources/ssl/policy-keystore";
+
+    @Test
+    public void testHealthCheckSuccess() throws PolicyDistributionException, InterruptedException,
+        KeyManagementException, NoSuchAlgorithmException {
+        final String reportString = "Report [name=Policy SSD, url=self, healthy=true, code=200, message=alive]";
+        final Main main = startDistributionService();
+        final HealthCheckReport report = performHealthCheck();
+        validateReport(NAME, SELF, true, 200, ALIVE, reportString, report);
+        stopDistributionService(main);
+    }
+
+    private Main startDistributionService() {
+        Properties systemProps = System.getProperties();
+        systemProps.put("javax.net.ssl.keyStore", KEYSTORE);
+        systemProps.put("javax.net.ssl.keyStorePassword", "Pol1cy_0nap");
+        System.setProperties(systemProps);
+
+        final String[] distributionConfigParameters = { "-c", "parameters/DistributionConfigParameters_Https.json" };
+        return new Main(distributionConfigParameters);
+    }
+
+    private void stopDistributionService(final Main main) throws PolicyDistributionException {
+        main.shutdown();
+    }
+
+    private HealthCheckReport performHealthCheck() throws InterruptedException, KeyManagementException,
+        NoSuchAlgorithmException {
+        HealthCheckReport response = null;
+
+        TrustManager[] noopTrustManager = new TrustManager[]{
+            new X509TrustManager() {
+
+                @Override
+                public X509Certificate[] getAcceptedIssuers() {
+                    return new X509Certificate[0];
+                }
+
+                @Override
+                public void checkClientTrusted(java.security.cert.X509Certificate[] certs, String authType) {
+                }
+
+                @Override
+                public void checkServerTrusted(java.security.cert.X509Certificate[] certs, String authType) {
+                }
+            }
+        };
+
+        SSLContext sc = SSLContext.getInstance("TLSv1.2");
+        sc.init(null, noopTrustManager, new SecureRandom());
+        final ClientBuilder clientBuilder =
+            ClientBuilder.newBuilder().sslContext(sc).hostnameVerifier((host, session) -> true);
+        final Client client = clientBuilder.build();
+        final HttpAuthenticationFeature feature = HttpAuthenticationFeature.basic("healthcheck", "zb!XztG34");
+        client.register(feature);
+
+        final WebTarget webTarget = client.target("https://localhost:6969/healthcheck");
+
+        final Invocation.Builder invocationBuilder = webTarget.request(MediaType.APPLICATION_JSON);
+        while (response == null) {
+            try {
+                response = invocationBuilder.get(HealthCheckReport.class);
+            } catch (final Exception exp) {
+                LOGGER.info("the server is not started yet. We will retry again");
+                Thread.sleep(1000);
+            }
+        }
+        return response;
+    }
+
+    private void validateReport(final String name, final String url, final boolean healthy, final int code,
+            final String message, final String reportString, final HealthCheckReport report) {
+        assertEquals(name, report.getName());
+        assertEquals(url, report.getUrl());
+        assertEquals(healthy, report.isHealthy());
+        assertEquals(code, report.getCode());
+        assertEquals(message, report.getMessage());
+        assertEquals(reportString, report.toString());
+    }
+}
diff --git a/main/src/test/java/org/onap/policy/distribution/main/rest/TestHttpsStatisticDistributionRestServer.java b/main/src/test/java/org/onap/policy/distribution/main/rest/TestHttpsStatisticDistributionRestServer.java
new file mode 100644 (file)
index 0000000..f1beb0a
--- /dev/null
@@ -0,0 +1,143 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2018 Intel. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.main.rest;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.security.KeyManagementException;
+import java.security.NoSuchAlgorithmException;
+import java.security.SecureRandom;
+import java.security.cert.X509Certificate;
+import java.util.Properties;
+
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.TrustManager;
+import javax.net.ssl.X509TrustManager;
+
+import javax.ws.rs.client.Client;
+import javax.ws.rs.client.ClientBuilder;
+import javax.ws.rs.client.Invocation;
+import javax.ws.rs.client.WebTarget;
+import javax.ws.rs.core.MediaType;
+
+import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature;
+import org.junit.Test;
+import org.onap.policy.common.logging.flexlogger.FlexLogger;
+import org.onap.policy.common.logging.flexlogger.Logger;
+import org.onap.policy.distribution.main.PolicyDistributionException;
+import org.onap.policy.distribution.main.parameters.CommonTestData;
+import org.onap.policy.distribution.main.parameters.RestServerParameters;
+import org.onap.policy.distribution.main.startstop.Main;
+
+/**
+ * Class to perform unit test of HealthCheckMonitor.
+ *
+ * @author Libo Zhu (libo.zhu@intel.com)
+ */
+public class TestHttpsStatisticDistributionRestServer {
+
+    private static final Logger LOGGER = FlexLogger.getLogger(TestHttpsStatisticDistributionRestServer.class);
+    private static String KEYSTORE = System.getProperty("user.dir") + "/src/test/resources/ssl/policy-keystore";
+
+    @Test
+    public void testHealthCheckSuccess() throws PolicyDistributionException, InterruptedException,
+        KeyManagementException, NoSuchAlgorithmException {
+        final String reportString = "StatisticsReport [code=200, totalDistributionCount=0, distributionSuccessCount=0, "
+                                    + "distributionFailureCount=0, totalDownloadCount=0, "
+                                    + "downloadSuccessCount=0, downloadFailureCount=0]";
+        final Main main = startDistributionService();
+        final StatisticsReport report = performStatisticCheck();
+        validateReport(200, 0, 0, 0, 0, 0, 0, reportString, report);
+        stopDistributionService(main);
+    }
+
+    private Main startDistributionService() {
+        Properties systemProps = System.getProperties();
+        systemProps.put("javax.net.ssl.keyStore", KEYSTORE);
+        systemProps.put("javax.net.ssl.keyStorePassword", "Pol1cy_0nap");
+        System.setProperties(systemProps);
+
+        final String[] distributionConfigParameters = { "-c", "parameters/DistributionConfigParameters_Https.json" };
+        return new Main(distributionConfigParameters);
+    }
+
+    private void stopDistributionService(final Main main) throws PolicyDistributionException {
+        main.shutdown();
+    }
+
+    private StatisticsReport performStatisticCheck() throws InterruptedException, KeyManagementException,
+        NoSuchAlgorithmException {
+        StatisticsReport response = null;
+
+        TrustManager[] noopTrustManager = new TrustManager[]{
+            new X509TrustManager() {
+
+                @Override
+                public X509Certificate[] getAcceptedIssuers() {
+                    return new X509Certificate[0];
+                }
+
+                @Override
+                public void checkClientTrusted(java.security.cert.X509Certificate[] certs, String authType) {
+                }
+
+                @Override
+                public void checkServerTrusted(java.security.cert.X509Certificate[] certs, String authType) {
+                }
+            }
+        };
+
+        SSLContext sc = SSLContext.getInstance("TLSv1.2");
+        sc.init(null, noopTrustManager, new SecureRandom());
+        final ClientBuilder clientBuilder =
+            ClientBuilder.newBuilder().sslContext(sc).hostnameVerifier((host, session) -> true);
+        final Client client = clientBuilder.build();
+        final HttpAuthenticationFeature feature = HttpAuthenticationFeature.basic("healthcheck", "zb!XztG34");
+        client.register(feature);
+
+        final WebTarget webTarget = client.target("https://localhost:6969/statistics");
+
+        final Invocation.Builder invocationBuilder = webTarget.request(MediaType.APPLICATION_JSON);
+        while (response == null) {
+            try {
+                response = invocationBuilder.get(StatisticsReport.class);
+            } catch (final Exception exp) {
+                LOGGER.info("the server is not started yet. We will retry again");
+                Thread.sleep(1000);
+            }
+        }
+        return response;
+    }
+
+    private void validateReport(final int code, final int total, final int successCount, final int failureCount,
+            final int download, final int downloadSuccess, final int downloadFailure, final String reportString, 
+            final StatisticsReport report) {
+        assertEquals(code, report.getCode());
+        assertEquals(total, report.getTotalDistributionCount());
+        assertEquals(successCount, report.getDistributionSuccessCount());
+        assertEquals(failureCount, report.getDistributionFailureCount());
+        assertEquals(download, report.getTotalDownloadCount());
+        assertEquals(downloadSuccess, report.getDownloadSuccessCount());
+        assertEquals(downloadFailure, report.getDownloadFailureCount());
+        assertEquals(reportString, report.toString());
+    }
+}
diff --git a/main/src/test/resources/parameters/DistributionConfigParameters_Https.json b/main/src/test/resources/parameters/DistributionConfigParameters_Https.json
new file mode 100644 (file)
index 0000000..6454a42
--- /dev/null
@@ -0,0 +1,65 @@
+{
+    "name":"SDCDistributionGroup",
+    "restServerParameters":{
+        "host":"0.0.0.0",
+        "port":6969,
+        "userName":"healthcheck",
+        "password":"zb!XztG34",
+        "https":true
+    },
+    "receptionHandlerParameters":{
+        "DummyReceptionHandler":{
+            "receptionHandlerType":"DummyReceptionHandler",
+            "receptionHandlerClassName":"org.onap.policy.distribution.main.testclasses.DummyReceptionHandler",
+            "receptionHandlerConfigurationName":"dummyReceptionHandlerConfiguration",
+            "pluginHandlerParameters":{
+                "policyDecoders":{
+                    "DummyDecoder":{
+                        "decoderType":"DummyDecoder",
+                        "decoderClassName":"org.onap.policy.distribution.main.testclasses.DummyDecoder",
+                        "decoderConfigurationParameters": "dummyDecoderConfiguration"
+                    }
+                },
+                "policyForwarders":{
+                    "DummyForwarder":{
+                        "forwarderType":"DummyForwarder",
+                        "forwarderClassName":"org.onap.policy.distribution.main.testclasses.DummyPolicyForwarder",
+                        "forwarderConfigurationParameters": "dummyConfiguration"
+                    }
+                }
+            }
+        }
+    },
+    "receptionHandlerConfigurationParameters":{
+        "dummyReceptionHandlerConfiguration":{
+            "parameterClassName":"org.onap.policy.distribution.main.testclasses.DummyReceptionHandlerParameterGroup",
+            "parameters":{
+                "myStringParameter": "stringValue",
+                "myIntegerParameter":20,
+                "myBooleanParameter": true
+            }
+        }
+    },
+    "policyForwarderConfigurationParameters":{
+        "dummyConfiguration":{
+            "parameterClassName":"org.onap.policy.distribution.main.testclasses.DummyPolicyForwarderParameterGroup",
+            "parameters":{
+                "useHttps": false,
+                "hostname": "192.168.99.100",
+                "port": 8081,
+                "userName": "user",
+                "password": "pw123",
+                "isManaged": true
+            }
+        }
+    },
+    "policyDecoderConfigurationParameters":{
+        "dummyDecoderConfiguration":{
+            "parameterClassName":"org.onap.policy.distribution.main.testclasses.DummyPolicyDecoderParameterGroup",
+            "parameters":{
+                "policyName": "SamplePolicy",
+                "policyType": "DUMMY"
+            }
+        }
+    }
+}
diff --git a/main/src/test/resources/ssl/policy-keystore b/main/src/test/resources/ssl/policy-keystore
new file mode 100644 (file)
index 0000000..7d2b1ec
Binary files /dev/null and b/main/src/test/resources/ssl/policy-keystore differ
index e134977..3168d72 100644 (file)
@@ -28,8 +28,8 @@ RUN \
 RUN groupadd policy 
 RUN useradd --create-home --shell /bin/bash -g policy policy
 
-RUN mkdir -p ${POLICY_DISTRIBUTION_HOME} ${POLICY_LOGS} && \ 
-    chown  policy:policy ${POLICY_HOME} ${POLICY_DISTRIBUTION_HOME} ${POLICY_LOGS}
+RUN mkdir -p ${POLICY_DISTRIBUTION_HOME} ${POLICY_LOGS} ${POLICY_HOME}/etc/ssl && \
+    chown  -R policy:policy ${POLICY_HOME} ${POLICY_DISTRIBUTION_HOME} ${POLICY_LOGS}
 
 RUN mkdir /packages
 COPY /maven/* /packages
@@ -39,6 +39,7 @@ RUN rm /packages/policy-distribution.tar.gz
 WORKDIR ${POLICY_DISTRIBUTION_HOME}
 COPY policy-dist.sh  bin/.
 RUN chown -R policy:policy * && chmod +x bin/*.sh
+RUN cp ${POLICY_DISTRIBUTION_HOME}/etc/ssl/* ${POLICY_HOME}/etc/ssl && chown policy:policy ${POLICY_HOME}/etc/ssl/*
 
 USER policy
 WORKDIR ${POLICY_DISTRIBUTION_HOME}/bin
index ebb6b8d..91d7290 100644 (file)
 
 JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/
 POLICY_DISTRIBUTION_HOME=/opt/app/policy/distribution
+KEYSTORE="${POLICY_HOME}/etc/ssl/policy-keystore"
+KEYSTORE_PASSWD="Pol1cy_0nap"
+TRUSTSTORE="${POLICY_HOME}/etc/ssl/policy-truststore"
+TRUSTSTORE_PASSWD="Pol1cy_0nap"
+
 
 if [ "$#" -eq 1 ]; then
     CONFIG_FILE=$1
@@ -35,4 +40,4 @@ fi
 
 echo "Policy distribution config file: $CONFIG_FILE"
 
-$JAVA_HOME/bin/java -cp "$POLICY_DISTRIBUTION_HOME/etc:$POLICY_DISTRIBUTION_HOME/lib/*" org.onap.policy.distribution.main.startstop.Main -c $CONFIG_FILE
+$JAVA_HOME/bin/java -cp "$POLICY_DISTRIBUTION_HOME/etc:$POLICY_DISTRIBUTION_HOME/lib/*" -Djavax.net.ssl.keyStore="$KEYSTORE" -Djavax.net.ssl.keyStorePassword="$KEYSTORE_PASSWD" -Djavax.net.ssl.trustStore="$TRUSTSTORE" -Djavax.net.ssl.trustStore="$TRUSTSTORE_PASSWD" org.onap.policy.distribution.main.startstop.Main -c $CONFIG_FILE
index 455b77a..1703512 100644 (file)
@@ -4,7 +4,8 @@
         "host":"0.0.0.0",
         "port":6969,
         "userName":"healthcheck",
-        "password":"zb!XztG34"
+        "password":"zb!XztG34",
+        "https":true
     },
     "receptionHandlerParameters":{
         "SDCReceptionHandler":{
diff --git a/packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-keystore b/packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-keystore
new file mode 100644 (file)
index 0000000..7d2b1ec
Binary files /dev/null and b/packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-keystore differ
diff --git a/packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-truststore b/packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-truststore
new file mode 100644 (file)
index 0000000..8834ac2
Binary files /dev/null and b/packages/policy-distribution-tarball/src/main/resources/etc/ssl/policy-truststore differ