Package org.springframework.security.saml2.core

Class Saml2X509Credential

java.lang.Object

org.springframework.security.saml2.core.Saml2X509Credential

public final class Saml2X509Credential
extends Object

An object for holding a public certificate, any associated private key, and its intended usages (Line 584, Section 4.3 Credentials).

Since:

5.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Saml2X509Credential.Saml2X509CredentialType

Constructor Summary

Constructors

Constructor	Description
Saml2X509Credential(X509Certificate certificate, Saml2X509Credential.Saml2X509CredentialType... types)	Creates a Saml2X509Credential using the provided parameters
Saml2X509Credential(PrivateKey privateKey, X509Certificate certificate, Set<Saml2X509Credential.Saml2X509CredentialType> types)	Creates a Saml2X509Credential using the provided parameters
Saml2X509Credential(PrivateKey privateKey, X509Certificate certificate, Saml2X509Credential.Saml2X509CredentialType... types)	Creates a Saml2X509Credential using the provided parameters

Method Summary

Modifier and Type	Method	Description
static Saml2X509Credential	decryption(PrivateKey privateKey, X509Certificate certificate)	Create a Saml2X509Credential that can be used for decryption.
static Saml2X509Credential	encryption(X509Certificate certificate)	Create a Saml2X509Credential that can be used for encryption.
boolean	equals(Object o)
X509Certificate	getCertificate()	Get the public certificate for this credential
Set<Saml2X509Credential.Saml2X509CredentialType>	getCredentialTypes()	List all this credential's intended usages
PrivateKey	getPrivateKey()	Get the private key for this credential
int	hashCode()
boolean	isDecryptionCredential()	Indicate whether this credential can be used for decryption
boolean	isEncryptionCredential()	Indicate whether this credential can be used for encryption
boolean	isSigningCredential()	Indicate whether this credential can be used for signing
boolean	isVerificationCredential()	Indicate whether this credential can be used for verification
static Saml2X509Credential	signing(PrivateKey privateKey, X509Certificate certificate)	Create a Saml2X509Credential that can be used for signing.
static Saml2X509Credential	verification(X509Certificate certificate)	Create a Saml2X509Credential that can be used for verification.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Saml2X509Credential

public Saml2X509Credential(X509Certificate certificate,
 Saml2X509Credential.Saml2X509CredentialType... types)

Creates a Saml2X509Credential using the provided parameters

Parameters:

certificate - the credential's public certificiate

types - the credential's intended usages, must be one of Saml2X509Credential.Saml2X509CredentialType.VERIFICATION or Saml2X509Credential.Saml2X509CredentialType.ENCRYPTION or both.

Saml2X509Credential

public Saml2X509Credential(PrivateKey privateKey,
 X509Certificate certificate,
 Saml2X509Credential.Saml2X509CredentialType... types)

Creates a Saml2X509Credential using the provided parameters

Parameters:

privateKey - the credential's private key

certificate - the credential's public certificate

types - the credential's intended usages, must be one of Saml2X509Credential.Saml2X509CredentialType.SIGNING or Saml2X509Credential.Saml2X509CredentialType.DECRYPTION or both.

Saml2X509Credential

public Saml2X509Credential(PrivateKey privateKey,
 X509Certificate certificate,
 Set<Saml2X509Credential.Saml2X509CredentialType> types)

Creates a Saml2X509Credential using the provided parameters

Parameters:

privateKey - the credential's private key

certificate - the credential's public certificate

types - the credential's intended usages

Method Details

encryption

public static Saml2X509Credential encryption(X509Certificate certificate)

Create a Saml2X509Credential that can be used for encryption.

Parameters:

certificate - the certificate to use for encryption

Returns:

an encrypting Saml2X509Credential

verification

public static Saml2X509Credential verification(X509Certificate certificate)

Create a Saml2X509Credential that can be used for verification.

Parameters:

certificate - the certificate to use for verification

Returns:

a verifying Saml2X509Credential

decryption

public static Saml2X509Credential decryption(PrivateKey privateKey,
 X509Certificate certificate)

Create a Saml2X509Credential that can be used for decryption.

Parameters:

privateKey - the private key to use for decryption

certificate - the certificate to use for decryption

Returns:

an decrypting Saml2X509Credential

signing

public static Saml2X509Credential signing(PrivateKey privateKey,
 X509Certificate certificate)

Create a Saml2X509Credential that can be used for signing.

Parameters:

privateKey - the private key to use for signing

certificate - the certificate to use for signing

Returns:

a signing Saml2X509Credential

getPrivateKey

public PrivateKey getPrivateKey()

Get the private key for this credential

Returns:

the private key, may be null

See Also:

• Saml2X509Credential(PrivateKey, X509Certificate, Saml2X509CredentialType...)

getCertificate

public X509Certificate getCertificate()

Get the public certificate for this credential

Returns:

the public certificate

isSigningCredential

public boolean isSigningCredential()

Indicate whether this credential can be used for signing

Returns:

true if the credential has a Saml2X509Credential.Saml2X509CredentialType.SIGNING type

isDecryptionCredential

public boolean isDecryptionCredential()

Indicate whether this credential can be used for decryption

Returns:

true if the credential has a Saml2X509Credential.Saml2X509CredentialType.DECRYPTION type

isVerificationCredential

public boolean isVerificationCredential()

Indicate whether this credential can be used for verification

Returns:

true if the credential has a Saml2X509Credential.Saml2X509CredentialType.VERIFICATION type

isEncryptionCredential

public boolean isEncryptionCredential()

Indicate whether this credential can be used for encryption

Returns:

true if the credential has a Saml2X509Credential.Saml2X509CredentialType.ENCRYPTION type

getCredentialTypes

public Set<Saml2X509Credential.Saml2X509CredentialType> getCredentialTypes()

List all this credential's intended usages

Returns:

the set of this credential's intended usages

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object