[FEATURE] Audit authority, code quality and documentation in sha2-tool #1
Labels
No labels
alpha-1
bug
ci
docs
duplicate
enhancement
help wanted
invalid
performance
phase-6
question
refactor
security
wontfix
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
erix/sha2-tool#1
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Problem and motivation
Audit
sha2-toolthroughout Phase 6. Stream SHA-256/SHA-512 over caller-selected host paths or standard input and emit deterministic path-safe output records.Review each changed boundary at the final published revision. Prioritize security, reliability, then performance.
Proposed behavior and scope
Current inventory: 6 Cargo targets (1 library, 1 Linux binary and 4 integration-test targets); manifest:
Cargo.toml. Include explicit and automatically discovered targets, supported features and target-specific configurations.Review explicit host input/output selection, subprocess/environment inputs if present, descriptor lifetime and partial-I/O failure. Map service-startup dimensions to the tool invocation/exit boundary and document unsupported runtime roles individually.
Publish an original
sha2-tool(1)page for the complete implemented command, with options, examples, errors, statuses and its Linux/native authority boundary. An explicitmanual-pages.jsonbinds the implemented source inputs and selects the page for offline store packaging.Authority, security and reliability
Record each finding's affected revision, invariant, reproduction, owner, regression coverage and resolution. Report suspected vulnerabilities through SECURITY.md and keep sensitive details private. Record a result and rationale for each audit criterion, including caller responsibilities when this component has no process or Rust target.
Acceptance criteria
Checklist
missing_docsenforcement without blanket allowances or hidden-API escapes, warning-denied private-item rustdoc and an undocumented-public-API negative gate.cargo fmt --all -- --check, strict Clippy, unit/doctests and warning-denied builds/rustdoc for every owned crate/target under default and all valid feature, freestanding/host, SMP and profile combinations; test mutually exclusive combinations separately. Add focused VM regressions for runtime behavior and observe the older catalog and unit tests at the exact published heads.sha2-tool(1)page with an explicit owning manual inventory.Alternatives and tradeoffs
Refactor within the component unless shared semantics justify extracting common code. Preserve regression coverage before deleting superseded paths. Profile before optimizing, and document ABI limits, hardware limits and explicit quotas. Preserve security and reliability requirements.
Tracking and rollout
Complete product-image adoption remains required.
Related records and contracts
[FEATURE] [P02.R69] Audit authority, code quality and documentation in sha2-toolto [FEATURE] Audit authority, code quality and documentation in sha2-toolThe original sha2-tool(1) page now covers the complete implemented grammar, digest records, errors, statuses, examples and Linux/native authority boundary. Its explicit inventory binds the owning source inputs; native execution and image installation remain open.