Skip to content

Latest commit

 

History

History
195 lines (150 loc) · 5.79 KB

README.md

File metadata and controls

195 lines (150 loc) · 5.79 KB
Raw

ddgst, dd's digest utility

ddgst is a simple hasher available cross-platform (Windows, macOS, Linux, BSDs) and comes with more features than built-in OS utilities.

Feature Comparison

Feature ddgst GNU coreutils uutils/coreutils OpenSSL 1
Check support ✔️ ✔️2 ✔️ ✔️
GNU style hashes ✔️ ✔️ ✔️3 ✔️
BSD style hashes ✔️ ✔️ ✔️ ✔️
SRI style hashes ✔️ 4 4 4

Algorithm Comparison

Checksum/Hash ddgst GNU coreutils uutils/coreutils OpenSSL1
CRC-32 ✔️
CRC-64-ISO ✔️
CRC-64-ECMA ✔️
MurmurHash3 ✔️
MD5 ✔️ ✔️ ✔️ ✔️
RIPEMD-160 ✔️ ✔️ ✔️
SHA-1 ✔️ ✔️ ✔️ ✔️
SHA-2 ✔️ ✔️ ✔️ ✔️
SHA-3/SHAKE ✔️ ✔️ ✔️
BLAKE2b ✔️ ✔️ ✔️5 ✔️
BLAKE2s ✔️ ✔️
BLAKE3 6 ✔️5

Algorithm Security

Checksum/Hash Type Secure
CRC-32 Checksum ❌
CRC-64-ISO Checksum ❌
CRC-64-ECMA Checksum ❌
Murmurhash-32 Hash ❌
Murmurhash-128-32 Hash ❌
Murmurhash-128-64 Hash ❌
MD5 Hash ❌
RIPEMD-160 Hash ✔️
SHA-1 Hash ❌
SHA-2 Hash ✔️
SHA-3/SHAKE Hash ✔️
BLAKE2b Hash ✔️
BLAKE2s Hash ✔️

Usage

Usage:

  • ddgst [options...] [file|-]
  • ddgst [options...] {--check|--autocheck} list
  • ddgst [options...] --against=HASH files...
  • ddgst [options...] --compare files...
  • ddgst [options...] --args text...
  • ddgst [options...] --benchmark

With no arguments, the help page is shown.

For a list of options available, use the --help argument.

For a list of supported checksums and hashes, use the --hashes switch.

Hashing files

The default mode is hashing files and directories using the GNU style.

Styles available:

Style Argument Example
GNU (default) 3853e2a78a247145b4aa16667736f6de LICENSE
BSD --tag MD5(LICENSE)= 3853e2a78a247145b4aa16667736f6de
SRI --sri md5-HSZ86zqNj3XxvjAR7ky/Uw==
Plain --plain 3853e2a78a247145b4aa16667736f6de

Check list of hashes

Check against file list (supports --tag):

$ ddgst --sha256 -c list
file1: OK
file2: FAILED
2 total: 1 mismatch, 0 not read

Using autodetection:

$ ddgst --autocheck list.sha256
file: OK
file2: FAILED
2 total: 1 mismatch, 0 not read

Check files against a hash digest

Supports hex and base64 digests.

$ ddgst --sha1 LICENSE -A f6067df486cbdbb0aac026b799b26261c92734a3
LICENSE: OK

Compare files against each other

$ ddgst --sha512 --compare LICENSE README.md dub.sdl 
Files 'LICENSE' and 'README.md' are different
Files 'README.md' and 'dub.sdl' are different
Files 'LICENSE' and 'dub.sdl' are different

Hash text entries

$ ddgst --crc32 --args "Argument with spaces" Arguments without spaces
f17cf59f  "Argument with spacesArgumentswithoutspaces"

Digest parameters

Some hashes may take optional parameters.

  • Murmurhash3
    • The --seed option takes an argument literal for seeding the hash.
    • Can only be a 32-bit integer seed in decimal format.
  • BLAKE2
    • The --key option takes a binary file for keying the hash.
    • BLAKE2s: Key can be up to 64 Bytes in size.
    • BLAKE2b: Key can be up to 128 Bytes in size.

File Pattern Globbing (* vs. '*')

This utility supports file globbing out of the box using std.file.dirEntries.

However, while useful on Windows, most UNIX-like terminals support in-shell globbing. This may behave differently than the dirEntries function.

To force the usage of the embedded globbing mechanism, you may want to use '*' or \*. To disable it, use the -- parameter.

The globbing pattern is further explained on dlang.org.

The default parameters used in dirEntries are:

  • SpanMode: shallow (same-level directory);
  • And followSymlink: true (follows soft symbolic links).

NOTE: The embedded globbing system includes hidden files.

EXAMPLE: A pattern such as src/*.{d,dd}:

  • Matches src/example.d, src/.dd, and src/file.dd;
  • But doesn't match example.d, src/.ddd, and src/.e;
  • Basically all files ending with .d and .dd in the src directory, following symlinks.

Errors

Code Description
1 CLI error
2 No hashes selected or autocheck not used
3 Internal error
4 Failed to set the hash key
5 Failed to set the hash seed
6 Missing entries
9 Could not hash text argument
10 List is empty
11 Unsupported style format
15 Two or more files are required to compare

Compiling

Compiling requires a recent D compiler and DUB.

To compile a debug build with the default compiler:

dub build

Release recommendation with the LDC compiler:

dub build -b release-nobounds --compiler=ldc2

To compile with GDC, you'll also need gdmd installed.

Footnotes

  1. See dgst command. ↩ ↩2

  2. All but cksum and sum. ↩

  3. * prepended to filename. ↩

  4. Possible to do with a chain of commands, but good luck remembering them. ↩ ↩2 ↩3

  5. As of 0.0.13 ↩ ↩2

  6. While the official BLAKE3 team has a b3sum, GNU does not. ↩