/*
* JBoss, Home of Professional Open Source.
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.identity.federation.core.saml.v2.factories;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import javax.xml.datatype.XMLGregorianCalendar;
import org.jboss.identity.federation.core.exceptions.ConfigurationException;
import org.jboss.identity.federation.core.saml.v2.holders.IDPInfoHolder;
import org.jboss.identity.federation.core.saml.v2.holders.IssuerInfoHolder;
import org.jboss.identity.federation.core.saml.v2.holders.SPInfoHolder;
import org.jboss.identity.federation.core.saml.v2.util.XMLTimeUtil;
import org.jboss.identity.federation.core.util.JAXBUtil;
import org.jboss.identity.federation.saml.v2.assertion.AssertionType;
import org.jboss.identity.federation.saml.v2.assertion.NameIDType;
import org.jboss.identity.federation.saml.v2.assertion.SubjectConfirmationDataType;
import org.jboss.identity.federation.saml.v2.assertion.SubjectConfirmationType;
import org.jboss.identity.federation.saml.v2.assertion.SubjectType;
import org.jboss.identity.federation.saml.v2.protocol.ResponseType;
import org.jboss.identity.federation.saml.v2.protocol.StatusCodeType;
import org.jboss.identity.federation.saml.v2.protocol.StatusType;
import org.xml.sax.SAXException;
/**
* Factory for the SAML v2 Authn Response
* @author Anil.Saldhana@redhat.com
* @since Dec 9, 2008
*/
public class JBossSAMLAuthnResponseFactory
{
private static String pkgName = "org.jboss.identity.federation.saml.v2.protocol:org.jboss.identity.xmlsec.w3.xmldsig:org.jboss.identity.xmlsec.w3.xmlenc";
private static String schemaLocation = "schema/saml/v2/saml-schema-protocol-2.0.xsd";
/**
* Create a StatusType given the status code uri
* @param statusCodeURI
* @return
*/
public static StatusType createStatusType(String statusCodeURI)
{
StatusCodeType sct = SAMLProtocolFactory.getObjectFactory().createStatusCodeType();
sct.setValue(statusCodeURI);
StatusType statusType = SAMLProtocolFactory.getObjectFactory().createStatusType();
statusType.setStatusCode(sct);
return statusType;
}
/**
* Create an empty response type
* @return
*/
public static ResponseType createResponseType()
{
return SAMLProtocolFactory.getObjectFactory().createResponseType();
}
/**
* Create a ResponseType
* @param ID id of the response
* @param sp holder with the information about the Service Provider
* @param idp holder with the information on the Identity Provider
* @param issuerInfo holder with information on the issuer
* @return
* @throws ConfigurationException
*/
public static ResponseType createResponseType(String ID, SPInfoHolder sp, IDPInfoHolder idp,
IssuerInfoHolder issuerInfo) throws ConfigurationException
{
String responseDestinationURI = sp.getResponseDestinationURI();
XMLGregorianCalendar issueInstant = XMLTimeUtil.getIssueInstant();
//Create an assertion
AssertionType assertionType = JBossSAMLBaseFactory.createAssertion();
assertionType.setID("ID_" + JBossSAMLBaseFactory.createUUID());
assertionType.setVersion(issuerInfo.getSamlVersion());
assertionType.setIssueInstant(issueInstant);
assertionType.setIssuer(issuerInfo.getIssuer());
//Create assertion -> subject
SubjectType subjectType = JBossSAMLBaseFactory.createSubject();
//subject -> nameid
NameIDType nameIDType = JBossSAMLBaseFactory.createNameID();
nameIDType.setFormat(idp.getNameIDFormat());
nameIDType.setValue(idp.getNameIDFormatValue());
JAXBElement<NameIDType> jaxbNameIDType = JBossSAMLBaseFactory.createNameID(nameIDType);
subjectType.getContent().add(jaxbNameIDType);
SubjectConfirmationType subjectConfirmation =
JBossSAMLBaseFactory.createSubjectConfirmation(idp.getSubjectConfirmationMethod());
SubjectConfirmationDataType subjectConfirmationData =
JBossSAMLBaseFactory.createSubjectConfirmationData(sp.getRequestID(),
responseDestinationURI, issueInstant);
subjectConfirmation.setSubjectConfirmationData(subjectConfirmationData);
JAXBElement<SubjectConfirmationType> jaxbSubjectConfirmationType =
JBossSAMLBaseFactory.createSubjectConfirmation(subjectConfirmation);
subjectType.getContent().add(jaxbSubjectConfirmationType);
assertionType.setSubject(subjectType);
ResponseType responseType = createResponseType(ID, issuerInfo, assertionType);
//InResponseTo ID
responseType.setInResponseTo(sp.getRequestID());
//Destination
responseType.setDestination(responseDestinationURI);
return responseType;
}
/**
* Create a Response Type
* @param ID
* @param issuerInfo
* @param assertionType
* @return
* @throws ConfigurationException
*/
public static ResponseType createResponseType(String ID, IssuerInfoHolder issuerInfo, AssertionType assertionType)
throws ConfigurationException
{
ResponseType responseType = SAMLProtocolFactory.getObjectFactory().createResponseType();
responseType.setVersion(issuerInfo.getSamlVersion());
//ID
responseType.setID(ID);
//Issuer
NameIDType issuer = issuerInfo.getIssuer();
responseType.setIssuer(issuer);
//Status
String statusCode = issuerInfo.getStatusCode();
if(statusCode == null)
throw new IllegalArgumentException("issuerInfo missing status code");
responseType.setStatus(createStatusType(statusCode) );
XMLGregorianCalendar issueInstant = XMLTimeUtil.getIssueInstant();
//IssueInstant
responseType.setIssueInstant(issueInstant);
if(assertionType.getIssueInstant() == null)
assertionType.setIssueInstant(issueInstant);
responseType.getAssertionOrEncryptedAssertion().add(assertionType);
return responseType;
}
/**
* Get the JAXB2 marshaller
* @return
* @throws JAXBException
* @throws SAXException
*/
public static Marshaller getMarshaller() throws SAXException, JAXBException
{
return JAXBUtil.getMarshaller(pkgName);
}
/**
* Get the JAXB2 Unmarshaller
* @return
* @throws SAXException
* @throws JAXBException
*/
public static Unmarshaller getUnmarshaller() throws JAXBException, SAXException
{
return JAXBUtil.getUnmarshaller(pkgName);
}
/**
* Get the validating marshaller
*
* @param schemaValidation Whether schema validation is needed
* @return
* @throws JAXBException
* @throws SAXException
*/
public static Marshaller getValidatingMarshaller(boolean schemaValidation) throws SAXException, JAXBException
{
if (schemaValidation)
return JAXBUtil.getValidatingMarshaller(pkgName, schemaLocation);
else
return JAXBUtil.getMarshaller(pkgName);
}
/**
* Get the JAXB2 Unmarshaller
* @return
* @throws SAXException
* @throws JAXBException
*/
public static Unmarshaller getValidatingUnmarshaller() throws JAXBException, SAXException
{
return JAXBUtil.getValidatingUnmarshaller(pkgName, schemaLocation);
}
}