Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

XSECCryptoKeyRSA Class Reference
[Cryptographic Abstraction Layer]

#include <XSECCryptoKeyRSA.hpp>

Inheritance diagram for XSECCryptoKeyRSA:

Inheritance graph
[legend]
Collaboration diagram for XSECCryptoKeyRSA:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface class for RSA keys.

The library uses classes derived from this to process RSA keys.


Public Methods

Constructors and Destructors
 XSECCryptoKeyRSA ()
virtual ~XSECCryptoKeyRSA ()
Key Interface methods
virtual XSECCryptoKey::KeyType getKeyType ()
 Return the type of this key.

virtual XSECCryptoKeyclone ()=0
 Replicate key.

Mandatory RSA interface methods
These classes are required by the library.

virtual bool verifySHA1PKCS1Base64Signature (const unsigned char *hashBuf, unsigned int hashLen, const char *base64Signature, unsigned int sigLen)=0
 Verify a SHA1 PKCS1 encoded signature.

virtual unsigned int signSHA1PKCS1Base64Signature (unsigned char *hashBuf, unsigned int hashLen, char *base64SignatureBuf, unsigned int base64SignatureBufLen)=0
 Create a signature.

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 loadPublicModulusBase64BigNums (const char *b64, unsigned int len)=0
 Load the modulus.

virtual void loadPublicExponentBase64BigNums (const char *b64, unsigned int len)=0
 Load the exponent.


Constructor & Destructor Documentation

XSECCryptoKeyRSA::XSECCryptoKeyRSA   [inline]
 

virtual XSECCryptoKeyRSA::~XSECCryptoKeyRSA   [inline, virtual]
 


Member Function Documentation

virtual XSECCryptoKey* XSECCryptoKeyRSA::clone   [pure virtual]
 

Replicate key.

Implements XSECCryptoKey.

Implemented in OpenSSLCryptoKeyRSA.

virtual XSECCryptoKey::KeyType XSECCryptoKeyRSA::getKeyType   [inline, virtual]
 

Return the type of this key.

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

Reimplemented from XSECCryptoKey.

Reimplemented in OpenSSLCryptoKeyRSA.

virtual void XSECCryptoKeyRSA::loadPublicExponentBase64BigNums const char *    b64,
unsigned int    len
[pure virtual]
 

Load the exponent.

Load the exponent from a Base64 encoded string

param b64 A buffer containing the encoded string param len The length of the data in the buffer

Implemented in OpenSSLCryptoKeyRSA.

virtual void XSECCryptoKeyRSA::loadPublicModulusBase64BigNums const char *    b64,
unsigned int    len
[pure virtual]
 

Load the modulus.

Load the modulus from a Base64 encoded string

param b64 A buffer containing the encoded string param len The length of the data in the buffer

Implemented in OpenSSLCryptoKeyRSA.

virtual unsigned int XSECCryptoKeyRSA::signSHA1PKCS1Base64Signature unsigned char *    hashBuf,
unsigned int    hashLen,
char *    base64SignatureBuf,
unsigned int    base64SignatureBufLen
[pure virtual]
 

Create a signature.

The library will call this function to create a signature from a pre-calculated digest. The output signature is required to be Base64 encoded such that it can be placed directly into the XML document

This call needs to do a PKCS1 encode for a SHA-1 signature.

Parameters:
hashBuf  Buffer containing the pre-calculated (binary) digest
hashLen  Number of bytes of hash in the hashBuf
base64SignatureBuf  Buffer to place the base64 encoded result in.
base64SignatureBufLen  Implementations need to ensure they do not write more bytes than this into the buffer

Implemented in OpenSSLCryptoKeyRSA.

virtual bool XSECCryptoKeyRSA::verifySHA1PKCS1Base64Signature const unsigned char *    hashBuf,
unsigned int    hashLen,
const char *    base64Signature,
unsigned int    sigLen
[pure virtual]
 

Verify a SHA1 PKCS1 encoded signature.

The library will call this function to validate an RSA signature The standard by default uses SHA1 in a PKCS1 encoding.

Parameters:
hashBuf  Buffer containing the pre-calculated (binary) digest
hashLen  Length of the data in the digest buffer
base64Signature  Buffer containing the Base64 encoded signature
sigLen  Length of the data in the signature buffer
Returns:
true if the signature was valid, false otherwise

Implemented in OpenSSLCryptoKeyRSA.


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 20:59:29 2003 for XML-Security-C by doxygen1.2.18