core/src/main/java/com/att/cadi/config/SecurityInfo.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  ******************************************************************************/\r
  24 package com.att.cadi.config;\r
  25 \r
  26 import java.io.File;\r
  27 import java.io.FileInputStream;\r
  28 import java.io.IOException;\r
  29 import java.net.InetAddress;\r
  30 import java.net.UnknownHostException;\r
  31 import java.rmi.AccessException;\r
  32 import java.security.GeneralSecurityException;\r
  33 import java.security.KeyStore;\r
  34 import java.security.cert.CertificateException;\r
  35 import java.security.cert.X509Certificate;\r
  36 import java.util.ArrayList;\r
  37 \r
  38 import javax.net.ssl.HostnameVerifier;\r
  39 import javax.net.ssl.HttpsURLConnection;\r
  40 import javax.net.ssl.KeyManager;\r
  41 import javax.net.ssl.KeyManagerFactory;\r
  42 import javax.net.ssl.SSLContext;\r
  43 import javax.net.ssl.SSLSession;\r
  44 import javax.net.ssl.SSLSocketFactory;\r
  45 import javax.net.ssl.TrustManager;\r
  46 import javax.net.ssl.TrustManagerFactory;\r
  47 import javax.net.ssl.X509KeyManager;\r
  48 import javax.net.ssl.X509TrustManager;\r
  49 \r
  50 import com.att.cadi.Access;\r
  51 import com.att.cadi.Access.Level;\r
  52 import com.att.cadi.util.MaskFormatException;\r
  53 import com.att.cadi.util.NetMask;\r
  54 \r
  55 public class SecurityInfo {\r
  56         private static final String SECURITY_ALGO = "RSA";\r
  57         private static final String HTTPS_PROTOCOLS = "https.protocols";\r
  58         private static final String JDK_TLS_CLIENT_PROTOCOLS = "jdk.tls.client.protocols";\r
  59 \r
  60         public static final String HTTPS_PROTOCOLS_DEFAULT = "TLSv1.1,TLSv1.2";\r
  61         public static final String REGEX_COMMA = "\\s*,\\s*";\r
  62         public static final String SslKeyManagerFactoryAlgorithm;\r
  63         \r
  64         private SSLSocketFactory scf;\r
  65         private X509KeyManager[] km;\r
  66         private X509TrustManager[] tm;\r
  67         public final String default_alias;\r
  68         private NetMask[] trustMasks;\r
  69         private SSLContext ctx;\r
  70         private HostnameVerifier maskHV;\r
  71 \r
  72         // Change Key Algorithms for IBM's VM.  Could put in others, if needed.\r
  73         static {\r
  74                 if(System.getProperty("java.vm.vendor").equalsIgnoreCase("IBM Corporation")) {\r
  75                         SslKeyManagerFactoryAlgorithm = "IbmX509";\r
  76                 } else {\r
  77                         SslKeyManagerFactoryAlgorithm = "SunX509";\r
  78                 }\r
  79         }\r
  80         \r
  81 \r
  82         public SecurityInfo(final Access access) throws GeneralSecurityException, IOException {\r
  83                 // reuse DME2 Properties for convenience if specific Properties don't exist\r
  84                 String keyStore = access.getProperty(Config.CADI_KEYSTORE,\r
  85                                 access.getProperty(Config.AFT_DME2_KEYSTORE,null));\r
  86                 String keyStorePasswd = access.getProperty(Config.CADI_KEYSTORE_PASSWORD,\r
  87                                 access.getProperty(Config.AFT_DME2_KEYSTORE_PASSWORD, null));\r
  88                 keyStorePasswd = keyStorePasswd==null?null:access.decrypt(keyStorePasswd,false);\r
  89                 String trustStore = access.getProperty(Config.CADI_TRUSTSTORE,\r
  90                                 access.getProperty(Config.AFT_DME2_TRUSTSTORE, null));\r
  91                 String trustStorePasswd = access.getProperty(Config.CADI_TRUSTSTORE_PASSWORD,\r
  92                                 access.getProperty(Config.AFT_DME2_TRUSTSTORE_PASSWORD,null));\r
  93                 trustStorePasswd = trustStorePasswd==null?null:access.decrypt(trustStorePasswd,false);\r
  94                 default_alias = access.getProperty(Config.CADI_ALIAS, \r
  95                                 access.getProperty(Config.AFT_DME2_CLIENT_SSL_CERT_ALIAS,null));\r
  96                 \r
  97                 String keyPasswd = access.getProperty(Config.CADI_KEY_PASSWORD,null);\r
  98                 keyPasswd = keyPasswd==null?keyStorePasswd:access.decrypt(keyPasswd,false);\r
  99                 String tips=access.getProperty(Config.CADI_TRUST_MASKS, null);\r
 100                 if(tips!=null) {\r
 101                         access.log(Level.INIT,"Explicitly accepting valid X509s from",tips);\r
 102                         String[] ipsplit = tips.split(REGEX_COMMA);\r
 103                         trustMasks = new NetMask[ipsplit.length];\r
 104                         for(int i=0;i<ipsplit.length;++i) {\r
 105                                 try {\r
 106                                         trustMasks[i]=new NetMask(ipsplit[i]);\r
 107                                 } catch (MaskFormatException e) {\r
 108                                         throw new AccessException("Invalid IP Mask in " + Config.CADI_TRUST_MASKS,e);\r
 109                                 }\r
 110                         }\r
 111                 }\r
 112                 String https_protocols = Config.logProp(access,Config.CADI_PROTOCOLS, \r
 113                                 access.getProperty(Config.AFT_DME2_SSL_INCLUDE_PROTOCOLS, \r
 114                                         access.getProperty(HTTPS_PROTOCOLS,HTTPS_PROTOCOLS_DEFAULT)\r
 115                                         ));\r
 116                 System.setProperty(HTTPS_PROTOCOLS,https_protocols);\r
 117                 System.setProperty(JDK_TLS_CLIENT_PROTOCOLS, https_protocols);\r
 118                 \r
 119                 KeyManagerFactory kmf = KeyManagerFactory.getInstance(SslKeyManagerFactoryAlgorithm);\r
 120                 File file;\r
 121 \r
 122 \r
 123                 if(keyStore==null || keyStorePasswd == null) { \r
 124                         km = new X509KeyManager[0];\r
 125                 } else {\r
 126                         ArrayList<X509KeyManager> kmal = new ArrayList<X509KeyManager>();\r
 127                         for(String ksname : keyStore.split(REGEX_COMMA)) {\r
 128                                 file = new File(ksname);\r
 129                                 String keystoreFormat;\r
 130                                 if(ksname.endsWith("pkcs12")) {\r
 131                                         keystoreFormat = "PKCS12";\r
 132                                 } else {\r
 133                                         keystoreFormat = "JKS";\r
 134                                 }\r
 135                                 if(file.exists()) {\r
 136                                         FileInputStream fis = new FileInputStream(file);\r
 137                                         try {\r
 138                                                 KeyStore ks = KeyStore.getInstance(keystoreFormat);\r
 139                                                 ks.load(fis, keyStorePasswd.toCharArray());\r
 140                                                 kmf.init(ks, keyPasswd.toCharArray());\r
 141                                         } finally {\r
 142                                                 fis.close();\r
 143                                         }\r
 144                                 }\r
 145                         }\r
 146                         for(KeyManager km : kmf.getKeyManagers()) {\r
 147                                 if(km instanceof X509KeyManager) {\r
 148                                         kmal.add((X509KeyManager)km);\r
 149                                 }\r
 150                         }\r
 151                         km = new X509KeyManager[kmal.size()];\r
 152                         kmal.toArray(km);\r
 153                 }\r
 154 \r
 155                 TrustManagerFactory tmf = TrustManagerFactory.getInstance(SslKeyManagerFactoryAlgorithm);\r
 156                 if(trustStore!=null) {\r
 157                         for(String tsname : trustStore.split(REGEX_COMMA)) {\r
 158                                 file = new File(tsname);\r
 159                                 if(file.exists()) {\r
 160                                         FileInputStream fis = new FileInputStream(file);\r
 161                                         try {\r
 162                                                 KeyStore ts = KeyStore.getInstance("JKS");\r
 163                                                 ts.load(fis, trustStorePasswd.toCharArray());\r
 164                                                 tmf.init(ts); \r
 165                                         } finally {\r
 166                                                 fis.close();\r
 167                                         }\r
 168                                 }\r
 169                         }\r
 170                         TrustManager tms[] = tmf.getTrustManagers();\r
 171                         tm = new X509TrustManager[tms==null?0:tms.length];\r
 172                         for(int i=0;i<tms.length;++i) {\r
 173                                 try {\r
 174                                         tm[i]=(X509TrustManager)tms[i];\r
 175                                 } catch (ClassCastException e) {\r
 176                                         access.log(Level.WARN, "Non X509 TrustManager", tm[i].getClass().getName(),"skipped in SecurityInfo");\r
 177                                 }\r
 178                         }\r
 179                 }\r
 180                 \r
 181                 if(trustMasks!=null) {\r
 182                         final HostnameVerifier origHV = HttpsURLConnection.getDefaultHostnameVerifier();\r
 183                         HttpsURLConnection.setDefaultHostnameVerifier(maskHV = new HostnameVerifier() {\r
 184                                 @Override\r
 185                                 public boolean verify(final String urlHostName, final SSLSession session) {\r
 186                                         try {\r
 187                                                 // This will pick up /etc/host entries as well as DNS\r
 188                                                 InetAddress ia = InetAddress.getByName(session.getPeerHost());\r
 189                                                 for(NetMask tmask : trustMasks) {\r
 190                                                         if(tmask.isInNet(ia.getHostAddress())) {\r
 191                                                                 return true;\r
 192                                                         }\r
 193                                                 }\r
 194                                         } catch (UnknownHostException e) {\r
 195                                                 // It's ok. do normal Verify\r
 196                                         }\r
 197                                         return origHV.verify(urlHostName,session);\r
 198                                 };\r
 199                         });\r
 200                 }\r
 201                 ctx = SSLContext.getInstance("TLS");\r
 202                 ctx.init(km, tm, null);\r
 203                 SSLContext.setDefault(ctx);\r
 204                 scf = ctx.getSocketFactory();\r
 205         }\r
 206 \r
 207         /**\r
 208          * @return the scf\r
 209          */\r
 210         public SSLSocketFactory getSSLSocketFactory() {\r
 211                 return scf;\r
 212         }\r
 213 \r
 214         public SSLContext getSSLContext() {\r
 215                 return ctx;\r
 216         }\r
 217 \r
 218         /**\r
 219          * @return the km\r
 220          */\r
 221         public X509KeyManager[] getKeyManagers() {\r
 222                 return km;\r
 223         }\r
 224 \r
 225         public void checkClientTrusted(X509Certificate[] certarr) throws CertificateException {\r
 226                 for(X509TrustManager xtm : tm) {\r
 227                         xtm.checkClientTrusted(certarr, SECURITY_ALGO);\r
 228                 }\r
 229         }\r
 230 \r
 231         public void checkServerTrusted(X509Certificate[] certarr) throws CertificateException {\r
 232                 for(X509TrustManager xtm : tm) {\r
 233                         xtm.checkServerTrusted(certarr, SECURITY_ALGO);\r
 234                 }\r
 235         }\r
 236 \r
 237         public void setSocketFactoryOn(HttpsURLConnection hsuc) {\r
 238                 hsuc.setSSLSocketFactory(scf);\r
 239                 if(maskHV!=null && !maskHV.equals(hsuc.getHostnameVerifier())) {\r
 240                         hsuc.setHostnameVerifier(maskHV);\r
 241                 }\r
 242         }\r
 243 \r
 244 }\r