A cryptographic hash library that plays nicely with the C++ standard library
C C++
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cmake
docs
hashstream
test
CMakeLists.txt
LICENSE
README.md

README.md

The hashstream library

This is a library that wraps up implementations of various standard hashing functions into one library integrating with the C++ standard library.

Basic usage

See the test/test_hashstream.cpp file for a full example of usage. The gist is:

#include <iostream>
#include <string>

#include <hashstream/hashstream.hpp>

int main(int argc, char** argv)
{
  hashstream::hashstream hs(hashstream::SHA1);
  hs << "You can hash strings, or numbers: " << 34 << ", or even new-lines." << std::endl;

  std::cout << hs; // print the hexadecimal digest.
  std::string hd(hs.hex_digest()); // or get it as a string.

  return 0;
}

Compiling

You must have the boost libraries and CMake installed to compile hashstream. Make some temporary build directory, and compile hashstream with the following commands, replacing <build_dir> and <source_dir> with your build directory and the directory containing this file respectively.

$ cd <build_dir>
$ cmake <source_dir>
# ... output
$ make all

Full documentation

If you have the doxygen program installed, API documentation can be generated with make hashstream-docs. If CMake found the doxygen program at configure time, the documentation is always automatically built.

Embedding hashstream

It is envisaged that hashstream will be used within larger projects. To that end, it has been designed to be 'embedding friendly' with regards to CMake. If you include this directory in your existing CMake project and simply point CMake at it with add_subdirectory(hashstream), the Right Thing Should Happen(TM).

License

The majority of this code is under a permissive BSD-style license. See the LICENSE file for full details.