All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.wss.saml.Assertion Maven / Gradle / Ivy

Go to download

There is a newer version: 4.0.4
Show newest version
/*
 * Copyright (c) 2010, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

/*
 * Assertion.java
 *
 * Created on August 18, 2005, 12:08 PM
 */

package com.sun.xml.wss.saml;

import com.sun.xml.ws.security.Token;
import com.sun.xml.wss.XWSSecurityException;
import java.math.BigInteger;
import java.security.PrivateKey;
import java.security.PublicKey;
import java.security.cert.X509Certificate;
import java.util.List;
import javax.xml.crypto.dsig.DigestMethod;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

/**
 * This interface stands for Assertion element. An Assertion is a package
 * of information that supplies one or more Statement made by an
 * issuer. There are three kinds of assertions Authentication, Authorization
 * Decision and Attribute assertion.
 * 
{@code
 *
 *       
 *         
 *         
 *             
 *                 CN=SAML User,OU=SU,O=SAML User,L=Los Angeles,ST=CA,C=US
 *             
 *
 *             
 *                 urn:oasis:names:tc:SAML:1.0:cm:sender-vouches
 *             
 *         
 *         
 *             ATTRIBUTE1
 *         
 *      
 * }

 */
public interface Assertion extends Token {
    
    /**
     * Sign the SAML Assertion - Enveloped Signature
     *
     * @param pubKey A java.security.PublicKey representing the public key used for Signature verification
     * @param privKey A java.security.PrivateKey representing the private key used for Signature calculation.
     *
     * By Default DigestMethod.SHA1, SignatureMethod.RSA_SHA1 and CanonicalizationMethod.EXCLUSIVE will be used.
     * @return An org.w3c.dom.Element representation of Signed SAML Assertion
     */
    Element sign(PublicKey pubKey, PrivateKey privKey) throws SAMLException;
    
    /**
     * Sign the SAML Assertion - Enveloped Signature
     *
     * @param cert A java.security.cert.X509Certificate representing the certificate used for Signature verification
     * @param privKey A java.security.PrivateKey representing the private key used for Signature calculation.
     *
     * By Default DigestMethod.SHA1, SignatureMethod.RSA_SHA1 and CanonicalizationMethod.EXCLUSIVE will be used.
     * @return An org.w3c.dom.Element representation of Signed SAML Assertion
     */
    Element sign(X509Certificate cert, PrivateKey privKey) throws SAMLException;
    
    /**
     * Sign the SAML Assertion - Enveloped Signature
     *
     * @param cert A java.security.cert.X509Certificate representing the certificate used for Signature verification
     * @param privKey A java.security.PrivateKey representing the private key used for Signature calculation.
     * @param alwaysIncludeCert A flag to tell whether to incude the certificate in the SAML signature.
     *
     * By Default DigestMethod.SHA1, SignatureMethod.RSA_SHA1 and CanonicalizationMethod.EXCLUSIVE will be used.
     * @return An org.w3c.dom.Element representation of Signed SAML Assertion
     */
    Element sign(X509Certificate cert, PrivateKey privKey, boolean alwaysIncludeCert) throws SAMLException;
    
    /**
     * Sign the SAML Assertion - Enveloped Signature
     *
     * @param cert A java.security.cert.X509Certificate representing the certificate used for Signature verification
     * @param privKey A java.security.PrivateKey representing the private key used for Signature calculation.
     * @param alwaysIncludeCert A flag to tell whether to incude the certificate in the SAML signature.
     * @param signatureMethod A javax.xml.crypto.dsig.SignatureMethod representing the signature algorithm used SAML signature.
     * @param canonicalizationMethod A javax.xml.crypto.dsig.CanonicalizationMethod representing the canonicalization algorithm used SAML signature.
     * 
     * By Default DigestMethod.SHA1, SignatureMethod.RSA_SHA1 and CanonicalizationMethod.EXCLUSIVE will be used.
     * @return An org.w3c.dom.Element representation of Signed SAML Assertion
     */
    Element sign(X509Certificate cert, PrivateKey privKey, boolean alwaysIncludeCert, String signatureMethod, String canonicalizationMethod) throws SAMLException;
           
    /**
     * Sign the SAML Assertion - Enveloped Signature
     *
     * @param digestMethod A javax.xml.crypto.dsig.DigestMethod representing the digest method used for SAML signature.
     * @param signatureMethod A javax.xml.crypto.dsig.SignatureMethod representing the signature algorithm used SAML signature.
     * @param pubKey A java.security.PublicKey representing the public key used for Signature verification
     * @param privKey A java.security.PrivateKey representing the private key used for Signature calculation.
     *
     * By Default DigestMethod.SHA1, SignatureMethod.RSA_SHA1 and CanonicalizationMethod.EXCLUSIVE will be used.
     * @return An org.w3c.dom.Element representation of Signed SAML Assertion
     */
    Element sign(DigestMethod digestMethod, String signatureMethod, PublicKey pubKey, PrivateKey privKey) throws SAMLException ;
    
    /**
     * Sign the SAML Assertion - Enveloped Signature
     *
     * @param digestMethod A javax.xml.crypto.dsig.DigestMethod representing the digest method used for SAML signature.
     * @param signatureMethod A javax.xml.crypto.dsig.SignatureMethod representing the signature algorithm used SAML signature.
     * @param cert A java.security.cert.X509Certificate representing the certificate used for Signature verification
     * @param privKey A java.security.PrivateKey representing the private key used for Signature calculation.
     *
     * By Default DigestMethod.SHA1, SignatureMethod.RSA_SHA1 and CanonicalizationMethod.EXCLUSIVE will be used.
     * @return An org.w3c.dom.Element representation of Signed SAML Assertion
     */
    Element sign(DigestMethod digestMethod, String signatureMethod, X509Certificate cert, PrivateKey privKey) throws SAMLException ;
    
    /**
     * Sign the SAML Assertion - Enveloped Signature
     *
     * @param digestMethod A javax.xml.crypto.dsig.DigestMethod representing the digest method used for SAML signature.
     * @param signatureMethod A javax.xml.crypto.dsig.SignatureMethod representing the signature algorithm used SAML signature.
     * @param cert A java.security.cert.X509Certificate representing the certificate used for Signature verification
     * @param privKey A java.security.PrivateKey representing the private key used for Signature calculation.
     * @param alwaysIncludeCert A flag to tell whether to incude the certificate in the SAML signature.
     * 
     * By Default DigestMethod.SHA1, SignatureMethod.RSA_SHA1 and CanonicalizationMethod.EXCLUSIVE will be used.
     * @return An org.w3c.dom.Element representation of Signed SAML Assertion
     */
    Element sign(DigestMethod digestMethod, String signatureMethod, X509Certificate cert, PrivateKey privKey, boolean alwaysIncludeCert) throws SAMLException ;
    
    /**
     * @deprecated
     * Set the saml major version for SAML1.0 and SAML1.1
     * @param value A java.math.BigInteger representing saml major version.
     * 
     */
    void setMajorVersion(java.math.BigInteger value);
    
    /**
     * @deprecated
     * Set the saml minor version for SAML1.0 and SAML1.1
     * @param value A java.math.BigInteger representing saml minor version.
     * 
     */
    void setMinorVersion(java.math.BigInteger value);
    
    /**
     * @deprecated
     * Set the saml version for SAML2.0
     * @param version A java.lang.String representing saml version
     * 
     */
    void setVersion(String version);
        
    /**
     * Convert SAML Assertion to org.w3c.dom.Element
     * @param doc the context org.w3c.dom.Node for the creation of the resulting org.w3c.dom.Element.
     * 
     * @return org.w3c.dom.Element element representation of SAML Assertion
     */
    Element toElement(Node doc) throws XWSSecurityException;
        
    /**
     * Get the issuer of SAML Assertion 
     * 
     * @return An java.lang.String representing saml issuer.
     */
    String getSamlIssuer();
       
    /**
     * Get the SAML Assertion ID for SAML1.0 and SAML1.1
     * 
     * @return An java.lang.String representing saml assertion ID.
     */
    String getAssertionID();
    
    /**
     * Get the SAML Assertion ID for SAML2.0
     * 
     * @return An java.lang.String representing saml assertion ID.
     */
    String getID();
    
    /**
     * Get the SAML Vertion SAML2.0
     * 
     * @return An java.lang.String representing saml version.
     */
    String getVersion();
    
    /**
     * Get the SAML Major Vertion for SAML1.0 and SAML1.1
     * 
     * @return An java.math.BigInteger representing saml major version.
     */
    BigInteger getMajorVersion();
    
    /**
     * Get the SAML Minor Vertion for SAML1.0 and SAML1.1
     * 
     * @return An java.math.BigInteger representing saml minor version.
     */
    BigInteger getMinorVersion();
    
    /**
     * Gets the value of the issueInstant property.
     * 
     * @return A {@link java.lang.String } representing the issue timestamp of the SAML Assertion
     *     
     */
    String getIssueInstance();
    
    /**
     * Return all statements presents in the SAML Assertion.
     * 
     * @return An java.util.List of java.lang.Object 
     * representing all statements present inside the SAML assertion.
     * 
     */
    List getStatements();
    
    /**
     * Gets the value of the conditions property of SAML
     * 
     * @return A {@link Conditions} representing conditions of the SAML Assertion.
     *     
     */
    Conditions getConditions();
    
    /**
     * Gets the value of the advice property of SAML
     * 
     * @return An {@link Advice} representing Advice element present in the SAML Assertion.
     *     
     */
    Advice getAdvice();
    
    /**
     * Gets the value of the subject property of SAML 2.0
     * This method should be applied only on SAML 2.0 assertion. 
     * For SAML1.1 and SAML1.0, first get a list of statements of the SAML assertion 
     * by calling getStatements() on the Assertion object, then call 
     * the getSubject() on each statement.
     * 
     * @return A {@link Subject} representing Subject of SAML 2.0
     *     
     */
    Subject getSubject();
    
    /**
     * Verify the SAML signature with the Public Key
     * 
     * @param pubKey A java.security.PublicKey representing the public key used for Signature verification
     * 
     * @return An {@link Boolean} representing whether SAML signature verification is successful or not.
     *     
     */
    boolean verifySignature(PublicKey pubKey) throws SAMLException;
    
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy