SAMLCallbackHandler.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.io.IOException;
  24. import java.security.cert.X509Certificate;
  25. import java.util.ArrayList;
  26. import java.util.Collections;
  27. import java.util.List;

  29. import javax.security.auth.callback.Callback;
  30. import javax.security.auth.callback.CallbackHandler;
  31. import javax.security.auth.callback.UnsupportedCallbackException;

  33. import org.apache.wss4j.common.crypto.Crypto;
  34. import org.apache.wss4j.common.crypto.CryptoType;
  35. import org.apache.wss4j.common.saml.SAMLCallback;
  36. import org.apache.wss4j.common.saml.bean.AttributeBean;
  37. import org.apache.wss4j.common.saml.bean.AttributeStatementBean;
  38. import org.apache.wss4j.common.saml.bean.AudienceRestrictionBean;
  39. import org.apache.wss4j.common.saml.bean.AuthenticationStatementBean;
  40. import org.apache.wss4j.common.saml.bean.ConditionsBean;
  41. import org.apache.wss4j.common.saml.bean.KeyInfoBean;
  42. import org.apache.wss4j.common.saml.bean.KeyInfoBean.CERT_IDENTIFIER;
  43. import org.apache.wss4j.common.saml.bean.SubjectBean;
  44. import org.apache.wss4j.common.saml.bean.SubjectConfirmationDataBean;
  45. import org.apache.wss4j.common.saml.bean.SubjectLocalityBean;
  46. import org.apache.wss4j.common.saml.bean.Version;
  47. import org.apache.wss4j.common.saml.builder.SAML1Constants;
  48. import org.apache.wss4j.common.saml.builder.SAML2Constants;
  49. import org.joda.time.DateTime;

  51. /**
  52.  * SAMLCallbackHandler
  53.  *  
  54.  * @author Andrea Poli (apoli@link.it)
  55.  * @author $Author$
  56.  * @version $Rev$, $Date$
  57.  */
  58. public class SAMLCallbackHandler implements CallbackHandler {


  61.     
  62.     // ---- INSTANCE -----
  63.     
  64.     private SAMLBuilderConfig samlBuilderConfig = null;
  65.     public SAMLCallbackHandler(SAMLBuilderConfig config) throws IOException{
  66.         if(config==null){
  67.             throw new IOException("SAMLBuilderConfig undefined");
  68.         }
  69.         this.samlBuilderConfig = config;
  70.     }
  71.     

  73.     @Override
  74.     public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException {
  75.         
  76.         for (int i = 0; i < callbacks.length; i++) {
  77.             if (callbacks[i] instanceof SAMLCallback) {
  78.                 SAMLCallback callback = (SAMLCallback) callbacks[i];
  79.                 
  80.                 DateTime now = new DateTime();
  81.                 
  82.                 
  83.                 // *** SamlVersion ***
  84.                 
  85.                 callback.setSamlVersion(this.samlBuilderConfig.getVersion());
  86.                 
  87.                 
  88.                 // *** Issuer ***
  89.                 
  90.                 callback.setIssuer(this.samlBuilderConfig.getIssuerValue());
  91.                 callback.setIssuerQualifier(this.samlBuilderConfig.getIssuerQualifier());
  92.                 callback.setIssuerFormat(this.samlBuilderConfig.getIssuerFormat());
  93.                 
  94.                 
  95.                 // *** Signature ***
  96.                 
  97.                 boolean signAssertion = this.samlBuilderConfig.isSignAssertion();
  98.                 callback.setSignAssertion(signAssertion);
  99.                 if(signAssertion){
  100.                 
  101.                     try{
  102.                         callback.setIssuerCrypto(this.samlBuilderConfig.getSignAssertionCrypto());
  103.                     }catch(Exception e){
  104.                         throw new IOException(e.getMessage(),e);
  105.                     }
  106.                     callback.setIssuerKeyName(this.samlBuilderConfig.getSignAssertionIssuerKeyName());
  107.                     callback.setIssuerKeyPassword(this.samlBuilderConfig.getSignAssertionIssuerKeyPassword());
  108.                     
  109.                     if(this.samlBuilderConfig.getSignAssertionSignatureDigestAlgorithm()!=null)
  110.                         callback.setSignatureDigestAlgorithm(this.samlBuilderConfig.getSignAssertionSignatureDigestAlgorithm());
  111.                     if(this.samlBuilderConfig.getSignAssertionSignatureAlgorithm()!=null)
  112.                         callback.setSignatureAlgorithm(this.samlBuilderConfig.getSignAssertionSignatureAlgorithm());
  113.                     if(this.samlBuilderConfig.getSignAssertionCanonicalizationAlgorithm()!=null)
  114.                         callback.setCanonicalizationAlgorithm(this.samlBuilderConfig.getSignAssertionCanonicalizationAlgorithm());
  115.                     
  116.                     callback.setSendKeyValue(this.samlBuilderConfig.isSignAssertionSendKeyValue());
  117.                     
  118.                 }

  120.                 
  121.                 // *** Subject ***
  122.                 
  123.                 SubjectBean subjectBean = null;
  124.                 if(this.samlBuilderConfig.isSubjectEnabled()){

  126.                     subjectBean = new SubjectBean();
  127.                     
  128.                     subjectBean.setSubjectName(this.samlBuilderConfig.getSubjectNameIDValue());
  129.                     subjectBean.setSubjectNameIDFormat(this.samlBuilderConfig.getSubjectNameIDFormat());            
  130.                     subjectBean.setSubjectNameQualifier(this.samlBuilderConfig.getSubjectNameIDQualifier());
  131.                     
  132.                     subjectBean.setSubjectConfirmationMethod(this.samlBuilderConfig.getSubjectConfirmationMethod());
  133.                     
  134.                     SubjectConfirmationDataBean subjectConfirmationData = new SubjectConfirmationDataBean();
  135.                     DateTime subjectConfirmationMethod_notBefore = SAMLUtilities.minutesOperator(now,this.samlBuilderConfig.getSubjectConfirmationDataNotBefore());
  136.                     DateTime subjectConfirmationMethod_notOnOrAfter = SAMLUtilities.minutesOperator(now,this.samlBuilderConfig.getSubjectConfirmationDataNotOnOrAfter());
  137.                     subjectConfirmationData.setNotBefore(subjectConfirmationMethod_notBefore);
  138.                     subjectConfirmationData.setNotAfter(subjectConfirmationMethod_notOnOrAfter);
  139.                     subjectConfirmationData.setAddress(this.samlBuilderConfig.getSubjectConfirmationDataAddress());
  140.                     subjectConfirmationData.setInResponseTo(this.samlBuilderConfig.getSubjectConfirmationDataInResponseTo());
  141.                     subjectConfirmationData.setRecipient(this.samlBuilderConfig.getSubjectConfirmationDataRecipient());
  142.                     subjectBean.setSubjectConfirmationData(subjectConfirmationData);
  143.                     
  144.                     if (SAML2Constants.CONF_HOLDER_KEY.equals(this.samlBuilderConfig.getSubjectConfirmationMethod())
  145.                             || SAML1Constants.CONF_HOLDER_KEY.equals(this.samlBuilderConfig.getSubjectConfirmationMethod())) {
  146.                         try {
  147.                             KeyInfoBean keyInfo = createKeyInfo();
  148.                             subjectBean.setKeyInfo(keyInfo);
  149.                         } catch (Exception ex) {
  150.                             ex.printStackTrace(System.out);
  151.                             throw new IOException("Problem creating KeyInfo: " +  ex.getMessage());
  152.                         }
  153.                     }
  154.     
  155.                     callback.setSubject(subjectBean);
  156.                 }
  157.                 
  158.                 
  159.                 // *** ConditionsStatement ***
  160.                 
  161.                 if(this.samlBuilderConfig.isConditionsEnabled()){
  162.                     
  163.                     ConditionsBean conditions = new ConditionsBean();
  164.                     
  165.                     DateTime conditions_notBefore = SAMLUtilities.minutesOperator(now,this.samlBuilderConfig.getConditionsDataNotBefore());
  166.                     DateTime conditions_notOnOrAfter = SAMLUtilities.minutesOperator(now,this.samlBuilderConfig.getConditionsDataNotOnOrAfter());
  167.                     conditions.setNotBefore(conditions_notBefore);
  168.                     conditions.setNotAfter(conditions_notOnOrAfter);
  169.                     
  170.                     if(this.samlBuilderConfig.getConditionsAudienceURI()!=null){
  171.                         
  172.                         // per adesso viene gestita una unica audience uri
  173.                         
  174.                         List<AudienceRestrictionBean> lAudience = new ArrayList<AudienceRestrictionBean>();
  175.                         
  176.                         AudienceRestrictionBean arb = new AudienceRestrictionBean();
  177.                         List<String> uri = new ArrayList<>();
  178.                         uri.add(this.samlBuilderConfig.getConditionsAudienceURI());
  179.                         arb.setAudienceURIs(uri);
  180.                         lAudience.add(arb);
  181.                                                 
  182.                         conditions.setAudienceRestrictions(lAudience);
  183.                     }
  184.                     
  185.                     callback.setConditions(conditions);
  186.                 }
  187.                 
  188.             
  189.                 // *** AuthenticationStatement ***
  190.                 
  191.                 AuthenticationStatementBean authBean = null;
  192.                 if(this.samlBuilderConfig.isAuthnStatementEnabled()){
  193.                     
  194.                     authBean = new AuthenticationStatementBean();
  195.                     authBean.setSubject(subjectBean); // necessario per saml 1.1
  196.                     
  197.                     DateTime authnStatement_instant = null;
  198.                     if(this.samlBuilderConfig.getAuthnStatementDataInstantDate()!=null) {
  199.                         authnStatement_instant = new DateTime(this.samlBuilderConfig.getAuthnStatementDataInstantDate());
  200.                     }
  201.                     else {
  202.                         authnStatement_instant = SAMLUtilities.minutesOperator(now,this.samlBuilderConfig.getAuthnStatementDataInstant());
  203.                     }
  204.                     DateTime authnStatement_notOnOrAfter = null;
  205.                     if(this.samlBuilderConfig.getAuthnStatementDataNotOnOrAfterDate()!=null) {
  206.                         authnStatement_notOnOrAfter = new DateTime(this.samlBuilderConfig.getAuthnStatementDataNotOnOrAfterDate());
  207.                     }
  208.                     else {
  209.                         authnStatement_notOnOrAfter = SAMLUtilities.minutesOperator(now,this.samlBuilderConfig.getAuthnStatementDataNotOnOrAfter());
  210.                     }
  211.                     authBean.setAuthenticationInstant(authnStatement_instant);
  212.                     authBean.setSessionNotOnOrAfter(authnStatement_notOnOrAfter);
  213.                     
  214.                     if(this.samlBuilderConfig.getAuthnSubjectLocalityIpAddress()!=null || this.samlBuilderConfig.getAuthnSubjectLocalityDnsAddress()!=null) {
  215.                         SubjectLocalityBean subjectLocality = new SubjectLocalityBean();
  216.                         subjectLocality.setIpAddress(this.samlBuilderConfig.getAuthnSubjectLocalityIpAddress());
  217.                         subjectLocality.setDnsAddress(this.samlBuilderConfig.getAuthnSubjectLocalityDnsAddress());
  218.                         authBean.setSubjectLocality(subjectLocality);
  219.                     }
  220.                     
  221.                     authBean.setAuthenticationMethod(this.samlBuilderConfig.getAuthnStatementClassRef());
  222.                     
  223.                     callback.setAuthenticationStatementData(Collections.singletonList(authBean));
  224.                 }
  225.                 if(authBean==null && !Version.SAML_20.equals(this.samlBuilderConfig.getVersion()) && subjectBean!=null){
  226.                     // Nelle asserzioni saml1x il subject deve viaggiare dentro authn o authz
  227.                     authBean = new AuthenticationStatementBean();
  228.                     authBean.setSubject(subjectBean); // necessario per saml 1.1
  229.                     callback.setAuthenticationStatementData(Collections.singletonList(authBean));
  230.                 }

  232.                 
  233.                 
  234.                 // *** AttributeBean ***
  235.                 
  236.                 List<SAMLBuilderConfigAttribute> listAttributes = this.samlBuilderConfig.getAttributes();
  237.                 if(listAttributes!=null && listAttributes.size()>0){
  238.                     
  239.                     AttributeStatementBean attrBean = new AttributeStatementBean();
  240.                     attrBean.setSubject(subjectBean); // necessario per saml 1.1
  241.                     
  242.                     List<AttributeBean> attributeBeans = new ArrayList<AttributeBean>();
  243.                 
  244.                     for (SAMLBuilderConfigAttribute configAttribute : listAttributes) {
  245.                         AttributeBean attributeBean = new AttributeBean();
  246.                         attributeBean.setSimpleName(configAttribute.getSimpleName());
  247.                         attributeBean.setQualifiedName(configAttribute.getQualifiedName());
  248.                         attributeBean.setNameFormat(configAttribute.getFormatName());
  249.                         attributeBean.setAttributeValues(configAttribute.getValues());
  250.                         attributeBeans.add(attributeBean);
  251.                     }
  252.                     
  253.                     attrBean.setSamlAttributes(attributeBeans);
  254.                     callback.setAttributeStatementData(Collections.singletonList(attrBean));
  255.                 }
  256.                 
  257.             }
  258.         }
  259.     }

  261.     /*
  262.         SAML Holder of Key

  264.         This mechanism protects messages with a signed SAML assertion (issued by a trusted authority) 
  265.         carrying client public key and authorization information with integrity and confidentiality protection using mutual certificates. 
  266.         The Holder-of-Key (HOK) method establishes the correspondence between a SOAP message and the SAML assertions added to the SOAP message. 
  267.         The attesting entity includes a signature that can be verified with the key information in the confirmation method of the subject statements 
  268.         of the SAML assertion referenced for key info for the signature. 
  269.         For more information about the Holder of Key method, 
  270.         read the SAML Token Profile document at http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.0.pdf.

  272.         Under this scenario, the service does not trust the client directly, but requires the client to send a SAML assertion issued by a particular SAML authority. 
  273.         The client knows the recipient’s public key, but does not share a direct trust relationship with the recipient. 
  274.         The recipient has a trust relationship with the authority that issues the SAML token. 
  275.         The request is signed with the client’s private key and encrypted with the server certificate. 
  276.         The response is signed using the server’s private key and encrypted using the key provided within the HOK SAML assertion.
  277.     */
  278.     protected KeyInfoBean createKeyInfo() throws Exception {
  279.         Crypto crypto = this.samlBuilderConfig.getSubjectConfirmationMethodHolderOfKeyCrypto();
  280.         CryptoType cryptoType = new CryptoType(CryptoType.TYPE.ALIAS);
  281.         cryptoType.setAlias(this.samlBuilderConfig.getSubjectConfirmationMethodHolderOfKeyCryptoCertificateAlias());
  282.         X509Certificate[] certs = crypto.getX509Certificates(cryptoType);

  284.         KeyInfoBean keyInfo = new KeyInfoBean();
  285.         keyInfo.setCertificate(certs[0]);
  286.         keyInfo.setCertIdentifer(CERT_IDENTIFIER.X509_CERT);

  288.         return keyInfo;
  289.     }

  291. }
Created with JaCoCo 0.8.8.202204050719