Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page.
Requires a signed-in GitHub account. This works well for small changes.
If you'd like to make larger changes you may want to consider using
a local clone.
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.
Category | Functions |
---|---|
Template API | SHA1 |
OOP API | SHA1Digest |
Helpers | sha1Of |
License:
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
Kai Nacke, Johannes Pfau, Nick Sabalausky
Source std/digest/sha.d
Examples:
//Template API import std.digest.sha; ubyte[20] hash1 = sha1Of("abc"); writeln(toHexString(hash1)); // "A9993E364706816ABA3E25717850C26C9CD0D89D" ubyte[28] hash224 = sha224Of("abc"); writeln(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();
Examples:
//OOP API import std.digest.sha; auto sha1 = new SHA1Digest(); ubyte[] hash1 = sha1.digest("abc"); writeln(toHexString(hash1)); // "A9993E364706816ABA3E25717850C26C9CD0D89D" auto sha224 = new SHA224Digest(); ubyte[] hash224 = sha224.digest("abc"); writeln(toHexString(hash224)); // "23097D223405D8228642A477BDA255B32AADBCE4BDA0B3F7E36C9DA7" //Feeding data ubyte[1024] data; sha1.put(data[]); sha1.reset(); //Start again sha1.put(data[]); hash1 = sha1.finish();
- 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.The hashBlockSize and digestSize are in bits. However, it's likely easier to simply use the convenience aliases: SHA1, SHA224, SHA256, SHA384, SHA512, SHA512_224 and SHA512_256. See std.digest for differences between template and OOP API.Examples:
//Simple example, hashing a string using sha1Of helper function ubyte[20] hash = sha1Of("abc"); //Let's get a hash string writeln(toHexString(hash)); // "A9993E364706816ABA3E25717850C26C9CD0D89D" //The same, but using SHA-224 ubyte[28] hash224 = sha224Of("abc"); writeln(toHexString(hash224)); // "23097D223405D8228642A477BDA255B32AADBCE4BDA0B3F7E36C9DA7"
Examples://Using the basic API SHA1 hash; hash.start(); ubyte[1024] data; //Initialize data here... hash.put(data); ubyte[20] result = hash.finish();
Examples://Let's use the template features: //Note: When passing a SHA1 to a function, it must be passed by reference! void doSomething(T)(ref T hash) if (isDigest!T) { hash.put(cast(ubyte) 0); } SHA1 sha; sha.start(); doSomething(sha); writeln(toHexString(sha.finish())); // "5BA93C9DB0CFF93F52B521D7420E43F6EDA2784F"
- pure nothrow @nogc @safe void
start
(); - SHA initialization. Begins an SHA1/SHA2 operation.
Note For this SHA Digest implementation calling start after default construction is not necessary. Calling start is only necessary to reset the Digest.
Generic code which deals with different Digest types should always call start though.Example
SHA1 digest; //digest.start(); //Not necessary digest.put(0);
- pure nothrow @nogc @trusted void
put
(scope const(ubyte)[]input
...); - Use this to feed the digest with data. Also implements the std.range.primitives.isOutputRange interface for ubyte and const(ubyte)[].
- pure nothrow @nogc @trusted ubyte[digestSize / 8]
finish
(); - Returns the finished SHA hash. This also calls start to reset the internal state.Examples:
//Simple example SHA1 hash; hash.start(); hash.put(cast(ubyte) 0); ubyte[20] result = hash.finish();
- alias
SHA1
= SHA!(512u, 160u).SHA; - SHA alias for SHA-1, hash is ubyte[20]
- alias
SHA224
= SHA!(512u, 224u).SHA; - SHA alias for SHA-224, hash is ubyte[28]
- alias
SHA256
= SHA!(512u, 256u).SHA; - SHA alias for SHA-256, hash is ubyte[32]
- alias
SHA384
= SHA!(1024u, 384u).SHA; - SHA alias for SHA-384, hash is ubyte[48]
- alias
SHA512
= SHA!(1024u, 512u).SHA; - SHA alias for SHA-512, hash is ubyte[64]
- alias
SHA512_224
= SHA!(1024u, 224u).SHA; - SHA alias for SHA-512/224, hash is ubyte[28]
- alias
SHA512_256
= SHA!(1024u, 256u).SHA; - SHA alias for SHA-512/256, hash is ubyte[32]
- auto
sha1Of
(T...)(Tdata
);
autosha224Of
(T...)(Tdata
);
autosha256Of
(T...)(Tdata
);
autosha384Of
(T...)(Tdata
);
autosha512Of
(T...)(Tdata
);
autosha512_224Of
(T...)(Tdata
);
autosha512_256Of
(T...)(Tdata
); - These are convenience aliases for std.digest.digest using the SHA implementation.Examples:
ubyte[20] hash = sha1Of("abc"); writeln(hash); // digest!SHA1("abc") ubyte[28] hash224 = sha224Of("abc"); writeln(hash224); // digest!SHA224("abc") ubyte[32] hash256 = sha256Of("abc"); writeln(hash256); // digest!SHA256("abc") ubyte[48] hash384 = sha384Of("abc"); writeln(hash384); // digest!SHA384("abc") ubyte[64] hash512 = sha512Of("abc"); writeln(hash512); // digest!SHA512("abc") ubyte[28] hash512_224 = sha512_224Of("abc"); writeln(hash512_224); // digest!SHA512_224("abc") ubyte[32] hash512_256 = sha512_256Of("abc"); writeln(hash512_256); // digest!SHA512_256("abc")
- alias
SHA1Digest
= std.digest.WrapperDigest!(SHA!(512u, 160u)).WrapperDigest;
aliasSHA224Digest
= std.digest.WrapperDigest!(SHA!(512u, 224u)).WrapperDigest;
aliasSHA256Digest
= std.digest.WrapperDigest!(SHA!(512u, 256u)).WrapperDigest;
aliasSHA384Digest
= std.digest.WrapperDigest!(SHA!(1024u, 384u)).WrapperDigest;
aliasSHA512Digest
= std.digest.WrapperDigest!(SHA!(1024u, 512u)).WrapperDigest;
aliasSHA512_224Digest
= std.digest.WrapperDigest!(SHA!(1024u, 224u)).WrapperDigest;
aliasSHA512_256Digest
= std.digest.WrapperDigest!(SHA!(1024u, 256u)).WrapperDigest; - OOP API SHA1 and SHA2 implementations. See std.digest for differences between template and OOP API.This is an alias for std.digest.WrapperDigest!SHA1, see there for more information.Examples:
//Simple example, hashing a string using Digest.digest helper function auto sha = new SHA1Digest(); ubyte[] hash = sha.digest("abc"); //Let's get a hash string writeln(toHexString(hash)); // "A9993E364706816ABA3E25717850C26C9CD0D89D" //The same, but using SHA-224 auto sha224 = new SHA224Digest(); ubyte[] hash224 = sha224.digest("abc"); //Let's get a hash string writeln(toHexString(hash224)); // "23097D223405D8228642A477BDA255B32AADBCE4BDA0B3F7E36C9DA7"
Examples://Let's use the OOP features: void test(Digest dig) { dig.put(cast(ubyte) 0); } auto sha = new SHA1Digest(); test(sha); //Let's use a custom buffer: ubyte[20] buf; ubyte[] result = sha.finish(buf[]); writeln(toHexString(result)); // "5BA93C9DB0CFF93F52B521D7420E43F6EDA2784F"
Copyright © 1999-2022 by the D Language Foundation | Page generated by
Ddoc on (no date time)