SecurityUtils.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.  */
  20. package org.openspcoop2.security.message.utils;

  22. import java.security.KeyStore;
  23. import java.util.ArrayList;
  24. import java.util.List;

  26. import org.apache.commons.lang.StringUtils;
  27. import org.openspcoop2.core.config.MessageSecurityFlowParameter;
  28. import org.openspcoop2.core.config.PortaApplicativa;
  29. import org.openspcoop2.core.config.PortaDelegata;
  30. import org.openspcoop2.core.constants.CostantiProprieta;
  31. import org.openspcoop2.security.keystore.MerlinProvider;
  32. import org.openspcoop2.security.message.constants.SecurityConstants;
  33. import org.openspcoop2.utils.certificate.KeystoreParams;

  35. /**     
  36.  * SecurityUtils
  37.  *
  38.  * @author Poli Andrea (poli@link.it)
  39.  * @author $Author$
  40.  * @version $Rev$, $Date$
  41.  */
  42. public class SecurityUtils {
  43.     
  44.     private SecurityUtils() {}

  46.     public static List<KeystoreParams> readRequestKeystoreParams(PortaApplicativa porta) {
  47.         List<KeystoreParams> listKP = new ArrayList<>();
  48.         if(porta!=null && porta.getMessageSecurity()!=null && porta.getMessageSecurity().getRequestFlow()!=null &&
  49.                 porta.getMessageSecurity().getRequestFlow().sizeParameterList()>0) {
  50.             readStoreParams(listKP, porta.getMessageSecurity().getRequestFlow().getParameterList());
  51.         }
  52.         return listKP;
  53.     }
  54.     
  55.     public static List<KeystoreParams> readResponseKeystoreParams(PortaApplicativa porta) {
  56.         List<KeystoreParams> listKP = new ArrayList<>();
  57.         if(porta!=null && porta.getMessageSecurity()!=null && porta.getMessageSecurity().getResponseFlow()!=null &&
  58.                 porta.getMessageSecurity().getResponseFlow().sizeParameterList()>0) {
  59.             readStoreParams(listKP, porta.getMessageSecurity().getResponseFlow().getParameterList());
  60.         }
  61.         return listKP;
  62.     }
  63.     
  64.     public static List<KeystoreParams> readRequestKeystoreParams(PortaDelegata porta) {
  65.         List<KeystoreParams> listKP = new ArrayList<>();
  66.         if(porta!=null && porta.getMessageSecurity()!=null && porta.getMessageSecurity().getRequestFlow()!=null &&
  67.                 porta.getMessageSecurity().getRequestFlow().sizeParameterList()>0) {
  68.             readStoreParams(listKP, porta.getMessageSecurity().getRequestFlow().getParameterList());
  69.         }
  70.         return listKP;
  71.     }
  72.     
  73.     public static List<KeystoreParams> readResponseKeystoreParams(PortaDelegata porta) {
  74.         List<KeystoreParams> listKP = new ArrayList<>();
  75.         if(porta!=null && porta.getMessageSecurity()!=null && porta.getMessageSecurity().getResponseFlow()!=null &&
  76.                 porta.getMessageSecurity().getResponseFlow().sizeParameterList()>0) {
  77.             readStoreParams(listKP, porta.getMessageSecurity().getResponseFlow().getParameterList());
  78.         }
  79.         return listKP;
  80.     }
  81.     
  82.     private static void readStoreParams(List<KeystoreParams> listKP, List<MessageSecurityFlowParameter> list) {
  83.         
  84.         readKestoreParamsJose(listKP, list);
  85.         readTruststoreParamsJoseTls(listKP, list);
  86.         readTruststoreParamsJoseUseHeaders(listKP, list);
  87.         readKeystoreParamsJoseUseHeaders(listKP, list);
  88.         
  89.         readKeystoreParamsMerlin(listKP, list);
  90.         
  91.     }
  92.     
  93.     
  94.     // JOSE
  95.     
  96.     private static void readKestoreParamsJose(List<KeystoreParams> listKP, List<MessageSecurityFlowParameter> list) {
  97.         String pathJose = readProperty(list, SecurityConstants.JOSE_KEYSTORE_FILE);
  98.         if(pathJose!=null && StringUtils.isNotEmpty(pathJose)) {
  99.             // jose
  100.             KeystoreParams kp = new KeystoreParams();
  101.             kp.setPath(pathJose);
  102.             kp.setType(readProperty(list, SecurityConstants.JOSE_KEYSTORE_TYPE));
  103.             kp.setPassword(readProperty(list, SecurityConstants.JOSE_KEYSTORE_PSWD));
  104.             
  105.             kp.setCrls(readProperty(list, SecurityConstants.JOSE_KEYSTORE_CRL));
  106.             kp.setOcspPolicy(readProperty(list, SecurityConstants.JOSE_KEYSTORE_OCSP_POLICY));
  107.             
  108.             kp.setByokPolicy(readProperty(list, SecurityConstants.JOSE_KEYSTORE_BYOK_POLICY));
  109.             
  110.             kp.setKeyAlias(readProperty(list, SecurityConstants.JOSE_KEYSTORE_KEY_ALIAS));
  111.             kp.setKeyPassword(readProperty(list, SecurityConstants.JOSE_KEYSTORE_KEY_PSWD));
  112.             
  113.             kp.setKeyPairPublicKeyPath(readProperty(list, SecurityConstants.JOSE_KEYSTORE_PUBLIC_KEY));
  114.             kp.setKeyPairAlgorithm(readProperty(list, SecurityConstants.JOSE_KEYSTORE_KEY_ALGORITHM));
  115.             
  116.             listKP.add(kp);
  117.         }
  118.     }
  119.     
  120.     private static void readTruststoreParamsJoseTls(List<KeystoreParams> listKP, List<MessageSecurityFlowParameter> list) {
  121.         String pathJose = readProperty(list, SecurityConstants.JOSE_TRUSTSTORE_SSL_FILE);
  122.         if(pathJose!=null && StringUtils.isNotEmpty(pathJose)) {
  123.             // jose
  124.             KeystoreParams kp = new KeystoreParams();
  125.             kp.setPath(pathJose);
  126.             kp.setType(readProperty(list, SecurityConstants.JOSE_TRUSTSTORE_SSL_TYPE));
  127.             kp.setPassword(readProperty(list, SecurityConstants.JOSE_TRUSTSTORE_SSL_PSWD));
  128.             
  129.             kp.setCrls(readProperty(list, SecurityConstants.JOSE_TRUSTSTORE_SSL_CRL));
  130.             kp.setOcspPolicy(readProperty(list, SecurityConstants.JOSE_TRUSTSTORE_SSL_OCSP));
  131.             
  132.             kp.setDescription("TLS TrustStore");
  133.             
  134.             listKP.add(kp);
  135.         }
  136.     }
  137.     
  138.     private static void readTruststoreParamsJoseUseHeaders(List<KeystoreParams> listKP, List<MessageSecurityFlowParameter> list) {
  139.         String pathJose = readProperty(list, SecurityConstants.JOSE_USE_HEADERS_TRUSTSTORE_FILE);
  140.         if(pathJose!=null && StringUtils.isNotEmpty(pathJose)) {
  141.             // jose
  142.             KeystoreParams kp = new KeystoreParams();
  143.             kp.setPath(pathJose);
  144.             kp.setType(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_TRUSTSTORE_TYPE));
  145.             kp.setPassword(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_TRUSTSTORE_PASSWORD));
  146.             
  147.             kp.setCrls(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_TRUSTSTORE_CRL));
  148.             kp.setOcspPolicy(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_TRUSTSTORE_OCSP));
  149.             
  150.             kp.setKeyPairAlgorithm(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_TRUSTSTORE_KEY_PAIR_ALGORITHM));
  151.             
  152.             kp.setDescription("TrustStore Certificati X.509");
  153.             
  154.             listKP.add(kp);
  155.         }    
  156.     }
  157.     
  158.     private static void readKeystoreParamsJoseUseHeaders(List<KeystoreParams> listKP, List<MessageSecurityFlowParameter> list) {
  159.         String pathJose = readProperty(list, SecurityConstants.JOSE_USE_HEADERS_KEYSTORE_FILE);
  160.         if(pathJose!=null && StringUtils.isNotEmpty(pathJose)) {
  161.             
  162.             for (int i = 1; i < 11; i++) {
  163.             
  164.                 String user = readProperty(list, SecurityConstants.JOSE_USE_HEADERS_KEYSTORE_MAP_ALIAS_PW+i+SecurityConstants.JOSE_USE_HEADERS_KEYSTORE_MAP_ALIAS_PW_SUFFIX_ALIAS);
  165.                 if(user!=null) {
  166.                     // jose
  167.                     KeystoreParams kp = new KeystoreParams();
  168.                     kp.setPath(pathJose);
  169.                     kp.setType(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_KEYSTORE_TYPE));
  170.                     kp.setPassword(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_KEYSTORE_PASSWORD));
  171.                     
  172.                     kp.setKeyAlias(user);
  173.                     kp.setKeyPassword(readProperty(list, SecurityConstants.JOSE_USE_HEADERS_KEYSTORE_MAP_ALIAS_PW+i+SecurityConstants.JOSE_USE_HEADERS_KEYSTORE_MAP_ALIAS_PW_SUFFIX_PW));
  174.                     
  175.                     kp.setDescription("KeyStore Certificati X.509");
  176.                     
  177.                     listKP.add(kp);
  178.                 }
  179.                 
  180.             }
  181.             
  182.         }    
  183.     }
  184.     
  185.     
  186.     // MERLIN
  187.     
  188.     private static void readKeystoreParamsMerlin(List<KeystoreParams> listKP, List<MessageSecurityFlowParameter> list) {
  189.         
  190.         String prefix = readPrefix(list);
  191.         if(prefix==null || StringUtils.isEmpty(prefix)) {
  192.             return;
  193.         }
  194.         
  195.         String pathKeystore = readProperty(list, prefix+org.apache.wss4j.common.crypto.Merlin.KEYSTORE_FILE);
  196.         if(pathKeystore==null || StringUtils.isEmpty(pathKeystore)) {
  197.             pathKeystore = readProperty(list, prefix+org.apache.wss4j.common.crypto.Merlin.OLD_KEYSTORE_FILE);
  198.         }
  199.         
  200.         if(pathKeystore!=null && StringUtils.isNotEmpty(pathKeystore)) {
  201.             readKeystoreParamsMerlin(listKP, list, prefix, pathKeystore);
  202.         }    
  203.     }
  204.     private static void readKeystoreParamsMerlin(List<KeystoreParams> listKP, List<MessageSecurityFlowParameter> list, String prefix, String pathKeystore) {
  205.         KeystoreParams kp = new KeystoreParams();
  206.         kp.setPath(pathKeystore);
  207.         
  208.         String keyStoreType = readProperty(list, prefix+org.apache.wss4j.common.crypto.Merlin.KEYSTORE_TYPE);
  209.         if (keyStoreType == null) {
  210.             keyStoreType = KeyStore.getDefaultType();
  211.         }
  212.         kp.setType(keyStoreType);
  213.         kp.setPassword(readProperty(list, prefix+org.apache.wss4j.common.crypto.Merlin.KEYSTORE_PASSWORD));
  214.         
  215.         String crlLocations = readProperty(list, prefix+org.apache.wss4j.common.crypto.Merlin.X509_CRL_FILE);
  216.         if (crlLocations == null || StringUtils.isEmpty(crlLocations)) {
  217.             crlLocations = readProperty(list, SecurityConstants.SIGNATURE_CRL);
  218.         }
  219.         kp.setCrls(crlLocations);
  220.         kp.setOcspPolicy(readProperty(list, SecurityConstants.SIGNATURE_OCSP));
  221.         
  222.         String keyStoreByokPolicy = readProperty(list, prefix+org.apache.wss4j.common.crypto.Merlin.KEYSTORE_FILE+MerlinProvider.SUFFIX_BYOK);
  223.         if (keyStoreByokPolicy == null || StringUtils.isEmpty(keyStoreByokPolicy)) {
  224.             keyStoreByokPolicy = readProperty(list, prefix+org.apache.wss4j.common.crypto.Merlin.OLD_KEYSTORE_FILE+MerlinProvider.SUFFIX_BYOK);
  225.         }
  226.         kp.setByokPolicy(keyStoreByokPolicy);
  227.         
  228.         listKP.add(kp);
  229.         
  230.         readKeystoreAliasParamsMerlin(list, kp);
  231.     }
  232.     private static void readKeystoreAliasParamsMerlin(List<MessageSecurityFlowParameter> list, KeystoreParams kp) {
  233.         if(readKeystoreSignatureAliasParamsMerlin(list,  kp)) {
  234.             return;
  235.         }
  236.         if(readKeystoreEncryptAliasParamsMerlin(list, kp)) {
  237.             return;
  238.         }
  239.         if(readKeystoreUserAliasParamsMerlin(list, kp)) {
  240.             /**return;*/
  241.         }
  242.     }
  243.     private static boolean readKeystoreSignatureAliasParamsMerlin(List<MessageSecurityFlowParameter> list, KeystoreParams kp) {
  244.         String alias = readProperty(list, SecurityConstants.SIGNATURE_USER);
  245.         if (alias != null && StringUtils.isNotEmpty(alias)) {
  246.             kp.setKeyAlias(alias);
  247.             kp.setKeyPassword(readProperty(list, SecurityConstants.SIGNATURE_PASSWORD));
  248.             return true;
  249.         }
  250.         return false;
  251.     }
  252.     private static boolean readKeystoreEncryptAliasParamsMerlin(List<MessageSecurityFlowParameter> list, KeystoreParams kp) {   
  253.         String alias = readProperty(list, SecurityConstants.ENCRYPTION_USER);
  254.         if (alias != null && StringUtils.isNotEmpty(alias)) {
  255.             kp.setKeyAlias(alias);
  256.             String pwd = readProperty(list, SecurityConstants.ENCRYPTION_PASSWORD);
  257.             if (pwd == null || StringUtils.isEmpty(pwd)) {
  258.                 pwd = readProperty(list, SecurityConstants.DECRYPTION_PASSWORD);
  259.             }
  260.             kp.setKeyPassword(pwd);
  261.             return true;
  262.         }
  263.         
  264.         alias = readProperty(list, SecurityConstants.DECRYPTION_USER);
  265.         if (alias != null && StringUtils.isNotEmpty(alias)) {
  266.             kp.setKeyAlias(alias);
  267.             String pwd = readProperty(list, SecurityConstants.DECRYPTION_PASSWORD);
  268.             if (pwd == null || StringUtils.isEmpty(pwd)) {
  269.                 pwd = readProperty(list, SecurityConstants.ENCRYPTION_PASSWORD);
  270.             }
  271.             kp.setKeyPassword(pwd);
  272.             return true;
  273.         }
  274.         return false;
  275.     }
  276.     private static boolean readKeystoreUserAliasParamsMerlin(List<MessageSecurityFlowParameter> list, KeystoreParams kp) {  
  277.         
  278.         String alias = readProperty(list, SecurityConstants.USER);
  279.         if (alias != null && StringUtils.isNotEmpty(alias)) {
  280.             kp.setKeyAlias(alias);
  281.             String pwd = readProperty(list, SecurityConstants.SIGNATURE_PASSWORD);
  282.             if (pwd == null || StringUtils.isEmpty(pwd)) {
  283.                 pwd = readProperty(list, SecurityConstants.ENCRYPTION_PASSWORD);
  284.             }
  285.             if (pwd == null || StringUtils.isEmpty(pwd)) {
  286.                 pwd = readProperty(list, SecurityConstants.DECRYPTION_PASSWORD);
  287.             }
  288.             kp.setKeyPassword(pwd);
  289.             return true;
  290.         }
  291.         return false;
  292.     }
  293.     
  294.     private static String readPrefix(List<MessageSecurityFlowParameter> list) {
  295.         if(list==null || list.isEmpty()) {
  296.             return null;
  297.         }
  298.         String prefix = null;
  299.         for (MessageSecurityFlowParameter p : list) {
  300.             String propKey = p.getNome();
  301.             if (startsWith(propKey,org.apache.wss4j.common.crypto.Merlin.PREFIX)) {
  302.                 prefix = org.apache.wss4j.common.crypto.Merlin.PREFIX;
  303.                 return prefix;
  304.             } else if (startsWith(propKey,org.apache.wss4j.common.crypto.Merlin.OLD_PREFIX)) {
  305.                 prefix = org.apache.wss4j.common.crypto.Merlin.OLD_PREFIX;
  306.                 return prefix;
  307.             }
  308.         }
  309.         return prefix;
  310.     }
  311.     private static boolean startsWith(String propKey, String check) {
  312.         return propKey.startsWith(check)
  313.                 ||
  314.                 (propKey.contains(CostantiProprieta.KEY_PROPERTIES_CUSTOM_SEPARATOR) && isStartsWithConfidentialPropertyCustomSeparator(propKey,check))
  315.                 ||
  316.                 (propKey.contains(CostantiProprieta.KEY_PROPERTIES_DEFAULT_SEPARATOR) && isStartsWithConfidentialPropertyDefaultSeparator(propKey,check));
  317.     }
  318.     
  319.     
  320.     // UTILITY
  321.     
  322.     private static String readProperty(List<MessageSecurityFlowParameter> list, String name) {
  323.         if(list!=null && !list.isEmpty()) {
  324.             for (MessageSecurityFlowParameter messageSecurityFlowParameter : list) {
  325.                 if(isProperty(messageSecurityFlowParameter, name)) {
  326.                     if(messageSecurityFlowParameter.getValore()!=null && StringUtils.isNotEmpty(messageSecurityFlowParameter.getValore())) {
  327.                         return messageSecurityFlowParameter.getValore();
  328.                     }
  329.                     return null;
  330.                 }
  331.             }
  332.         }
  333.         return null;
  334.     }
  335.     private static boolean isProperty(MessageSecurityFlowParameter messageSecurityFlowParameter, String name) {
  336.         return (messageSecurityFlowParameter.getNome()!=null && 
  337.                 (
  338.                         messageSecurityFlowParameter.getNome().equals(name)
  339.                         ||
  340.                         (messageSecurityFlowParameter.getNome().contains(CostantiProprieta.KEY_PROPERTIES_CUSTOM_SEPARATOR) && isConfidentialPropertyCustomSeparator(messageSecurityFlowParameter.getNome(),name))
  341.                         ||
  342.                         (messageSecurityFlowParameter.getNome().contains(CostantiProprieta.KEY_PROPERTIES_DEFAULT_SEPARATOR) && isConfidentialPropertyDefaultSeparator(messageSecurityFlowParameter.getNome(),name))
  343.                 )
  344.         );
  345.     }   
  346.     private static boolean isConfidentialPropertyCustomSeparator(String nome, String check) {
  347.         String [] tmp = nome.split(CostantiProprieta.KEY_PROPERTIES_CUSTOM_SEPARATOR);
  348.         return (tmp!=null && tmp.length>1 && tmp[1]!=null &&
  349.             tmp[1].equals(check));
  350.     }
  351.     private static boolean isConfidentialPropertyDefaultSeparator(String nome, String check) {
  352.         String [] tmp = nome.split(CostantiProprieta.KEY_PROPERTIES_DEFAULT_SEPARATOR);
  353.         return (tmp!=null && tmp.length>1 && tmp[1]!=null &&
  354.             tmp[1].equals(check)) ;
  355.     }
  356.     private static boolean isStartsWithConfidentialPropertyCustomSeparator(String nome, String check) {
  357.         String [] tmp = nome.split(CostantiProprieta.KEY_PROPERTIES_CUSTOM_SEPARATOR);
  358.         return (tmp!=null && tmp.length>1 && tmp[1]!=null &&
  359.             tmp[1].startsWith(check));
  360.     }
  361.     private static boolean isStartsWithConfidentialPropertyDefaultSeparator(String nome, String check) {
  362.         String [] tmp = nome.split(CostantiProprieta.KEY_PROPERTIES_DEFAULT_SEPARATOR);
  363.         return (tmp!=null && tmp.length>1 && tmp[1]!=null &&
  364.             tmp[1].startsWith(check)) ;
  365.     }
  366. }
Created with JaCoCo 0.8.8.202204050719