diff --git a/.github/ISSUE_TEMPLATE/accessibility.yml b/.github/ISSUE_TEMPLATE/accessibility.yml index 2422178..89e3198 100644 --- a/.github/ISSUE_TEMPLATE/accessibility.yml +++ b/.github/ISSUE_TEMPLATE/accessibility.yml @@ -7,7 +7,7 @@ body: value: > Thanks for reporting this. You do not need to tell us about any disability; describing what gets in your way is enough. See [ACCESSIBILITY.md](https://github.com/poli0981/HashTool/blob/main/ACCESSIBILITY.md) for what is - already known. + already known. If you cannot use GitHub, email accessibility@poli0981.dev instead. - type: textarea id: barrier attributes: @@ -66,7 +66,7 @@ body: attributes: label: Hash Tool version description: Shown on the About page, or `hashtool --version` for the command-line tool. - placeholder: "1.2.3" + placeholder: "1.3.0" validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 43e6fb3..7ccb021 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -24,7 +24,7 @@ body: attributes: label: Hash Tool version description: Shown on the About page. - placeholder: "1.2.0" + placeholder: "1.3.0" validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 912644c..bdbb639 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,6 +3,11 @@ contact_links: - name: Report a security vulnerability url: https://github.com/poli0981/HashTool/security/advisories/new about: Please report security issues privately, not as public issues. - - name: Questions and ideas - url: https://github.com/poli0981/HashTool/discussions - about: Ask questions or discuss ideas before opening a feature request. + - name: Questions + url: https://github.com/poli0981/HashTool/discussions/categories/q-a + about: Ask how to do something with Hash Tool. + - name: Ideas for new features + url: https://github.com/poli0981/HashTool/discussions/categories/ideas + about: > + Hash Tool is in maintenance mode and new features are generally not added. Ideas are still welcome in Discussions; + see "Project status" in CONTRIBUTING.md for what is accepted. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index bffd7e0..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Feature request -description: Suggest an improvement or a new feature. -labels: [enhancement] -body: - - type: textarea - id: problem - attributes: - label: What problem would this solve? - validations: - required: true - - type: textarea - id: idea - attributes: - label: What would you like to happen? - validations: - required: true - - type: textarea - id: alternatives - attributes: - label: Alternatives you have considered diff --git a/.github/ISSUE_TEMPLATE/hash_algorithm.yml b/.github/ISSUE_TEMPLATE/hash_algorithm.yml new file mode 100644 index 0000000..04b77e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/hash_algorithm.yml @@ -0,0 +1,49 @@ +name: Hash algorithm request +description: Ask for a hash algorithm to be added (or removed) because you need it to check real files. +labels: [hash-algorithm] +body: + - type: markdown + attributes: + value: > + Hash Tool is in maintenance mode: algorithms are added or removed only when someone really needs them. Tell us + where the algorithm is used, ideally with a real checksum file. Candidates already considered are listed in + [CONTRIBUTING.md](https://github.com/poli0981/HashTool/blob/main/CONTRIBUTING.md#hash-algorithms). + - type: dropdown + id: change + attributes: + label: Add or remove? + options: + - Add an algorithm + - Remove an algorithm + validations: + required: true + - type: input + id: algorithm + attributes: + label: Algorithm + placeholder: "BLAKE2b-512" + validations: + required: true + - type: textarea + id: usage + attributes: + label: Where is it used? + description: Which projects publish checksums with it, which tools create or check them, and what you need to verify. + placeholder: "Example: Arch Linux publishes b2sums.txt next to its ISO images; coreutils' b2sum creates them." + validations: + required: true + - type: textarea + id: sample + attributes: + label: A checksum file or link + description: A link to a published checksum file, or a few lines of one (with the file names if they are public). + render: text + - type: dropdown + id: format + attributes: + label: Checksum file format + multiple: true + options: + - GNU (hash file name) + - BSD tagged (ALGORITHM (file name) = hash) + - Something else (described above) diff --git a/.github/ISSUE_TEMPLATE/translation.yml b/.github/ISSUE_TEMPLATE/translation.yml new file mode 100644 index 0000000..32ae2bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/translation.yml @@ -0,0 +1,52 @@ +name: Translation problem +description: Wrong, misleading or culturally inappropriate wording, or a typo that changes the meaning, in one language. +labels: [translation] +body: + - type: markdown + attributes: + value: > + Thank you! Most of Hash Tool's 67 languages were translated with AI assistance, so corrections from native + speakers are very welcome. Keep "Hash Tool" and placeholders such as {0} as they are. You can also open a pull + request: see "Translations" in + [CONTRIBUTING.md](https://github.com/poli0981/HashTool/blob/main/CONTRIBUTING.md#translations). + - type: input + id: language + attributes: + label: Language + placeholder: "Vietnamese (vi-VN)" + validations: + required: true + - type: input + id: where + attributes: + label: Where in the app? + placeholder: "Verify Hash, the status of a row" + validations: + required: true + - type: textarea + id: current + attributes: + label: Current text + render: text + validations: + required: true + - type: textarea + id: suggested + attributes: + label: Suggested text + render: text + validations: + required: true + - type: dropdown + id: reason + attributes: + label: What is wrong with it? + multiple: true + options: + - Wrong or misleading meaning + - Unnatural or not how people say it here + - Culturally inappropriate + - Spelling or grammar + - Something else + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f37e99a..b7a0429 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,6 +2,18 @@ +## Type of change + + + +- [ ] Bug fix, including UI/UX problems +- [ ] Accessibility fix +- [ ] Translation fix +- [ ] Hash algorithm added or removed (link the request) +- [ ] Security fix or dependency/.NET update +- [ ] Documentation, tests or CI + ## How it was tested diff --git a/CHANGELOG.md b/CHANGELOG.md index df8fb0d..619a52e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ All notable changes to this project will be documented in this file. - **Hash Text** page: type or paste text and see its hash in every algorithm, updated as you type, with a copy button for each. Choose UTF-8 or UTF-16 and LF or CRLF line breaks; nothing is added at the end, so the SHA-256 matches `printf '%s' 'text' | sha256sum`. Suggested in [Discussions #23](https://github.com/poli0981/HashTool/discussions/23). This is Hash Tool's last new feature: from 1.3.0 on, the project is in maintenance mode. - `hashtool hash -` hashes standard input, as `sha256sum -` does. +### Changed +- Hash Tool is now in **maintenance mode**: security fixes, dependency and .NET updates, bug fixes, accessibility and translation fixes, and hash algorithms when someone needs one, but no new features. See "Project status" in CONTRIBUTING.md. Feature ideas move to Discussions, and there are new issue forms for translation problems and hash algorithm requests. +- Updated Avalonia to 12.1.6 (including fixes to its screen reader support on macOS and Linux), Microsoft.Extensions and System.IO.Hashing to 10.0.15, System.CommandLine to 2.0.15, and the code analyzers. + ### Fixed - Accessibility: in right-to-left languages, hashes, file names and paths keep their left-to-right order. - Accessibility: when a file does not match, Verify shows the hash it really has under the expected one, in a box the keyboard and screen readers reach; before, it was only in a tooltip, which also ignored hash masking. The expected-hash box is announced as "Expected hash" instead of its placeholder text. @@ -18,9 +22,6 @@ All notable changes to this project will be documented in this file. ### Security - Updated to the .NET 10.0.15 runtime, which the self-contained downloads include. It fixes denial of service and elevation of privilege vulnerabilities in .NET (CVE-2026-109475, CVE-2026-105544, CVE-2026-114155, CVE-2026-118747). -### Changed -- Updated Avalonia to 12.1.6 (including fixes to its screen reader support on macOS and Linux), Microsoft.Extensions and System.IO.Hashing to 10.0.15, System.CommandLine to 2.0.15, and the code analyzers. - --- ## [1.2.3] - 2026-11-09 diff --git a/CLAUDE.md b/CLAUDE.md index 80aaa55..28f309d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -10,6 +10,11 @@ in Vietnamese; reply in Vietnamese unless asked otherwise. Code, comments, commi Read docs/ARCHITECTURE.md before larger changes and docs/RELEASING.md before touching packaging or the Release workflow. +**Project status: maintenance mode since 1.3.0** (CONTRIBUTING.md, "Project status"). Accepted: security fixes +(high/critical CVEs in .NET or dependencies get a prompt release), dependency and .NET updates, bug and UI/UX fixes, +accessibility, translation fixes, adding or removing hash algorithms on real demand. Do not add features unless the +maintainer explicitly asks; propose them instead. + ## Commands ```text diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06828be..bec0393 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,10 +5,33 @@ Whether you're reporting a bug, suggesting a new feature, fixing a translation o This project is still small and solo-maintained, so keep it simple and direct — I read everything. -## Reporting bugs or requesting features +## Project status: maintenance mode -Open an [issue](https://github.com/poli0981/HashTool/issues/new/choose) and pick **Bug report**, **Feature request** or **Accessibility issue** — the form asks for what's needed (version, OS, steps, logs). -Questions and ideas are welcome in [Discussions](https://github.com/poli0981/HashTool/discussions). +Since version 1.3.0 (November 2026), Hash Tool is in **maintenance mode**: it does what it set out to do, and the work +now goes into keeping it secure, working and accessible rather than into new features. + +**Accepted:** + +- **Security fixes.** Vulnerabilities rated *high* or *critical* in the .NET runtime or a dependency, and other serious + security problems, are fixed as soon as practical, with a new release. +- **Regular dependency updates** — .NET servicing releases, Avalonia and the other packages, CI tooling (Dependabot). +- **Major platform updates**, such as moving to a new .NET version when it is worth it. Hash Tool stays on .NET 10 (LTS) + for now. +- **Bug fixes**, including UI and UX problems. +- **Accessibility fixes** — keyboard, screen readers, contrast, scaling ([ACCESSIBILITY.md](ACCESSIBILITY.md)). +- **Translation fixes** — wording that is wrong, misleading, unnatural or culturally inappropriate, and typos that + change the meaning. +- **Hash algorithms** — adding or removing one when someone really needs it (see [below](#hash-algorithms)). + +**Not accepted:** new features, unless one is truly necessary. Feature requests and pull requests that add features +will usually be closed with a short explanation. If you have an idea, start a discussion in +[Ideas](https://github.com/poli0981/HashTool/discussions/categories/ideas) before writing code. + +## Reporting a problem + +Open an [issue](https://github.com/poli0981/HashTool/issues/new/choose) and pick **Bug report**, **Accessibility issue**, +**Translation problem** or **Hash algorithm request** — the form asks for what's needed (version, OS, steps, logs). +Questions are welcome in [Discussions](https://github.com/poli0981/HashTool/discussions). Security problems: please **don't** open a public issue — see [SECURITY.md](SECURITY.md). @@ -30,7 +53,8 @@ How the code is organised: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md). ## Submitting code (pull requests) -1. Fork the repo and create a branch: `fix/crash-on-large-files` or `feature/new-algorithm`. +1. Fork the repo and create a branch: `fix/crash-on-large-files`, `a11y/row-names` or `l10n/vi-vn-status`. For anything + bigger than a small fix, open an issue first so we can agree on it. 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. @@ -51,6 +75,21 @@ python -I eng/loc.py set changes.json # {"vi-vn": {"Key": "text"}, "neutral 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. +## Hash algorithms + +Hash Tool supports MD5, SHA-1, SHA-256, SHA-384, SHA-512, BLAKE3, xxHash32, xxHash64, XXH3, XXH128 and CRC32. A new one +is added when someone needs it to check real files — open a +[Hash algorithm request](https://github.com/poli0981/HashTool/issues/new?template=hash_algorithm.yml) and say where it is +used. Candidates already looked at, in order of how likely they are to be useful: + +| Algorithm | Where it is used | Notes | +|---|---|---| +| BLAKE2b-512 | `b2sum` (GNU coreutils), the `b2sums.txt` files of Arch Linux | Not in .NET; needs a small implementation or package. Same length as SHA-512. | +| SHA3-256, SHA3-512 | FIPS 202, `openssl dgst -sha3-256` | The SHA-3 of .NET is missing on macOS and Windows 10, so it needs a managed implementation. Same lengths as SHA-256 and SHA-512. | +| CRC-32C | iSCSI, ext4, Btrfs, cloud storage | .NET only has the instruction (`BitOperations.Crc32C`). Same length as CRC32; cloud services usually show it in Base64. | + +How an algorithm is wired in, and what to watch for: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md#adding-a-hash-algorithm). + ## Accessibility UI changes must keep the app usable with the keyboard alone and with screen readers: translated names for controls, diff --git a/README.md b/README.md index ca24583..4ce9810 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,10 @@ [![CI](https://github.com/poli0981/HashTool/actions/workflows/ci.yml/badge.svg)](https://github.com/poli0981/HashTool/actions/workflows/ci.yml) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=poli0981_HashTool&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=poli0981_HashTool) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=poli0981_HashTool&metric=coverage)](https://sonarcloud.io/component_measures?id=poli0981_HashTool&metric=coverage) +[![Qodana](https://github.com/poli0981/HashTool/actions/workflows/qodana.yml/badge.svg)](https://github.com/poli0981/HashTool/actions/workflows/qodana.yml) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/poli0981/HashTool/badge)](https://scorecard.dev/viewer/?uri=github.com/poli0981/HashTool) +[![Maintenance mode](https://img.shields.io/badge/status-maintenance%20mode-blue.svg)](#project-status) +[![.NET 10 LTS](https://img.shields.io/badge/.NET-10%20LTS-512BD4.svg)](https://dotnet.microsoft.com/download/dotnet/10.0) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) [![Downloads](https://img.shields.io/github/downloads/poli0981/HashTool/total.svg)](https://github.com/poli0981/HashTool/releases) @@ -12,6 +15,13 @@ Built with C# on .NET 10 and Avalonia UI. +## Project status + +**Maintenance mode** since Hash Tool 1.3.0 (November 2026). Hash Tool keeps getting security fixes, dependency and .NET +updates, bug fixes, accessibility and translation fixes, and new hash algorithms when someone needs one — but no new +features. Details: [CONTRIBUTING.md](CONTRIBUTING.md#project-status-maintenance-mode) and the +[announcement](https://github.com/poli0981/HashTool/discussions/categories/announcements). + ## Motivation Why open a terminal and type cryptic commands just to hash a file? @@ -125,7 +135,8 @@ How the code is organised: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md). How rel ## Contributing -Bug reports, translations and pull requests are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md). Something hard to +Bug reports, translation fixes and pull requests within the maintenance scope are welcome — see +[CONTRIBUTING.md](CONTRIBUTING.md). Something hard to use with a keyboard, screen reader or other assistive technology? See [ACCESSIBILITY.md](ACCESSIBILITY.md). ## Legal Stuff diff --git a/SECURITY.md b/SECURITY.md index 21f60c9..e8fbb51 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,6 +1,6 @@ # Security Policy for HashTool -**Last updated: October 2026** +**Last updated: November 2026** 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. @@ -9,12 +9,14 @@ Security fixes are released for the latest minor version only. Installed and por | Version | Supported | | ------- | ------------------ | -| 1.2.x | :white_check_mark: | -| < 1.2 | :x: | +| 1.3.x | :white_check_mark: | +| < 1.3 | :x: | + +Hash Tool is in maintenance mode (see [CONTRIBUTING.md](CONTRIBUTING.md#project-status-maintenance-mode)), which does not change this: vulnerabilities rated *high* or *critical* in the .NET runtime or a dependency, and other serious security problems, get a new release as soon as practical. ### 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 --repo poli0981/HashTool`). -- Every pull request is checked for vulnerable NuGet packages, licences, leaked secrets and unsafe workflow patterns, in addition to CodeQL, SonarCloud and OpenSSF Scorecard. +- Every pull request is checked for vulnerable NuGet packages, licences, leaked secrets and unsafe workflow patterns, in addition to CodeQL, Qodana, SonarCloud 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 diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 858f095..c2c0b9b 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -69,6 +69,24 @@ the SonarCloud workflow: the C# during a real build, with coverage from the test (`dotnet-coverage`), plus the scripts and workflows. Its quality gate ("Sonar way") applies to new code; `bench/` is analysed as test code and `eng/` is left out of coverage. +## Adding a hash algorithm + +In maintenance mode an algorithm is added only on real demand (CONTRIBUTING.md, "Hash algorithms"). What it touches: + +- `HashType`: append only, never rename. Settings store the name (`"SHA256"`), an unknown name resets `config.json` + (so would a downgrade after a new algorithm was chosen), and the name is what the UI, the CLI and `-a` show. +- `HashAlgorithms`: `GuessPriority` (every algorithm must be listed), `Aliases`, `SizeInBytes`, `FileExtension`, + `BsdTag`, `IsInsecure`. +- `HashFunction.Create`: the implementation. `HashEngine` creates every requested function before reading, so one that + can fail on some platforms (the SHA-3 of .NET on macOS and Windows 10) breaks unrelated rows: use a managed + implementation. +- `ChecksumFileNames`: extensions and well-known file names (`B2SUMS`…). The Windows context menu uses the same list, + and `build/macos/Info.plist` must match it (`PackagingTests`). +- Digests of the same length become guesses (64 hex digits: SHA-256, BLAKE3…): Verify hashes every candidate in one + read, except when the Default algorithm of the page has that length. +- Tests: `KnownAnswerTests` (published vectors), `EdgeCaseTests` and `CliTests` (both assert that `sha3` is unknown + today), `HashMatcherTests`; docs: README, USAGE, `hashtool hash --help`. + ## Benchmarks ```text