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

OpenSSLCryptoBase64 Class Reference

#include <OpenSSLCryptoBase64.hpp>

Inheritance diagram for OpenSSLCryptoBase64:

Inheritance graph
[legend]
Collaboration diagram for OpenSSLCryptoBase64:

Collaboration graph
[legend]
List of all members.

Public Methods

 OpenSSLCryptoBase64 ()
virtual ~OpenSSLCryptoBase64 ()
virtual void decodeInit (void)
 Initialise the base64 object. More...

virtual unsigned int decode (unsigned char *inData, unsigned int inLength, unsigned char *outData, unsigned int outLength)
 Decode some passed in data. More...

virtual unsigned int decodeFinish (unsigned char *outData, unsigned int outLength)
 Finish off a decode. More...

virtual void encodeInit (void)
 Initialise the base64 object for encoding. More...

virtual unsigned int encode (unsigned char *inData, unsigned int inLength, unsigned char *outData, unsigned int outLength)
 Encode some passed in data. More...

virtual unsigned int encodeFinish (unsigned char *outData, unsigned int outLength)
 Finish off an encode. More...


Static Public Methods

BIGNUM * b642BN (char *b64in, unsigned int len)

Constructor & Destructor Documentation

OpenSSLCryptoBase64::OpenSSLCryptoBase64   [inline]
 

virtual OpenSSLCryptoBase64::~OpenSSLCryptoBase64   [inline, virtual]
 


Member Function Documentation

BIGNUM* OpenSSLCryptoBase64::b642BN char *    b64in,
unsigned int    len
[static]
 

virtual unsigned int OpenSSLCryptoBase64::decode unsigned char *    inData,
unsigned int    inLength,
unsigned char *    outData,
unsigned int    outLength
[virtual]
 

Decode some passed in data.

The XSEC library will pass a block of data into the decoder and request that as much as possible be decoded into the outData buffer.

Due to the nature of base64, there may be data that cannot be fully decoded (not enough encoding through yet). The implementation is expected to keep this in memory until another call to decode() or a call to decodeFinish().

Parameters:
inData  Pointer to the buffer holding encoded data.
inLength  Length of the encoded data in the buffer
outData  Buffer to place decoded data into
outLength  Maximum amount of data that can be placed in the buffer.
Returns:
The number of bytes placed in the outData buffer.

Implements XSECCryptoBase64.

virtual unsigned int OpenSSLCryptoBase64::decodeFinish unsigned char *    outData,
unsigned int    outLength
[virtual]
 

Finish off a decode.

The library will call this when there is no more base64 data for the current decode.

Parameters:
outData  Buffer to place any remaining decoded data
outLength  Max amount of data to be placed in the buffer.
Returns:
Amount of data placed in the outData buffer

Implements XSECCryptoBase64.

virtual void OpenSSLCryptoBase64::decodeInit void    [virtual]
 

Initialise the base64 object.

The XSEC library will always call this function prior to decoding any data. This function will also be called when one decode (or encode) has been completed and the library wishes to re-use the object for another decode operation.

Implements XSECCryptoBase64.

virtual unsigned int OpenSSLCryptoBase64::encode unsigned char *    inData,
unsigned int    inLength,
unsigned char *    outData,
unsigned int    outLength
[virtual]
 

Encode some passed in data.

The XSEC library will pass a block of data into the Encoder and request that as much as possible be encoded into the outData buffer.

Due to the nature of the implementation, there may be data that cannot be fully encoded (not enough data through yet). The implementation is expected to keep this in memory until another call to encode() or a call to encodeFinish().

Parameters:
inData  Pointer to the buffer holding data to be encoded.
inLength  Length of the data in the buffer
outData  Buffer to place encoded data into
outLength  Maximum amount of data that can be placed in the buffer.
Returns:
The number of bytes placed in the outData buffer.

Implements XSECCryptoBase64.

virtual unsigned int OpenSSLCryptoBase64::encodeFinish unsigned char *    outData,
unsigned int    outLength
[virtual]
 

Finish off an encode.

The library will call this when there is no more data for the current encode operation.

Parameters:
outData  Buffer to place any remaining encoded data
outLength  Max amount of data to be placed in the buffer.
Returns:
Amount of data placed in the outData buffer

Implements XSECCryptoBase64.

virtual void OpenSSLCryptoBase64::encodeInit void    [virtual]
 

Initialise the base64 object for encoding.

The XSEC library will always call this function prior to encoding any data. This function will also be called when one encode (or decode) has been completed and the library wishes to re-use the object for another encode operation.

Implements XSECCryptoBase64.


The documentation for this class was generated from the following file:
Generated on Sat Jan 11 20:35:16 2003 for XML-Security-C by doxygen1.2.15