std.digest.sha

Computes SHA1 and SHA2 hashes of arbitrary data. SHA hashes are 20 to 64 byte quantities (depending on the SHA algorithm) that are like a checksum or CRC, but are more robust.

CategoryFunctions
Template APISHA1
OOP APISHA1Digest
Helperssha1Of

SHA2 comes in several different versions, all supported by this module: SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224 and SHA-512/256.

This module conforms to the APIs defined in std.digest. To understand the differences between the template and the OOP API, see std.digest.

This module publicly imports std.digest and can be used as a stand-alone module.

Public Imports

std.digest
public import std.digest;
Undocumented in source.

Members

Aliases

SHA1Digest
alias SHA1Digest = WrapperDigest!SHA1

OOP API SHA1 and SHA2 implementations. See std.digest for differences between template and OOP API.

Functions

sha1Of
auto sha1Of(T data)
sha224Of
auto sha224Of(T data)
sha256Of
auto sha256Of(T data)
sha384Of
auto sha384Of(T data)
sha512Of
auto sha512Of(T data)
sha512_224Of
auto sha512_224Of(T data)
sha512_256Of
auto sha512_256Of(T data)

These are convenience aliases for std.digest.digest using the SHA implementation.

Structs

SHA
struct SHA(uint hashBlockSize, uint digestSize)

Template API SHA1/SHA2 implementation. Supports: SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224 and SHA-512/256.

Examples

//Template API
import std.digest.sha;

ubyte[20] hash1 = sha1Of("abc");
assert(toHexString(hash1) == "A9993E364706816ABA3E25717850C26C9CD0D89D");

ubyte[28] hash224 = sha224Of("abc");
assert(toHexString(hash224) == "23097D223405D8228642A477BDA255B32AADBCE4BDA0B3F7E36C9DA7");

//Feeding data
ubyte[1024] data;
SHA1 sha1;
sha1.start();
sha1.put(data[]);
sha1.start(); //Start again
sha1.put(data[]);
hash1 = sha1.finish();
//OOP API
import std.digest.sha;

auto sha1 = new SHA1Digest();
ubyte[] hash1 = sha1.digest("abc");
assert(toHexString(hash1) == "A9993E364706816ABA3E25717850C26C9CD0D89D");

auto sha224 = new SHA224Digest();
ubyte[] hash224 = sha224.digest("abc");
assert(toHexString(hash224) == "23097D223405D8228642A477BDA255B32AADBCE4BDA0B3F7E36C9DA7");

//Feeding data
ubyte[1024] data;
sha1.put(data[]);
sha1.reset(); //Start again
sha1.put(data[]);
hash1 = sha1.finish();

Meta

License

Boost License 1.0.

CTFE: Digests do not work in CTFE

Authors

The routines and algorithms are derived from the Secure Hash Signature Standard (SHS) (FIPS PUB 180-2).
Kai Nacke, Johannes Pfau, Nick Sabalausky

References: