ezcheck

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 24 Open GitHub ↗

An easy-to-use, lightweight, cross-platform, and high-performance tool for calculating, comparing, and verifying hash of strings and files.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ezcheck

[![Build](https://github.com/Metaphorme/ezcheck/actions/workflows/build.yml/badge.svg)](https://github.com/Metaphorme/ezcheck/actions/workflows/build.yml)
[![Test](https://github.com/Metaphorme/ezcheck/actions/workflows/test.yml/badge.svg)](https://github.com/Metaphorme/ezcheck/actions/workflows/test.yml)
[![Crates.io Version](https://img.shields.io/crates/v/ezcheck?logo=rust)](https://crates.io/crates/ezcheck)
[![Mirror Gitee](https://img.shields.io/badge/Mirror-Gitee-blue?logo=gitee)](https://gitee.com/metaphorme/ezcheck)

[中文文档](./README_zh.md)

ezcheck(easy check) is an easy-to-use, lightweight, cross-platform, and high-performance tool for calculating,
comparing, and verifying hash of strings and files. Designed to prevent content tampering and ensure file integrity.

ezcheck have three backends: [ring](https://docs.rs/ring), [hashes](https://docs.rs/hashes) and mix
backend([ring](https://docs.rs/ring) and [hashes](https://docs.rs/hashes)), and you can only choose
one of them. The main differences between them are:

| Features             | ring                                                       | hashes                                                          | mix(Recommended)                                                                                |
|----------------------|------------------------------------------------------------|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| Speed                | Fast.                                                      | About 5 times slower than ring.                                 | Use the fastest backend that supports the algorithm.                                            | 
| Supported algorithms | SHA256, SHA384, SHA512, SHA512/256, XXHASH32, XXHASH64, XXHASH3_64 | MD2, MD4, MD5, SHA1, SHA224, SHA256, SHA384, SHA512, SHA512/256, XXHASH32, XXHASH64, XXHASH3_64 | MD2, MD4, MD5, SHA1, SHA224, SHA256, SHA384, SHA512, SHA512/256, XXHASH32, XXHASH64, XXHASH3_64 |
| Implement languages  | Assembly, Rust, C and etc..                                | Rust                                                            | Assembly, Rust, C and etc..                                                                     |
| Compatibility        | May not work on every machine with different architecture. | Works well with Rust.                                           | Same to ring.                                                                                   |

❗️ To achieve both fastest speed and maximum compatibility, the default backend is **mix backend**.

⚠️ Please notice that although ezcheck supports a lot of hash algorithms, `MD2`, `MD4`, `MD5`, `SHA1` are proven to be
**insecure**. ezcheck still provides them for maximum compatibility, but **it does not recommend users continue to use
them**.

## Setup

### Direct Binary Download

Download the suitable **mix backend** binary from the [release](https://github.com/Metaphorme/ezcheck/releases/latest).

### Install from Cargo

```bash
$ # mix backend
$ cargo install ezcheck
$ # ring backend
$ cargo install ezcheck --no-default-features --features ring_backend
$ # hashes backend
$ cargo install ezcheck --no-default-features --features hashes_backend
```

### Instantly run ezcheck with x-cmd

[x-cmd](https://x-cmd.com) is a lightweight cross-platform package manager implemented in posix shell. Quickly download
and execute `ezcheck` with a single command: [`x ezcheck`](https://x-cmd.com/pkg/ezcheck)

You can also install `ezcheck` in the user level without requiring root privileges:

```bash
$ x env use ezcheck
```

### Build from source

[![MSRV](https://img.shields.io/crates/msrv/ezcheck)](https://raw.githubusercontent.com/Metaphorme/ezcheck/master/Cargo.toml)

#### Build

```bash
$ git clone https://github.com/Metaphorme/ezcheck && cd ezcheck
$ # Choose one from mix backend, hashes backend or ring backend
$ # mix backend
$ cargo build --release
$ # ring backend
$ cargo build --release --no-default-features --features ring_backend
$ # hashes backend
$ cargo build --release --no-default-features --features hashes_backend
$
$ ./target/release/ezcheck --version
```

## Run tests

```bash
$ git clone https://github.com/Metaphorme/ezcheck && cd ezcheck
$ cargo test  # mix backend
$ cargo test --no-default-features --features ring_backend    # ring backend
$ cargo test --no-default-features --features hashes_backend  # hashes backend
```

## Usage

Supported hash algorithms of different backends:

| ring       | hashes     | mix                       |
|------------|------------|---------------------------|
|            | MD2        | MD2 (hashes backend)      |
|            | MD4        | MD4 (hashes backend)      |
|            | MD5        | MD5 (hashes backend)      |
|            | SHA1       | SHA1 (hashes backend)     |
|            | SHA224     | SHA224 (hashes backend)   |
| SHA256     | SHA256     | SHA256 (ring backend)     |
| SHA384     | SHA384     | SHA384 (ring backend)     |
| SHA512     | SHA512     | SHA512 (ring backend)     |
| SHA512/256 | SHA512/256 | SHA512/256 (ring backend) |
| XXHASH32   | XXHASH32   | XXHASH32                  |
| XXHASH64   | XXHASH64   | XXHASH64                  |
| XXHASH3_64 | XXHASH3_64 | XXHASH3_64                |

### Calculate

Calculate hash for file(s) or text.

```bash
$ # Usage:
$ #  ezcheck calculate|c [ALGORITHM (Default SHA256)] (-f file(s)/"-" for standard input | -t text)
$
$ # Examples:
$ ezcheck c sha256 -f image.jpg
b4c5e1d0a1f84a07ef6f329d3dcec62bce40103f49d8088e2b1b98a87e4ff0c2  image.jpg
$
$ cat image.jpg | ezcheck calculate sha256 -f -
b4c5e1d0a1f84a07ef6f329d3dcec62bce40103f49d8088e2b1b98a87e4ff0c2  -
$
$ ezcheck calculate sha256 -t "Hello"
185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969
$
$ ezcheck calculate -f image.jpg
No algorithm specified. Using SHA256 as the default.
b4c5e1d0a1f84a07ef6f329d3dcec62bce40103f49d8088e2b1b98a87e4ff0c2  image.jpg
$
$ # We could also redirect the output into a file, just like shasum does.
$ ezcheck calculate sha256 -f image.jpg > sha256sum.txt
```

### Compare

Compare with given hash.

The `-c/--check-hash` value also accepts `algorithm:hash`. Algorithm names keep the same
case-insensitive alias support as the CLI, such as `SHA256:...` or `sha512/256:...`.

```bash
$ # Usage:
$ #  ezcheck compare|m [ALGORITHM (Leave blank to automatically detect algorithm)] (-f file/"-" for standard input | -t text) -c hash
$  
$ # Examples:
$ ezcheck compare -t "Hello" -c sha256:185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969
SHA256 OK
$
$ ezcheck m sha256 -f image.jpg -c b4c5e1d0a1f84a07ef6f329d3dcec62bce40103f49d8088e2b1b98a87e4ff0c2
SHA256 OK
$
$ cat image.jpg | ezcheck compare sha256 -f - -c b4c5e1d0a1f84a07ef6f329d3dcec62bce40103f49d8088e2b1b98a87e4ff0c2                           
SHA256 OK
$
$ ezcheck compare sha256 -t "Hello" -c 085f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969
SHA256 FAILED  Current Hash:185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969
$
$ # Auto detect hash algorithm
$ ezcheck compare -f image.jpg -c b68c5da64847c4d8fd046ea6d6b4739f
INFO: Hash Algorithm could be MD5, MD4, MD2
MD5 FAILED  Current Hash:c8d0b68ed0abd920f9388973aa5a926e
MD4 OK
```

### Check

Check with given shasum-style check file.

shasum-style check file could be generated from [shasum](https://linux.die.net/man/1/shasum)
and [ezcheck](https://github.com/Metaphorme/ezcheck). The hash column can also use
`algorithm:hash`. It looks like:

```
00691413c731ee37f551bfaca6a34b8443b3e85d7c0816a6fe90aa8fc8eaec95  滕王阁序.txt
sha256:b4c5e1d0a1f84a07ef6f329d3dcec62bce40103f49d8088e2b1b98a87e4ff0c2 *image.jpg
```

```bash
$ # Usage:
$ #  ezcheck check|k [ALGORITHM (Leave blank to automatically detect algorithm)] -c check-file
$
$ # Relative paths inside the check file are resolved from the check file's directory.
$ # Example:
$ ezcheck k sha256 -c sha256sum.txt 
滕王阁序.txt: SHA256 OK
image.jpg: SHA256 OK
$
$ # Auto detect hash algorithm
$ cat md4sum.txt
9ec44ac67ab1e1c98fe0406478d5297d  滕王阁序.txt
b68c5da64847c4d8fd046ea6d6b4739f  image.jpg
$ ezcheck check -c md4sum.txt
滕王阁序.txt: MD5 FAILED  Current Hash:07c4e6a2c2db5f2d3a8998a3dba84a96
滕王阁序.txt: MD4 OK
image.jpg: MD5 FAILED  Current Hash:c8d0b68ed0abd920f9388973aa5a926e
image.jpg: MD4 OK
$
$ # Actually, ezcheck supports various algorithm in the same check file in auto detect.
$ # 🤔 But why this happens?
$ cat sha256sum.txt
00691413c731ee37f551bfaca6a34b8443b3e85d7c0816a6fe90aa8fc8eaec95  滕王阁序.txt
b4c5e1d0a1f84a07ef6f329d3dcec62bce40103f49d8088e2b1b98a87e4ff0c2 *image.jpg
9ec44ac67ab1e1c98fe0406478d5297d  滕王阁序.txt
$
$ ezcheck check -c sha256sum.txt
滕王阁序.txt: SHA256 OK
image.jpg: SHA256 OK
滕王阁序.txt: MD5 FAILED  Current Hash:07c4e6a2c2db5f2d3a8998a3dba84a96
滕王阁序.txt: MD4 OK
```

## Benchmark

### SHA256 Benchmark Tests

#### Method

* Device: MacBook Air M1 8GB

* Steps

1. Run and repeat 3 times:
        ```bash
        $ count=10000  # Test size = 1MiB * $count
        $ # Bare, Speed of generating the data
        $ dd if=/dev/zero bs=1M count=$count | pv > /dev/null
        $ # ezcheck-hashes
        $ dd if=/dev/zero bs=1M count=$count | pv | ./ezcheck-hashes calculate sha256 -f -
        $ # ezcheck-ring
        $ dd if=/dev/zero bs=1M count=$count | pv | ./ezcheck-ring calculate sha256 -f -
        $ # sha256sum
        $ dd if=/dev/zero bs=1M count=$count | pv | sha256sum
        ```

2. Calculate the average value.

#### Result

| Implementation / Speed(GiB/s) / Test size(MiB) | 1    | 100  | 500  | 1000 | 5000 | 10000 |
|------------------------------------------------|------|------|------|------|------|-------|
| Bare (Speed of generating the data)            | 2.13 | 3.02 | 4.59 | 5.31 | 5.97 | 6.07  |
| ezcheck-hashes                                 | 0.13 | 0.28 | 0.29 | 0.30 | 0.30 | 0.30  |
| ezcheck-ring                                   | 0.58 | 1.24 | 1.57 | 1.63 | 1.68 | 1.68  |
| sha256sum                                      | 0.73 | 1.26 | 1.63 | 1.69 | 1.75 | 1.81  |

![benchmark](https://raw.githubusercontent.com/Metaphorme/ezcheck/master/benchmark-sha256.png)

### Speed vs. Algorithms, Implementations

#### Method

* Device: MacBook Air M1 8GB

* Version: ezcheck 0.1.2

* Steps

1. Run:
        ```bash
        $ algorithm=sha256
        $ # ezcheck-hashes
        $ dd if=/dev/zero bs=1M count=10000 | pv | ./ezcheck-hashes calculate $algorithm -f -
        $ # ezcheck-ring
        $ dd if=/dev/zero bs=1M count=10000 | pv | ./ezcheck-ring calculate $algorithm -f -
        $ # ezcheck-mix
        $ dd if=/dev/zero bs=1M count=10000 | pv | ./ezcheck-mix calculate $algorithm -f -
        ```
    2. Calculate the average value.

#### Result

| Algorithms / Speed(GiB/s) / Implementations | ring   | hashes   | mix      |
|---------------------------------------------|--------|----------|----------|
| MD2                                         | 	null* | 	0.00896 | 	0.00896 |
| MD4                                         | 	null* | 	0.852   | 	0.852   |               
| MD5                                         | 	null* | 	0.549   | 	0.549   |                     
| SHA1                                        | 	null* | 	0.802   | 	0.802   |                      
| SHA224	                                     | null*  | 	0.299   | 	0.299   |                  
| SHA256                                      | 	1.69	 | 0.298    | 	1.70    |                   
| SHA384                                      | 	1.12	 | 0.473    | 	1.13    |                   
| SHA512	                                     | 1.13	  | 0.473    | 	1.13    |                   
| SHA512/256                                  | 	1.13	 | 0.473    | 	1.13    |               
| XXHASH32	                                   | N/A**  | N/A**    | 2.45     |               
| XXHASH64	                                   | N/A**  | N/A**    | 3.27     |               
| XXHASH3_64	                                 | N/A**  | N/A**    | 3.65     |

* _null*: The algorithm is not implemented in this implementation._

* _N/A**: XXHASH is supported by all current backends; this historical benchmark table only recorded the mix-backend measurements for XXHASH._

![benchmark](https://raw.githubusercontent.com/Metaphorme/ezcheck/master/benchmark-algorithms-implementations.png)

## License

```
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

ezcheck

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README