ConnettoreHTTPSProperties.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */


  22. package org.openspcoop2.core.commons;

  24. import java.io.File;
  25. import java.io.FileInputStream;
  26. import java.io.Serializable;
  27. import java.security.KeyStore;
  28. import java.util.Enumeration;
  29. import java.util.HashMap;
  30. import java.util.Map;
  31. import java.util.Properties;

  33. import javax.net.ssl.KeyManagerFactory;
  34. import javax.net.ssl.TrustManagerFactory;

  36. import org.openspcoop2.core.constants.CostantiConnettori;
  37. import org.openspcoop2.utils.certificate.KeystoreType;
  38. import org.openspcoop2.utils.transport.http.SSLConfig;

  40. /**
  41.  * Classe utilizzata per interprare le proprieta' https
  42.  *
  43.  *
  44.  * @author Poli Andrea (apoli@link.it)
  45.  * @author $Author$
  46.  * @version $Rev$, $Date$
  47.  */
  48. public class ConnettoreHTTPSProperties extends SSLConfig implements Serializable  {

  50.     /**
  51.      * 
  52.      */
  53.     private static final long serialVersionUID = 1L;

  55.     private static final String VALORE_DEFINITO_PER_PROPRIETA = "Valore definito per la proprietà '";
  56.     private static final String VALORE_NON_DEFINITO_PER_PROPRIETA = "Valore non definito per la proprietà '";
  57.     private static final String NON_VALIDO_TRUE_FALSE = "' non valido, valori accettati true/false";
  58.     private static final String DEFINITO_TRAMITE_PROPRIETA = "' nonostante sia stato definito un trustStore attraverso la proprietà '";
  59.     
  60.     public static ConnettoreHTTPSProperties readProperties(java.util.Map<String,String> properties) throws CoreException{
  61.         ConnettoreHTTPSProperties propertiesHTTPS = new ConnettoreHTTPSProperties();
  62.         
  63.         // AUTENTICAZIONE SERVER
  64.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_ALL_CERTS)!=null){
  65.             String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_ALL_CERTS).trim();
  66.             try{
  67.                 propertiesHTTPS.setTrustAllCerts(Boolean.parseBoolean(tmp));
  68.             }catch(Exception e){
  69.                 throw new CoreException(VALORE_DEFINITO_PER_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_TRUST_ALL_CERTS+NON_VALIDO_TRUE_FALSE);
  70.             }
  71.         }
  72.         if(!propertiesHTTPS.isTrustAllCerts() && properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_LOCATION)!=null){
  73.             readTrustStoreConfig(properties, propertiesHTTPS);
  74.         }
  75.         else if(propertiesHTTPS.isTrustAllCerts()){
  76.             // potrei accettare qualsiasi certificato ma validarlo rispetto a OCSP
  77.             readTrustStoreAllConfig(properties, propertiesHTTPS);
  78.         }
  79.         
  80.         // AUTENTICAZIONE CLIENT
  81.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_LOCATION)!=null){
  82.             readKeyStoreConfig(properties, propertiesHTTPS);
  83.         }   
  84.         
  85.         // HostName verifier
  86.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_HOSTNAME_VERIFIER)!=null){
  87.             String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_HOSTNAME_VERIFIER).trim();
  88.             try{
  89.                 propertiesHTTPS.setHostnameVerifier(Boolean.parseBoolean(tmp));
  90.             }catch(Exception e){
  91.                 throw new CoreException(VALORE_DEFINITO_PER_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_HOSTNAME_VERIFIER+NON_VALIDO_TRUE_FALSE);
  92.             }
  93.         }
  94.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_CLASSNAME_HOSTNAME_VERIFIER)!=null){
  95.             String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_CLASSNAME_HOSTNAME_VERIFIER).trim();
  96.             propertiesHTTPS.setClassNameHostnameVerifier(tmp);
  97.         }
  98.         
  99.         // TipologiaSSL: SSL, SSLv3, TLS, TLSv1
  100.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_SSL_TYPE)!=null){
  101.             String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_SSL_TYPE).trim();
  102.             propertiesHTTPS.setSslType(tmp);
  103.         }else{
  104.             propertiesHTTPS.setSslType(CostantiConnettori.CONNETTORE_HTTPS_SSL_TYPE_DEFAULT_VALUE); 
  105.         }
  106.         
  107.         // SecureRandom
  108.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_SECURE_RANDOM)!=null){
  109.             readSecureRandomConfig(properties, propertiesHTTPS);
  110.         }
  111.         
  112.         return propertiesHTTPS;
  113.     }
  114.     private static void readTrustStoreConfig(java.util.Map<String,String> properties, ConnettoreHTTPSProperties propertiesHTTPS) throws CoreException {
  115.         String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_LOCATION).trim();
  116.         propertiesHTTPS.setTrustStoreLocation(tmp);
  117.         
  118.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_TYPE)!=null){
  119.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_TYPE).trim();
  120.             propertiesHTTPS.setTrustStoreType(tmp);
  121.         }else{
  122.             propertiesHTTPS.setTrustStoreType(KeyStore.getDefaultType()); // JKS
  123.         }
  124.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_PASSWORD)!=null){
  125.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_PASSWORD).trim();
  126.             propertiesHTTPS.setTrustStorePassword(tmp);
  127.         }
  128.         else {
  129.             boolean throwException = true;
  130.             if( 
  131.                     (KeystoreType.JKS.isType(propertiesHTTPS.getTrustStoreType()) && !DBUtils.isTruststoreJksPasswordRequired())
  132.                     ||
  133.                     (KeystoreType.PKCS12.isType(propertiesHTTPS.getTrustStoreType()) && !DBUtils.isTruststorePkcs12PasswordRequired())
  134.             ) {
  135.                 throwException = false;
  136.             }
  137.             if(throwException) {
  138.                 throw new CoreException(VALORE_NON_DEFINITO_PER_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_PASSWORD+
  139.                         DEFINITO_TRAMITE_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_LOCATION+"'");
  140.             }
  141.         }
  142.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_MANAGEMENT_ALGORITHM)!=null){
  143.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_MANAGEMENT_ALGORITHM).trim();
  144.             propertiesHTTPS.setTrustManagementAlgorithm(tmp);
  145.         }else{
  146.             propertiesHTTPS.setTrustManagementAlgorithm(TrustManagerFactory.getDefaultAlgorithm());
  147.         }
  148.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_CRLS)!=null){
  149.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_CRLS).trim();
  150.             propertiesHTTPS.setTrustStoreCRLsLocation(tmp);
  151.         }
  152.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_OCSP_POLICY)!=null){
  153.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_OCSP_POLICY).trim();
  154.             propertiesHTTPS.setTrustStoreOCSPPolicy(tmp);
  155.         }
  156.     }
  157.     private static void readTrustStoreAllConfig(java.util.Map<String,String> properties, ConnettoreHTTPSProperties propertiesHTTPS) {
  158.         // potrei accettare qualsiasi certificato ma validarlo rispetto a OCSP
  159.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_OCSP_POLICY)!=null){
  160.             String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_OCSP_POLICY).trim();
  161.             propertiesHTTPS.setTrustStoreOCSPPolicy(tmp);
  162.             
  163.             if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_CRLS)!=null){
  164.                 tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_TRUST_STORE_CRLS).trim();
  165.                 propertiesHTTPS.setTrustStoreCRLsLocation(tmp);
  166.             }
  167.         }
  168.     }
  169.     private static void readKeyStoreConfig(java.util.Map<String,String> properties, ConnettoreHTTPSProperties propertiesHTTPS) throws CoreException {
  170.         String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_LOCATION).trim();
  171.         propertiesHTTPS.setKeyStoreLocation(tmp);
  172.         
  173.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_TYPE)!=null){
  174.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_TYPE).trim();
  175.             propertiesHTTPS.setKeyStoreType(tmp);
  176.         }else{
  177.             propertiesHTTPS.setKeyStoreType(KeyStore.getDefaultType()); // JKS
  178.         }
  179.         
  180.         readKeyStorePasswordConfig(properties, propertiesHTTPS);
  181.         
  182.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_ALIAS)!=null){
  183.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_ALIAS).trim();
  184.             propertiesHTTPS.setKeyAlias(tmp);
  185.         }
  186.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_MANAGEMENT_ALGORITHM)!=null){
  187.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_MANAGEMENT_ALGORITHM).trim();
  188.             propertiesHTTPS.setKeyManagementAlgorithm(tmp);
  189.         }else{
  190.             propertiesHTTPS.setKeyManagementAlgorithm(KeyManagerFactory.getDefaultAlgorithm());
  191.         }
  192.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_BYOK_POLICY)!=null){
  193.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_BYOK_POLICY).trim();
  194.             propertiesHTTPS.setKeyStoreBYOKPolicy(tmp);
  195.         }
  196.     }
  197.     private static void readKeyStorePasswordConfig(java.util.Map<String,String> properties, ConnettoreHTTPSProperties propertiesHTTPS) throws CoreException {
  198.         String tmp = null;
  199.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_PASSWORD)!=null){
  200.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_PASSWORD).trim();
  201.             propertiesHTTPS.setKeyStorePassword(tmp);
  202.         }
  203.         else{
  204.             boolean throwException = true;
  205.             if( 
  206.                     (KeystoreType.JKS.isType(propertiesHTTPS.getKeyStoreType()) && !DBUtils.isKeystoreJksPasswordRequired())
  207.                     ||
  208.                     (KeystoreType.PKCS12.isType(propertiesHTTPS.getKeyStoreType()) && !DBUtils.isKeystorePkcs12PasswordRequired())
  209.             ) {
  210.                 throwException = false;
  211.             }
  212.             if(throwException) {
  213.                 throw new CoreException(VALORE_NON_DEFINITO_PER_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_PASSWORD
  214.                         +DEFINITO_TRAMITE_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_LOCATION+"'");
  215.             }
  216.         }
  217.         if(properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_PASSWORD)!=null){
  218.             tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_KEY_PASSWORD).trim();
  219.             propertiesHTTPS.setKeyPassword(tmp);
  220.         }else{
  221.             boolean throwException = true;
  222.             if( 
  223.                     (KeystoreType.JKS.isType(propertiesHTTPS.getKeyStoreType()) && !DBUtils.isKeystoreJksKeyPasswordRequired())
  224.                     ||
  225.                     (KeystoreType.PKCS12.isType(propertiesHTTPS.getKeyStoreType()) && !DBUtils.isKeystorePkcs12KeyPasswordRequired())
  226.             ) {
  227.                 throwException = false;
  228.             }
  229.             if(throwException) {
  230.                 throw new CoreException(VALORE_NON_DEFINITO_PER_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_KEY_PASSWORD
  231.                         +DEFINITO_TRAMITE_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_KEY_STORE_LOCATION+"'");
  232.             }
  233.         }
  234.     }
  235.     private static void readSecureRandomConfig(java.util.Map<String,String> properties, ConnettoreHTTPSProperties propertiesHTTPS) throws CoreException {
  236.         String tmp = properties.get(CostantiConnettori.CONNETTORE_HTTPS_SECURE_RANDOM).trim();
  237.         try{
  238.             propertiesHTTPS.setSecureRandom(Boolean.parseBoolean(tmp));
  239.         }catch(Exception e){
  240.             throw new CoreException(VALORE_DEFINITO_PER_PROPRIETA+CostantiConnettori.CONNETTORE_HTTPS_SECURE_RANDOM+NON_VALIDO_TRUE_FALSE);
  241.         }
  242.         if(propertiesHTTPS.isSecureRandom() &&
  243.             properties.get(CostantiConnettori.CONNETTORE_HTTPS_SECURE_RANDOM_ALGORITHM)!=null){
  244.             propertiesHTTPS.setSecureRandomAlgorithm(properties.get(CostantiConnettori.CONNETTORE_HTTPS_SECURE_RANDOM_ALGORITHM).trim());
  245.         }
  246.     }
  247.     
  248.     public static ConnettoreHTTPSProperties readPropertyFile(String file, boolean sslConfigRequired) throws CoreException{
  249.         return readPropertyFile(new File(file), sslConfigRequired);
  250.     }
  251.     public static ConnettoreHTTPSProperties readPropertyFile(File file, boolean sslConfigRequired) throws CoreException{
  252.         
  253.         String prefix = "Config file ["+file.getAbsolutePath()+"] ";
  254.         if(!file.exists()) {
  255.             if(sslConfigRequired) {
  256.                 throw new CoreException(prefix+"not exists");
  257.             }
  258.             return null;
  259.         }
  260.         if(file.isDirectory()) {
  261.             throw new CoreException(prefix+"is directory");
  262.         }
  263.         if(!file.canRead()) {
  264.             throw new CoreException(prefix+"cannot read");
  265.         }
  266.         
  267.         Properties p = new Properties();
  268.         try (FileInputStream fin = new FileInputStream(file)){
  269.             p.load(fin);
  270.         }
  271.         catch(Exception e) {
  272.             throw new CoreException(e.getMessage(),e);
  273.         }
  274.         Map<String, String> pMap = new HashMap<>();
  275.         Enumeration<?> enP = p.keys();
  276.         while (enP.hasMoreElements()) {
  277.             String key = (String) enP.nextElement();
  278.             pMap.put(key, p.getProperty(key));
  279.         }
  280.         return readProperties(pMap); 
  281.     }
  282. }
Created with JaCoCo 0.8.8.202204050719