samlresponse.java

开放源代码的基于SAML的单点登录系统

/* 
 * The OpenSAML License, Version 1. 
 * Copyright (c) 2002 
 * University Corporation for Advanced Internet Development, Inc. 
 * All rights reserved
 * 
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this 
 * list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution, if any, must include 
 * the following acknowledgment: "This product includes software developed by 
 * the University Corporation for Advanced Internet Development 
 * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
 * may appear in the software itself, if and wherever such third-party 
 * acknowledgments normally appear.
 * 
 * Neither the name of OpenSAML nor the names of its contributors, nor 
 * Internet2, nor the University Corporation for Advanced Internet Development, 
 * Inc., nor UCAID may be used to endorse or promote products derived from this 
 * software without specific prior written permission. For written permission, 
 * please contact [e-mail]
 * 
 * Products derived from this software may not be called OpenSAML, Internet2, 
 * UCAID, or the University Corporation for Advanced Internet Development, nor 
 * may OpenSAML appear in their name, without prior written permission of the 
 * University Corporation for Advanced Internet Development.
 * 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
 * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
 * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
 * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
 * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
package org.opensaml;

import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
import java.util.TimeZone;

import org.w3c.dom.*;

/**
 *  Represents a SAML protocol response
 *
 * @author     Scott Cantor
 * @created    March 18, 2002
 */
public class SAMLResponse extends SAMLSignedObject
{
    protected String responseId = new SAMLIdentifier().toString();
    protected String inResponseTo = null;
    protected Date issueInstant = new Date();
    protected String recipient = null;
    protected ArrayList assertions = new ArrayList();
    protected SAMLException e = null;

    /**
     *  Places the signature into the object's DOM to prepare for signing<p>

     * @throws SAMLException    Thrown if an error occurs while placing the signature
     */
    protected void insertSignature() throws SAMLException {
        root.insertBefore(getSignatureElement(),root.getFirstChild());
    }
    
    /**
     *  Default constructor
     */
    public SAMLResponse() {
    }

    /**
     *  Builds a SAML response out of its component parts<P>
     *
     *  If a signature object is provided, it is annotated with transforms to
     *  sign the entire response and use the SHA-1 digest algorithm.
     *
     * @param  inResponseTo       The request ID that prompted the response, if any
     * @param  recipient          The URL of the intended recipient of the response
     * @param  assertions         The SAML assertion(s) to return in the
     *      response, if any
     * @param  e                  The SAML error status information to return in
     *      the response, if any
     * @exception  SAMLException  Raised if a response cannot be constructed
     *      from the supplied information
     */
    public SAMLResponse(String inResponseTo, String recipient, Collection assertions, SAMLException e) throws SAMLException {
        this.inResponseTo = inResponseTo;
        this.recipient = recipient;
        this.e = e;

        if (assertions != null)
            this.assertions.addAll(assertions);
    }

    /**
     *  Reconstructs a response from a DOM tree
     *
     * @param  e                  The root of a DOM tree
     * @exception  SAMLException  Thrown if the object cannot be constructed
     */
    public SAMLResponse(Element e) throws SAMLException {
        fromDOM(e);
    }

    /**
     *  Reconstructs a response from a stream
     *
     * @param  in                   A stream containing XML
     * @exception  SAMLException  Raised if an exception occurs while constructing
     *                              the object.
     */
    public SAMLResponse(InputStream in) throws SAMLException {
        fromDOM(fromStream(in));
    }
    
    /**
     * @see org.opensaml.SAMLObject#fromDOM(org.w3c.dom.Element)
     */
    public void fromDOM(Element e) throws SAMLException {
        super.fromDOM(e);
        
        if (config.getBooleanProperty("org.opensaml.strict-dom-checking") && !XML.isElementNamed(e,XML.SAMLP_NS,"Response"))
            throw new MalformedException(SAMLException.RESPONDER,"SAMLResponse.fromDOM() requires samlp:Response at root");

        if (Integer.parseInt(e.getAttributeNS(null, "MajorVersion")) != 1)
            throw new MalformedException(SAMLException.VERSION,
                "SAMLResponse() detected incompatible response major version of " + e.getAttributeNS(null, "MajorVersion"));
            
        responseId = e.getAttributeNS(null, "ResponseID");
        e.setIdAttributeNode(e.getAttributeNodeNS(null, "ResponseID"), true);
        inResponseTo = e.getAttributeNS(null, "InResponseTo");
        recipient = e.getAttributeNS(null, "Recipient");

        try {
            SimpleDateFormat formatter = null;
            String dateTime = e.getAttributeNS(null, "IssueInstant");
            int dot = dateTime.indexOf('.');
            if (dot > 0) {
                formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
            }
            else {
                formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
            }
            formatter.setTimeZone(TimeZone.getTimeZone("GMT"));
            issueInstant = formatter.parse(dateTime);
        }
        catch (java.text.ParseException ex) {
            throw new MalformedException(SAMLException.RESPONDER, "SAMLResponse() detected an invalid datetime while parsing response", ex);
        }

        Element n = XML.getFirstChildElement(e, XML.SAMLP_NS, "Status");
            
        // Process status, and toss out any errors.
        this.e = SAMLException.getInstance(n);
        Iterator it=this.e.getCodes();
        if (it.hasNext())
            if (!it.next().equals(SAMLException.SUCCESS))
                throw this.e;

        n = XML.getNextSiblingElement(n, XML.SAML_NS, "Assertion");
        while (n != null) {
            assertions.add(new SAMLAssertion(n));
            n = XML.getNextSiblingElement(n, XML.SAML_NS, "Assertion");
        }
    }

    /**
     *  Gets the response ID
     *
     * @return    The response ID
     */
    public String getId() {
        return responseId;
    }

    /**
     *  Sets the response ID
     * 
     *  <b>NOTE:</b> Use this method with caution. Responses must contain unique identifiers
     *  and only specialized applications should need to explicitly assign an identifier.
     *
     * @param   id    The response ID
     */
    public void setId(String id) {
        if (XML.isEmpty(id))
            throw new IllegalArgumentException("id cannot be null");
        responseId = id;
        if (root != null) {
            unsign();
            ((Element)root).getAttributeNodeNS(null,"ResponseID").setNodeValue(id);
        }
    }

    /**
     *  Gets the InResponseTo attribute
     *