path: root/appc-event-listener/appc-event-listener-bundle/src/main/java/org/onap/appc/listener/LCM/operation/ProviderOperations.java

/*-
 * ============LICENSE_START=======================================================
 * ONAP : APPC
 * ================================================================================
 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Copyright (C) 2017 Amdocs
 * ================================================================================
 * Modifications Copyright (C) 2019 Ericsson
 * =============================================================================
 * 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.appc.listener.LCM.operation;

import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import com.fasterxml.jackson.databind.JsonNode;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.Socket;
import java.net.URL;
import java.security.KeyManagementException;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.UnrecoverableKeyException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.io.IOUtils;
import org.apache.http.HttpHeaders;
import org.apache.http.HttpResponse;
import org.apache.http.HttpVersion;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.conn.ClientConnectionManager;
import org.apache.http.conn.scheme.PlainSocketFactory;
import org.apache.http.conn.scheme.Scheme;
import org.apache.http.conn.scheme.SchemeRegistry;
import org.apache.http.conn.ssl.SSLSocketFactory;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpProtocolParams;
import org.apache.http.protocol.HTTP;
import org.onap.appc.exceptions.APPCException;
import org.onap.appc.listener.LCM.model.ResponseStatus;
import org.onap.appc.listener.util.Mapper;

public class ProviderOperations {

    private final EELFLogger LOG = EELFManager.getInstance().getLogger(ProviderOperations.class);

    private URL url;
    private String basicAuth;

    private static ProviderOperationRequestFormatter requestFormatter = new GenericProviderOperationRequestFormatter();


    public ProviderOperations(String url, String username, String password){
        setAuthentication(username, password);
        try {
            this.url = new URL(url);
        } catch (MalformedURLException e) {
            LOG.error("An error occurred while building url", e);
        }
    }

    /**
     * Calls the AppcProvider to run a topology directed graph
     *
     * @param message The incoming message to be run
     * @return True if the result is success. Never returns false and throws an exception instead.
     * @throws UnsupportedEncodingException
     * @throws Exception                    if there was a failure processing the request. The exception message is the failure reason.
     */
    @SuppressWarnings("nls")
    public JsonNode topologyDG(String rpcName, JsonNode message) throws APPCException {
        if (message == null) {
            throw new APPCException("Provided message was null");
        }

        HttpPost postRequest = buildPostRequest(rpcName, message);
        return getJsonNode(message, postRequest);
    }

    private HttpPost buildPostRequest(String rpcName, JsonNode message) throws APPCException {
        HttpPost post;
        try {

            // Concatenate the "action" on the end of the URL
            String path = requestFormatter.buildPath(url, rpcName);
            URL serviceUrl = new URL(url.getProtocol(), url.getHost(), url.getPort(), path);

            post = new HttpPost(serviceUrl.toExternalForm());
            post.setHeader(HttpHeaders.CONTENT_TYPE, "application/json");
            post.setHeader(HttpHeaders.ACCEPT, "application/json");

            // Set Auth
            if (basicAuth != null) {
                post.setHeader(HttpHeaders.AUTHORIZATION, "Basic " + basicAuth);
            }

            String body = Mapper.toJsonString(message);
            StringEntity entity = new StringEntity(body);
            entity.setContentType("application/json");
            post.setEntity(entity);
        } catch (UnsupportedEncodingException | MalformedURLException e) {
            throw new APPCException(e);
        }
        return post;
    }

    private JsonNode getJsonNode(JsonNode message, HttpPost post) throws APPCException {
        HttpClient client = getHttpClient();

        int httpCode;
        String respBody;
        try {
            HttpResponse response = client.execute(post);
            httpCode = response.getStatusLine().getStatusCode();
            respBody = IOUtils.toString(response.getEntity().getContent());
        } catch (IOException e) {
            throw new APPCException(e);
        }

        if (httpCode >= 200 && httpCode < 300 && respBody != null) {
            JsonNode json;
            try {
                json = Mapper.toJsonNodeFromJsonString(respBody);
            } catch (Exception e) {
                LOG.error("Error processing response from provider. Could not map response to json", e);
                throw new APPCException("APPC has an unknown RPC error");
            }
            ResponseStatus responseStatus = requestFormatter.getResponseStatus(json);
            if (!isSucceeded(responseStatus.getCode())) {
                LOG.warn(String.format("Operation failed [%s]", message.toString()));
            }
            return json;
        }
        throw new APPCException(String.format("Unexpected response from endpoint: [%d] - %s ", httpCode, respBody));
    }

    /**
     * Updates the static var URL and returns the value;
     *
     * @return The new value of URL
     */
    public String getUrl() {
        return url.toExternalForm();
    }

    public void setUrl(String newUrl) {
        try {
            url = new URL(newUrl);
        } catch (MalformedURLException e) {
            LOG.error("An error occurred while building url", e);
        }
    }

    /**
     * Sets the basic authentication header for the given user and password. If either entry is null then set basic auth
     * to null
     *
     * @param user     The user with optional domain name
     * @param password The password for the user
     * @return The new value of the basic auth string that will be used in the request headers
     */
    public String setAuthentication(String user, String password) {
        if (user != null && password != null) {
            String authStr = user + ":" + password;
            basicAuth = new String(org.apache.commons.codec.binary.Base64.encodeBase64(authStr.getBytes()));
        } else {
            basicAuth = null;
        }
        return basicAuth;
    }

    @SuppressWarnings("deprecation")
    protected HttpClient getHttpClient() throws APPCException {
        HttpClient client;
        switch (url.getProtocol()) {
            case "https":
                try {
                    KeyStore trustStore = KeyStore.getInstance(KeyStore.getDefaultType());
                    trustStore.load(null, null);
                    MySSLSocketFactory sf = new MySSLSocketFactory(trustStore);
                    sf.setHostnameVerifier(MySSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);

                    HttpParams params = new BasicHttpParams();
                    HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1);
                    HttpProtocolParams.setContentCharset(params, HTTP.UTF_8);

                    SchemeRegistry registry = new SchemeRegistry();
                    registry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
                    registry.register(new Scheme("https", sf, 443));
                    registry.register(new Scheme("https", sf, 8443));
                    registry.register(new Scheme("http", sf, 8181));

                    ClientConnectionManager ccm = new ThreadSafeClientConnManager(params, registry);
                    client = new DefaultHttpClient(ccm, params);
                } catch (Exception e) {
                    LOG.error("Error getting HTTP Client", e);
                    client = new DefaultHttpClient();
                }
                break;
            case "http":
                client = new DefaultHttpClient();
                break;
            default:
                throw new APPCException(
                    "The provider.topology.url property is invalid. The url did not start with http[s]");
        }
        return client;
    }

    @SuppressWarnings("deprecation")
    public static class MySSLSocketFactory extends SSLSocketFactory {
        private SSLContext sslContext = SSLContext.getInstance("TLS");

        public MySSLSocketFactory(KeyStore truststore) throws NoSuchAlgorithmException, KeyManagementException,
            KeyStoreException, UnrecoverableKeyException {
            super(truststore);

            TrustManager tm = new X509TrustManager() {
                @Override
                public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {
                }

                @Override
                public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {
                }

                @Override
                public X509Certificate[] getAcceptedIssuers() {
                    return null;
                }
            };

            sslContext.init(null, new TrustManager[]{
                tm
            }, null);
        }

        @Override
        public Socket createSocket(Socket socket, String host, int port, boolean autoClose)
            throws IOException {
            return sslContext.getSocketFactory().createSocket(socket, host, port, autoClose);
        }

        @Override
        public Socket createSocket() throws IOException {
            return sslContext.getSocketFactory().createSocket();
        }
    }

    public static boolean isSucceeded(Integer code) {

        //FIXME is it working as intended?
        return code != null && ((code == 100) || (code == 400));
    }
}