HashifyNET CLI is a robust and versatile platform-independent command-line utility. It provides a high-performance interface for computing a comprehensive array of cryptographic and non-cryptographic hash algorithms, all of which are made available through the underlying HashifyNET library.
The CLI is fundamentally powered by the HashifyNET project, inheriting its extensive suite of validated hash algorithm implementations. This foundational dependency ensures that all computations are both accurate and efficient. The tool serves a dual purpose: it acts as a practical demonstration of the library's power and provides the community with a standardized, reliable utility for hash computation tasks.
A key architectural feature of HashifyNET CLI is its use of Lua for all input/output (I/O) operations. This design choice empowers users with unparalleled flexibility, far exceeding that of typical command-line tools. It grants a level of control comparable to native C# programming without the overhead of compiling a full application. Users can implement complex logic to preprocess input data from various sources, interact with external systems, or dynamically format the output into structured formats such as JSON, CSV, or XML, tailored to their specific needs.
To accommodate a wide range of operational scenarios, from simple ad-hoc tasks to complex, automated workflows, the utility provides a hierarchical configuration system:
- Direct Command-Line Parameters: For straightforward, immediate operations and easy integration into shell scripts.
- Parameter Files: Ideal for managing exceptionally long or complex command-line arguments. This method enhances readability, ensures reproducibility, and circumvents potential command-length and syntax limitations imposed by the operating system.
- JSON Configuration Files: For advanced customization, users can define persistent settings, configure algorithm-specific parameters (e.g., keys, salts), and create multiple profiles for different use cases, ensuring a consistent and efficient workflow.
The combination of extensive algorithm support and advanced scripting makes HashifyNET CLI suitable for a multitude of applications, including file integrity verification, data deduplication, digital forensics, password security analysis, and integration into larger data processing pipelines. In summary, it stands as a powerful and extensible framework for anyone requiring precise and adaptable hashing capabilities.
Currently, the only ways to access HashifyNETCLI are downloading the pre-built binaries from here on GitHub or building the source code yourself.
You can find the pre-built binaries in the Releases page.
Important
Starting from version 0.7.0, HashifyNETCLI supports streaming computation for large files.
Please use OpenRead instead of ReadAllBytes for large files.
HashifyCLI -i "'Hello World'" -a "CRC" -cp "CRC=CRC32"
HashifyCLI -i "'Hello World'" -a "CRC:1 CRC:2" -cp "CRC:1=CRC32 CRC:2=CRC64"
HashifyCLI -i "ReadAllBytes('HashifyCLI.exe')" -if "Input" -a "MD5 CRC:1 CRC:2" -cp "CRC:1=CRC32 CRC:2=CRC64"
For files larger than 64 megabytes, HashifyNETCLI reads them in 64-megabyte chunks.
Make sure to use OpenRead or a similar alternative that returns a Stream and not a byte array for streaming computation support.
HashifyCLI -i "OpenRead('LARGEFILE')" -if "Input" -a "MD5 CRC:1 CRC:2" -cp "CRC:1=CRC32 CRC:2=CRC64"
The query used for algorithms and config profiles is the same; each execution is separated with spaces.
A query of CRC CRC will compute two CRC hashes, typically yielding the same output.
To use the same hash algorithm more than once with different config profiles, you must use the name suffixes separated by a colon, just like this:
CRC:myCrc1 CRC:myCrc2
And when you are going to assign profiles to them, you do it in a very similar way, as follows:
CRC:myCrc1=CRC32 CRC:myCrc2=CRC64
The command line results in something like this:
HashifyCLI -i "'Hello World'" -a "CRC:myCrc1 CRC:myCrc2" -cp "CRC:myCrc1=CRC32 CRC:myCrc2=CRC64"
This will generate 2 CRC hashes, first 32-bit and the second 64-bit, for the same input.
The execution order for the entire process is as follows:
-input >> --input-finalizer >> [cyclist begin // --algorithm >> Compute >> --output-finalizer >> --output \\ cyclist end]
HashifyCLI -i "tostring(DateTimeOffset.UtcNow.Ticks)" -a "CRC" -cp "CRC=CRC32"
HashifyCLI -i "ToArray({5, 3, 1})" -if "Input" -a "MD5" -of "AsHexString() ~= '395a1d76a5406630c9d355a6c7b34ae0' and Fail('Hash Mismatch').ToString() or 'Hash Matches'"
Important
Lua table conversion with ToArray or ToByteArray is available in 0.7.0 and later.
Note
Call to Fail interrupts the entire execution and causes the CLI to return status code 2.
HashifyCLI -i "'Hello World'" -a "Argon2id" -cp "Argon2id=OWASP" -of "Decode()"
HashifyCLI -i "'Hello World'" -a "Argon2id" -cp "Argon2id=OWASP" -of "Decode()" -o "PrintDirect(Result)"
The CLI supports JSON config files to be passed with the -cf or --config-file parameter. This JSON file must contain config profiles or preferences for any supported hash algorithm that you'd use.
A valid JSON config is like this:
{
"CRC": {
"profile": "CRC32"
}
}A custom CRC would look like this in JSON:
{
"CRC": {
"config": {
"HashSizeInBits": 32,
"Polynomial": 79764919,
"InitialValue": 4294967295,
"ReflectIn": true,
"ReflectOut": true,
"XOrOut": 4294967295
}
}
}Here's another JSON containing multiple configs:
{
"CRC": {
"config": {
"HashSizeInBits": 32,
"Polynomial": 79764919,
"InitialValue": 4294967295,
"ReflectIn": true,
"ReflectOut": true,
"XOrOut": 4294967295
}
},
"Argon2id": {
"profile": "OWASP"
},
"FNV1a": {
"profile": "Default"
}
}JSON containing multiple configs for the same algorithm:
Note
JSON input is ignored when -cp or --config-profiles exists in the command line parameters.
Make sure to use only one of them.
For reporting bugs and feature requests, please make an issue. For additional features or bug fixes made by you, feel free to open a pull request.
HashifyNETCLI is released under the terms of the MIT license. See LICENSE for more information or see http://opensource.org/licenses/MIT.
{ // Default CRC config that will be used for callees without a suffix. "CRC": { "profile": "CRC32" }, // CRC config for myCrc1 suffix. "CRC:myCrc1": { "profile": "CRC64" }, }