FBB::DigestBuf(3bobcat)

Compute Message Digests
(libbobcat-dev_4.08.03-x.tar.gz)

2005-2018

NAME

FBB::DigestBuf - Computes Message Digests from information inserted into a std::ostream

SYNOPSIS

#include <bobcat/digestbuf>
Linking option: -lbobcat

DESCRIPTION

FBB::DigestBuf objects are std::streambuf objects that can be used to initialize std::ostream objects with.

All information inserted into such a std::ostream is used to compute a message digest from.

All the message digests defined by the OpenSSL library that can be selected by name may be used in combination with DigestBuf objects.

The following message digest algorithms are currently supported: mull, md2, md5, sha, sha1, sha224, sha256, sha384, sha512, dss, dss1, ecdsa, mdc2, ripemd160. These very names are the ones to use to select the particular digest algorithms for the class's constructor, below. It is quite possible that future releases of the openssl library will support additional message digest algorithms. The header file openssl/evp.h lists all available digest algorithms (in that file look for EVP_MD *EVP_: a message digest algorithm immediately follows the 2nd underscore. E.g., const EVP_MD *EVP_md4(void) which refers to the md4 message digest algorithm).

NAMESPACE

FBB
All constructors, members, operators and manipulators, mentioned in this man-page, are defined in the namespace FBB.

INHERITS FROM

std::streambuf

CONSTRUCTORS

There is no copy constructor.

OVERLOADED OPERATOR

The overloaded assignment operator is not available.

MEMBER FUNCTIONS

All members of std::streambuf are available, as FBB::DigestBuf inherits from this class. Some of the std::streambuf's member are overridden or are hidden by DigestBuf. In normal situations these inherited members will not be used by programs using DigestBuf objects.

EXAMPLE

#include <iostream>
#include <ostream>
#include <bobcat/exception>
#include <bobcat/digestbuf>

using namespace std;
using namespace FBB;

int main(int argc, char **argv)
try
{
    DigestBuf digestbuf(argv[1]);
    ostream out(&digestbuf);

    string hw("hello world\n");

    out << hw;
    digestbuf.close();
    cout << ">" << digestbuf << "<" << endl;

    digestbuf.open();
    out.write(hw.c_str(), hw.length());
    digestbuf.close();
    cout << ">" << digestbuf << "<" << endl;
}
catch(exception const &err)
{
    cout << err.what() << endl;
    return 1;
}

FILES

bobcat/digestbuf - defines the class interface

SEE ALSO

bobcat(7), hmacbuf(3bobcat), std::streambuf

BUGS

None reported

DISTRIBUTION FILES

BOBCAT

Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.

COPYRIGHT

This is free software, distributed under the terms of the GNU General Public License (GPL).

AUTHOR

Frank B. Brokken (f.b.brokken@rug.nl).