Package org.opensaml.xml.security.credential

Interfaces and classes related to credentials and ways to represent them.

See: Description

Interface Summary

Interface	Description
Credential	A credential for an entity.
CredentialContext	Marker interface for implementations which hold information specific to a a particular context within which a CredentialResolver resolves a Credential.
CredentialResolver	A resolver which uses Criteria to resolve and return instances of Credential.

Class Summary

Class	Description
AbstractCredential	Base class for Credential implementations.
AbstractCredentialResolver	Abstract base class for CredentialResolver implementations.
AbstractCriteriaFilteringCredentialResolver	An abstract implementation of CredentialResolver which filters the returned Credentials based on the instances of EvaluableCredentialCriteria which are present in the set of criteria, or which are obtained via lookup in the EvaluableCredentialCriteriaRegistry.
BasicCredential	A basic implementation of Credential.
BasicKeyInfoGeneratorFactory	A factory implementation which produces instances of KeyInfoGenerator capable of handling the information contained within a Credential.
ChainingCredentialResolver	An implementation of CredentialResolver which chains together one or more underlying credential resolver implementations.
CollectionCredentialResolver	An implementation of CredentialResolver which uses a Collection as the underlying credential source.
CredentialContextSet	This class holds instances of CredentialContext which represent information about the context in which a CredentialResolver has resolved a Credential.
FilesystemCredentialResolver	NOTE: this class is not yet implemented A CredentialResolver that pulls credential information from the file system.
KeyStoreCredentialResolver	A CredentialResolver that extracts Credential's from a key store.
StaticCredentialResolver	Simple implementation of CredentialResolver which just stores and returns a static set of credentials.

Enum Summary

Enum	Description
UsageType	Credential usage types.

Package org.opensaml.xml.security.credential Description

Interfaces and classes related to credentials and ways to represent them. Developers will generally create and populate CredentialResolvers during application initialization time. CredentialCriteria can then be constructured to model the information the application has about a particular credential and then provided to the CredentialResolver in order retrieve the previously loaded credential information. Here are a couple of use cases where this approach might be used:

• An application wishes to decrypt a message from one of many peers. The encrypted message contains a KeyInfo which itself contains the public key used to encrypt the data. The application can then use the public key to lookup its appropriate private key and decrypt the message.
• An application uses client-cert authentication via TLS when communicating with a peer. Upon receipt of the peers certificate the application uses the provide entity certificate to lookup additional information associated with this credential, including CRLs, to determine if the credential should be trusted. It then looks up it's credential for the given peer and uses it to authenticate. Once completed the application stores the TLS session key in a CredentialResolver so that it may be used during encryption processes.