# hasher – 高性能多算法哈希计算器

[![许可证](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![OpenSSL](https://img.shields.io/badge/OpenSSL-3.x-green.svg)](https://www.openssl.org/)
[![构建状态](https://github.com/GavinGe021/hasher/actions/workflows/build.yml/badge.svg)](https://github.com/GavinGe021/hasher/actions)

[English](README.md) | [英文文档](README.md)

<<<<<<< HEAD
**版本 2.1.0** – 新增图形界面、自动优化和并行哈希！

`hasher` 是一款轻量级、高性能的命令行哈希计算工具。基于 OpenSSL 3.x EVP 接口，支持 20 余种哈希算法，具备异步 I/O、多文件并行处理和智能进度条等功能。

=======
`hasher` 是一款轻量级、高性能的命令行哈希计算工具。基于 OpenSSL 3.x EVP 接口，支持 20 余种哈希算法，具备异步 I/O、多文件并行处理和智能进度条等功能。

**版本 2.0.0** 新增了 HMAC、校验和验证/生成、JSON/CSV 输出、彩色输出和配置文件支持。

>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403
## ✨ 特性

- **多算法支持**：MD4, MD5, SHA-1, SHA-2 系列, SHA-3, BLAKE2, SM3, RIPEMD-160, Whirlpool, Keccak 等。
- **高性能**：采用双缓冲 + 异步 I/O 架构，充分发挥 CPU 与磁盘性能。
- **并行处理**：通过 `--threads` 支持多文件并行计算。
- **智能进度条**：大文件实时显示速度和剩余时间。
<<<<<<< HEAD
- **自动优化**：线程数和缓冲区大小自动调整。
- **单文件并行哈希**：大文件分块多线程计算，速度提升 2~4 倍。
- **图形界面**：基于 Qt 的 GUI，支持拖放、进度条、任务栏进度、复制/保存结果。
- **HMAC 支持**：`--hmac <key>` 计算键控哈希消息认证码。
- **校验模式**：`--check <file>` 验证校验和文件（类似 `sha256sum -c`），支持通配符。
=======
- **HMAC 支持**：`--hmac <key>` 计算键控哈希消息认证码。
- **校验模式**：`--check <file>` 验证校验和文件（类似 `sha256sum -c`）。
>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403
- **生成模式**：`--generate <file>` 生成标准校验和文件。
- **JSON/CSV 输出**：`--format json/csv` 方便脚本集成。
- **彩色输出**：`--color always/never/auto` 控制终端颜色。
- **配置文件**：`~/.hasher/config` 持久化设置。
<<<<<<< HEAD
- **管道输入**：支持 `echo -n hello | hasher`。
=======
>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403
- **跨平台**：Windows 与 Linux 均使用原生 I/O 接口，无性能损失。

## 📦 安装方式

<<<<<<< HEAD
### 下载预编译二进制（推荐）

从 [Releases 发布页](https://github.com/GavinGe021/hasher/releases) 下载对应平台的安装包：

- `hasher-2.1.0-setup.exe` – Windows GUI 版
- `hasher-cli-2.1.0-setup.exe` – Windows 命令行版
- `hasher` (Linux/macOS) – 静态二进制

=======
>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403
### 从源码编译

    git clone https://github.com/GavinGe021/hasher.git
    cd hasher
    make
    # 或手动编译：
    # g++ -std=c++17 -O3 -pthread -o hasher hasher.cpp -lcrypto -lssl
<<<<<<< HEAD

**依赖项**：OpenSSL 3.x 开发库（`libssl-dev` / `openssl-devel`）。
=======
    # 依赖项：OpenSSL 3.x 开发库（libssl-dev / openssl-devel）

### 下载预编译二进制（推荐）

从 [Releases 发布页](https://github.com/GavinGe021/hasher/releases) 下载对应平台的静态编译版本，解压即可使用。

### 包管理器安装（由社区维护）

- Windows (winget)：`winget install hasher`（待提交）
- Windows (Chocolatey)：`choco install hasher`
- Linux (APT)：后续将通过 PPA 提供
- macOS (Homebrew)：`brew install hasher`
>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403

## 🚀 使用说明

    hasher [选项] <输入> [算法] [<输入2> ...]

### 示例

    # 基本哈希（字符串）
    hasher hello

    # 文件哈希
    hasher --file myfile.iso

    # 自动检测（若存在同名文件则视为文件，否则视为字符串）
    hasher myfile

    # 指定算法
    hasher hello sha512

    # 并行处理（4 线程）
    hasher --threads=4 file1.iso file2.iso file3.iso

    # SHAKE 自定义输出长度（512 位）
    hasher --digest-bits=512 --file data.bin shake256

    # HMAC
    hasher --hmac mykey hello sha256

    # 验证校验和
    hasher --check checksum.sha256

    # 生成校验和文件
    hasher --generate output.sha256 file1.bin file2.bin

    # JSON 输出
    hasher --format json hello

    # 详细模式（显示速度）
    hasher --verbose largefile.bin

<<<<<<< HEAD
    # 管道输入
    echo -n hello | hasher

    # 通配符校验
    hasher --check "*.sha256"

=======
>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403
### 选项参数

| 选项 | 说明 |
| :--- | :--- |
| `--help, -h` | 显示帮助信息 |
| `--version, -V` | 显示版本号和 OpenSSL 版本信息 |
| `--file` | 强制将所有输入视为文件路径 |
| `--string` | 强制将所有输入视为文字字符串 |
<<<<<<< HEAD
| `--progress, -p` | 强制显示进度条 |
| `--no-progress` | 禁用进度条 |
| `--buffer-size=<MB>` | I/O 缓冲区大小（MB，默认自动） |
| `--threads=<N>` | 并行线程数（默认自动，最大 8） |
=======
| `--progress, -p` | 强制显示进度条（仅单文件模式） |
| `--no-progress` | 禁用进度条 |
| `--buffer-size=<MB>` | I/O 缓冲区大小（MB，默认 64） |
| `--threads=<N>` | 并行处理文件的数量（默认 1） |
>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403
| `--verbose, -v` | 打印速度、耗时等信息 |
| `--digest-bits=<N>` | SHAKE 算法的输出比特数 |
| `--format <fmt>` | 输出格式：`text`、`json`、`csv` |
| `--color <mode>` | 颜色模式：`auto`、`always`、`never` |
| `--hmac <key>` | 使用密钥计算 HMAC |
<<<<<<< HEAD
| `--check <file>` | 从文件验证校验和（支持通配符） |
=======
| `--check <file>` | 从文件验证校验和 |
>>>>>>> 0d407c4574fcf998e4016aa9d7459bdd385d5403
| `--generate <file>` | 生成标准校验和文件 |

### 支持的全部算法

`md4`, `md5`, `md5-sha1`, `sha1`, `sha224`, `sha256`, `sha384`, `sha512`, `sha512-224`, `sha512-256`, `sha3-224`, `sha3-256`, `sha3-384`, `sha3-512`, `shake128`, `shake256`, `blake2b512`, `blake2s256`, `ripemd160`, `sm3`, `whirlpool`, `mdc2`, `keccak224`, `keccak256`, `keccak384`, `keccak512`

> 安全提示：MD4、MD5、SHA-1 等算法已被证实存在安全风险，使用时会自动显示警告。

## ⚙️ 配置文件

创建 `~/.hasher/config`，每行 `键 = 值` 格式。支持的键：

- `default_algorithm` – 默认哈希算法（如 `sha256`）
- `buffer_size_mb` – I/O 缓冲区大小（MB）
- `color` – `auto`、`always`、`never`
- `format` – `text`、`json`、`csv`
- `progress` – `true` / `false`
- `threads` – 并行进程数
- `verbose` – `true` / `false`

环境变量 `HASHER_CONFIG` 可覆盖配置文件路径。

## 📊 性能表现

在测试环境（NVMe SSD + Intel i7）下，计算 10GB 文件的 SHA-256 速度可达 ~600 MB/s，多文件并行时可充分利用多核 CPU。

## 🔒 安全说明

- 本工具仅用于哈希计算，不涉及加密或身份验证。
- 使用弱哈希算法（如 MD5）时，用户需自行承担安全风险（工具会显示警告）。

## 🤝 参与贡献

欢迎提交 Issue 和 Pull Request。提交代码时请确保兼容 C++17，并遵循 OpenSSL 的使用规范。

## 📜 许可证

本项目采用 **MIT 许可证**，使用 OpenSSL 3.x（Apache 2.0 许可证），详见 [LICENSE](LICENSE) 文件。