[FEATURE] Audit authority, code quality and documentation in sha2-tool #1

Open
opened 2026-09-12 07:58:00 +02:00 by erikinkinen · 1 comment
Owner

Problem and motivation

Audit sha2-tool throughout 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 explicit manual-pages.json binds 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
  • Record origin, recipient, object, operations, delegation ceiling, lifetime and aliases for each relevant capability or caller-supplied authority-bearing value.
  • Audit ambient discovery/selectors, cwd/PATH/environment, numeric identities, inherited routes and host fallbacks; require explicit authorized intake.
  • Account for residual authority after success, error, cancellation, timeout, restart, failed transfer and teardown, including fork/exec where implemented.
  • Remove unnecessary endpoints, broad rights, duplicate aliases, provider/admin grants and debug routes.
  • Exercise stale generations, replay, pending replies, forged descriptive identity and object/path resolution races at the owned boundary.
  • Prove independent cleanup attempts and caller-specific error precedence; quarantine or terminate when retained authority cannot be accounted for.
  • Review unsafe/FFI/parser/arithmetic/lifetime/lock/publication invariants and add adversarial coverage where practical.
  • Inventory obsolete APIs, wrappers, fallback/dead paths and duplicate validators with their maintained callers.
  • Migrate callers and delete deprecated contracts/shims in a coherent signed revision graph; reject retired input versions where relevant.
  • Classify each size/count/depth/time bound as ABI, hardware, explicit resource policy or accidental limitation.
  • Test beyond removed boundaries and at allocation/ABI limits while preserving exhaustion errors, denial-of-service controls and bounded waits.
  • Keep every tracked authored code/test/script/workflow file below 1000 physical lines through thematic refactoring.
  • Run the deterministic tracked-source size gate, covering executable fixtures/generators and excluding only genuine non-code data or external payloads.
  • Audit production/test feature and symbol separation, including this repository's effect on rootd test orchestration.
  • Supply changes affecting rootd semantic surface to the maintained same-toolchain baseline; record a justified component-specific applicability result.
  • Check bootstrap ownership and development/release authority parity at this repository's producer/consumer boundary.
  • Use maintained integration#3 profiler evidence before optimizing; preserve live access checks, ownership and success criteria.
  • Audit build/CI inputs, secret handling, private outputs, symlink containment, deletion, subprocess bounds, warnings and host dependencies.
  • meaningful public/private inline documentation, crate/target missing_docs enforcement without blanket allowances or hidden-API escapes, warning-denied private-item rustdoc and an undocumented-public-API negative gate.
  • Validation: Run 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.
  • Documentation: update applicable README/ARCHITECTURE/ROADMAP in meta's canonical format and affected technical-manual TeX/API references; keep README evergreen and shared governance byte-identical to meta.
  • Publish the complete sha2-tool(1) page with an explicit owning manual inventory.
  • Bind the implemented source inputs, check page freshness in CI and consume the selected manifest through the maintained store writer.
  • Evidence: record exact source/dependency revisions, commands, configurations, real exit status, CI run URLs and results; repeat the audit on final heads and obtain independent review of security closures. No skipped/pending/predecessor result counts as a pass.

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
Repository Links
docs issue 1
integration issue 2
sha2-tool PR 2
## Problem and motivation Audit `sha2-tool` throughout 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 explicit `manual-pages.json` binds 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 <details> <summary>Checklist</summary> - [ ] Record origin, recipient, object, operations, delegation ceiling, lifetime and aliases for each relevant capability or caller-supplied authority-bearing value. - [ ] Audit ambient discovery/selectors, cwd/PATH/environment, numeric identities, inherited routes and host fallbacks; require explicit authorized intake. - [ ] Account for residual authority after success, error, cancellation, timeout, restart, failed transfer and teardown, including fork/exec where implemented. - [ ] Remove unnecessary endpoints, broad rights, duplicate aliases, provider/admin grants and debug routes. - [ ] Exercise stale generations, replay, pending replies, forged descriptive identity and object/path resolution races at the owned boundary. - [ ] Prove independent cleanup attempts and caller-specific error precedence; quarantine or terminate when retained authority cannot be accounted for. - [ ] Review unsafe/FFI/parser/arithmetic/lifetime/lock/publication invariants and add adversarial coverage where practical. - [ ] Inventory obsolete APIs, wrappers, fallback/dead paths and duplicate validators with their maintained callers. - [ ] Migrate callers and delete deprecated contracts/shims in a coherent signed revision graph; reject retired input versions where relevant. - [ ] Classify each size/count/depth/time bound as ABI, hardware, explicit resource policy or accidental limitation. - [ ] Test beyond removed boundaries and at allocation/ABI limits while preserving exhaustion errors, denial-of-service controls and bounded waits. - [ ] Keep every tracked authored code/test/script/workflow file below 1000 physical lines through thematic refactoring. - [ ] Run the deterministic tracked-source size gate, covering executable fixtures/generators and excluding only genuine non-code data or external payloads. - [ ] Audit production/test feature and symbol separation, including this repository's effect on rootd test orchestration. - [ ] Supply changes affecting rootd semantic surface to the maintained same-toolchain baseline; record a justified component-specific applicability result. - [ ] Check bootstrap ownership and development/release authority parity at this repository's producer/consumer boundary. - [ ] Use maintained [integration#3](https://git.erikinkinen.fi/erix/integration/issues/3) profiler evidence before optimizing; preserve live access checks, ownership and success criteria. - [ ] Audit build/CI inputs, secret handling, private outputs, symlink containment, deletion, subprocess bounds, warnings and host dependencies. - [ ] meaningful public/private inline documentation, crate/target `missing_docs` enforcement without blanket allowances or hidden-API escapes, warning-denied private-item rustdoc and an undocumented-public-API negative gate. - [ ] Validation: Run `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. - [ ] Documentation: update applicable README/ARCHITECTURE/ROADMAP in meta's canonical format and affected technical-manual TeX/API references; keep README evergreen and shared governance byte-identical to meta. - [x] Publish the complete `sha2-tool(1)` page with an explicit owning manual inventory. - [x] Bind the implemented source inputs, check page freshness in CI and consume the selected manifest through the maintained store writer. - [ ] Evidence: record exact source/dependency revisions, commands, configurations, real exit status, CI run URLs and results; repeat the audit on final heads and obtain independent review of security closures. No skipped/pending/predecessor result counts as a pass. </details> ## 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. <details> <summary>Related records and contracts</summary> | Repository | Links | | --- | --- | | docs | [issue 1](https://git.erikinkinen.fi/erix/docs/issues/1) | | integration | [issue 2](https://git.erikinkinen.fi/erix/integration/issues/2) | | sha2-tool | [PR 2](https://git.erikinkinen.fi/erix/sha2-tool/pulls/2) | </details>
erikinkinen changed title from [FEATURE] [P02.R69] Audit authority, code quality and documentation in sha2-tool to [FEATURE] Audit authority, code quality and documentation in sha2-tool 2026-09-12 08:02:40 +02:00
Author
Owner

The 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.

The original [sha2-tool(1) page](https://git.erikinkinen.fi/erix/sha2-tool/src/commit/5204253ce8c2f84fad8f5b9cf02ffb493a51c865/manual/sha2-tool.1.txt) 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.
erikinkinen added this to the Alpha 1 milestone 2026-10-30 09:35:13 +01:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
erix/sha2-tool#1
No description provided.