SAMLUtilities.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.  */

  21. package org.openspcoop2.security.message.saml;

  23. import java.util.ArrayList;
  24. import java.util.List;
  25. import java.util.Map;
  26. import java.util.Properties;

  28. import org.joda.time.DateTime;
  29. import org.openspcoop2.core.commons.DBUtils;
  30. import org.openspcoop2.security.SecurityException;
  31. import org.openspcoop2.security.keystore.KeystoreConstants;
  32. import org.openspcoop2.security.keystore.MerlinProvider;
  33. import org.openspcoop2.security.message.MessageSecurityContext;
  34. import org.openspcoop2.security.message.constants.SecurityConstants;
  35. import org.openspcoop2.utils.certificate.KeystoreType;



  39. /**
  40.  * SAMLUtilities
  41.  *  
  42.  * @author Andrea Poli (apoli@link.it)
  43.  * @author $Author$
  44.  * @version $Rev$, $Date$
  45.  */
  46. public class SAMLUtilities {
  47.     
  48.     private SAMLUtilities() {}

  50.     public static DateTime minutesOperator(DateTime dateTime,Integer intValue){
  51.         if(intValue!=null){
  52.             DateTime dateTimeRes = null;
  53.             if(intValue.intValue() == 0){
  54.                 dateTimeRes = dateTime;
  55.             }
  56.             else if(intValue.intValue() > 0){
  57.                 dateTimeRes = dateTime.plusMinutes(intValue.intValue());
  58.             }
  59.             else {/**if(intValue.intValue() < 0){*/
  60.                 dateTimeRes = dateTime.minusMinutes(intValue.intValue()*-1);
  61.             }
  62.             /**else {
  63.                 dateTimeRes = dateTime;
  64.             }*/
  65.             return dateTimeRes;
  66.         }
  67.         else {
  68.             return dateTime;
  69.         }
  70.     }

  72.     public static void injectSignaturePropRefIdIntoSamlConfig(Map<String,Object> wssProperties) throws SecurityException {
  73.         
  74.         if (wssProperties != null && wssProperties.size() > 0) {
  75.             
  76.             // preprocess per saml
  77.             List<String> keys = new ArrayList<>();
  78.             keys.addAll(wssProperties.keySet());
  79.             for (String key : keys) {
  80.                 Object oValue = wssProperties.get(key);
  81.                 String value = null;
  82.                 if(oValue instanceof String) {
  83.                     value = (String) oValue;
  84.                 }
  85.                 
  86.                 if(SecurityConstants.SIGNATURE_PARTS.equals(key)) {
  87.                     if(value!=null && value.contains(SecurityConstants.SAML_NAMESPACE_TEMPLATE)) {
  88.                         String samlVersion = null;
  89.                         if(wssProperties.containsKey(SecurityConstants.SAML_PROF_REF_ID)) {
  90.                             Object o = wssProperties.get(SecurityConstants.SAML_PROF_REF_ID);
  91.                             if(o instanceof Properties) {
  92.                                 Properties samlConfig = (Properties) o;
  93.                                 if(samlConfig.containsKey(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_VERSION)) {
  94.                                     samlVersion = samlConfig.getProperty(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_VERSION);
  95.                                 }
  96.                             }
  97.                         }
  98.                         if(samlVersion==null) {
  99.                             throw new SecurityException("SAML version undefined");
  100.                         }
  101.                         if(SecurityConstants.SAML_VERSION_XMLCONFIG_ID_VALUE_20.equals(samlVersion)) {
  102.                             while(value.contains(SecurityConstants.SAML_NAMESPACE_TEMPLATE)) {
  103.                                 value = value.replace(SecurityConstants.SAML_NAMESPACE_TEMPLATE, SAMLConstants.SAML_20_NAMESPACE);
  104.                             }
  105.                         }
  106.                         else {
  107.                             while(value.contains(SecurityConstants.SAML_NAMESPACE_TEMPLATE)) {
  108.                                 value = value.replace(SecurityConstants.SAML_NAMESPACE_TEMPLATE, SAMLConstants.SAML_11_NAMESPACE);
  109.                             }
  110.                         }
  111.                         wssProperties.remove(key);
  112.                         wssProperties.put(key, value);
  113.                     }
  114.                 }
  115.                 else if(
  116.                         (SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key) || 
  117.                         SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG_HOLDER_OF_KEY.equals(key))
  118.                         &&
  119.                         (value!=null && wssProperties.containsKey(value))
  120.                         ){
  121.                     injectSignaturePropRefIdIntoSamlConfig(wssProperties, key, value);
  122.                 }
  123.             }
  124.         }
  125.     }
  126.     
  127.     private static void injectSignaturePropRefIdIntoSamlConfig(Map<String,Object> wssProperties, String key, String value) throws SecurityException {
  128.         // raccolgo parametri 
  129.         Properties signaturePropRefiId = null;
  130.         String signatureAlias = null;
  131.         String signaturePassword = null;
  132.         if(wssProperties.containsKey(SecurityConstants.SIGNATURE_PROPERTY_REF_ID)) {
  133.             Object o = wssProperties.get(SecurityConstants.SIGNATURE_PROPERTY_REF_ID);
  134.             if(o instanceof Properties) {
  135.                 signaturePropRefiId = (Properties) o;
  136.             }
  137.         }
  138.         if(wssProperties.containsKey(SecurityConstants.SIGNATURE_USER)) {
  139.             Object o = wssProperties.get(SecurityConstants.SIGNATURE_USER);
  140.             if(o instanceof String) {
  141.                 signatureAlias = (String) o;
  142.             }
  143.         }
  144.         else if(wssProperties.containsKey(SecurityConstants.USER)) {
  145.             Object o = wssProperties.get(SecurityConstants.USER);
  146.             if(o instanceof String) {
  147.                 signatureAlias = (String) o;
  148.             }
  149.         }
  150.         if(wssProperties.containsKey(SecurityConstants.SIGNATURE_PASSWORD)) {
  151.             Object o = wssProperties.get(SecurityConstants.SIGNATURE_PASSWORD);
  152.             if(o instanceof String) {
  153.                 signaturePassword = (String) o;
  154.             }
  155.         }
  156.         
  157.         // algoritmi
  158.         String signatureAlgorithm = null;
  159.         String signatureDigestAlgorithm = null;
  160.         String signatureC14nAlgorithmExclusive = null;
  161.         if(SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key)) {
  162.             if(wssProperties.containsKey(SecurityConstants.SIGNATURE_ALGORITHM)) {
  163.                 Object o = wssProperties.get(SecurityConstants.SIGNATURE_ALGORITHM);
  164.                 if(o instanceof String) {
  165.                     signatureAlgorithm = (String) o;
  166.                 }
  167.             }
  168.             if(wssProperties.containsKey(SecurityConstants.SIGNATURE_DIGEST_ALGORITHM)) {
  169.                 Object o = wssProperties.get(SecurityConstants.SIGNATURE_DIGEST_ALGORITHM);
  170.                 if(o instanceof String) {
  171.                     signatureDigestAlgorithm = (String) o;
  172.                 }
  173.             }
  174.             if(wssProperties.containsKey(SecurityConstants.SIGNATURE_C14N_ALGORITHM)) {
  175.                 Object o = wssProperties.get(SecurityConstants.SIGNATURE_C14N_ALGORITHM);
  176.                 if(o instanceof String) {
  177.                     signatureC14nAlgorithmExclusive = (String) o;
  178.                 }
  179.             }
  180.         }
  181.         
  182.         // Prelevo saml comfig
  183.         Object o = wssProperties.get(value);
  184.         if(o instanceof Properties) {
  185.             Properties samlConfig = (Properties) o;
  186.             
  187.             String type = signaturePropRefiId.getProperty("org.apache.ws.security.crypto.merlin.keystore.type");
  188.             if(type!=null) {
  189.                 if(SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key)) {
  190.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_CRYPTO_PROP_KEYSTORE_TYPE, type);
  191.                 }
  192.                 else {
  193.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SUBJECT_CONFIRMATION_METHOD_HOLDER_OF_KEY_CRYPTO_PROPERTIES_KEYSTORE_TYPE, type);
  194.                 }
  195.             }
  196.             String file = signaturePropRefiId.getProperty("org.apache.ws.security.crypto.merlin.file");
  197.             if(file==null) {
  198.                 throw new SecurityException("Keystore file in signaturePropRefId undefined");
  199.             }
  200.             if(SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key)) {
  201.                 samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_CRYPTO_PROP_KEYSTORE_FILE, file);
  202.             }
  203.             else {
  204.                 samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SUBJECT_CONFIRMATION_METHOD_HOLDER_OF_KEY_CRYPTO_PROPERTIES_KEYSTORE_FILE, file);
  205.             }
  206.             
  207.             String byokPolicy = signaturePropRefiId.getProperty("org.apache.ws.security.crypto.merlin.file"+MerlinProvider.SUFFIX_BYOK);
  208.             if(byokPolicy!=null) {
  209.                 if(SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key)) {
  210.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_CRYPTO_PROP_KEYSTORE_BYOK_POLICY, byokPolicy);
  211.                 }
  212.                 else {
  213.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SUBJECT_CONFIRMATION_METHOD_HOLDER_OF_KEY_CRYPTO_PROPERTIES_KEYSTORE_BYOK_POLICY, byokPolicy);
  214.                 }
  215.             }
  216.             
  217.             String password = signaturePropRefiId.getProperty("org.apache.ws.security.crypto.merlin.keystore.password");
  218.             if(password==null && MessageSecurityContext.isPasswordRequired(signaturePropRefiId, false)) {
  219.                 throw new SecurityException("Keystore password in signaturePropRefId undefined");
  220.             }
  221.             if(password!=null) {
  222.                 if(SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key)) {
  223.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_CRYPTO_PROP_KEYSTORE_PASSWORD, password);
  224.                 }
  225.                 else {
  226.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SUBJECT_CONFIRMATION_METHOD_HOLDER_OF_KEY_CRYPTO_PROPERTIES_KEYSTORE_PASSWORD, password);
  227.                 }
  228.             }
  229.             
  230.             if(signatureAlias==null) {
  231.                 throw new SecurityException("Signature alias undefined");
  232.             }
  233.             if(SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key)) {
  234.                 samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_KEY_NAME, signatureAlias);
  235.             }
  236.             else {
  237.                 samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SUBJECT_CONFIRMATION_METHOD_HOLDER_OF_KEY_CRYPTO_ALIAS, signatureAlias);
  238.             }
  239.             
  240.             if(SecurityConstants.SAML_SIGNATURE_PARAM_CONVERTO_INTO_SAML_CONFIG.equals(key)) {
  241.                 if(signaturePassword==null && MessageSecurityContext.isPasswordRequired(signaturePropRefiId, true)) {
  242.                     throw new SecurityException("Signature password undefined");
  243.                 }
  244.                 if(signaturePassword!=null) {
  245.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_KEY_PASSWORD, signaturePassword);
  246.                 }
  247.                 
  248.                 if(signatureAlgorithm!=null) {
  249.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_SIGNATURE_ALGORITHM, signatureAlgorithm);
  250.                 }
  251.                 if(signatureDigestAlgorithm!=null) {
  252.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_SIGNATURE_DIGEST_ALGORITHM, signatureDigestAlgorithm);
  253.                 }
  254.                 if(signatureC14nAlgorithmExclusive!=null) {
  255.                     samlConfig.put(SAMLBuilderConfigConstants.SAML_CONFIG_BUILDER_SIGN_ASSERTION_SIGNATURE_CANONICALIZATION_ALGORITHM, signatureC14nAlgorithmExclusive);
  256.                 }
  257.             }
  258.         }
  259.     }
  260.     
  261.     public static Properties convertToMerlinProperties(String keystoreType,String keystoreFile, String keystorePassword, boolean useKeystoreCache, String byokPolicy) throws SecurityException {
  262.         Properties p = new Properties();
  263.         if(useKeystoreCache) {
  264.             p.put(KeystoreConstants.PROPERTY_PROVIDER, KeystoreConstants.PROVIDER_GOVWAY);
  265.         }
  266.         else {
  267.             p.put(KeystoreConstants.PROPERTY_PROVIDER, KeystoreConstants.OLD_PROVIDER_DEFAULT);
  268.         }
  269.         if(keystoreType!=null) {
  270.             p.put(KeystoreConstants.PROPERTY_KEYSTORE_TYPE, keystoreType);
  271.         }
  272.         if(keystoreFile==null) {
  273.             throw new SecurityException("Keystore file undefined");
  274.         }
  275.         p.put(KeystoreConstants.PROPERTY_KEYSTORE_PATH, keystoreFile);
  276.         if(keystorePassword==null) {
  277.             boolean required = true;
  278.             if(KeystoreType.JKS.isType(keystoreType)) {
  279.                 required = DBUtils.isKeystoreJksPasswordRequired();
  280.             }
  281.             else if(KeystoreType.PKCS12.isType(keystoreType)) {
  282.                 required = DBUtils.isKeystorePkcs12PasswordRequired();
  283.             }
  284.             if(required) {
  285.                 throw new SecurityException("Keystore password undefined");
  286.             }
  287.         }
  288.         if(keystorePassword!=null) {
  289.             p.put(KeystoreConstants.PROPERTY_KEYSTORE_PASSWORD, keystorePassword);
  290.         }
  291.         if(byokPolicy!=null) {
  292.             p.put(KeystoreConstants.PROPERTY_KEYSTORE_PATH_BYOK, byokPolicy);
  293.         }
  294.         return p;
  295.     }
  296. }
Created with JaCoCo 0.8.8.202204050719