---

KMD5 Class Reference

An adapted C++ implementation of RSA Data Securities MD5 algorithm. More...

#include <kmdcodec.h>

List of all members.

Public Methods
	KMD5 (const char *in, int len=-1)
	KMD5 (const QByteArray &a)
	KMD5 (const QCString &a)
void	update (const char *in, int len=-1)
void	update (const unsigned char *in, int len=-1)
void	update (const QByteArray &in)
void	update (const QCString &in)
bool	update (QIODevice &file)
void	reset ()
const Digest &	rawDigest ()
void	rawDigest (KMD5::Digest &bin)
QCString	hexDigest ()
void	hexDigest (QCString &)
QCString	base64Digest ()
bool	verify (const KMD5::Digest &digest)
bool	verify (const QCString &)
Protected Methods
void	transform (const unsigned char buffer[64])
void	finalize ()

---

Detailed Description

An adapted C++ implementation of RSA Data Securities MD5 algorithm.

Provides an easy to use C++ implementation of RSA's MD5 algorithm.

The default constructor is designed to provide much the same functionality as the most commonly used C-implementation, while the other three constructors are meant to further simplify the process of obtaining a digest by calculating the result in a single step.

KMD5 is state-based, that means you can add new contents with update() as long as you didn't request the digest value yet. After the digest value was requested, the object is "finalized" and you have to call reset() to be able to do another calculation with it. The reason for this behaviour is that upon requesting the message digest KMD5 has to pad the received contents up to a 64 byte boundary to calculate its value. After this operation it is not possible to resume consuming data.

@sect Usage:

A common usage of this class:

  const char* test1;
  KMD5::Digest rawResult;

  test1 = "This is a simple test.";
  KMD5 context (test1);
  cout << "Hex Digest output: " << context.hexDigest().data() << endl;
 

To cut down on the unnecessary overhead of creating multiple KMD5 objects, you can simply invoke reset() to reuse the same object in making another calculation:

  context.reset ();
  context.update ("TWO");
  context.update ("THREE");
  cout << "Hex Digest output: " << context.hexDigest().data() << endl;
 

Author:

Dirk Mueller <mueller@kde.org>, Dawit Alemayehu <adawit@kde.org>

Definition at line 404 of file kmdcodec.h.

---

Constructor & Destructor Documentation

KMD5::KMD5 (  const char *    in, int    len = -1 )

Constructor that updates the digest for the given string. Parameters: in  C string or binary data len  if negative, calculates the length by using strlen on the first parameter, otherwise it trusts the given length (does not stop on NUL byte).

KMD5::KMD5 (  const QByteArray &    a )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Same as above except it accepts a QByteArray as its argument.

KMD5::KMD5 (  const QCString &    a )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Same as above except it accepts a QByteArray as its argument.

---

Member Function Documentation

QCString KMD5::base64Digest (    )

Returns the value of the calculated message digest in a base64-encoded representation.

void KMD5::finalize (    )  [protected]

finalizes the digest

void KMD5::hexDigest (  QCString &    )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QCString KMD5::hexDigest (    )

Returns the value of the calculated message digest in a hexadecimal representation.

void KMD5::rawDigest (  KMD5::Digest &    bin )

Fills the given array with the binary representation of the message digest. Use this method if you do not want to worry about making copy of the digest once you obtain it. Parameters: bin  an array of 16 characters ( char[16] )

const Digest& KMD5::rawDigest (    )

Returns: the raw representation of the digest

void KMD5::reset (    )

Calling this function will reset the calculated message digest. Use this method to perform another message digest calculation without recreating the KMD5 object.

void KMD5::transform (  const unsigned char    buffer[64] )  [protected]

Performs the real update work. Note that length is implied to be 64.

bool KMD5::update (  QIODevice &    file )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. reads the data from an I/O device, i.e. from a file (QFile). NOTE that the file must be open for reading. Parameters: file  a pointer to FILE as returned by calls like f{d,re}open Returns: false if an error occured during reading.

void KMD5::update (  const QCString &    in )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Parameters: in  message to be added to the digest (QByteArray).

void KMD5::update (  const QByteArray &    in )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Parameters: in  message to be added to the digest (QByteArray).

void KMD5::update (  const unsigned char *    in, int    len = -1 )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void KMD5::update (  const char *    in, int    len = -1 )  [inline]

Updates the message to be digested. Be sure to add all data before you read the digest. After reading the digest, you can not add more data! Parameters: in  message to be added to digest len  the length of the given message. Definition at line 444 of file kmdcodec.h.

bool KMD5::verify (  const QCString &    )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool KMD5::verify (  const KMD5::Digest &    digest )

returns true if the calculated digest for the given message matches the given one.

---

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

• kmdcodec.h

---