assertion/impl/EncryptedIDImpl.java

	EncryptedIDImpl.java revision 736d3f6b62297235a26138b2958b0a1ff96261cd
/**
 * 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: EncryptedIDImpl.java,v 1.2 2008/06/25 05:47:43 qcheng Exp $
 *
 * Portions copyright 2014 ForgeRock AS.
 *
 */


package com.sun.identity.saml2.assertion.impl;

import java.security.Key;

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

import com.sun.identity.shared.xml.XMLUtils;
import com.sun.identity.saml2.assertion.EncryptedID;
import com.sun.identity.saml2.assertion.NameID;
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;

/**
 * Java content class for EncryptedID element declaration.
 * <p>The following schema fragment specifies the expected
 *    content contained within this java content object.
 * <p>
 * <pre>
 * &lt;element name="EncryptedID"
 * type="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedElementType"/>
 * </pre>
 *
 */
public class EncryptedIDImpl extends EncryptedElementImpl implements EncryptedID
{
    public final String elementName = "EncryptedID";

    // 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("EncryptedIDImpl.parseElement: "
                    + "Input is null.");
            }
            throw new SAML2Exception(
                      SAML2SDKUtils.bundle.getString("nullInput"));
        }

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

    }

    /**
     * Class constructor with <code>EncryptedID</code> in
     * <code>Element</code> format.
     */
    public EncryptedIDImpl(Element element)
    throws SAML2Exception
    {
        parseElement(element);
        xmlString = XMLUtils.print(element);
    }

    /**
     * Class constructor with <code>EncryptedID</code> in xml string
     * format.
     */
    public EncryptedIDImpl(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;
    }

    /**
     * Returns an instance of <code>NameID</code> object.
     *
     * @param recipientPrivateKey Private key of the recipient used to
     *                            decrypt the secret key
     * @return <code>NameID</code> object.
     * @throws SAML2Exception if error occurs.
     */
    public NameID decrypt(Key recipientPrivateKey)
        throws SAML2Exception
    {
        Element el = EncManager.getEncInstance().
            decrypt(xmlString, recipientPrivateKey);

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

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