Package se.swedenconnect.security.credential.opensaml

Class OpenSamlCredential

java.lang.Object

org.opensaml.security.credential.AbstractCredential

org.opensaml.security.credential.BasicCredential

org.opensaml.security.x509.BasicX509Credential

se.swedenconnect.security.credential.opensaml.OpenSamlCredential

All Implemented Interfaces:

Credential, MutableCredential, X509Credential

public class OpenSamlCredential
extends BasicX509Credential

A credential that implements OpenSAML's X509Credential interface and wraps a PkiCredential. This enables us to make use of features such as testing and re-loading (see ReloadablePkiCredential), but most importantly, it gives use a smooth way of instantiating OpenSAML credentials.

Author:

Martin Lindström (martin@idsec.se)

Constructor Summary

Constructors

Constructor	Description
OpenSamlCredential(X509Certificate entityCertificate, PrivateKey privateKey)	Constructor setting up the credential by explicitly assigning the certificate and private key.
OpenSamlCredential(PkiCredential credential)	Constructor setting up the OpenSAML credential by assigning a PkiCredential instance.

Method Summary

Modifier and Type	Method	Description
X509Certificate	getEntityCertificate()
Collection<X509Certificate>	getEntityCertificateChain()
PrivateKey	getPrivateKey()
PublicKey	getPublicKey()
boolean	isHardwareCredential()	Predicate that tells whether this credential resides in a hardware module.
void	setEntityCertificate(X509Certificate entityCertificate)
void	setEntityCertificateChain(Collection<X509Certificate> certificateChain)
void	setPrivateKey(PrivateKey privateKey)

Methods inherited from class org.opensaml.security.x509.BasicX509Credential

getCredentialType, getCRLs, getSecretKey, setCRLs, setPublicKey, setSecretKey

Methods inherited from class org.opensaml.security.credential.BasicCredential

setEntityId, setUsageType

Methods inherited from class org.opensaml.security.credential.AbstractCredential

getCredentialContextSet, getEntityId, getKeyNames, getUsageType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.security.credential.Credential

getCredentialContextSet, getEntityId, getKeyNames, getUsageType

Constructor Details

OpenSamlCredential

public OpenSamlCredential(@Nonnull
 X509Certificate entityCertificate,
 @Nonnull
 PrivateKey privateKey)

Constructor setting up the credential by explicitly assigning the certificate and private key.

Parameters:

entityCertificate - the certificate

privateKey - the private key

OpenSamlCredential

public OpenSamlCredential(@Nonnull
 PkiCredential credential)

Constructor setting up the OpenSAML credential by assigning a PkiCredential instance. This type of setting up the OpenSamlCredential is recommended since it gives the benefits of monitoring (and reloading) credentials as well as a simple way to use hardware based keys (e.g. Pkcs11Credential).

Parameters:

credential - the credential to wrap in a OpenSAML credential

Method Details

getPublicKey

@Nonnull
public PublicKey getPublicKey()

Specified by:

getPublicKey in interface Credential

Overrides:

getPublicKey in class BasicX509Credential

getPrivateKey

@Nonnull
public PrivateKey getPrivateKey()

Specified by:

getPrivateKey in interface Credential

Overrides:

getPrivateKey in class AbstractCredential

setPrivateKey

public void setPrivateKey(@Nonnull
 PrivateKey privateKey)

Specified by:

setPrivateKey in interface MutableCredential

Overrides:

setPrivateKey in class BasicCredential

getEntityCertificate

@Nonnull
public X509Certificate getEntityCertificate()

Specified by:

getEntityCertificate in interface X509Credential

Overrides:

getEntityCertificate in class BasicX509Credential

setEntityCertificate

public void setEntityCertificate(@Nonnull
 X509Certificate entityCertificate)

Overrides:

setEntityCertificate in class BasicX509Credential

getEntityCertificateChain

@Nonnull
public Collection<X509Certificate> getEntityCertificateChain()

Specified by:

getEntityCertificateChain in interface X509Credential

Overrides:

getEntityCertificateChain in class BasicX509Credential

setEntityCertificateChain

public void setEntityCertificateChain(@Nonnull
 Collection<X509Certificate> certificateChain)

Overrides:

setEntityCertificateChain in class BasicX509Credential

isHardwareCredential

public boolean isHardwareCredential()

Predicate that tells whether this credential resides in a hardware module.

Returns:

true if the credential resides in a hardware module and false otherwise