docs: update README, changelog, policies and add architecture, usage and release guides
- README: Windows/macOS/Linux, release assets, CLI, verifying downloads, building from source, live badges. - CHANGELOG: 1.2.0 notes (including the CRC32 byte-order change and the removed features); corrected the 1.0.0 ZIP description. - Privacy policy, ToS, EULA, disclaimer: describe the automatic update check and where data is stored; no more version pins; fixed the LICENSE link. SECURITY: supported versions and release protections. - ACKNOWLEDGEMENTS without stale version numbers; CONTRIBUTING with build, test and translation workflow. - New docs/ARCHITECTURE.md, docs/USAGE.md, docs/RELEASING.md and CLAUDE.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
e7a4830c41
commit
34aee3c5d2
13 files changed
+507
-153
No files matched your search
+20
-14
@@ -5,25 +5,31 @@ HashTool would not have been possible without the generous contributions of open
|
||||
All AI-generated content (code suggestions, translations, text) was carefully reviewed, tested, and verified by the author.
|
||||
|
||||
### AI Assistance
|
||||
- **Gemini 3 Pro** (including Jules Agent) (by Google): Provided code suggestions, debugging help, error detection,
|
||||
and fixes.
|
||||
- **Gemini 3 Pro** (including Jules Agent) (by Google): Provided code suggestions, debugging help, error detection, and fixes.
|
||||
- **Grok 4.1** (by xAI): Code suggestions, multi-language translations (30+ languages), and assistance in writing documentation/texts (e.g., Disclaimer, Privacy Policy).
|
||||
- **Claude** (by Anthropic): The 1.2.0 overhaul — new hashing engine, checksum files, command-line tool, tests, CI/CD and release automation, bug fixes, and translations of the new texts.
|
||||
|
||||
Big thanks to these AIs for speeding up development.
|
||||
|
||||
### Third-Party Libraries
|
||||
HashTool uses the following open-source libraries:
|
||||
HashTool uses the following open-source libraries. Exact versions are listed on the app's *About* page and in the SBOM files (`*.cdx.json`) attached to every release.
|
||||
|
||||
| Library | Used for | License |
|
||||
|---|---|---|
|
||||
| [Avalonia UI](https://github.com/AvaloniaUI/Avalonia) (Avalonia, Desktop, Themes.Fluent, Headless) | Cross-platform user interface | MIT |
|
||||
| [Inter](https://rsms.me/inter/) via Avalonia.Fonts.Inter | Default font | SIL OFL 1.1 (font), MIT (package) |
|
||||
| [SkiaSharp](https://github.com/mono/SkiaSharp) and [HarfBuzzSharp](https://github.com/mono/SkiaSharp) | Rendering and text shaping (through Avalonia) | MIT |
|
||||
| [Tmds.DBus.Protocol](https://github.com/tmds/Tmds.DBus) | Linux desktop integration (through Avalonia) | MIT |
|
||||
| [Blake3.NET](https://github.com/xoofx/Blake3.NET) | BLAKE3 hashing | BSD 2-Clause |
|
||||
| [System.IO.Hashing](https://github.com/dotnet/runtime) | xxHash and CRC32 | MIT |
|
||||
| [CommunityToolkit.Mvvm](https://github.com/CommunityToolkit/dotnet) | MVVM helpers | MIT |
|
||||
| [Material.Icons.Avalonia](https://github.com/AvaloniaUtils/Material.Icons.Avalonia) | Icons | MIT |
|
||||
| [Microsoft.Extensions.DependencyInjection / Logging](https://github.com/dotnet/runtime) | Composition and logging | MIT |
|
||||
| [System.CommandLine](https://github.com/dotnet/command-line-api) | The `hashtool` command-line tool | MIT |
|
||||
| [Velopack](https://github.com/velopack/velopack) | Installers and automatic updates | MIT |
|
||||
|
||||
Development and CI tools: [xUnit](https://github.com/xunit/xunit), [BenchmarkDotNet](https://github.com/dotnet/BenchmarkDotNet), [Meziantou.Analyzer](https://github.com/meziantou/Meziantou.Analyzer), [ReferenceTrimmer](https://github.com/dfederm/ReferenceTrimmer), [nuget-license](https://github.com/sensslen/nuget-license), [CycloneDX for .NET](https://github.com/CycloneDX/cyclonedx-dotnet), [zizmor](https://github.com/zizmorcore/zizmor), [actionlint](https://github.com/rhysd/actionlint), [gitleaks](https://github.com/gitleaks/gitleaks) and [OpenSSF Scorecard](https://github.com/ossf/scorecard).
|
||||
|
||||
- [Avalonia UI](https://github.com/AvaloniaUI/Avalonia) version 11.3.11 – Licensed under the MIT License.
|
||||
- [Avalonia.Controls.ColorPicker](https://github.com/AvaloniaUI/Avalonia) version 11.3.11 – Licensed under the MIT License.
|
||||
- [Avalonia.Controls.DataGrid](https://github.com/AvaloniaUI/Avalonia) version 11.3.11 – Licensed under the MIT License.
|
||||
- [Avalonia.Desktop](https://github.com/AvaloniaUI/Avalonia) version 11.3.11 – Licensed under the MIT License.
|
||||
- [Avalonia.Fonts.Inter](https://github.com/AvaloniaUI/Avalonia) version 11.3.11 – Licensed under the MIT License / SIL OFL 1.1.
|
||||
- [Avalonia.Themes.Fluent](https://github.com/AvaloniaUI/Avalonia) version 11.3.11 – Licensed under the MIT License.
|
||||
- [Blake3.NET](https://github.com/xoofx/Blake3.NET) version 2.2.0 – Copyright © Alexandre Mutel. Licensed under the BSD 2-Clause License.
|
||||
- [CommunityToolkit.Mvvm](https://github.com/CommunityToolkit/dotnet) version 8.2.1 – Licensed under the MIT License.
|
||||
- [Material.Icons.Avalonia](https://github.com/AvaloniaUtils/Material.Icons.Avalonia) version 2.4.1 – Licensed under the MIT License.
|
||||
- [Velopack](https://github.com/velopack/velopack) version 0.0.1298 – Licensed under the MIT License.
|
||||
Thank you to all the maintainers and contributors of these projects. Your work is greatly appreciated.
|
||||
|
||||
_© 2026 poli0981. All rights reserved._
|
||||
_© 2026 poli0981. All rights reserved._
|
||||
+50
-1
@@ -2,6 +2,55 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [1.2.0] - Unreleased
|
||||
|
||||
A big rework under the hood: faster hashing, standard checksum files, a command-line tool, a Linux build and a long list of fixes.
|
||||
|
||||
### Added
|
||||
- **Checksum files**: save all hashes as one `SHA256SUMS`-style file (GNU, BSD tagged, SFV, JSON or CSV), and verify any checksum file: `sha256sum`/`md5sum` output, BSD tagged lists, `.sfv`, xxhsum (`XXH3_` prefix) and single-hash files such as `image.iso.sha256`. Dropping a checksum file on Verify loads every file it lists.
|
||||
- **Command-line tool `hashtool`** for Windows, macOS and Linux: `hashtool hash`, `hashtool verify` (like `sha256sum -c`), `hashtool check` and `hashtool algorithms`.
|
||||
- **Linux** (AppImage) and **Intel Mac** builds.
|
||||
- **Open files from the system**: optional Explorer context menu on Windows ("Generate hash with Hash Tool", "Verify with Hash Tool"), "Open With" on macOS and `--create`/`--verify` command-line arguments. A second launch hands its files to the window that is already open.
|
||||
- Settings for files processed at the same time, hard-drive mode, hidden files, hash letter case, default checksum file format and the automatic update check.
|
||||
- Updates: optional automatic check (at most once a day), release notes, cancellable download, install now or when closing the app.
|
||||
- "Restart as Administrator" (Windows) when files cannot be read, keeping the file list.
|
||||
- Developer console: level filter, auto-scroll and export.
|
||||
- Keyboard shortcuts: Ctrl/⌘+O (add files), Ctrl/⌘+Shift+O (add folder), Ctrl/⌘+F (search), Ctrl/⌘+Enter (run all), Esc (cancel), Delete (remove).
|
||||
- The window remembers its size and position.
|
||||
|
||||
### Changed
|
||||
- **CRC32 is shown in the standard byte order** used by 7-Zip, SFV files and `cksum`: "123456789" now gives `CBF43926` (1.1 showed `2639F4CB`). CRC32 values saved by 1.1 still verify and are marked as using the old byte order.
|
||||
- New hashing engine: each file is read once for all selected algorithms, with large double-buffered reads, and several files are hashed at once (large files in their own lane). In benchmarks SHA-256 of a large file is about 1.7× faster than a plain single-buffer read, and 2,000 small files finish about 3.5× faster than one at a time.
|
||||
- Adding folders scans in the background, skips unreadable folders and symbolic-link loops, and no longer freezes the window.
|
||||
- Settings are written safely; a damaged settings file is backed up and reset instead of breaking the app. The chosen language is saved right away.
|
||||
- Daily log files with ISO timestamps (kept 14 days), user folder names masked, and crash reports.
|
||||
- Statuses, filters and dialogs follow the selected language immediately, including right-to-left layouts. Automatic language detection picks the right variant (Traditional Chinese for Taiwan and Hong Kong, Latin American Spanish, Norwegian, British English for Australia and others).
|
||||
- The colour-blind and high-contrast themes also recolour statuses.
|
||||
- Updated to Avalonia 12, the .NET 10.0.13 runtime, Velopack 1.2 and current versions of every library.
|
||||
|
||||
### Fixed
|
||||
- Crash when dropping a folder.
|
||||
- The app closing on unexpected errors, such as saving into a read-only folder; errors are now shown in a dialog.
|
||||
- Single-letter shortcuts (Shift+A/C/Z) firing while typing.
|
||||
- The search highlight showing the end of a file name twice.
|
||||
- Split archives (`.001`, `.7z.002`) being mistaken for hash files.
|
||||
- "Invalid" when loading a hash file that does not name the file, such as `SHA256SUMS`.
|
||||
- The expected hash getting lost when a file and its hash file were dropped together.
|
||||
- Calendar and number formatting in logs for some languages (Thai, Arabic, Turkish).
|
||||
- Missing, untranslated or misaligned text in several dialogs and languages; the Filipino translation is complete.
|
||||
|
||||
### Removed
|
||||
- The Free Memory button, Force Quit and its timeout setting.
|
||||
- Starting as administrator automatically (replaced by "Restart as Administrator" when it is needed).
|
||||
- The developer (pre-release) update channel and its disclaimer.
|
||||
|
||||
### Security
|
||||
- Removed the vulnerable Tmds.DBus.Protocol version (GHSA-xrw6-gwf8-vvr9) through the Avalonia upgrade.
|
||||
- Checksum files cannot point to network (UNC) or device paths, and exported CSV files cannot inject spreadsheet formulas.
|
||||
- Releases are built and tested in GitHub Actions, with `SHA256SUMS`, SBOMs and build provenance attestations; every pull request is scanned for vulnerable packages, licences and secrets.
|
||||
|
||||
---
|
||||
|
||||
## [1.1.3] - 2026-02-23
|
||||
|
||||
### Removed
|
||||
@@ -78,7 +127,7 @@ Quick hotfix to make things smoother. Enjoy.
|
||||
#### Create Hash
|
||||
- **Multi-Algorithm Support**: Calculate hashes using MD5, SHA1, SHA256, SHA384, SHA512, and BLAKE3.
|
||||
- **Batch Processing**: Compute hashes for multiple files simultaneously with high performance.
|
||||
- **File Compression**: Create ZIP archives containing both the original files and their generated hash files.
|
||||
- **File Compression**: Create ZIP archives of the generated hash files.
|
||||
- **Export**: Save hash results to separate files (e.g., `.sha256`).
|
||||
- **Clipboard Integration**: Quickly copy hash values to the clipboard.
|
||||
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
# CLAUDE.md
|
||||
|
||||
Guidance for AI coding agents working in this repository. Human contributors: see CONTRIBUTING.md.
|
||||
|
||||
## Project
|
||||
|
||||
Hash Tool — Avalonia 12 / .NET 10 desktop app (`src/HashTool.App`, executable `CheckHash`) plus the `hashtool` CLI
|
||||
(`src/HashTool.Cli`, NativeAOT), both built on `src/HashTool.Core`. Maintainer: poli0981 (GitHub). The maintainer writes
|
||||
in Vietnamese; reply in Vietnamese unless asked otherwise. Code, comments, commits and docs are English.
|
||||
|
||||
Read docs/ARCHITECTURE.md before larger changes and docs/RELEASING.md before touching packaging or the Release workflow.
|
||||
|
||||
## Commands
|
||||
|
||||
```text
|
||||
dotnet build HashTool.slnx -warnaserror # CI treats warnings (incl. NuGet audit, analyzers) as errors
|
||||
dotnet test --solution HashTool.slnx # Microsoft.Testing.Platform (global.json); not VSTest
|
||||
dotnet format HashTool.slnx --verify-no-changes # CI-enforced
|
||||
python -I eng/loc.py check # translations: keys, placeholders, whitespace, wiring
|
||||
dotnet src/HashTool.App/bin/Debug/net10.0/CheckHash.dll --smoke-test # headless end-to-end check
|
||||
```
|
||||
|
||||
Run the app or smoke test with `HASHTOOL_DATA_DIR` pointing at a scratch folder so the user's real settings
|
||||
(`%LOCALAPPDATA%\HashTool`) are never touched. Chain build/test/format/commit with `&&`, not `;`.
|
||||
|
||||
## Rules that are easy to break
|
||||
|
||||
- **Velopack/update invariants** (docs/RELEASING.md): pack id `HashTool`, channels `win`/`osx` (+ `osx-x64`, `linux`),
|
||||
main exe `CheckHash(.exe)`, macOS bundle id `com.HashTool.HashTool` (build/macos/Info.plist), no `--packTitle` on
|
||||
Windows, tags without `v`, settings path. Changing any of these strands 1.x users.
|
||||
- Never run a built `HashTool-*-Setup.exe`/`.pkg` on the maintainer's machine; test updates with portable builds in a
|
||||
scratch folder (the Release workflow's upgrade gate does this in CI).
|
||||
- Every UI string goes through `Localization[Key]` / `L["Key"]` and must exist in all 67 resx files; add keys with
|
||||
`eng/loc.py set` (JSON `{culture: {key: value}}`, `"neutral"` = English). App.Tests fail on missing, unused or
|
||||
mismatched keys. Keep "Hash Tool" untranslated inside sentences.
|
||||
- Core is UI-free and AOT/trim compatible: no reflection-based JSON (use the source-generated contexts), keep
|
||||
`ConfigureAwait(false)` (Meziantou MA0004 is on for Core and CLI, off for App/tests).
|
||||
- Culture: use invariant formatting for logs, file names and machine-readable output; the UI uses the selected culture.
|
||||
- CRC32 is big-endian (standard); `HashMatcher` accepts the 1.1 little-endian form as `LegacyByteOrderMatch`.
|
||||
- Checksum entries must go through `ChecksumEntry.ResolvePath` (rejects UNC/device paths).
|
||||
- GitHub Actions: pin every action to a full commit SHA with a version comment, `persist-credentials: false`, per-job
|
||||
minimal `permissions`, no `${{ }}` inside `run:` (pass through `env:`). zizmor and actionlint run in the Security
|
||||
workflow; `ci-ok` is the single required check.
|
||||
- Don't embed C# or regex text containing backslashes in Python/bash heredocs — the escapes get mangled. Edit such
|
||||
files with the editor tools.
|
||||
|
||||
## Workflows
|
||||
|
||||
- `ci.yml` — build/test on Windows, macOS, Linux; coverage gate (Core ≥ 80%); smoke test; format; translation check.
|
||||
- `security.yml` — vulnerable packages, licences (eng/allowed-licenses.json), gitleaks, actionlint, zizmor.
|
||||
- `release.yml` — manual (`workflow_dispatch`, version + publish) with an upgrade gate from 1.1.3; dry run on PRs that
|
||||
touch release files. Discord notifications use the maintainer's `poli0981/.github` reusable workflows, pinned by SHA.
|
||||
+34
-39
@@ -1,65 +1,60 @@
|
||||
# Contributing to HashTool
|
||||
|
||||
Thanks for taking an interest in HashTool. Your contributions help make it better for everyone.
|
||||
Whether you're reporting a bug, suggesting a new feature, or submitting code, every contribution is appreciated.
|
||||
Whether you're reporting a bug, suggesting a new feature, fixing a translation or submitting code, every contribution is appreciated.
|
||||
|
||||
This project is still small and solo-maintained, so keep it simple and direct — I read everything.
|
||||
|
||||
## Reporting Bugs or Requesting Features
|
||||
## Reporting bugs or requesting features
|
||||
|
||||
**Super easy way**:
|
||||
- Check the **pinned issues** first (there'll be a "Bug Reports" and "Feature Requests" thread).
|
||||
- Just **comment** on the relevant thread, or create a new issue if it doesn't fit.
|
||||
Open an [issue](https://github.com/poli0981/HashTool/issues/new/choose) and pick **Bug report** or **Feature request** — the form asks for what's needed (version, OS, steps, logs).
|
||||
Questions and ideas are welcome in [Discussions](https://github.com/poli0981/HashTool/discussions).
|
||||
|
||||
### Issue Template (keep it short!)
|
||||
Please use this format in your issue title and body:
|
||||
Security problems: please **don't** open a public issue — see [SECURITY.md](SECURITY.md).
|
||||
|
||||
**Title**
|
||||
`Bug: <short description>` or `Feature: <short description>`
|
||||
(e.g., `Bug: App crashes on large files` or `Feature: Add CRC32 algorithm`)
|
||||
## Building and testing
|
||||
|
||||
**Body**
|
||||
1. **Description**
|
||||
Clearly explain the bug or the feature you'd like.
|
||||
Example for bug: "NullReferenceException when selecting >100 files on Windows 11".
|
||||
You need the [.NET 10 SDK](https://dotnet.microsoft.com/download) (10.0.400 or newer) — `global.json` picks it up. Python 3 is only needed for the translation tool.
|
||||
|
||||
2. **Steps to Reproduce** (for bugs) or **Expected Behavior** (for features)
|
||||
Be specific if possible.
|
||||
```text
|
||||
dotnet build HashTool.slnx -warnaserror # what CI runs; warnings are errors
|
||||
dotnet test --solution HashTool.slnx # Core, CLI and headless UI tests
|
||||
dotnet format HashTool.slnx --verify-no-changes # formatting, enforced by CI
|
||||
dotnet run --project src/HashTool.App # start the app
|
||||
dotnet src/HashTool.App/bin/Debug/net10.0/CheckHash.dll --smoke-test # headless self-check
|
||||
```
|
||||
|
||||
3. **Screenshots** (optional but super helpful)
|
||||
Drag & drop images directly into the issue.
|
||||
Set `HASHTOOL_DATA_DIR` to a scratch folder when you run the app during development, so it does not touch your real settings.
|
||||
|
||||
4. **Pseudo-code / Suggestion** (optional)
|
||||
If you have an idea how to fix/implement it, share it!
|
||||
How the code is organised: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md).
|
||||
|
||||
5. **Priority** (optional)
|
||||
Your opinion: "Critical", "Nice to have", "Low priority", etc.
|
||||
## Submitting code (pull requests)
|
||||
|
||||
That's it! No strict rules — just be clear and concise.
|
||||
1. Fork the repo and create a branch: `fix/crash-on-large-files` or `feature/new-algorithm`.
|
||||
2. Keep the change focused; follow the existing style (the analyzers and `.editorconfig` help).
|
||||
3. Add or update tests — hashing and checksum logic belongs in `HashTool.Core` with tests in `tests/HashTool.Core.Tests`.
|
||||
4. Add a line under `## [Unreleased]` in [CHANGELOG.md](CHANGELOG.md) for anything users will notice.
|
||||
5. Open the pull request and link the issue. CI builds and tests on Windows, macOS and Linux, and scans dependencies, licences, secrets and workflows; everything must be green before merging.
|
||||
|
||||
## Submitting Code (Pull Requests)
|
||||
Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) (`fix(core): …`, `feat(app): …`, `docs: …`).
|
||||
|
||||
Want to fix something yourself? Awesome.
|
||||
## Translations
|
||||
|
||||
1. Fork the repo.
|
||||
2. Clone your fork.
|
||||
3. Create a branch: `git checkout -b fix/crash-on-large-files` or `feature/new-algorithm`.
|
||||
4. Make your changes (follow existing code style — clean, readable C#).
|
||||
5. Test thoroughly (especially on both Windows & macOS if possible).
|
||||
6. Push and open a Pull Request.
|
||||
- Link the related issue in the PR description.
|
||||
- Keep PRs focused on one thing when possible.
|
||||
All UI text lives in `src/HashTool.App/Lang/Resources.*.resx` (English is `Resources.resx`; 66 other languages). Use the helper instead of editing XML by hand:
|
||||
|
||||
I'll review as fast as I can. If it's good, it gets merged and you get credit.
|
||||
```text
|
||||
python -I eng/loc.py check # same keys and placeholders everywhere, no stray whitespace
|
||||
python -I eng/loc.py untranslated vi-vn # strings that are still English
|
||||
python -I eng/loc.py export vi-vn # a language as JSON
|
||||
python -I eng/loc.py set changes.json # {"vi-vn": {"Key": "text"}, "neutral": {...}}
|
||||
```
|
||||
|
||||
## Code Style & Guidelines
|
||||
- Keep it simple and consistent with existing code.
|
||||
- Add comments for tricky parts.
|
||||
- No strict linter yet — just make it readable.
|
||||
New text needs a key in **every** file — the localization tests fail otherwise. Keep placeholders such as `{0}` exactly, and keep the product name "Hash Tool". Corrections from native speakers are very welcome; most translations were made with AI assistance.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please be respectful — see [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.
|
||||
|
||||
Thanks again for helping make HashTool better.
|
||||
|
||||
© 2026 poli0981. All rights reserved.
|
||||
© 2026 poli0981. All rights reserved.
|
||||
@@ -1,120 +1,130 @@
|
||||
# HashTool 🛠️
|
||||
|
||||
[](https://github.com/poli0981/HashTool/releases/tag/1.1.3) [](LICENSE)
|
||||
[](https://github.com/poli0981/HashTool/releases/latest)
|
||||
[](https://github.com/poli0981/HashTool/actions/workflows/ci.yml)
|
||||
[](https://scorecard.dev/viewer/?uri=github.com/poli0981/HashTool)
|
||||
[](LICENSE)
|
||||
[](https://github.com/poli0981/HashTool/releases)
|
||||
|
||||
**A user-friendly, cross-platform desktop app (Windows & macOS) for generating, verifying, and managing file hashes — no terminal commands required.**
|
||||
**A friendly desktop app for Windows, macOS and Linux that generates and verifies file hashes and checksum files — no terminal commands required.** A small `hashtool` command-line tool comes along for when you do want the terminal.
|
||||
|
||||
Built with C# on .NET 10 and Avalonia UI.
|
||||
|
||||
## Motivation
|
||||
|
||||
Why open a terminal and type cryptic commands just to hash a file?
|
||||
Why open a terminal and type cryptic commands just to hash a file?
|
||||
HashTool was born out of pure laziness — a simple, intuitive GUI to do the job without the hassle.
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||
*Generate Hash – batch processing with multiple export options*
|
||||

|
||||
*Generate Hash – batch processing with several export options*
|
||||
|
||||

|
||||
*Verify Hash – smart detection and batch verification*
|
||||

|
||||
*Verify Hash – checksum files, sidecar detection and batch verification*
|
||||
|
||||

|
||||
*Settings – themes, localization, performance tweaks*
|
||||

|
||||
*Settings – themes, languages, performance and limits*
|
||||
|
||||

|
||||
*Settings – Windows Admin Mode, Hash Masking, Developer Mode, etc.*
|
||||
 *Dark mode – because who doesn't love dark mode?*
|
||||
|
||||
 *About – version info and links*
|
||||
|
||||

|
||||
*Update – check for latest version*
|
||||
|
||||

|
||||
*Developer Mode – extra tools for power users*
|
||||
|
||||
 *Dark Mode – because who doesn't love dark mode?*
|
||||
More: [About](docs/images/about.png) · [Update](docs/images/update.png) · [Developer console](docs/images/dev.png) · [Settings 2](docs/images/setting_screenshot_2.png)
|
||||
|
||||
## Features
|
||||
|
||||
### Generate Hash
|
||||
|
||||
- **Batch processing**: Compute hashes for multiple files simultaneously using parallel processing.
|
||||
- **Export options**:
|
||||
- Save individual hash files (e.g., `filename.ext.sha256`).
|
||||
- Copy hash results to clipboard.
|
||||
- Bundle all hashes into a single ZIP archive.
|
||||
- Drop files or whole folders (or use Add Files / Add Folder); folders are scanned in the background.
|
||||
- Several files are hashed at once; each file is read only once, whatever the algorithm.
|
||||
- Export all results as **one checksum file** — GNU (`sha256sum` style), BSD tagged, SFV, JSON or CSV — with paths relative to where you save it.
|
||||
- Save a single hash next to its file (`photo.jpg.sha256`), copy hashes, or bundle them into a ZIP with a `CHECKSUMS.txt` manifest.
|
||||
|
||||
### Verify Hash
|
||||
|
||||
- **Batch verification**: Check multiple files against their expected hashes.
|
||||
- **Smart detection**:
|
||||
- Automatically finds accompanying hash files (e.g., checks `image.png.sha256` when verifying `image.png`).
|
||||
- Directly load hash files (`.md5`, `.sha1`, etc.) to verify the source file.
|
||||
- Drop or open a checksum file (`SHA256SUMS`, `*.sha256`, `*.md5`, `*.sfv`, BSD tagged lists, xxhsum output…) and every file it lists is loaded and checked.
|
||||
- Drop a file alone and HashTool finds its sidecar (`image.iso.sha256`, `image.iso.md5`…) automatically.
|
||||
- Paste an expected hash, or drop a hash file onto a row; the algorithm is guessed from the file name or the hash length when needed.
|
||||
- Clear results: **VALID**, **MISMATCH**, missing files, access denied, files in use, time-outs.
|
||||
|
||||
### Settings & Customization
|
||||
### Everything else
|
||||
|
||||
- **Appearance**:
|
||||
- Light, Dark, or System theme.
|
||||
- Custom UI scaling and font size.
|
||||
- **Localization**: 30+ languages with auto-detection based on OS. Manually override and set as default.
|
||||
- **Performance**: Configure max file size limits and per-file timeout.
|
||||
- **Windows Admin Mode**: Toggle elevated privileges when needed.
|
||||
- **Extra goodies**: Hash masking (hide sensitive parts), Developer Mode, Settings Lock, UI Reset.
|
||||
- **11 algorithms**: MD5, SHA-1, SHA-256, SHA-384, SHA-512, BLAKE3, xxHash32, xxHash64, XXH3, XXH128, CRC32 (MD5 and SHA-1 are fine for detecting corruption, not for security).
|
||||
- **67 languages** with automatic detection and right-to-left layouts.
|
||||
- Light/dark/system, eight theme styles (including colour-blind friendly and high contrast), fonts and UI scale.
|
||||
- Hash masking, settings lock, file size/count limits, per-file time-out, hard-drive mode.
|
||||
- **System integration**: Explorer right-click menu on Windows (optional), "Open With" on macOS, `--create`/`--verify` command-line arguments.
|
||||
- Automatic update check (at most once a day, can be turned off) with release notes; updates install in place.
|
||||
- Developer console with live logs.
|
||||
|
||||
> **Note**: Hashing speed depends on your drive (SSD vs HDD) and system load.
|
||||
|
||||
### Update
|
||||
|
||||
- **Update**: Check for updates on "Update" page.
|
||||
|
||||
### Supported Algorithms
|
||||
|
||||
- MD5
|
||||
- SHA1
|
||||
- SHA256
|
||||
- SHA384
|
||||
- SHA512
|
||||
- BLAKE3
|
||||
- CRC32
|
||||
- XXHash64
|
||||
- XXHash128
|
||||
- XXHash32
|
||||
- XXHash3
|
||||
> Hashing speed depends mostly on your drive (SSD vs HDD) and system load. Turn on *Optimize for hard drives* in Settings for spinning disks and network shares.
|
||||
|
||||
## Installation
|
||||
|
||||
### Windows
|
||||
Download from the [latest release](https://github.com/poli0981/HashTool/releases/latest):
|
||||
|
||||
- **Installer**: Download `HashTool-win-setup.exe` from GitHub Releases → run → done in seconds.
|
||||
- **Portable**: Download the ZIP → extract → run `Hash Tool.exe`.
|
||||
| Platform | Installer | Portable |
|
||||
|---|---|---|
|
||||
| Windows 10/11 (x64) | `HashTool-win-Setup.exe` | `HashTool-win-Portable.zip` — extract, run `HashTool.exe` |
|
||||
| macOS, Apple silicon | `HashTool-osx-Setup.pkg` | `HashTool-osx-Portable.zip` |
|
||||
| macOS, Intel | `HashTool-osx-x64-Setup.pkg` | `HashTool-osx-x64-Portable.zip` |
|
||||
| Linux (x64) | — | `HashTool.AppImage` |
|
||||
|
||||
### macOS
|
||||
**macOS:** the app is not signed yet (no Apple Developer account 😅), so Gatekeeper may complain. Right-click the app → **Open**, or allow it in *System Settings → Privacy & Security*.
|
||||
|
||||
*(May trigger Gatekeeper warnings — unsigned app because no Apple Developer account yet 😅)*
|
||||
**Linux:** make the AppImage executable (`chmod +x HashTool.AppImage`) and run it. AppImages need FUSE 2 (`sudo apt install libfuse2` on Ubuntu/Debian).
|
||||
|
||||
- **Installer**: Download `.pkg` → Continue → Install → Done.
|
||||
- **Portable**: Download `.zip` → extract → open `.app` (right-click → Open if Gatekeeper complains).
|
||||
Installed and portable copies update themselves from the *Update* page.
|
||||
|
||||
## Usage
|
||||
### Command-line tool
|
||||
|
||||
The UI is designed to be dead simple — drag & drop files, pick your algorithm, hit Go.
|
||||
Detailed guides and advanced tips will be added to the [Wiki](https://github.com/poli0981/HashTool/wiki) soon.
|
||||
`hashtool-<version>-<platform>` archives contain a single native executable — no .NET install needed.
|
||||
|
||||
```text
|
||||
hashtool hash photo.jpg # sha256sum-style line
|
||||
hashtool hash -r ./dist -o ./dist/SHA256SUMS # every file in a folder, paths relative to the output
|
||||
hashtool hash -a sha256,blake3 big.iso # several algorithms, one read (BSD tagged output)
|
||||
hashtool verify SHA256SUMS # like sha256sum -c: exit 0 = all OK, 1 = mismatch/missing
|
||||
hashtool check big.iso -e 4f2c… # one file against one hash (algorithm guessed from length)
|
||||
hashtool algorithms
|
||||
```
|
||||
|
||||
See [docs/USAGE.md](docs/USAGE.md) for every option and the app's command-line arguments.
|
||||
|
||||
## Verifying downloads
|
||||
|
||||
Every release includes `SHA256SUMS` and GitHub build provenance attestations:
|
||||
|
||||
```text
|
||||
sha256sum -c SHA256SUMS --ignore-missing
|
||||
gh attestation verify HashTool-win-Setup.exe --repo poli0981/HashTool
|
||||
```
|
||||
|
||||
## Building from source
|
||||
|
||||
Requires the [.NET 10 SDK](https://dotnet.microsoft.com/download) (10.0.400 or newer).
|
||||
|
||||
```text
|
||||
dotnet build HashTool.slnx
|
||||
dotnet test --solution HashTool.slnx
|
||||
dotnet run --project src/HashTool.App
|
||||
dotnet run --project src/HashTool.Cli -- hash README.md
|
||||
```
|
||||
|
||||
How the code is organised: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md). How releases are made: [docs/RELEASING.md](docs/RELEASING.md).
|
||||
|
||||
## Contributing
|
||||
|
||||
Want to help? Check out [CONTRIBUTING.md](CONTRIBUTING.md) for bug reports, feature requests, or code contributions.
|
||||
Bug reports, translations and pull requests are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
## Legal Stuff
|
||||
|
||||
- [LICENSE (MIT)](LICENSE)
|
||||
- [EULA](docs/EULA.md)
|
||||
- [Disclaimer](/docs/DISCLAIMER.md)
|
||||
- [Terms of Service](/docs/ToS.md)
|
||||
- [Privacy Policy](/docs/PrivacyPolicy.md)
|
||||
- [Security Policy](SECURITY.md)
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md)
|
||||
- [LICENSE (MIT)](LICENSE)
|
||||
- [EULA](docs/EULA.md)
|
||||
- [Disclaimer](docs/DISCLAIMER.md)
|
||||
- [Terms of Service](docs/ToS.md)
|
||||
- [Privacy Policy](docs/PrivacyPolicy.md)
|
||||
- [Security Policy](SECURITY.md)
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md)
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
@@ -124,4 +134,4 @@ Big thanks to the open-source community and AI assistants — full credits in [A
|
||||
|
||||
Made with ❤️ (and a lot of coffee) by poli0981
|
||||
|
||||
*© 2026 poli0981. All rights reserved.*
|
||||
*© 2026 poli0981. Released under the MIT License.*
|
||||
+10
-6
@@ -1,17 +1,21 @@
|
||||
# Security Policy for HashTool
|
||||
|
||||
**Version 1.1.3**
|
||||
**Last updated: February 2026**
|
||||
**Last updated: October 2026**
|
||||
|
||||
HashTool is a free, open-source desktop application built with C# (.NET 10) and Avalonia UI. It runs **100% offline** (except optional update check via GitHub), processes files locally, and has no network server components.
|
||||
HashTool is a free, open-source desktop application built with C# (.NET 10) and Avalonia UI. It processes files locally, has no server components, and only goes online to check GitHub for updates.
|
||||
|
||||
### Supported Versions
|
||||
Currently, security updates are provided for the latest release only:
|
||||
Security fixes are released for the latest minor version only. Installed and portable copies update themselves, so please stay on the newest release.
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 1.0.x | :white_check_mark: |
|
||||
| < 1.0 | :x: |
|
||||
| 1.2.x | :white_check_mark: |
|
||||
| < 1.2 | :x: |
|
||||
|
||||
### How releases are protected
|
||||
- Releases are built, tested and published by GitHub Actions from the `main` branch; every release includes `SHA256SUMS`, CycloneDX SBOMs and [build provenance attestations](https://docs.github.com/actions/security-for-github-actions/using-artifact-attestations) (`gh attestation verify <file> --repo poli0981/HashTool`).
|
||||
- Every pull request is checked for vulnerable NuGet packages, licences, leaked secrets and unsafe workflow patterns, in addition to CodeQL and OpenSSF Scorecard.
|
||||
- The apps are not code-signed yet, so Windows SmartScreen and macOS Gatekeeper may warn when they are first opened.
|
||||
|
||||
### Reporting a Vulnerability
|
||||
If you discover a potential security vulnerability, please report it responsibly:
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
# Architecture
|
||||
|
||||
HashTool is a .NET 10 solution with three shipped programs sharing one core library.
|
||||
|
||||
```
|
||||
src/HashTool.Core hashing, checksum files, folder walking, settings (no UI; trim/AOT compatible)
|
||||
src/HashTool.App Avalonia 12 desktop app (CheckHash.exe) — views, view models, services
|
||||
src/HashTool.Cli `hashtool` command-line tool (System.CommandLine, NativeAOT)
|
||||
tests/ Core.Tests, Cli.Tests, App.Tests (Avalonia headless); Compat/LegacyClient (release gate)
|
||||
bench/ BenchmarkDotNet benchmarks (run by hand)
|
||||
eng/ scripts used by CI and releases (translations, coverage, release notes, package checks)
|
||||
build/ packaging inputs (macOS Info.plist, Linux icon)
|
||||
```
|
||||
|
||||
Shared build settings: `Directory.Build.props` (version, nullable, analyzers, NuGet audit), `Directory.Packages.props`
|
||||
(central package versions with transitive pinning), `global.json` (SDK and the Microsoft.Testing.Platform runner),
|
||||
`dotnet-tools.json` (vpk, nuget-license, CycloneDX).
|
||||
|
||||
## HashTool.Core
|
||||
|
||||
| Area | Types | Notes |
|
||||
|---|---|---|
|
||||
| Hashing | `HashEngine`, `HashType`, `HashAlgorithms`, `HashResult`, `HashMatcher` | One read per file for any number of algorithms: double-buffered reads (1 MiB, 4 MiB above 1 GiB), each block fed to every algorithm in parallel; BLAKE3 uses its multi-threaded update for large blocks. CRC32 is big-endian (as 7-Zip/SFV); `HashMatcher` still accepts the reversed order Hash Tool 1.1 wrote. |
|
||||
| Checksum files | `ChecksumParser`, `ChecksumWriter`, `ChecksumDocument`, `ChecksumFileNames` | Reads GNU (`hash name`, `*name`, escaped names), BSD tagged, SFV, xxhsum `XXH3_` and bare sidecar hashes; writes GNU/BSD/SFV/JSON/CSV. The algorithm comes from the line, then the file name, then the user's choice, then the hash length. Paths may not point to UNC or device locations; CSV output neutralises formulas. |
|
||||
| Files | `FileEnumerator`, `FileErrors` | Walks folders without following symbolic links or junctions, skips unreadable folders, optionally hidden files. |
|
||||
| Processing | `BatchProcessor`, `HashJob`, `IHashJobObserver<T>` | Small files in parallel (default `min(cores, 4)`), files ≥ 1 GiB in a separate lane, one at a time in HDD mode; per-file time-out; every item is reported exactly once. |
|
||||
| Configuration | `AppSettings`, `SettingsStore` | `config.json` with a schema version; atomic writes (temp file + move), values clamped on load, a corrupt file is backed up as `config.json.bak-<time>`, 1.x font settings are migrated. |
|
||||
|
||||
## HashTool.App
|
||||
|
||||
- **Composition** — `AppHost` builds a `Microsoft.Extensions.DependencyInjection` container (services and view models are
|
||||
singletons). `Program.Main` runs Velopack hooks first, then `--smoke-test`, single-instance forwarding and Avalonia.
|
||||
- **Views and view models** — compiled bindings everywhere; `App.axaml` maps each view model to its view.
|
||||
`FileListViewModelBase` holds what Generate and Verify share: importing (background enumeration, batches of 1000),
|
||||
filtering, running a `BatchProcessor` with UI updates pumped every 100 ms, and the summary dialog.
|
||||
- **Localization** — `LocalizationService` reads the satellite resources, detects the system language, sets the culture
|
||||
(including `DefaultThreadCurrentCulture`, so async work keeps it) and right-to-left flow. Views bind
|
||||
`Localization[Key]`; view models swap their `LocalizationProxy` when the language changes, which refreshes every
|
||||
binding. Status texts are stored as enums and translated by converters, so they follow language changes.
|
||||
- **Services** — dialogs, file pickers, clipboard and launcher behind interfaces (`UiServices.cs`); `SettingsService`
|
||||
debounces saves; `ThemeService`/`ThemePalettes` swap brush resources; `FontService` picks per-script fonts;
|
||||
`UpdateService` wraps Velopack (GitHub source, stable channel).
|
||||
- **Infrastructure** — logging to daily files and an in-memory sink for the Developer console (`Logging/`), crash
|
||||
reports, `AppPaths` (`HASHTOOL_DATA_DIR` override), command-line parsing, single instance (named mutex/lock file plus
|
||||
a per-user named pipe), Windows shell integration under `HKCU\Software\Classes`, on-demand elevation, and the
|
||||
headless smoke test.
|
||||
|
||||
## HashTool.Cli
|
||||
|
||||
`hashtool hash | verify | check | algorithms`, built on Core. Exit codes follow `sha256sum`: 0 success, 1 failed or
|
||||
mismatched file, 2 usage error or unreadable checksum file. Published per platform as a single NativeAOT executable.
|
||||
|
||||
## Tests
|
||||
|
||||
- `HashTool.Core.Tests` — known-answer vectors for every algorithm, engine, parser/writer, enumerator, batch processor,
|
||||
settings store. CI requires at least 80% line coverage of Core.
|
||||
- `HashTool.Cli.Tests` — commands, output formats and exit codes.
|
||||
- `HashTool.App.Tests` — Avalonia headless: every page in several languages, a create-and-verify flow, translation
|
||||
integrity (keys, placeholders, Languages.json ↔ resx ↔ project, satellite assemblies, unused keys), language detection.
|
||||
- `tests/Compat/LegacyClient` — not in the solution: the release workflow uses it to update a real 1.1.3 install with
|
||||
its own Velopack 0.0.1298 library and updater (see [RELEASING.md](RELEASING.md)).
|
||||
|
||||
## Benchmarks
|
||||
|
||||
```text
|
||||
dotnet run -c Release --project bench/HashTool.Benchmarks -- --filter '*'
|
||||
```
|
||||
|
||||
`LargeFileBenchmarks` compares the engine with `SHA256.HashData(FileStream)`; `SmallFilesBenchmarks` compares sequential
|
||||
hashing with `BatchProcessor`. On an i7-14700KF with a warm cache: SHA-256 of 256 MiB 129 ms vs 221 ms, BLAKE3 57 ms,
|
||||
XXH3 36 ms, CRC32 34 ms; 2,000 × 16 KiB files 26 ms in parallel vs 89 ms sequentially.
|
||||
+3
-4
@@ -1,7 +1,6 @@
|
||||
# Disclaimer for HashTool
|
||||
|
||||
**Version 1.1.3**
|
||||
**Last updated: February 2026**
|
||||
**Last updated: October 2026**
|
||||
|
||||
HashTool is free, open-source software distributed under the MIT License (see LICENSE file).
|
||||
|
||||
@@ -17,8 +16,8 @@ The author shall not be liable for any damages, losses, or issues (including dat
|
||||
|
||||
### Privacy
|
||||
|
||||
HashTool is **completely offline** and does not collect, store, or transmit any personal data.
|
||||
The only network activity is the optional "Check for Updates" feature, which queries public GitHub releases. No telemetry or analytics are sent. Refer to GitHub's privacy policy for their handling.
|
||||
HashTool works offline and does not collect, store, or transmit any personal data.
|
||||
The only network activity is the update check against public GitHub releases (automatic at most once a day — it can be turned off in Settings — or on request). No telemetry or analytics are sent. See the [Privacy Policy](PrivacyPolicy.md).
|
||||
|
||||
### Translations
|
||||
|
||||
|
||||
+4
-5
@@ -1,9 +1,8 @@
|
||||
# End User License Agreement (EULA) for Hash Tool
|
||||
|
||||
**Version 1.1.3**
|
||||
**Last updated: February 2026**
|
||||
**Last updated: October 2026**
|
||||
|
||||
HashTool is a free, open-source desktop application licensed under the MIT License (see [LICENSE](LICENSE) file).
|
||||
HashTool is a free, open-source desktop application licensed under the MIT License (see the [LICENSE](../LICENSE) file).
|
||||
|
||||
### 1. Grant of License
|
||||
The author grants you a non-exclusive, royalty-free, worldwide license to use, copy, distribute, and modify HashTool for any purpose, subject to the terms of the MIT License.
|
||||
@@ -16,8 +15,8 @@ The author makes no guarantee that the software will be error-free, secure, or m
|
||||
In no event shall the author be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including loss of data, revenue, or profit) arising from the use or inability to use HashTool, even if advised of the possibility of such damage.
|
||||
|
||||
### 4. Privacy & Data Collection
|
||||
HashTool is **100% offline**. It does not collect, store, or transmit any personal data.
|
||||
The only online feature is _**"Check for Updates",**_ which simply queries GitHub's public release API. No usage data is sent. For details on GitHub's privacy practices, see their policy.
|
||||
HashTool works offline. It does not collect, store, or transmit any personal data.
|
||||
The only online feature is the update check, which queries GitHub's public release API (automatically at most once a day — it can be turned off in Settings — or when you click Check Now). No usage data is sent. See the [Privacy Policy](PrivacyPolicy.md) for details.
|
||||
|
||||
### 5. Translations
|
||||
Non-English translations (if any) are provided as-is and generated with AI assistance. The author makes no guarantee of accuracy or completeness.
|
||||
|
||||
+18
-5
@@ -1,22 +1,35 @@
|
||||
# Privacy Policy for HashTool
|
||||
|
||||
**Version 1.1.3**
|
||||
**Last updated: February 2026**
|
||||
**Last updated: October 2026**
|
||||
|
||||
HashTool is a free, open-source desktop application distributed under the MIT License (see LICENSE file).
|
||||
|
||||
### Data Collection and Usage
|
||||
HashTool is **100% offline** and does **not** collect, store, or transmit any personal data, usage statistics, or telemetry.
|
||||
HashTool does **not** collect, store, or transmit any personal data, usage statistics, or telemetry.
|
||||
|
||||
- No user information is gathered.
|
||||
- No analytics or tracking of any kind.
|
||||
- The application processes only the files you explicitly select for hashing, and all operations occur locally on your device.
|
||||
|
||||
### Online Features
|
||||
The only optional network activity is the "Check for Updates" feature, which queries the public GitHub Releases API to check for new versions.
|
||||
No personal data or usage information is sent during this request.
|
||||
HashTool only talks to the network to look for updates:
|
||||
|
||||
- **Automatic update check** (on by default, can be turned off in *Settings → Updates*): at most once a day, when the app starts, it asks the public GitHub Releases API whether a newer version exists.
|
||||
- **Check Now** on the *Update* page does the same on request.
|
||||
- An update is downloaded from GitHub only when you choose to install it.
|
||||
|
||||
These requests contain nothing about you or your files — GitHub sees the usual information of any web request (such as your IP address).
|
||||
For details about GitHub's data handling, please refer to [GitHub's Privacy Policy](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement).
|
||||
|
||||
### Data Stored on Your Device
|
||||
HashTool keeps its settings and logs in a local folder (`%LOCALAPPDATA%\HashTool` on Windows, `~/Library/Application Support/HashTool` on macOS, `~/.local/share/HashTool` on Linux):
|
||||
|
||||
- `settings/config.json` — your preferences.
|
||||
- `log/` — diagnostic logs, kept for 14 days. They may contain names of files you hashed; your user folder name is masked.
|
||||
|
||||
Nothing in this folder is ever sent anywhere. *Settings → Configuration → Open Data Folder* shows it; deleting it resets the app.
|
||||
If you turn on the Explorer context menu (Windows), HashTool adds entries under your user's registry (`HKEY_CURRENT_USER\Software\Classes`); turning the option off or uninstalling removes them.
|
||||
|
||||
### Translations
|
||||
Any non-English translations (if provided) are generated with AI assistance and provided as-is. They do not involve sending your data anywhere.
|
||||
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
# Releasing
|
||||
|
||||
Releases are built and published by the **Release** workflow (`.github/workflows/release.yml`). Nothing is built on a
|
||||
developer machine.
|
||||
|
||||
## Steps
|
||||
|
||||
1. Make sure `main` is green (CI, Security).
|
||||
2. On `main`, in one commit `chore(release): X.Y.Z`:
|
||||
- set `<Version>` in `Directory.Build.props`;
|
||||
- rename `## [Unreleased]` / `## [X.Y.Z] - Unreleased` in `CHANGELOG.md` to `## [X.Y.Z] - YYYY-MM-DD`.
|
||||
3. *Actions → Release → Run workflow* on `main` with `version = X.Y.Z` (no `v`) and **publish unchecked** — a dry run.
|
||||
4. When it is green, run it again with **publish checked**.
|
||||
|
||||
The workflow refuses to publish when the version does not match `Directory.Build.props`, the CHANGELOG heading has no
|
||||
date, the run is not on `main`, or the release already exists. Pull requests that change the release machinery get a
|
||||
dry run automatically (version `X.Y.Z-ci.<run>`).
|
||||
|
||||
## What the workflow does
|
||||
|
||||
| Job | Runner | Output |
|
||||
|---|---|---|
|
||||
| `prepare` | ubuntu | version, release notes from CHANGELOG |
|
||||
| `app (win)` | windows-2025 | `HashTool-win-Setup.exe`, `HashTool-win-Portable.zip`, `HashTool-X.Y.Z-full.nupkg`, `releases.win.json`, `RELEASES` |
|
||||
| `app (osx)` | macos-15 (arm64) | `HashTool-osx-Setup.pkg`, `HashTool-osx-Portable.zip`, `HashTool-X.Y.Z-osx-full.nupkg`, `releases.osx.json` |
|
||||
| `app (osx-x64)` | macos-15-intel | the same for Intel Macs (channel `osx-x64`) |
|
||||
| `app (linux)` | ubuntu-24.04 | `HashTool.AppImage`, `HashTool-X.Y.Z-linux-full.nupkg`, `releases.linux.json` |
|
||||
| `upgrade-gate` | windows-2025, macos-15 | proves a 1.1.3 install updates to the new version |
|
||||
| `cli` | all four | `hashtool-X.Y.Z-<rid>.zip/.tar.gz` (NativeAOT; Linux built on ubuntu-22.04 for older glibc) |
|
||||
| `publish` | ubuntu | SBOMs, `SHA256SUMS`, provenance attestation, draft release → verify uploads → publish |
|
||||
| `announce` | — | Discord announcement through the shared `poli0981/.github` workflow |
|
||||
|
||||
Each `app` job publishes self-contained single-file builds, starts them headless (`--smoke-test --expect-version`),
|
||||
packs them with `vpk` and checks the result with `eng/assert-release.py`.
|
||||
|
||||
## Invariants — never change these
|
||||
|
||||
Hash Tool 1.0–1.1 users update through Velopack and only find a release when these stay the same:
|
||||
|
||||
| | Windows | macOS (Apple silicon) |
|
||||
|---|---|---|
|
||||
| Velopack pack id | `HashTool` | `HashTool` |
|
||||
| Channel | `win` (x64) | `osx` (arm64) |
|
||||
| Main executable | `CheckHash.exe` (`<AssemblyName>CheckHash</AssemblyName>`) | `CheckHash` |
|
||||
| Title / bundle | no `--packTitle` (title "HashTool"), shortcuts Desktop + Start menu | `Hash Tool.app`, bundle id `com.HashTool.HashTool` (kept by `build/macos/Info.plist`) |
|
||||
|
||||
Also: tags have no `v` prefix (`1.2.0`), releases are not pre-releases, and settings stay in
|
||||
`LocalApplicationData/HashTool/settings/config.json`. New platforms get new channels (`osx-x64`, `linux`).
|
||||
|
||||
Releases are published with `--delta None`: every update downloads the full package, which old clients handle best.
|
||||
|
||||
## The upgrade gate
|
||||
|
||||
`tests/Compat/LegacyClient` references **Velopack 0.0.1298**, the library inside Hash Tool 1.1.x. For Windows and macOS
|
||||
the gate downloads the real 1.1.3 portable build, uses that library to read the new feed and download the update (with
|
||||
its checksum checks), applies it with the **1.1.3 updater** (`Update.exe` / `UpdateMac` `apply --package --norestart`)
|
||||
and starts the updated app with `--smoke-test --expect-version`. Publishing is blocked if any step fails.
|
||||
|
||||
## After publishing
|
||||
|
||||
- Check the release page lists every asset and that `SHA256SUMS` matches (`sha256sum -c SHA256SUMS --ignore-missing`).
|
||||
- Update an existing installation through *Update → Check Now* on at least one machine.
|
||||
- If something is wrong, publish a fixed `X.Y.Z+1` instead of editing or deleting the release: clients may already have
|
||||
downloaded it.
|
||||
+3
-4
@@ -1,7 +1,6 @@
|
||||
# Terms of Service (ToS) for HashTool
|
||||
|
||||
**Version 1.1.3**
|
||||
**Last updated: February 2026**
|
||||
**Last updated: October 2026**
|
||||
|
||||
HashTool is free, open-source desktop software distributed under the **MIT License** (see LICENSE file for full text).
|
||||
|
||||
@@ -19,8 +18,8 @@ All software has bugs. Even big tech companies ship imperfect products. Use at y
|
||||
The author shall not be liable for any damages (direct, indirect, incidental, consequential, loss of data, profit, or otherwise) arising from the use or inability to use HashTool.
|
||||
|
||||
### 5. Privacy & Data Collection
|
||||
HashTool is **100% offline** and does not collect, store, or transmit any personal information.
|
||||
The only optional online feature is "Check for Updates," which queries public GitHub releases. No telemetry or analytics are sent. See GitHub's privacy policy for their practices.
|
||||
HashTool works offline and does not collect, store, or transmit any personal information. No telemetry or analytics are sent.
|
||||
The only network activity is the update check against public GitHub releases (automatic at most once a day — it can be turned off in Settings — or on request). See the [Privacy Policy](PrivacyPolicy.md) for details.
|
||||
|
||||
### 6. Translations
|
||||
Non-English translations (if provided) are AI-generated and offered as-is. The author does not guarantee accuracy.
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
# Using HashTool
|
||||
|
||||
## The app
|
||||
|
||||
### Generate Hash
|
||||
|
||||
1. Drop files or folders on the page, or use **Add Files…** (Ctrl/⌘+O) / **Add Folder…** (Ctrl/⌘+Shift+O).
|
||||
2. Pick the **Algorithm** for new rows (each row can be changed until it runs).
|
||||
3. **COMPUTE ALL** (Ctrl/⌘+Enter) or the ▶ button on a row. **Cancel** (Esc) stops everything; ■ stops one row.
|
||||
4. Use the result:
|
||||
- **Export → Save Checksum File…** writes one file for everything — GNU (`sha256sum` format, e.g. `SHA256SUMS`),
|
||||
BSD tagged, SFV (CRC32 only), JSON or CSV. Paths are relative to where you save it, so keep it next to the files.
|
||||
- The 💾 button saves one row as `file.ext.sha256` next to the file.
|
||||
- **Export → Copy All Hashes** copies the list; **Compress (.Zip)** bundles the hash files and a `CHECKSUMS.txt`.
|
||||
|
||||
### Verify Hash
|
||||
|
||||
- **Checksum file** — drop it or use **Open Checksum File…**. Every file it lists is added with its expected hash and
|
||||
verified relative to the checksum file's folder. Supported: `sha256sum`/`md5sum`/`b3sum` output (also with `*name`
|
||||
and escaped names), BSD tagged lines (`SHA256 (name) = hash`), `.sfv`, xxhsum (`XXH3_` prefix), and files that contain
|
||||
only a hash (`image.iso.sha256`).
|
||||
- **A file** — drop it; HashTool looks for a sidecar (`image.iso.sha256`, `.md5`, `.b3`…). Otherwise paste the
|
||||
expected hash, drop a hash file onto the row's hash box, or browse for one.
|
||||
- **Default algorithm** is used when neither the checksum file nor the hash length decides (64 hex digits can be
|
||||
SHA-256 or BLAKE3, for example).
|
||||
|
||||
Results: **VALID**, **MISMATCH!**, *Not a valid … hash* (wrong length or characters), *Original file missing*,
|
||||
*Access denied*, *In use by another program*, *Timed out*. A CRC32 written by Hash Tool 1.1 (reversed byte order) shows
|
||||
**VALID (old CRC32 byte order)**.
|
||||
|
||||
On Windows, files you cannot read can be retried with **Restart as Administrator** (offered after a run, and in
|
||||
Settings). While elevated, Windows blocks drag and drop from Explorer.
|
||||
|
||||
### Settings worth knowing
|
||||
|
||||
| Setting | What it does |
|
||||
|---|---|
|
||||
| Files processed at the same time | 0 = automatic (up to 4). Large files (≥ 1 GiB) always run one at a time. |
|
||||
| Optimize for hard drives | One file at a time — faster on spinning disks and network shares. |
|
||||
| Include hidden files | Also add hidden/system files when scanning folders. |
|
||||
| Input file size limit / Max files per folder scan / Max folders per click | Guards against huge drops. |
|
||||
| File processing timeout | Gives up on a single file after the time you set. |
|
||||
| Hash letter case | Upper (default) or lower case on screen and in single-hash files; checksum files use lower case like `sha256sum`. |
|
||||
| Mask hash values | Hides hashes on screen until you reveal a row (stays editable while settings are locked). |
|
||||
| Explorer context menu (Windows) | Adds *Generate hash with Hash Tool* and *Verify with Hash Tool* (Windows 11: *Show more options*). |
|
||||
| Check for updates automatically | At most once a day at start-up. |
|
||||
|
||||
Settings and logs live in `%LOCALAPPDATA%\HashTool` (Windows), `~/Library/Application Support/HashTool` (macOS) or
|
||||
`~/.local/share/HashTool` (Linux); *Settings → Configuration → Open Data Folder* opens it.
|
||||
|
||||
### Command-line arguments
|
||||
|
||||
```text
|
||||
CheckHash [--create | --verify] [--files-from list.txt] [paths...]
|
||||
```
|
||||
|
||||
Paths open on Generate (`--create`) or Verify (`--verify`); without a verb, checksum files go to Verify and everything
|
||||
else to Generate. If Hash Tool is already open, the files are handed to that window. On macOS, use *Open With* in
|
||||
Finder; on Linux, pass paths to the AppImage.
|
||||
|
||||
`CheckHash --smoke-test [--smoke-out result.json] [--expect-version X.Y.Z]` starts the app without a window, checks
|
||||
every page and language, hashes and verifies a file, and exits with 0 when everything works.
|
||||
|
||||
## The `hashtool` command-line tool
|
||||
|
||||
```text
|
||||
hashtool hash <paths>... [-a ALGORITHM...] [-r] [--hidden] [-f gnu|bsd|sfv|json|csv] [-o FILE] [-u] [-j N]
|
||||
hashtool verify <checksum-files>... [-a ALGORITHM] [-q] [--ignore-missing]
|
||||
hashtool check <file> -e HASH [-a ALGORITHM]
|
||||
hashtool algorithms
|
||||
```
|
||||
|
||||
| Option | Meaning |
|
||||
|---|---|
|
||||
| `-a, --algorithm` | `sha256` (default), `sha1`, `md5`, `sha384`, `sha512`, `blake3`, `xxhash32`, `xxhash64`, `xxhash3`, `xxhash128`, `crc32`. Repeat or separate with commas: `-a sha256,blake3`. |
|
||||
| `-r, --recursive` | Hash every file inside the given folders (links are not followed). |
|
||||
| `-f, --format` | Output format. Default: `gnu` for one algorithm, `bsd` for several. |
|
||||
| `-o, --output` | Write to a file; paths in it are relative to its folder. |
|
||||
| `-u, --uppercase` | Upper-case hexadecimal digits. |
|
||||
| `-j, --jobs` | Files hashed in parallel (0 = automatic, 1 = one at a time). |
|
||||
| `-q, --quiet` | `verify`: only print problems. |
|
||||
| `--ignore-missing` | `verify`: skip listed files that do not exist. |
|
||||
|
||||
Exit codes: **0** everything OK · **1** a file could not be read or did not match · **2** usage error or unreadable
|
||||
checksum file.
|
||||
|
||||
Examples:
|
||||
|
||||
```text
|
||||
hashtool hash -r . -o SHA256SUMS && hashtool verify SHA256SUMS
|
||||
hashtool hash -a crc32 -f sfv *.rar > files.sfv
|
||||
hashtool check ubuntu.iso -e 3b1c… # algorithm guessed from the hash length
|
||||
```
|
||||
Reference in new issue
Block a user