[FEATURE] Audit authority, code quality and documentation in lib-input #1

Open
opened 2026-09-12 07:57:49 +02:00 by erikinkinen · 0 comments
Owner

Problem and motivation

Audit lib-input throughout Phase 6. Define normalized keyboard/pointer event contracts and validation used by input producers and consumers.

Review each changed boundary at the final published revision. Prioritize security, reliability, then performance.

Proposed behavior and scope

Current inventory: 1 Cargo target (1 lib); manifests: Cargo.toml. Include explicit and automatically discovered targets, supported features and target-specific configurations.

Trace authority-bearing inputs through callers and public APIs. Confirm that the library acquires no service, hardware or host authority implicitly. Review startup, teardown and Rootd parity at the caller boundary when this crate owns no process, and justify each applicability decision.

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

Downstream manifest/catalog adoption and actual consumer VM acceptance remain required; this is not full guest-build evidence.

Original coherent realm source CI acceptance — 18 September 2026: Signed 35fb303e41b934a254d30c40baa6e3399679dffb passes CI 27 and CI 26. Coherent catalog publication, actual consumer VMs and full guest-build acceptance remain separate open requirements.

Tracking and rollout

Counted-contract dependency checkpoint — 25 September 2026: signed lib-input 5b2c53e8 selects the validated original IPC revision for counted realm startup, client lifecycle, seal and final accounting. Lib-input also adopts the corresponding bootstrap revision. Local Rust implementation bytes, APIs and capability policy are unchanged. The current roadmap consolidates repeated historical dependency prose; README, ARCHITECTURE and technical manual contracts remain applicable.

All 31 checks pass, including 4 unit tests in each of default/all-feature dev/release configurations, strict host/native Clippy, warning-denied native library builds, private host/native rustdoc, doctests, formatting, Markdown and exact dependency-source validation. Original CI34 and CI35 pass with all complete logs independently reviewed and zero warnings. No unchanged workflow was rerun. This dependency alignment is part of coordinated graph adoption; actual four-client I/O, native repeated managed-row reuse, Integration profiler observation and both complete builds inside EriX remain open. See the phase completion checklist.

Each of the four default/all-feature development/release selections passes 4 tests/doctests. Formatting, strict host/native Clippy, warning-denied builds, private rustdoc, Markdown and exact original dependency checks pass with zero warnings.

Actual running mediator readiness/retirement, complete service-image acceptance, configuration/seal, client I/O and both required guest rebuilds remain open.

Tracking: owning issue, WIP PR and Phase 6 acceptance.

Coordinated library dependency update — 15 September 2026

Both isolated native scenarios pass on their first attempts; full coordinated service-image execution remains open under Kernel design 19. This dependency/wire checkpoint does not establish complete lifecycle acceptance or either full EriX build generation.

No local API or capability policy changes. Actual service consumer and coherent full VM adoption remain open in phase completion.

Related records and contracts
Repository Links
docs issue 1
integration issue 2
kernel issue 20
## Problem and motivation Audit `lib-input` throughout Phase 6. Define normalized keyboard/pointer event contracts and validation used by input producers and consumers. Review each changed boundary at the final published revision. Prioritize security, reliability, then performance. ## Proposed behavior and scope Current inventory: 1 Cargo target (1 lib); manifests: `Cargo.toml`. Include explicit and automatically discovered targets, supported features and target-specific configurations. Trace authority-bearing inputs through callers and public APIs. Confirm that the library acquires no service, hardware or host authority implicitly. Review startup, teardown and Rootd parity at the caller boundary when this crate owns no process, and justify each applicability decision. ## 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. - [ ] 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. Downstream manifest/catalog adoption and actual consumer VM acceptance remain required; this is not full guest-build evidence. Original coherent realm source CI acceptance — 18 September 2026: Signed `35fb303e41b934a254d30c40baa6e3399679dffb` passes [CI 27](https://git.erikinkinen.fi/erix/lib-input/actions/runs/27) and [CI 26](https://git.erikinkinen.fi/erix/lib-input/actions/runs/26). Coherent catalog publication, actual consumer VMs and full guest-build acceptance remain separate open requirements. ## Tracking and rollout Counted-contract dependency checkpoint — 25 September 2026: signed [lib-input 5b2c53e8](https://git.erikinkinen.fi/erix/lib-input/commit/5b2c53e8edda9d0b07040e9010cf6b918e0e5ca6) selects the validated original IPC revision for counted realm startup, client lifecycle, seal and final accounting. Lib-input also adopts the corresponding bootstrap revision. Local Rust implementation bytes, APIs and capability policy are unchanged. The current roadmap consolidates repeated historical dependency prose; README, ARCHITECTURE and technical manual contracts remain applicable. All 31 checks pass, including 4 unit tests in each of default/all-feature dev/release configurations, strict host/native Clippy, warning-denied native library builds, private host/native rustdoc, doctests, formatting, Markdown and exact dependency-source validation. Original [CI34](https://git.erikinkinen.fi/erix/lib-input/actions/runs/34) and [CI35](https://git.erikinkinen.fi/erix/lib-input/actions/runs/35) pass with all complete logs independently reviewed and zero warnings. No unchanged workflow was rerun. This dependency alignment is part of coordinated graph adoption; actual four-client I/O, native repeated managed-row reuse, Integration profiler observation and both complete builds inside EriX remain open. See the [phase completion checklist](https://git.erikinkinen.fi/erix/integration/issues/65). Each of the four default/all-feature development/release selections passes 4 tests/doctests. Formatting, strict host/native Clippy, warning-denied builds, private rustdoc, Markdown and exact original dependency checks pass with zero warnings. Actual running mediator readiness/retirement, complete service-image acceptance, configuration/seal, client I/O and both required guest rebuilds remain open. Tracking: [owning issue](https://git.erikinkinen.fi/erix/lib-input/issues/1), [WIP PR](https://git.erikinkinen.fi/erix/lib-input/pulls/2) and [Phase 6 acceptance](https://git.erikinkinen.fi/erix/integration/issues/65). ### Coordinated library dependency update — 15 September 2026 Both isolated native scenarios pass on their first attempts; full coordinated service-image execution remains open under [Kernel design 19](https://git.erikinkinen.fi/erix/kernel/issues/19). This dependency/wire checkpoint does not establish complete lifecycle acceptance or either full EriX build generation. No local API or capability policy changes. Actual service consumer and coherent full VM adoption remain open in [phase completion](https://git.erikinkinen.fi/erix/integration/issues/65). <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) | | kernel | [issue 20](https://git.erikinkinen.fi/erix/kernel/issues/20) | </details>
erikinkinen changed title from [FEATURE] [P02.R46] Audit authority, code quality and documentation in lib-input to [FEATURE] Audit authority, code quality and documentation in lib-input 2026-09-12 08:02:29 +02:00
erikinkinen added this to the Alpha 1 milestone 2026-10-30 09:34:45 +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/lib-input#1
No description provided.