se.swedenconnect.opensaml.security.credential

Class KeyAgreementCredential

java.lang.Object

org.opensaml.security.credential.AbstractCredential

org.opensaml.security.credential.BasicCredential

se.swedenconnect.opensaml.security.credential.KeyAgreementCredential

All Implemented Interfaces:

Credential, MutableCredential

public class KeyAgreementCredential
extends BasicCredential

A special purpose credential that is used when key agreement is used for encryption.

Author:

Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)

Constructor Summary

Constructors

Constructor and Description
KeyAgreementCredential(SecretKey secretKey, PublicKey senderGeneratedPublicKey, Credential peerCredential, String agreementMethodAlgorith, KeyDerivationMethod keyDerivationMethod) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAgreementMethodAlgorithm() Returns the agreement method used for this credential.
Class<? extends Credential>	getCredentialType()
KeyDerivationMethod	getKeyDerivationMethod() Returns the key derivation method used when constructing the key agreement key.
Credential	getPeerCredential() Returns the peer credential.
PublicKey	getSenderGeneratedPublicKey() Returns the generated public key that is used for key derivation.

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

setEntityId, setPrivateKey, setPublicKey, setSecretKey, setUsageType

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

getCredentialContextSet, getEntityId, getKeyNames, getPrivateKey, getPublicKey, getSecretKey, 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, getPrivateKey, getPublicKey, getSecretKey, getUsageType

Constructor Detail

KeyAgreementCredential

public KeyAgreementCredential(SecretKey secretKey,
                              PublicKey senderGeneratedPublicKey,
                              Credential peerCredential,
                              String agreementMethodAlgorith,
                              KeyDerivationMethod keyDerivationMethod)

Constructor.

Parameters:

secretKey - the key wrapping key (from the key agreement process)

senderGeneratedPublicKey - the generated public key (for key derivation)

peerCredential - the peer public certificate

agreementMethodAlgorith - the agreement method used for this key agreement credential

keyDerivationMethod - the key derivation method used

Method Detail

getCredentialType

public Class<? extends Credential> getCredentialType()

Specified by:

getCredentialType in interface Credential

Overrides:

getCredentialType in class BasicCredential

getSenderGeneratedPublicKey

public PublicKey getSenderGeneratedPublicKey()

Returns the generated public key that is used for key derivation.

Returns:

public key

getPeerCredential

public Credential getPeerCredential()

Returns the peer credential.

Returns:

peer credential

getAgreementMethodAlgorithm

public String getAgreementMethodAlgorithm()

Returns the agreement method used for this credential.

Returns:

the agreement method used for this credential

getKeyDerivationMethod

public KeyDerivationMethod getKeyDerivationMethod()

Returns the key derivation method used when constructing the key agreement key.

Returns:

the key derivation method