Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

Digest Class Reference

Compute Message Digests (MD5, SHA1 etc). More...

#include <Digest.h>

List of all members.

Public Member Functions

 Digest ()
 ~Digest ()
bool create (const std::string &name)
 initialize creation of a new message digest
const std::string & name ()
 get the name of the current digest algorithm
bool update (const char *bytes, size_t len)
 feed data into digest computation algorithm
std::string digest ()
 get hex string representation of the digest

Static Public Member Functions

static std::string digest (const std::string &name, std::istream &is, size_t bufsize=4096)
 compute digest of a stream. convenience function

Private Member Functions

 Digest (const Digest &d)
const Digestoperator= (const Digest &d)

Private Attributes

P * _dp


Detailed Description

Compute Message Digests (MD5, SHA1 etc).

The computation works by initializing the algorithm using create(). This will construct an internal state. successive calls to update() deliver the data for which the digest is to be computed. After all data has been deliverd, a call to digest() finalizes the computation and returns the result


Constructor & Destructor Documentation

Digest::Digest const Digest d  )  [private]
 

Digest::Digest  ) 
 

Digest::~Digest  ) 
 


Member Function Documentation

bool Digest::create const std::string &  name  ) 
 

initialize creation of a new message digest

Since openssl is used as backend you may use anything that openssl supports (see man 1 dgst). Common examples are md5 or sha1. sha1 should be preferred when creating digests to verify the authenticity of something.

successive calls to this funcion will destroy the internal state and reinit from scratch

Parameters:
name name of the message digest algorithm.
Returns:
whether an error occured

static std::string Digest::digest const std::string &  name,
std::istream &  is,
size_t  bufsize = 4096
[static]
 

compute digest of a stream. convenience function

calls create, update and digest in one function. The data for the computation is read from the stream

Parameters:
name name of the digest algorithm,
See also:
create
Parameters:
is an input stream to get the data from
bufsize size of the buffer used for update(). Be careful, this is on the stack.
Returns:
the digest or empty on error

std::string Digest::digest  ) 
 

get hex string representation of the digest

this function will finalize the digest computation. calls to update after this function will start from scratch

Returns:
hex string representation of the digest

const std::string& Digest::name  ) 
 

get the name of the current digest algorithm

const Digest& Digest::operator= const Digest d  )  [private]
 

bool Digest::update const char *  bytes,
size_t  len
 

feed data into digest computation algorithm

Parameters:
bytes 
len 
Returns:
whether an error occured


Member Data Documentation

P* Digest::_dp [private]
 


The documentation for this class was generated from the following file:
Generated on Fri Feb 24 00:30:02 2006 for liby2util by  doxygen 1.4.4