CPKIFKeyAgreeContextBase Class Reference

#include <PKIFKeyAgreeContextBase.h>

Inheritance diagram for CPKIFKeyAgreeContextBase:

[legend]

Collaboration diagram for CPKIFKeyAgreeContextBase:

[legend]

List of all members.

Detailed Description

CPKIFKeyAgreeContextBase provides an implementation of those portions of IPKIFKeyAgreeContext which are not specific to any particular back-end and unlikely to change.

Provider-specific pieces (such as opaque secret handles) will need to be added to subclasses

TSP-enforcing: No

Definition at line 26 of file PKIFKeyAgreeContextBase.h.


Public Member Functions
	CPKIFKeyAgreeContextBase ()
virtual	~CPKIFKeyAgreeContextBase ()
virtual void	SetAlgorithm (const CPKIFAlgorithm *alg)
virtual const CPKIFAlgorithm *	GetAlgorithm () const
virtual void	PrependSharedInfo (const CPKIFBufferPtr &data)
virtual void	AppendSharedInfo (const CPKIFBufferPtr &data)
virtual CPKIFBufferList &	GetPrependedSharedInfo () const
virtual CPKIFBufferList &	GetAppendedSharedInfo () const
virtual void	SetOwner (IPKIFCryptoKeyAgree *owner)
virtual IPKIFCryptoKeyAgree *	GetOwner () const

Constructor & Destructor Documentation

CPKIFKeyAgreeContextBase::CPKIFKeyAgreeContextBase ( )

Interface: External

Default constructor

Returns:: None

Definition at line 33 of file PKIFKeyAgreeContextBase.cpp.

References CPKIFKeyAgreeContextBaseImpl::m_kaAlg, and CPKIFKeyAgreeContextBaseImpl::m_owner.

CPKIFKeyAgreeContextBase::~CPKIFKeyAgreeContextBase ( ) [virtual]

Interface: External

Default destructor

Returns:: None

Definition at line 47 of file PKIFKeyAgreeContextBase.cpp.

Member Function Documentation

void CPKIFKeyAgreeContextBase::SetAlgorithm ( const CPKIFAlgorithm * alg ) [virtual]

Interface: External

Set the key agreement algorithm information. This needs to include a KDF. The pointer must be managed externally; this class does not own it and will not clean it up.

Returns:: None

Parameters:

alg

[in] description of key agreement and derivation algorithm

Implements IPKIFKeyAgreeContext.

Definition at line 64 of file PKIFKeyAgreeContextBase.cpp.

References CPKIFKeyAgreeContextBaseImpl::m_kaAlg.

const CPKIFAlgorithm * CPKIFKeyAgreeContextBase::GetAlgorithm ( ) const [virtual]

Interface: External

Get the key agreement algorithm information. The pointer returned must not be freed at during the lifetime of the context.

Returns:: pointer to information about key agreement algorithm.

Implements IPKIFKeyAgreeContext.

Definition at line 80 of file PKIFKeyAgreeContextBase.cpp.

References CPKIFKeyAgreeContextBaseImpl::m_kaAlg.

void CPKIFKeyAgreeContextBase::PrependSharedInfo ( const CPKIFBufferPtr & data ) [virtual]

Interface: External

Add a buffer which will be prepended to the secret prior to key derivation. If this function is called multiple times, data will be prepended in the order it was added.

Returns:: None

Parameters:

data

[in] data to prepend

Implements IPKIFKeyAgreeContext.

Definition at line 94 of file PKIFKeyAgreeContextBase.cpp.

References CPKIFKeyAgreeContextBaseImpl::m_prebufs.

void CPKIFKeyAgreeContextBase::AppendSharedInfo ( const CPKIFBufferPtr & data ) [virtual]

Interface: External

Add a buffer which will be appended to the secret prior to key derivation. If this function is called multiple times, data will be appended in the order it was added.

Returns:: None

Parameters:

data

[in] data to append

Implements IPKIFKeyAgreeContext.

Definition at line 111 of file PKIFKeyAgreeContextBase.cpp.

References CPKIFKeyAgreeContextBaseImpl::m_appbufs.

CPKIFBufferList & CPKIFKeyAgreeContextBase::GetPrependedSharedInfo ( ) const [virtual]

Interface: External

Get a list of buffers to prepend to the secret before input to KDF.

Returns:: ordered list of buffers to prepend to the secret before input to KDF.

Implements IPKIFKeyAgreeContext.

Definition at line 126 of file PKIFKeyAgreeContextBase.cpp.

References CPKIFKeyAgreeContextBaseImpl::m_prebufs.

CPKIFBufferList & CPKIFKeyAgreeContextBase::GetAppendedSharedInfo ( ) const [virtual]

Interface: External

Get a list of buffers to append to the secret before input to KDF.

Returns:: ordered list of buffers to append to the secret before input to KDF.

Implements IPKIFKeyAgreeContext.

Definition at line 138 of file PKIFKeyAgreeContextBase.cpp.

References CPKIFKeyAgreeContextBaseImpl::m_appbufs.

void CPKIFKeyAgreeContextBase::SetOwner ( IPKIFCryptoKeyAgree * owner ) [virtual]

Interface: External

Set the owner of this context. The mediator will use this to find which colleague's KDF it should use. The pointer must be managed externally; this class does not own it and will not clean it up.