001/* 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved 005 * 006 * The contents of this file are subject to the terms 007 * of the Common Development and Distribution License 008 * (the License). You may not use this file except in 009 * compliance with the License. 010 * 011 * You can obtain a copy of the License at 012 * https://opensso.dev.java.net/public/CDDLv1.0.html or 013 * opensso/legal/CDDLv1.0.txt 014 * See the License for the specific language governing 015 * permission and limitations under the License. 016 * 017 * When distributing Covered Code, include this CDDL 018 * Header Notice in each file and include the License file 019 * at opensso/legal/CDDLv1.0.txt. 020 * If applicable, add the following below the CDDL Header, 021 * with the fields enclosed by brackets [] replaced by 022 * your own identifying information: 023 * "Portions Copyrighted [year] [name of copyright owner]" 024 * 025 * $Id: EncryptedAssertion.java,v 1.2 2008/06/25 05:47:41 qcheng Exp $ 026 * 027 * Portions Copyrighted 2015 ForgeRock AS. 028 */ 029package com.sun.identity.saml2.assertion; 030 031import java.security.PrivateKey; 032import java.util.Set; 033 034import com.sun.identity.saml2.common.SAML2Exception; 035 036/** 037 * The <code>EncryptedAssertion</code> represents an assertion in 038 * encrypted fashion, as defined by the XML Encryption Syntax and 039 * Processing specification [XMLEnc]. The EncryptedAssertion contains 040 * an <code>EncryptedData</code> and zero or more 041 * <code>EncryptedKey</code>s. 042 * @supported.all.api 043 */ 044public interface EncryptedAssertion extends EncryptedElement { 045 046 /** 047 * Decrypt the encrypted assertion. 048 * 049 * @param privateKeys Private keys of the recipient used to decrypt the secret key. 050 * @return an assertion that is decrypted from this object 051 * @exception SAML2Exception if it could not decrypt the assertion properly. 052 */ 053 public Assertion decrypt(Set<PrivateKey> privateKeys) throws SAML2Exception; 054 055}