Uses of Interface
org.opensaml.xml.security.credential.Credential

Packages that use Credential

Package	Description
org.opensaml.xml.encryption	XMLObject interfaces and helper classes for representing encrypted content and encrypting/decrypting content.
org.opensaml.xml.security	Interfaces and classes used in representing cryptographic credentials, evaluating the trustworthiness of security of tokens, etc.
org.opensaml.xml.security.credential	Interfaces and classes related to credentials and ways to represent them.
org.opensaml.xml.security.credential.criteria	Implementations of EvaluableCriteria where the parameterized evaluation target type is Credential.
org.opensaml.xml.security.keyinfo	Interfaces and classes for working with XML KeyInfo elements.
org.opensaml.xml.security.keyinfo.provider	Specific implementations of KeyInfoProvider.
org.opensaml.xml.security.trust	Interfaces and classes used to evaluate the trustworthiness and validity of Credentials
org.opensaml.xml.security.x509	X509 based credential and trust class.
org.opensaml.xml.signature	XMLObject interfaces and helper classes for representing digitally signed content and signing/validating content.
org.opensaml.xml.signature.impl	Implementations of the interfaces for XMLObjects that represent XML signature types.

Uses of Credential in org.opensaml.xml.encryption

Methods in org.opensaml.xml.encryption that return Credential

Modifier and Type	Method and Description
Credential	EncryptionParameters.getEncryptionCredential() Gets the credential used to encrypt.

Methods in org.opensaml.xml.encryption with parameters of type Credential

Modifier and Type	Method and Description
void	EncryptionParameters.setEncryptionCredential(Credential newEncryptionCredential) Sets the credential used to encrypt.

Uses of Credential in org.opensaml.xml.security

Methods in org.opensaml.xml.security that return Credential

Modifier and Type	Method and Description
static Credential	SecurityTestHelper.generateKeyAndCredential(String algorithmURI) Generate a random symmetric key and return in a BasicCredential.
static Credential	SecurityTestHelper.generateKeyPairAndCredential(String algorithmURI, int keyLength, boolean includePrivate) Generate a random asymmetric key pair and return in a BasicCredential.

Methods in org.opensaml.xml.security with parameters of type Credential

Modifier and Type	Method and Description
static EncryptionParameters	SecurityHelper.buildDataEncryptionParams(Credential encryptionCredential, SecurityConfiguration config, String keyInfoGenName) Build an instance of EncryptionParameters suitable for passing to an Encrypter.
static KeyEncryptionParameters	SecurityHelper.buildKeyEncryptionParams(Credential encryptionCredential, String wrappedKeyAlgorithm, SecurityConfiguration config, String keyInfoGenName, String recipient) Build an instance of KeyEncryptionParameters suitable for passing to an Encrypter.
static Key	SecurityHelper.extractDecryptionKey(Credential credential) Extract the decryption key from the credential.
static Key	SecurityHelper.extractEncryptionKey(Credential credential) Extract the encryption key from the credential.
static Key	SecurityHelper.extractSigningKey(Credential credential) Extract the signing key from the credential.
static Key	SecurityHelper.extractVerificationKey(Credential credential) Extract the verification key from the credential.
String	BasicSecurityConfiguration.getDataEncryptionAlgorithmURI(Credential credential) Get the encryption algorithm URI for the encryption key contained within the specified credential.
String	SecurityConfiguration.getDataEncryptionAlgorithmURI(Credential credential) Get the encryption algorithm URI for the encryption key contained within the specified credential.
static KeyInfoGenerator	SecurityHelper.getKeyInfoGenerator(Credential credential, SecurityConfiguration config, String keyInfoGenName) Obtains a KeyInfoGenerator for the specified Credential.
String	BasicSecurityConfiguration.getKeyTransportEncryptionAlgorithmURI(Credential credential, String wrappedKeyAlgorithm) Get the key transport encryption algorithm URI for the encryption key contained within the specified credential.
String	SecurityConfiguration.getKeyTransportEncryptionAlgorithmURI(Credential credential, String wrappedKeyAlgorithm) Get the key transport encryption algorithm URI for the encryption key contained within the specified credential.
String	BasicSecurityConfiguration.getSignatureAlgorithmURI(Credential credential) Get the signature algorithm URI for the signing key contained within the specified credential.
String	SecurityConfiguration.getSignatureAlgorithmURI(Credential credential) Get the signature algorithm URI for the signing key contained within the specified credential.
static void	SecurityHelper.prepareSignatureParams(Signature signature, Credential signingCredential, SecurityConfiguration config, String keyInfoGenName) Prepare a Signature with necessary additional information prior to signing.
static byte[]	SigningUtil.sign(Credential signingCredential, String jcaAlgorithmID, boolean isMAC, byte[] input) Compute the signature or MAC value over the supplied input.
static byte[]	SigningUtil.signWithURI(Credential signingCredential, String algorithmURI, byte[] input) Compute the signature or MAC value over the supplied input.
static boolean	SigningUtil.verify(Credential verificationCredential, String jcaAlgorithmID, boolean isMAC, byte[] signature, byte[] input) Verify the signature value computed over the supplied input against the supplied signature value.
static boolean	SigningUtil.verifyWithURI(Credential verificationCredential, String algorithmURI, byte[] signature, byte[] input) Verify the signature value computed over the supplied input against the supplied signature value.

Uses of Credential in org.opensaml.xml.security.credential

Classes in org.opensaml.xml.security.credential that implement Credential

Modifier and Type	Class and Description
class	AbstractCredential Base class for Credential implementations.
class	BasicCredential A basic implementation of Credential.

Methods in org.opensaml.xml.security.credential that return Credential

Modifier and Type	Method and Description
protected Credential	KeyStoreCredentialResolver.buildCredential(KeyStore.Entry keyStoreEntry, String entityID, UsageType usage) Build a credential instance from the key store entry.
Credential	ChainingCredentialResolver.CredentialIterator.next()
protected Credential	KeyStoreCredentialResolver.processSecretKeyEntry(KeyStore.SecretKeyEntry secretKeyEntry, String entityID, UsageType usage) Build a Credential from a keystore secret key entry.
Credential	AbstractCredentialResolver.resolveSingle(CriteriaSet criteriaSet) Process the specified criteria and return a single instance of the product type which satisfies the criteria.

Methods in org.opensaml.xml.security.credential that return types with arguments of type Credential

Modifier and Type	Method and Description
Collection<Credential>	CollectionCredentialResolver.getCollection() Get the (modifiable) credential collection which is the backing store for the resolver.
Class<? extends Credential>	Credential.getCredentialType() Get the primary type of the credential instance.
Class<? extends Credential>	BasicCredential.getCredentialType() Get the primary type of the credential instance.
Class<? extends Credential>	BasicKeyInfoGeneratorFactory.getCredentialType() Get the type (interface) of the specific type of credential handled by generators produced by this factory.
Iterator<Credential>	ChainingCredentialResolver.CredentialIterable.iterator()
Iterable<Credential>	AbstractCriteriaFilteringCredentialResolver.resolve(CriteriaSet criteriaSet) Process the specified criteria and return the resulting instances the the product type which satisfy the criteria.
abstract Iterable<Credential>	AbstractCredentialResolver.resolve(CriteriaSet criteriaSet) Process the specified criteria and return the resulting instances the the product type which satisfy the criteria.
Iterable<Credential>	ChainingCredentialResolver.resolve(CriteriaSet criteriaSet) Process the specified criteria and return the resulting instances the the product type which satisfy the criteria.
Iterable<Credential>	StaticCredentialResolver.resolve(CriteriaSet criteria) Process the specified criteria and return the resulting instances the the product type which satisfy the criteria.
protected abstract Iterable<Credential>	AbstractCriteriaFilteringCredentialResolver.resolveFromSource(CriteriaSet criteriaSet) Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.
protected Iterable<Credential>	KeyStoreCredentialResolver.resolveFromSource(CriteriaSet criteriaSet) Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.
protected Iterable<Credential>	CollectionCredentialResolver.resolveFromSource(CriteriaSet criteriaSet) Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.
protected Iterable<Credential>	FilesystemCredentialResolver.resolveFromSource(CriteriaSet criteriaSet) Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.

Methods in org.opensaml.xml.security.credential with parameters of type Credential

Modifier and Type	Method and Description
KeyInfo	BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator.generate(Credential credential) Generate a new KeyInfo object based on keying material and other information within a credential.
boolean	BasicKeyInfoGeneratorFactory.handles(Credential credential) Check whether the generators produced by this factory can handle the specified credential.
protected void	BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator.processEntityID(KeyInfo keyInfo, Credential credential) Process the value of getEntityId().
protected void	BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator.processKeyNames(KeyInfo keyInfo, Credential credential) Process the values of getKeyNames().
protected void	BasicKeyInfoGeneratorFactory.BasicKeyInfoGenerator.processPublicKey(KeyInfo keyInfo, Credential credential) Process the value of getPublicKey().

Constructors in org.opensaml.xml.security.credential with parameters of type Credential

Constructor and Description
StaticCredentialResolver(Credential credential) Constructor.

Constructor parameters in org.opensaml.xml.security.credential with type arguments of type Credential

Constructor and Description
CollectionCredentialResolver(Collection<Credential> credentials) Constructor.
StaticCredentialResolver(List<Credential> credentials) Constructor.

Uses of Credential in org.opensaml.xml.security.credential.criteria

Methods in org.opensaml.xml.security.credential.criteria with parameters of type Credential

Modifier and Type	Method and Description
Boolean	EvaluableKeyAlgorithmCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableX509CertSelectorCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableKeyNameCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluablePublicKeyCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableUsageCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableEntityIDCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableX509SubjectNameCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableX509IssuerSerialCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableX509SubjectKeyIdentifierCredentialCriteria.evaluate(Credential target) Evaluate the target.
Boolean	EvaluableKeyLengthCredentialCriteria.evaluate(Credential target) Evaluate the target.

Uses of Credential in org.opensaml.xml.security.keyinfo

Methods in org.opensaml.xml.security.keyinfo that return Credential

Modifier and Type	Method and Description
protected Credential	BasicProviderKeyInfoCredentialResolver.buildBasicCredential(Key key, Set<String> keyNames) Construct a basic credential containing the specified key and set of key names.

Methods in org.opensaml.xml.security.keyinfo that return types with arguments of type Credential

Modifier and Type	Method and Description
Class<? extends Credential>	KeyInfoGeneratorFactory.getCredentialType() Get the type (interface) of the specific type of credential handled by generators produced by this factory.
Collection<Credential>	KeyInfoResolutionContext.getResolvedCredentials() Get the set of credentials previously resolved.
Collection<Credential>	KeyInfoProvider.process(KeyInfoCredentialResolver resolver, XMLObject keyInfoChild, CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext) Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.
protected Collection<Credential>	BasicProviderKeyInfoCredentialResolver.processKeyInfoChild(KeyInfoResolutionContext kiContext, CriteriaSet criteriaSet, XMLObject keyInfoChild) Process the given KeyInfo child with the registered providers.
protected Collection<? extends Credential>	LocalKeyInfoCredentialResolver.resolveByKeyName(String keyName) Resolve credentials from local resolver using key name criteria.
protected Collection<? extends Credential>	LocalKeyInfoCredentialResolver.resolveByPublicKey(PublicKey publicKey) Resolve credentials from local resolver using public key criteria.
protected Iterable<Credential>	BasicProviderKeyInfoCredentialResolver.resolveFromSource(CriteriaSet criteriaSet) Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.

Methods in org.opensaml.xml.security.keyinfo with parameters of type Credential

Modifier and Type	Method and Description
protected Key	BasicProviderKeyInfoCredentialResolver.extractKeyValue(Credential cred) Utility method to extract any key that might be present in the specified Credential.
KeyInfo	KeyInfoGenerator.generate(Credential credential) Generate a new KeyInfo object based on keying material and other information within a credential.
KeyInfo	StaticKeyInfoGenerator.generate(Credential credential) Generate a new KeyInfo object based on keying material and other information within a credential.
KeyInfoGeneratorFactory	KeyInfoGeneratorManager.getFactory(Credential credential) Get the factory which produces KeyInfoGenerators which can handle the specified credential.
KeyInfoGeneratorFactory	NamedKeyInfoGeneratorManager.getFactory(String name, Credential credential) Lookup and return the named generator factory for the type of the credential specified.
boolean	KeyInfoGeneratorFactory.handles(Credential credential) Check whether the generators produced by this factory can handle the specified credential.
protected boolean	LocalKeyInfoCredentialResolver.isLocalCredential(Credential credential) Determine whether the credential is a local credential.

Method parameters in org.opensaml.xml.security.keyinfo with type arguments of type Credential

Modifier and Type	Method and Description
protected void	BasicProviderKeyInfoCredentialResolver.postProcess(KeyInfoResolutionContext kiContext, CriteriaSet criteriaSet, List<Credential> credentials) Hook for subclasses to do post-processing of the credential set after all KeyInfo children have been processed.
protected void	LocalKeyInfoCredentialResolver.postProcess(KeyInfoResolutionContext kiContext, CriteriaSet criteriaSet, List<Credential> credentials) Hook for subclasses to do post-processing of the credential set after all KeyInfo children have been processed.
protected void	BasicProviderKeyInfoCredentialResolver.postProcessEmptyCredentials(KeyInfoResolutionContext kiContext, CriteriaSet criteriaSet, List<Credential> credentials) Hook for processing the case where no credentials were returned by any resolution method by any provider, nor by the processing of the BasicProviderKeyInfoCredentialResolver.postProcess(KeyInfoResolutionContext, CriteriaSet, List) hook.
protected void	BasicProviderKeyInfoCredentialResolver.processKeyInfoChildren(KeyInfoResolutionContext kiContext, CriteriaSet criteriaSet, List<Credential> credentials) Use registered providers to process the non-KeyValue children of KeyInfo.

Constructors in org.opensaml.xml.security.keyinfo with parameters of type Credential

Constructor and Description
StaticKeyInfoCredentialResolver(Credential credential) Constructor.

Constructor parameters in org.opensaml.xml.security.keyinfo with type arguments of type Credential

Constructor and Description
CollectionKeyInfoCredentialResolver(Collection<Credential> credentials) Constructor.
KeyInfoResolutionContext(Collection<Credential> credentials) Constructor.
StaticKeyInfoCredentialResolver(List<Credential> credentials) Constructor.

Uses of Credential in org.opensaml.xml.security.keyinfo.provider

Methods in org.opensaml.xml.security.keyinfo.provider that return types with arguments of type Credential

Modifier and Type	Method and Description
Collection<Credential>	RSAKeyValueProvider.process(KeyInfoCredentialResolver resolver, XMLObject keyInfoChild, CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext) Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.
Collection<Credential>	InlineX509DataProvider.process(KeyInfoCredentialResolver resolver, XMLObject keyInfoChild, CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext) Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.
Collection<Credential>	DSAKeyValueProvider.process(KeyInfoCredentialResolver resolver, XMLObject keyInfoChild, CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext) Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.

Methods in org.opensaml.xml.security.keyinfo.provider with parameters of type Credential

Modifier and Type	Method and Description
protected Key	AbstractKeyInfoProvider.extractKeyValue(Credential cred) Utility method to extract any key that might be present in the specified Credential.

Uses of Credential in org.opensaml.xml.security.trust

Methods in org.opensaml.xml.security.trust with parameters of type Credential

Modifier and Type	Method and Description
protected void	ExplicitKeyTrustEngine.checkParams(Credential untrustedCredential, CriteriaSet trustBasisCriteria) Check the parameters for required values.
boolean	ExplicitKeyTrustEvaluator.validate(Credential untrustedCredential, Credential trustedCredential) Evaluate trust.
boolean	ExplicitKeyTrustEngine.validate(Credential untrustedCredential, CriteriaSet trustBasisCriteria) Validates the token against trusted information obtained in an implementation-specific manner.
boolean	ExplicitKeyTrustEvaluator.validate(Credential untrustedCredential, Iterable<Credential> trustedCredentials) Evaluate trust.

Method parameters in org.opensaml.xml.security.trust with type arguments of type Credential

Modifier and Type	Method and Description
boolean	ExplicitKeyTrustEvaluator.validate(Credential untrustedCredential, Iterable<Credential> trustedCredentials) Evaluate trust.
boolean	ExplicitX509CertificateTrustEvaluator.validate(X509Credential untrustedCredential, Iterable<Credential> trustedCredentials) Evaluate trust.

Uses of Credential in org.opensaml.xml.security.x509

Subinterfaces of Credential in org.opensaml.xml.security.x509

Modifier and Type	Interface and Description
interface	X509Credential An entity credential based on key material and other information (e.g.

Classes in org.opensaml.xml.security.x509 that implement Credential

Modifier and Type	Class and Description
class	BasicX509Credential A basic implementation of X509Credential.
class	KeyStoreX509CredentialAdapter A wrapper that changes a KeyStore in to a X509Credential.
class	X509KeyManagerX509CredentialAdapter A class that wraps a X509KeyManager and exposes it as an X509Credential.

Methods in org.opensaml.xml.security.x509 that return types with arguments of type Credential

Modifier and Type	Method and Description
Class<? extends Credential>	BasicX509Credential.getCredentialType() Get the primary type of the credential instance.
Class<? extends Credential>	X509KeyInfoGeneratorFactory.getCredentialType() Get the type (interface) of the specific type of credential handled by generators produced by this factory.

Methods in org.opensaml.xml.security.x509 with parameters of type Credential

Modifier and Type	Method and Description
KeyInfo	X509KeyInfoGeneratorFactory.X509KeyInfoGenerator.generate(Credential credential) Generate a new KeyInfo object based on keying material and other information within a credential.
boolean	X509KeyInfoGeneratorFactory.handles(Credential credential) Check whether the generators produced by this factory can handle the specified credential.

Uses of Credential in org.opensaml.xml.signature

Methods in org.opensaml.xml.signature that return Credential

Modifier and Type	Method and Description
Credential	Signature.getSigningCredential() Gets the signature signing credential.

Methods in org.opensaml.xml.signature with parameters of type Credential

Modifier and Type	Method and Description
void	Signature.setSigningCredential(Credential newCredential) Sets the signature signing credential.
boolean	SignatureTrustEngine.validate(byte[] signature, byte[] content, String algorithmURI, CriteriaSet trustBasisCriteria, Credential candidateCredential) Determines whether a raw signature over specified content is valid and signed by a trusted credential.

Constructors in org.opensaml.xml.signature with parameters of type Credential

Constructor and Description
SignatureValidator(Credential validatingCredential) Constructor.

Uses of Credential in org.opensaml.xml.signature.impl

Methods in org.opensaml.xml.signature.impl that return Credential

Modifier and Type	Method and Description
Credential	SignatureImpl.getSigningCredential() Gets the signature signing credential.

Methods in org.opensaml.xml.signature.impl with parameters of type Credential

Modifier and Type	Method and Description
protected boolean	ExplicitKeySignatureTrustEngine.evaluateTrust(Credential untrustedCredential, Iterable<Credential> trustedCredentials) Evaluate the untrusted KeyInfo-derived credential with respect to the specified trusted information.
protected boolean	PKIXSignatureTrustEngine.evaluateTrust(Credential untrustedCredential, Pair<Set<String>,Iterable<PKIXValidationInformation>> validationPair) Evaluate the untrusted KeyInfo-derived credential with respect to the specified trusted information.
protected abstract boolean	BaseSignatureTrustEngine.evaluateTrust(Credential untrustedCredential, TrustBasisType trustBasis) Evaluate the untrusted KeyInfo-derived credential with respect to the specified trusted information.
void	SignatureImpl.setSigningCredential(Credential newCredential) Sets the signature signing credential.
boolean	ChainingSignatureTrustEngine.validate(byte[] signature, byte[] content, String algorithmURI, CriteriaSet trustBasisCriteria, Credential candidateCredential) Determines whether a raw signature over specified content is valid and signed by a trusted credential.
boolean	PKIXSignatureTrustEngine.validate(byte[] signature, byte[] content, String algorithmURI, CriteriaSet trustBasisCriteria, Credential candidateCredential) Determines whether a raw signature over specified content is valid and signed by a trusted credential.
boolean	ExplicitKeySignatureTrustEngine.validate(byte[] signature, byte[] content, String algorithmURI, CriteriaSet trustBasisCriteria, Credential candidateCredential) Determines whether a raw signature over specified content is valid and signed by a trusted credential.
protected boolean	BaseSignatureTrustEngine.verifySignature(Signature signature, Credential credential) Attempt to verify a signature using the key from the supplied credential.

Method parameters in org.opensaml.xml.signature.impl with type arguments of type Credential

Modifier and Type	Method and Description
protected boolean	ExplicitKeySignatureTrustEngine.evaluateTrust(Credential untrustedCredential, Iterable<Credential> trustedCredentials) Evaluate the untrusted KeyInfo-derived credential with respect to the specified trusted information.