src/main/java/org/onap/aai/restclient/rest/RestClientBuilder.java

   1 /**\r
   2  * ============LICENSE_START=======================================================\r
   3  * org.onap.aai\r
   4  * ================================================================================\r
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * Copyright © 2017 Amdocs\r
   7  * ================================================================================\r
   8  * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * you may not use this file except in compliance with the License.\r
  10  * You may obtain a copy of the License at\r
  11  *\r
  12  *       http://www.apache.org/licenses/LICENSE-2.0\r
  13  *\r
  14  * Unless required by applicable law or agreed to in writing, software\r
  15  * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * See the License for the specific language governing permissions and\r
  18  * limitations under the License.\r
  19  * ============LICENSE_END=========================================================\r
  20  *\r
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  */\r
  23 package org.onap.aai.restclient.rest;\r
  24 \r
  25 import java.io.FileInputStream;\r
  26 import java.security.KeyStore;\r
  27 import java.security.cert.X509Certificate;\r
  28 \r
  29 import javax.net.ssl.HostnameVerifier;\r
  30 import javax.net.ssl.KeyManagerFactory;\r
  31 import javax.net.ssl.SSLContext;\r
  32 import javax.net.ssl.SSLSession;\r
  33 import javax.net.ssl.TrustManager;\r
  34 import javax.net.ssl.X509TrustManager;\r
  35 \r
  36 import org.onap.aai.restclient.enums.RestAuthenticationMode;\r
  37 \r
  38 import com.sun.jersey.api.client.Client;\r
  39 import com.sun.jersey.api.client.config.ClientConfig;\r
  40 import com.sun.jersey.api.client.config.DefaultClientConfig;\r
  41 import com.sun.jersey.client.urlconnection.HTTPSProperties;\r
  42  \r
  43 /**\r
  44  * This is a generic REST Client builder with flexible security validation. Sometimes it's nice to\r
  45  * be able to disable server chain cert validation and hostname validation to work-around lab\r
  46  * issues, but at the same time be able to provide complete validation with client cert + hostname +\r
  47  * server cert chain validation. I used the ModelLoader REST client as a base and merged in the TSUI\r
  48  * client I wrote which also validates the server hostname and server certificate chain.\r
  49  */\r
  50 public class RestClientBuilder {\r
  51 \r
  52   public static final boolean DEFAULT_VALIDATE_SERVER_HOST = false;\r
  53   public static final boolean DEFAULT_VALIDATE_CERT_CHAIN = false;\r
  54   public static final String DEFAULT_CLIENT_CERT_FILENAME = null;\r
  55   public static final String DEFAULT_CERT_PASSWORD = null;\r
  56   public static final String DEFAULT_TRUST_STORE_FILENAME = null;\r
  57   public static final int DEFAULT_CONNECT_TIMEOUT_MS = 60000;\r
  58   public static final int DEFAULT_READ_TIMEOUT_MS = 60000;\r
  59   public static final RestAuthenticationMode DEFAULT_AUTH_MODE = RestAuthenticationMode.SSL_CERT;\r
  60   public static final String DEFAULT_BASIC_AUTH_USERNAME = "";\r
  61   public static final String DEFAULT_BASIC_AUTH_PASSWORD = "";\r
  62   public static final String DEFAULT_SSL_PROTOCOL = "TLS";\r
  63 \r
  64   private static final String KEYSTORE_ALGORITHM = "SunX509";\r
  65   private static final String KEYSTORE_TYPE = "PKCS12";\r
  66   private static final String TRUST_STORE_PROPERTY = "javax.net.ssl.trustStore";\r
  67 \r
  68   private boolean validateServerHostname;\r
  69   private boolean validateServerCertChain;\r
  70   private String clientCertFileName;\r
  71   private String clientCertPassword;\r
  72   private String truststoreFilename;\r
  73   private int connectTimeoutInMs;\r
  74   private int readTimeoutInMs;\r
  75   private RestAuthenticationMode authenticationMode;\r
  76   private String basicAuthUsername;\r
  77   private String basicAuthPassword;\r
  78   private String sslProtocol;\r
  79 \r
  80   /**\r
  81    * Rest Client Builder.\r
  82    */\r
  83   public RestClientBuilder() {\r
  84     validateServerHostname = DEFAULT_VALIDATE_SERVER_HOST;\r
  85     validateServerCertChain = DEFAULT_VALIDATE_CERT_CHAIN;\r
  86     clientCertFileName = DEFAULT_CLIENT_CERT_FILENAME;\r
  87     clientCertPassword = DEFAULT_CERT_PASSWORD;\r
  88     truststoreFilename = DEFAULT_TRUST_STORE_FILENAME;\r
  89     connectTimeoutInMs = DEFAULT_CONNECT_TIMEOUT_MS;\r
  90     readTimeoutInMs = DEFAULT_READ_TIMEOUT_MS;\r
  91     authenticationMode = DEFAULT_AUTH_MODE;\r
  92     basicAuthUsername = DEFAULT_BASIC_AUTH_USERNAME;\r
  93     basicAuthPassword = DEFAULT_BASIC_AUTH_PASSWORD;\r
  94     sslProtocol = DEFAULT_SSL_PROTOCOL;\r
  95   }\r
  96 \r
  97   public boolean isValidateServerHostname() {\r
  98     return validateServerHostname;\r
  99   }\r
 100 \r
 101   public void setValidateServerHostname(boolean validateServerHostname) {\r
 102     this.validateServerHostname = validateServerHostname;\r
 103   }\r
 104 \r
 105   public boolean isValidateServerCertChain() {\r
 106     return validateServerCertChain;\r
 107   }\r
 108 \r
 109   public void setValidateServerCertChain(boolean validateServerCertChain) {\r
 110     this.validateServerCertChain = validateServerCertChain;\r
 111   }\r
 112 \r
 113   public String getClientCertFileName() {\r
 114     return clientCertFileName;\r
 115   }\r
 116 \r
 117   public void setClientCertFileName(String clientCertFileName) {\r
 118     this.clientCertFileName = clientCertFileName;\r
 119   }\r
 120 \r
 121   public String getClientCertPassword() {\r
 122     return clientCertPassword;\r
 123   }\r
 124 \r
 125   public void setClientCertPassword(String clientCertPassword) {\r
 126     this.clientCertPassword = clientCertPassword;\r
 127   }\r
 128 \r
 129   public String getTruststoreFilename() {\r
 130     return truststoreFilename;\r
 131   }\r
 132 \r
 133   public void setTruststoreFilename(String truststoreFilename) {\r
 134     this.truststoreFilename = truststoreFilename;\r
 135   }\r
 136 \r
 137   public int getConnectTimeoutInMs() {\r
 138     return connectTimeoutInMs;\r
 139   }\r
 140 \r
 141   public void setConnectTimeoutInMs(int connectTimeoutInMs) {\r
 142     this.connectTimeoutInMs = connectTimeoutInMs;\r
 143   }\r
 144 \r
 145   public int getReadTimeoutInMs() {\r
 146     return readTimeoutInMs;\r
 147   }\r
 148 \r
 149   public void setReadTimeoutInMs(int readTimeoutInMs) {\r
 150     this.readTimeoutInMs = readTimeoutInMs;\r
 151   }\r
 152 \r
 153   public RestAuthenticationMode getAuthenticationMode() {\r
 154     return authenticationMode;\r
 155   }\r
 156 \r
 157   public void setAuthenticationMode(RestAuthenticationMode authenticationMode) {\r
 158     this.authenticationMode = authenticationMode;\r
 159   }\r
 160 \r
 161   public String getBasicAuthUsername() {\r
 162     return basicAuthUsername;\r
 163   }\r
 164 \r
 165   public void setBasicAuthUsername(String basicAuthUsername) {\r
 166     this.basicAuthUsername = basicAuthUsername;\r
 167   }\r
 168 \r
 169   public String getBasicAuthPassword() {\r
 170     return basicAuthPassword;\r
 171   }\r
 172 \r
 173   public void setBasicAuthPassword(String basicAuthPassword) {\r
 174     this.basicAuthPassword = basicAuthPassword;\r
 175   }\r
 176 \r
 177   public String getSslProtocol() {\r
 178     return sslProtocol;\r
 179   }\r
 180 \r
 181   public void setSslProtocol(String sslProtocol) {\r
 182     this.sslProtocol = sslProtocol;\r
 183   }\r
 184 \r
 185   /**\r
 186    * Returns Client configured for SSL\r
 187    */\r
 188   public Client getClient() throws Exception {\r
 189 \r
 190     switch (authenticationMode) {\r
 191       case SSL_BASIC:\r
 192       case SSL_CERT:\r
 193         return getClient(true);\r
 194 \r
 195       default:\r
 196         // return basic non-authenticating HTTP client\r
 197         return getClient(false);\r
 198     }\r
 199 \r
 200   }\r
 201 \r
 202   protected void setupSecureSocketLayerClientConfig(ClientConfig clientConfig) throws Exception {\r
 203     // Check to see if we need to perform proper validation of\r
 204     // the certificate chains.\r
 205     TrustManager[] trustAllCerts = null;\r
 206     if (validateServerCertChain) {\r
 207       if (truststoreFilename != null) {\r
 208         System.setProperty(TRUST_STORE_PROPERTY, truststoreFilename);\r
 209       } else {\r
 210         throw new IllegalArgumentException("Trust store filename must be set!");\r
 211       }\r
 212 \r
 213     } else {\r
 214 \r
 215       // We aren't validating certificates, so create a trust manager that does\r
 216       // not validate certificate chains.\r
 217       trustAllCerts = new TrustManager[] {new X509TrustManager() {\r
 218         public X509Certificate[] getAcceptedIssuers() {\r
 219           return null;\r
 220         }\r
 221 \r
 222         public void checkClientTrusted(X509Certificate[] certs, String authType) {}\r
 223 \r
 224         public void checkServerTrusted(X509Certificate[] certs, String authType) {}\r
 225       }};\r
 226     }\r
 227 \r
 228     // Set up the SSL context, keystore, etc. to use for our connection\r
 229     // to the AAI.\r
 230     SSLContext ctx = SSLContext.getInstance(sslProtocol);\r
 231     KeyManagerFactory kmf = KeyManagerFactory.getInstance(KEYSTORE_ALGORITHM);\r
 232     KeyStore ks = KeyStore.getInstance(KEYSTORE_TYPE);\r
 233 \r
 234     char[] pwd = null;\r
 235     if (clientCertPassword != null) {\r
 236       pwd = clientCertPassword.toCharArray();\r
 237     }\r
 238 \r
 239     if (clientCertFileName != null) {\r
 240       FileInputStream fin = new FileInputStream(clientCertFileName);\r
 241 \r
 242       // Load the keystore and initialize the key manager factory.\r
 243       ks.load(fin, pwd);\r
 244       kmf.init(ks, pwd);\r
 245 \r
 246       ctx.init(kmf.getKeyManagers(), trustAllCerts, null);\r
 247     } else {\r
 248       ctx.init(null, trustAllCerts, null);\r
 249     }\r
 250 \r
 251     // Are we performing validation of the server host name?\r
 252     if (validateServerHostname) {\r
 253       clientConfig.getProperties().put(HTTPSProperties.PROPERTY_HTTPS_PROPERTIES,\r
 254           new HTTPSProperties(null, ctx));\r
 255 \r
 256     } else {\r
 257       clientConfig.getProperties().put(HTTPSProperties.PROPERTY_HTTPS_PROPERTIES,\r
 258           new HTTPSProperties(new HostnameVerifier() {\r
 259             @Override\r
 260             public boolean verify(String str, SSLSession sslSession) {\r
 261               return true;\r
 262             }\r
 263           }, ctx));\r
 264     }\r
 265   }\r
 266 \r
 267 \r
 268   /**\r
 269    * Returns client instance\r
 270    * \r
 271    * @param useSsl - used to configure the client with an ssl-context or just plain http\r
 272    */\r
 273   protected Client getClient(boolean useSsl) throws Exception {\r
 274 \r
 275     ClientConfig clientConfig = new DefaultClientConfig();\r
 276 \r
 277     if (useSsl) {\r
 278       setupSecureSocketLayerClientConfig(clientConfig);\r
 279     }\r
 280 \r
 281     // Finally, create and initialize our client...\r
 282     Client client = null;\r
 283     client = Client.create(clientConfig);\r
 284     client.setConnectTimeout(connectTimeoutInMs);\r
 285     client.setReadTimeout(readTimeoutInMs);\r
 286 \r
 287     // ...and return it to the caller.\r
 288     return client;\r
 289   }\r
 290 \r
 291   public String getBasicAuthenticationCredentials() {\r
 292 \r
 293     String usernameAndPassword = getBasicAuthUsername() + ":" + getBasicAuthPassword();\r
 294     return "Basic " + java.util.Base64.getEncoder().encodeToString(usernameAndPassword.getBytes());\r
 295   }\r
 296 \r
 297   /* \r
 298    * Added a little bit of logic to obfuscate passwords that could be logged out\r
 299    * (non-Javadoc)\r
 300    * @see java.lang.Object#toString()\r
 301    */\r
 302   @Override\r
 303   public String toString() {\r
 304     return "RestClientBuilder [validateServerHostname=" + validateServerHostname\r
 305         + ", validateServerCertChain=" + validateServerCertChain + ", "\r
 306         + (clientCertFileName != null ? "clientCertFileName=" + clientCertFileName + ", " : "")\r
 307         + (clientCertPassword != null\r
 308             ? "clientCertPassword="\r
 309                 + java.util.Base64.getEncoder().encodeToString(clientCertPassword.getBytes()) + ", "\r
 310             : "")\r
 311         + (truststoreFilename != null ? "truststoreFilename=" + truststoreFilename + ", " : "")\r
 312         + "connectTimeoutInMs=" + connectTimeoutInMs + ", readTimeoutInMs=" + readTimeoutInMs + ", "\r
 313         + (authenticationMode != null ? "authenticationMode=" + authenticationMode + ", " : "")\r
 314         + (basicAuthUsername != null ? "basicAuthUsername=" + basicAuthUsername + ", " : "")\r
 315         + (basicAuthPassword != null ? "basicAuthPassword="\r
 316             + java.util.Base64.getEncoder().encodeToString(basicAuthPassword.getBytes()) : "")\r
 317         + "]";\r
 318   }\r
 319 \r
 320 }\r