Class Saml2X509Credential
java.lang.Object
org.springframework.security.saml2.credentials.Saml2X509Credential
Deprecated.
Saml2X509Credential is meant to hold an X509 certificate, or an X509 certificate and a
private key. Per:
https://www.oasis-open.org/committees/download.php/8958/sstc-saml-implementation-guidelines-draft-01.pdf
Line: 584, Section 4.3 Credentials Used for both signing, signature verification and
encryption/decryption
- Since:
- 5.2
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Deprecated.UseSaml2X509Credential.Saml2X509CredentialType
instead -
Constructor Summary
ConstructorsConstructorDescriptionSaml2X509Credential
(X509Certificate certificate, Saml2X509Credential.Saml2X509CredentialType... types) Deprecated.Creates a Saml2X509Credentials representing Identity Provider credentials for verification, encryption or both.Saml2X509Credential
(PrivateKey privateKey, X509Certificate certificate, Set<Saml2X509Credential.Saml2X509CredentialType> types) Deprecated.Saml2X509Credential
(PrivateKey privateKey, X509Certificate certificate, Saml2X509Credential.Saml2X509CredentialType... types) Deprecated.Creates a Saml2X509Credentials representing Service Provider credentials for signing, decryption or both. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.Deprecated.Returns the X509 certificate for ths credential.protected Set<Saml2X509Credential.Saml2X509CredentialType>
Deprecated.Returns the credential types for this credential.Deprecated.Returns the private key, or null if this credential type doesn't require one.int
hashCode()
Deprecated.boolean
Deprecated.Returns true if the credential has a private key and can be used for decryption, the types will containSaml2X509Credential.Saml2X509CredentialType.DECRYPTION
.boolean
Deprecated.Returns true if the credential has a certificate and can be used for signature verification, the types will containSaml2X509Credential.Saml2X509CredentialType.VERIFICATION
.boolean
Deprecated.Returns true if the credential has a certificate and can be used for signature verification, the types will containSaml2X509Credential.Saml2X509CredentialType.VERIFICATION
.boolean
Deprecated.Returns true if the credential has a private key and can be used for signing, the types will containSaml2X509Credential.Saml2X509CredentialType.SIGNING
.
-
Constructor Details
-
Saml2X509Credential
public Saml2X509Credential(X509Certificate certificate, Saml2X509Credential.Saml2X509CredentialType... types) Deprecated.Creates a Saml2X509Credentials representing Identity Provider credentials for verification, encryption or both.- Parameters:
certificate
- an IDP X509Certificate, cannot be nulltypes
- credential types, must be one ofSaml2X509Credential.Saml2X509CredentialType.VERIFICATION
orSaml2X509Credential.Saml2X509CredentialType.ENCRYPTION
or both.
-
Saml2X509Credential
public Saml2X509Credential(PrivateKey privateKey, X509Certificate certificate, Saml2X509Credential.Saml2X509CredentialType... types) Deprecated.Creates a Saml2X509Credentials representing Service Provider credentials for signing, decryption or both.- Parameters:
privateKey
- a private key used for signing or decryption, cannot be nullcertificate
- an SP X509Certificate shared with identity providers, cannot be nulltypes
- credential types, must be one ofSaml2X509Credential.Saml2X509CredentialType.SIGNING
orSaml2X509Credential.Saml2X509CredentialType.DECRYPTION
or both.
-
Saml2X509Credential
public Saml2X509Credential(PrivateKey privateKey, X509Certificate certificate, Set<Saml2X509Credential.Saml2X509CredentialType> types) Deprecated.
-
-
Method Details
-
isSigningCredential
public boolean isSigningCredential()Deprecated.Returns true if the credential has a private key and can be used for signing, the types will containSaml2X509Credential.Saml2X509CredentialType.SIGNING
.- Returns:
- true if the credential is a
Saml2X509Credential.Saml2X509CredentialType.SIGNING
type
-
isDecryptionCredential
public boolean isDecryptionCredential()Deprecated.Returns true if the credential has a private key and can be used for decryption, the types will containSaml2X509Credential.Saml2X509CredentialType.DECRYPTION
.- Returns:
- true if the credential is a
Saml2X509Credential.Saml2X509CredentialType.DECRYPTION
type
-
isSignatureVerficationCredential
public boolean isSignatureVerficationCredential()Deprecated.Returns true if the credential has a certificate and can be used for signature verification, the types will containSaml2X509Credential.Saml2X509CredentialType.VERIFICATION
.- Returns:
- true if the credential is a
Saml2X509Credential.Saml2X509CredentialType.VERIFICATION
type
-
isEncryptionCredential
public boolean isEncryptionCredential()Deprecated.Returns true if the credential has a certificate and can be used for signature verification, the types will containSaml2X509Credential.Saml2X509CredentialType.VERIFICATION
.- Returns:
- true if the credential is a
Saml2X509Credential.Saml2X509CredentialType.VERIFICATION
type
-
getCredentialTypes
Deprecated.Returns the credential types for this credential.- Returns:
- a set of credential types/usages that this credential can be used for
-
getPrivateKey
Deprecated.Returns the private key, or null if this credential type doesn't require one.- Returns:
- the private key, or null
- See Also:
-
getCertificate
Deprecated.Returns the X509 certificate for ths credential. Cannot be null- Returns:
- the X509 certificate
-
equals
Deprecated. -
hashCode
public int hashCode()Deprecated.
-
Saml2X509Credential
instead