FBB::HMacBuf(3bobcat)

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

2005-2018

NAME

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

SYNOPSIS

#include <bobcat/hmacbuf>
Linking option: -lbobcat -lcrypto

DESCRIPTION

FBB::HMacBuf 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 HMAC from.

All the message digest algorithms defined by the OpenSSL library that can be selected by name may be used in combination with HMacBuf objects.

The following message hmac 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 algorithm 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 hmac 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::HMacBuf inherits from this class. Some of the std::streambuf's member are overridden or are hidden by HMacBuf. In normal situations these inherited members will not be used by programs using HMacBuf objects.

EXAMPLE

#include <iostream>
#include <ostream>
#include <cstring>
#include <iomanip>
#include <bobcat/exception>
#include <bobcat/hmacbuf>

using namespace std;
using namespace FBB;

int main(int argc, char **argv)
try
{
    if (argc < 3)
        throw Exception(0) << "Arg1: key, arg2: digest method required";

    string key(argv[1]);

    HMacBuf hmacbuf(key, argv[2]);
    ostream out(&hmacbuf);

    string hw("hello world\n");

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

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

FILES

bobcat/hmacbuf - defines the class interface

SEE ALSO

bobcat(7), digestbuf(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).