UCommon
Public Member Functions | Static Public Member Functions | Protected Member Functions
ucommon::Digest Class Reference

A cryptographic digest class. More...

#include <secure.h>

Public Member Functions

const char * c_str (void)
 Digest (const char *type)
const unsigned char * get (void)
 operator bool () const
 operator String ()
bool operator! () const
const char * operator* ()
bool operator*= (const char *text)
bool operator+= (const char *text)
Digestoperator<< (const char *str)
Digestoperator<< (int16_t value)
Digestoperator<< (int32_t value)
Digestoperator<< (const PrintProtocol &p)
void operator= (const char *id)
bool put (const void *memory, size_t size)
bool puts (const char *str)
void recycle (bool binary=false)
 Finalize and recycle current digest to start a new digest.
void reset (void)
 Reset and restart digest object.
void set (const char *id)
unsigned size () const
String str (void)

Static Public Member Functions

static bool has (const char *name)
 Test to see if a specific digest type is supported.
static String md5 (const char *text)
 Shortcut for short md5 digests if supported...
static String sha1 (const char *text)
static String sha256 (const char *text)
static void uuid (char *string, const char *name, const unsigned char *ns=((void *) 0))
static String uuid (const char *name, const unsigned char *ns=((void *) 0))

Protected Member Functions

void release (void)

Detailed Description

A cryptographic digest class.

This class can support md5 digests, sha1, sha256, etc, depending on what the underlying library supports. The hash class accumulates the hash in the object.

Author:
David Sugar <dyfet@gnutelephony.org>
Examples:
digest.cpp.

Definition at line 445 of file secure.h.


Member Function Documentation

static bool ucommon::Digest::has ( const char *  name) [static]

Test to see if a specific digest type is supported.

Parameters:
nameof digest we want to check.
Returns:
true if supported, false if not.
static String ucommon::Digest::md5 ( const char *  text) [static]

Shortcut for short md5 digests if supported...

Parameters:
textto create a digest for.
Returns:
digest string.
Examples:
digest.cpp.
void ucommon::Digest::recycle ( bool  binary = false)

Finalize and recycle current digest to start a new digest.

Parameters:
binarydigest used rather than text if true.

The documentation for this class was generated from the following file: