com.sun.identity.saml2.assertion.impl.EncryptedAssertionImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openam-federation-library Show documentation
OpenAM Federation Library Components
There is a newer version: 14.8.4
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: EncryptedAssertionImpl.java,v 1.2 2008/06/25 05:47:43 qcheng Exp $
 *
 * Portions copyright 2014-2015 ForgeRock AS.
 */
package com.sun.identity.saml2.assertion.impl;

import java.security.PrivateKey;
import java.util.Set;

import org.w3c.dom.Document;
import org.w3c.dom.Element;

import com.sun.identity.shared.xml.XMLUtils;
import com.sun.identity.saml2.assertion.Assertion;
import com.sun.identity.saml2.assertion.EncryptedAssertion;
import com.sun.identity.saml2.assertion.AssertionFactory;
import com.sun.identity.saml2.common.SAML2Exception;
import com.sun.identity.saml2.common.SAML2SDKUtils;
import com.sun.identity.saml2.xmlenc.EncManager;

/**
 * The EncryptedAssertion represents an assertion in
 * encrypted fashion, as defined by the XML Encryption Syntax and
 * Processing specification [XMLEnc]. The EncryptedAssertion contains 
 * an EncryptedData and zero or more 
 * EncryptedKeys.
 */
public class EncryptedAssertionImpl extends EncryptedElementImpl implements EncryptedAssertion {
    public final String elementName = "EncryptedAssertion";

    // used by the constructors.
    private void parseElement(Element element)
        throws SAML2Exception
    {
        // make sure that the input xml block is not null
        if (element == null) {
            if (SAML2SDKUtils.debug.messageEnabled()) {
                SAML2SDKUtils.debug.message("EncryptedAssertionImpl."
                    + "parseElement: Input is null.");
            }
            throw new SAML2Exception(
                      SAML2SDKUtils.bundle.getString("nullInput"));
        }

        // Make sure this is an EncryptedAssertion.
        String tag = null;
        tag = element.getLocalName();
        if ((tag == null) || (!tag.equals(elementName))) {
            if (SAML2SDKUtils.debug.messageEnabled()) {
                SAML2SDKUtils.debug.message("EncryptedAssertionImpl." 
                     + "parseElement: not EncryptedAssertion.");
            }
            throw new SAML2Exception(
                      SAML2SDKUtils.bundle.getString("wrongInput"));
        }
        
    }

    /**
     * Class constructor with EncryptedAssertion in
     * Element format.
     */
    public EncryptedAssertionImpl(Element element) 
    throws SAML2Exception
    {
        parseElement(element);
        xmlString = XMLUtils.print(element);
    }

    /**
     * Class constructor with EncryptedAssertion in xml string
     * format.
     */
    public EncryptedAssertionImpl(String xmlString)
    throws SAML2Exception
    {
        Document doc = XMLUtils.toDOMDocument(xmlString, SAML2SDKUtils.debug);
        if (doc == null) {
            throw new SAML2Exception(
                SAML2SDKUtils.bundle.getString("errorObtainingElement"));
        }
        parseElement(doc.getDocumentElement());
        this.xmlString = xmlString;
    }

    @Override
    public Assertion decrypt(Set privateKeys) throws SAML2Exception {
        Element el = EncManager.getEncInstance().decrypt(xmlString, privateKeys);

        SAML2SDKUtils.decodeXMLToDebugLog("EncryptedAssertionImpl.decrypt: ", el);

        return AssertionFactory.getInstance().createAssertion(el);
    }
}