Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

OpenSSLCryptoKeyHMAC Class Reference
[OpenSSL Interface]

#include <OpenSSLCryptoKeyHMAC.hpp>

Inheritance diagram for OpenSSLCryptoKeyHMAC:

Inheritance graph
[legend]
Collaboration diagram for OpenSSLCryptoKeyHMAC:

Collaboration graph
[legend]
List of all members.

Detailed Description

OpenSSL implementation for HMAC keys.

Used to provide HMAC keys to OpenSSLCryptoHashHMAC


Public Member Functions

Constructors and Destructors
 OpenSSLCryptoKeyHMAC ()
virtual ~OpenSSLCryptoKeyHMAC ()
Key Interface methods
virtual XSECCryptoKey::KeyType getKeyType ()
 Return the type of this key.
virtual XSECCryptoKeyclone ()
 Replicate key.
virtual const XMLCh * getProviderName ()
 Return the OpenSSL string identifier.
Optional Interface methods
These functions do not necessarily have to be implmented. They are used by XSECKeyInfoResolverDefault to try to create a key from KeyInfo elements without knowing anything else.

If an interface class does not implement these functions, a simple stub that does nothing should be used.

virtual void setKey (unsigned char *inBuf, unsigned int inLength)
 Set the key.
virtual unsigned int getKey (safeBuffer &outBuf)
 Get the key value.


Constructor & Destructor Documentation

OpenSSLCryptoKeyHMAC::OpenSSLCryptoKeyHMAC  ) 
 

virtual OpenSSLCryptoKeyHMAC::~OpenSSLCryptoKeyHMAC  )  [inline, virtual]
 


Member Function Documentation

virtual XSECCryptoKey* OpenSSLCryptoKeyHMAC::clone  )  [virtual]
 

Replicate key.

Implements XSECCryptoKeyHMAC.

virtual unsigned int OpenSSLCryptoKeyHMAC::getKey safeBuffer outBuf  )  [virtual]
 

Get the key value.

Copy the key into the safeBuffer and return the number of bytes copied.

Parameters:
outBuf Buffer to copy key into
Returns:
number of bytes copied in

Implements XSECCryptoKeyHMAC.

virtual XSECCryptoKey::KeyType OpenSSLCryptoKeyHMAC::getKeyType  )  [inline, virtual]
 

Return the type of this key.

For DSA keys, this allows people to determine whether this is a public key, private key or a key pair

Reimplemented from XSECCryptoKeyHMAC.

virtual const XMLCh* OpenSSLCryptoKeyHMAC::getProviderName  )  [inline, virtual]
 

Return the OpenSSL string identifier.

Implements XSECCryptoKey.

virtual void OpenSSLCryptoKeyHMAC::setKey unsigned char *  inBuf,
unsigned int  inLength
[virtual]
 

Set the key.

Set the key from the buffer

Parameters:
inBuf Buffer containing the key
inLength Number of bytes of key in the buffer
Note:
isSensitive() should have been called on the inbound buffer to ensure the contents is overwritten when the safeBuffer is deleted

Implements XSECCryptoKeyHMAC.


The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:42:07 2005 for XML-Security-C by  doxygen 1.4.2