KMD5 Class Reference
Provides an easy to use C++ implementation of RSA's MD5 algorithm. An adapted C++ implementation of RSA Data Securities MD5 algorithm. More...
#include <kmdcodec.h>
Public Methods | |
KMD5 (const char *in, int len=-1) | |
Constructor that updates the digest for the given string. | |
KMD5 (const QByteArray &a) | |
Same as above except it accepts a QByteArray as its argument. | |
KMD5 (const QCString &a) | |
Same as above except it accepts a QByteArray as its argument. | |
void | update (const char *in, int len=-1) |
Updates the message to be digested. | |
void | update (const unsigned char *in, int len=-1) |
void | update (const QByteArray &in) |
void | update (const QCString &in) |
bool | update (QIODevice &file) |
reads the data from an I/O device, i.e. | |
void | reset () |
Calling this function will reset the calculated message digest. | |
const Digest & | rawDigest () |
void | rawDigest (KMD5::Digest &bin) |
Fills the given array with the binary representation of the message digest. | |
QCString | hexDigest () |
Returns the value of the calculated message digest in a hexadecimal representation. | |
void | hexDigest (QCString &) |
QCString | base64Digest () |
Returns the value of the calculated message digest in a base64-encoded representation. | |
bool | verify (const KMD5::Digest &digest) |
returns true if the calculated digest for the given message matches the given one. | |
bool | verify (const QCString &) |
Protected Methods | |
void | transform (const unsigned char buffer[64]) |
Performs the real update work. | |
void | finalize () |
finalizes the digest |
Detailed Description
Provides an easy to use C++ implementation of RSA's MD5 algorithm. An adapted C++ implementation of RSA Data Securities 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.
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
|
Constructor that updates the digest for the given string.
Definition at line 752 of file kmdcodec.cpp. References update(). |
|
Same as above except it accepts a QByteArray as its argument. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Definition at line 758 of file kmdcodec.cpp. References update(). |
|
Same as above except it accepts a QByteArray as its argument. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Definition at line 764 of file kmdcodec.cpp. References update(). |
Member Function Documentation
|
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!
Definition at line 444 of file kmdcodec.h. Referenced by finalize(), KMD5(), and update(). |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Definition at line 780 of file kmdcodec.cpp. References transform(). |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 770 of file kmdcodec.cpp. References update(). |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 775 of file kmdcodec.cpp. References QCString::length(), and update(). |
|
reads the data from an I/O device, i.e. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. from a file (QFile). NOTE that the file must be open for reading.
Definition at line 823 of file kmdcodec.cpp. References QIODevice::atEnd(), QIODevice::readBlock(), and update(). |
|
Calling this function will reset the calculated message digest. Use this method to perform another message digest calculation without recreating the KMD5 object. Definition at line 934 of file kmdcodec.cpp. |
|
Definition at line 882 of file kmdcodec.cpp. References finalize(). Referenced by verify(). |
|
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.
Definition at line 888 of file kmdcodec.cpp. References finalize(). |
|
Returns the value of the calculated message digest in a hexadecimal representation.
Definition at line 895 of file kmdcodec.cpp. References finalize(). Referenced by verify(). |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Definition at line 908 of file kmdcodec.cpp. References finalize(), and QCString::resize(). |
|
Returns the value of the calculated message digest in a base64-encoded representation.
Definition at line 918 of file kmdcodec.cpp. References KCodecs::base64Encode(), and finalize(). |
|
returns true if the calculated digest for the given message matches the given one.
Definition at line 870 of file kmdcodec.cpp. References finalize(), and rawDigest(). |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Definition at line 876 of file kmdcodec.cpp. References finalize(), and hexDigest(). |
|
Performs the real update work. Note that length is implied to be 64. Definition at line 950 of file kmdcodec.cpp. Referenced by update(). |
|
finalizes the digest
Definition at line 834 of file kmdcodec.cpp. References update(). Referenced by base64Digest(), hexDigest(), rawDigest(), and verify(). |
The documentation for this class was generated from the following files: