a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: FSNameRegistrationResponse.java,v 1.3 2008/06/25 05:46:45 qcheng Exp $
ccf9d4a5c6453fa9f8b839baeee25147865fbb7dJames Phillpotts * Portions Copyrighted 2014-2016 ForgeRock AS.
ccf9d4a5c6453fa9f8b839baeee25147865fbb7dJames Phillpottsimport static org.forgerock.openam.utils.Time.*;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.FSUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.IFSConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.message.common.FSMsgException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLResponderException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLVersionMismatchException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.protocol.AbstractResponse;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.xmlsig.XMLSignatureManager;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.encode.URLEncDec;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class has methods to create <code>NameRegistrationResponse</code>
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @supported.all.api
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class FSNameRegistrationResponse extends AbstractResponse {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Default Constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster StatusCode statusCode = new StatusCode(IFSConstants.SAML_SUCCESS);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.Constructor", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of <code>RelayState</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of <code>RelayState</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setRelayState(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Set the value of <code>RelayState</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param relayState the value of <code>RelayState</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getRelayState()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of <code>id</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of <code>id</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setID(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of <code>id</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param id the value of <code>id</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getID()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of <code>ProviderID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of <code>ProviderID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setProviderId(String).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of providerID attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param providerId the value of providerID attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getProviderId()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns signed <code>XML</code> representation of this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return xmlString signed <code>XML</code> representation of this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the signed <code>NameRegistrationResponse</code> string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return signatureString the signed <code>NameRegistrationResponse</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor creates the <code>FSNameRegistrationResponse</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param responseID the value of <code>ResponseID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param inResponseTo the value of <code>InResponseTo</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param status the <code>Status</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param providerId the value of <code>ProviderID</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param relayState the value of <code>RelayState</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error creating this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public FSNameRegistrationResponse(String responseID, String inResponseTo,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((responseID == null) || (responseID.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("errorGenerateID",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("Response: inResponseTo is null.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("Response: missing <Status>.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingElement",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor creates the <code>FSNameRegistrationResponse</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * from Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param root the Document Element objec.t
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error creating this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if there is an error creating this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public FSNameRegistrationResponse(Element root) throws
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("FSNameRegistrationResponse.parseXML:" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster " null input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster (!tag.equals("RegisterNameIdentifierResponse"))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseXML: wrong"+
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // Attribute ResponseID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((responseID == null) || (responseID.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseXML: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "Reponse doesn't have ResponseID.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingAttribute",args);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster parseMajorVersion(root.getAttribute("MajorVersion"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster parseMinorVersion(root.getAttribute("MinorVersion"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // Attribute InResponseTo
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster inResponseTo = root.getAttribute("InResponseTo");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseXML: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "Response doesn't have InResponseTo.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String[] args = { IFSConstants.IN_RESPONSE_TO };
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingAttribute",args);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // Attribute IssueInstant
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String instantString = root.getAttribute("IssueInstant");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((instantString == null) || (instantString.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse(Element): " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "missing IssueInstant");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String[] args = { IFSConstants.ISSUE_INSTANT };
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingAttribute",args);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster issueInstant = DateUtils.stringToDate(instantString);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "FSNameRegistrationResponse(Element):" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster " could not parse IssueInstant:" , e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((childName = child.getLocalName()) != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse: " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "included more than one <Status>");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if (childName.equals(IFSConstants.SIGNATURE)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse:" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster " included more than one providerId");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster providerId = XMLUtils.getElementValue((Element) child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster relayState = XMLUtils.getElementValue((Element) child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse: " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } // end if childName != null
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } // end for loop
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "FSNameRegistrationResponse: missing element <Status>.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "FSNameRegistrationResponse: missing element providerId.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster //check for signature
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster List signs = XMLUtils.getElementsByTagNameNS1(root,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse(Element): " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "included more than one Signature element.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setMinorVersion(int)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param version the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getMinorVersion()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the Response <code>Status</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the Response <code>Status</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setStatus(Status)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the Response <code>Status</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param status the Response <code>Status</code object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getStatus
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>MajorVersion</code> by parsing the version string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param majorVer a String representing the <code>MajorVersion</code> to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException on error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException when the version mismatchs.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("Response(Element): invalid MajorVersion", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (majorVersion != SAMLConstants.PROTOCOL_MAJOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (majorVersion > SAMLConstants.PROTOCOL_MAJOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("Response(Element):MajorVersion of"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + " the Response is too high.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLVersionMismatchException(FSUtils.BUNDLE_NAME,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("Response(Element):MajorVersion of"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + " the Response is too low.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLVersionMismatchException(FSUtils.BUNDLE_NAME,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>MinorVersion</code> by parsing the version string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param minorVer a String representing the <code>MinorVersion</code> to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException when the version mismatchs.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private void parseMinorVersion(String minorVer) throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "FSRegisResp(Element): "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "invalid MinorVersion", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (minorVersion > IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSRegisResp(Element):MinorVersion of"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + " the Response is too high.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("responseVersionTooHigh",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if (minorVersion < IFSConstants.FF_11_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSRegisResp(Element):MinorVersion of"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + " the Response is too low.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("responseVersionTooLow",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>FSNameRegistrationResponse</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param xml the XML string to be parsed.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>FSNameRegistrationResponsee</code> object created from
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * the XML string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is error creating the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static FSNameRegistrationResponse parseXML(String xml)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Document doc = XMLUtils.toDOMDocument(xml, FSUtils.debug);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("FSNameRegistrationResponse.parseXML: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "Error while parsing input xml string");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("parseError", null, ex);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the string representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This method translates the response to an XML string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return An XML String representing the Response.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException on error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return this.toXMLString(true, true);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the Logout Response.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNS : Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS : Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error converting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * this object to a string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNS, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return toXMLString(includeNS, declareNS, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the Logout Response.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNS Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeHeader Determines whether the output include the xml
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * declaration header.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error converting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * this object to a string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNS, boolean declareNS,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append("<?xml version=\"1.0\" encoding=\"").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(SAMLConstants.DEFAULT_ENCODING).append("\" ?>\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String instantString = DateUtils.toUTCDateFormat(issueInstant);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((providerId == null) || (providerId.length() == 0)){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.toXMLString: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "providerId is null in the response with responseId:"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("nullProviderID",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((responseID != null) && (inResponseTo != null)){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append("RegisterNameIdentifierResponse").append(uriLIB);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (minorVersion == IFSConstants.FF_11_PROTOCOL_MINOR_VERSION &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append(" ResponseID=\"").append(responseID).append("\" ").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(" InResponseTo=\"").append(inResponseTo).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(" MajorVersion=\"").append(majorVersion).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(" MinorVersion=\"").append(minorVersion).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(" IssueInstant=\"").append(instantString).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append("<").append(prefixLIB).append("ProviderID").append(">").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append("</").append(prefixLIB).append("ProviderID").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append("<").append(prefixLIB).append("RelayState").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns <code>FSNameRegistrationResponse</code> object. The object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * is created by parsing an Base64 encode Name Registration Response
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param encodedRes the encoded response string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * creating this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if there is an error
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * creating this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static FSNameRegistrationResponse parseBASE64EncodedString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String encodedRes) throws FSMsgException, SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String decodedNameRegRes = new String(Base64.decode(encodedRes));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("FSNameRegistrationResponse."
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "parseBASE64EncodedString: decoded input string: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "FSNameRegistrationResponse.parseBASE64EncodedString"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + ": null String passed in as argument.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a Base64 Encoded String.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a Base64 Encoded String.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error encoding
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * the string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toBASE64EncodedString() throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((responseID == null) || (responseID.length() == 0)){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "FSNameRegistrationResponse.toBASE64EncodedString: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "couldn't generate ResponseID.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("errorGenerateID",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return Base64.encode(this.toXMLString().getBytes());
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Signs the Name Registration Response.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param certAlias the Certificate Alias.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if this object cannot be signed.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void signXML(String certAlias) throws SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("FSNameRegistrationResponse.signXML: Called");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("FSNameRegistrationResponse.signXML: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "the assertion is already signed.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLResponderException(FSUtils.BUNDLE_NAME,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (certAlias == null || certAlias.length() == 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLResponderException(FSUtils.BUNDLE_NAME,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XMLSignatureManager manager = XMLSignatureManager.getInstance();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (minorVersion == IFSConstants.FF_11_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster signatureString = manager.signXML(this.toXMLString(true, true),
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster certAlias, IFSConstants.DEF_SIG_ALGO, IFSConstants.ID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.id, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster signatureString = manager.signXML(this.toXMLString(true, true),
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.getResponseID(), false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("invalid minor version.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XMLUtils.toDOMDocument(signatureString, FSUtils.debug)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLResponderException(FSUtils.BUNDLE_NAME,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Unsupported operation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the Signature.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param elem the Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if success otherwise false.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns an URL Encoded String.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a url encoded query string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toURLEncodedQueryString() throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((providerId == null) || (providerId.length() == 0)){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse."
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "toURLEncodedQueryString: providerId is null in "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "the response ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("nullProviderIdInRequest",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((responseID == null) || (responseID.length() == 0)){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationRequest."
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "toURLEncodedQueryString: couldn't generate "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "responseID.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("errorGenerateID",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster StringBuffer urlEncodedAuthnReq = new StringBuffer(300);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(majorVersion).append(IFSConstants.AMPERSAND);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(minorVersion).append(IFSConstants.AMPERSAND);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationRequest."
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "toURLEncodedQueryString: issueInstant missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String[] args = { IFSConstants.ISSUE_INSTANT };
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingAttribute",args);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (providerId != null && !providerId.equals("")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (relayState != null && relayState.length() > 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster URLEncDec.encode(status.getStatusCode().getValue())).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns <code>FSNameRegistrationLogoutResponse</code> object. The
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * object is creating by parsing the <code>HttpServletRequest</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param request the <code>HttpServletRequest</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if there is an error
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * creating this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static FSNameRegistrationResponse parseURLEncodedRequest(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster HttpServletRequest request) throws FSMsgException, SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSNameRegistrationResponse retNameRegistrationResponse =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("checking minor version");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Integer.parseInt(request.getParameter("MajorVersion"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Integer.parseInt(request.getParameter("MinorVersion"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "EncodedRequest: version parsing error:" + ex);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("invalidNumber",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (request.getParameter("ResponseID")!= null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "EncodedRequest: Response ID is null" );
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingAttribute",args);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String instantString = request.getParameter("IssueInstant");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (instantString == null || instantString.length() == 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "EncodedRequest: Issue Instant is null" );
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String[] args = { IFSConstants.ISSUE_INSTANT };
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingAttribute",args);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "EncodedRequest: Can not parse Issue Instant", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (request.getParameter("ProviderID")!= null){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "EncodedRequest: Provider ID is null " );
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingElement",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (request.getParameter("RelayState")!= null){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (request.getParameter("InResponseTo")!= null){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("Status : " + request.getParameter("Value"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster retNameRegistrationResponse.status = new Status(statusCode);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "EncodedRequest: Status Value is null " );
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException("missingElement",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("Returning registration response Object");