IC Host Tooling
Host-side Rust libraries for artifact inspection, local filesystem safety, admitted process execution and IC-specific format handling.
| Crate | Implemented source ownership |
|---|---|
| ic-host-artifacts | Bounded streams and hashing writers, exact byte comparison, SHA-256, gzip encoding/decoding, verified tar members and generic Wasm facts |
| ic-host-fs | Regular/no-follow reads, missing-suffix path resolution, streamed durable publication, private files and observed descriptor locks |
| ic-host-process | Executable resolution, digest/version admission, bounded capture, explicit child/group cleanup and Git observations |
| ic-host-tools | Candid extraction/normalization, ICP CLI response decoding and optional IC resource reports |
These run locally outside canisters. The ic-host prefix identifies their ecosystem;
the generic crates have no IC runtime dependency. Compression, archive and Wasm
support are optional features of ic-host-artifacts. Filesystem/process consumers
select the small default artifact dependency.
Response-only consumers can disable ic-host-tools' default features to exclude
the artifact/filesystem/process extraction dependencies. The default
candid-extraction feature preserves the existing Unix Candid API. Response
decoding is always available and needs only serde/serde_json.
The optional ic-limits feature compares Wasm facts with explicitly selected,
revision-bound IC resource limits, without filesystem/process dependencies when
defaults are disabled. See the 0.5 contract changes.
tool::capture_command accepts a caller-configured std::process::Command when
the consumer owns executable admission. It shares bounded capture and direct-child
cleanup with AdmittedTool, whose exact digest/version checks remain in place.
ToolError::evidence and execution_error borrow retained diagnostics without
copying output; callers own presentation and recovery.
child::OwnedChild::spawn starts a caller-configured command in a new owned
process group. It preserves command IO and supports polling, waiting, explicit
termination and cleanup during unwinding. Callers retain admission, readiness,
cancellation and application lifecycle policy. For deliberate background startup,
poll_exit retains cleanup ownership through result admission; explicit handoff
then reaps a successful leader without stopping the background group. See the
handoff contract and the
child cleanup contract
for exclusive ownership and descendant limitations.
tool::capture_group_command combines bounded stdout/stderr capture with that
group cleanup for commands whose descendants must be signalled on exit or
failure. Ordinary capture_command retains direct-child cleanup. Both share one
capture engine; callers retain budgets, admission and external-effect recovery.
AdmittedTool::admit_version accepts a VersionSpec for caller-trusted installed
tools without a published binary digest. It records the installed identity,
checks the exact version and rejects byte drift before later execution. That
observed identity is not authentication; installation provenance stays with the
caller. admit with ToolSpec continues to require an exact digest pin.
Filesystem reads live under ic_host_fs::read, including optional bounded
no-follow reads and typed private-file admission. Durable publication and locks
remain under durable. Upgrading from 0.3 requires the
0.4 consumer changes.
durable::write_named_with lets an external tool write to an owned absolute
staging path, then shares the normal durable publication engine. Callers validate
bounded output before success and retain typed producer/cleanup errors. See the
named-output contract before adopting it.
durable::write_validated_with closes the staging writer before a caller's
prepublication admission callback, enabling executable probes while preserving
the working destination on rejection. See the
closed-writer contract.
durable::write_typed_with retains serializer errors while streaming through
the same engine, with explicit replace/create-only options and file permissions.
durable::write_at_with borrows an admitted directory descriptor so publication
stays anchored to it even when its original path moves. Consumers retain path
admission, budgets and recovery; see the
publication contract.
With the artifact gzip feature, hash_gzip and hash_gzip_or_raw identify
decoded payloads without a full decoded allocation. gzip_matches compares
decoded bytes exactly with an expected slice. All retain explicit input/payload
bounds and strict single-member integrity checks; see the
gzip contract.
The four-crate workspace permits crates.io publication; a Git release does not establish registry availability. Release qualification is recorded in the handoff. The original local checkout has been removed after a verified full backup. Consumers adopt and qualify registry selections independently.
Read the extraction contract, host qualification, the handoff and agent rules. Human and agent contributions follow the PR contribution rules.
Use cargo test -p ic-host-artifacts --all-features --lib --locked --offline
or select the corresponding filesystem, process or IC adapter package.
make check, make clippy and make docs-check accept PACKAGE=.
make test-artifacts-minimal exercises the artifact library without optional
features; native CI runs it alongside the all-feature package checks.
make test-tools-response checks the response-only library, and
make tools-features-check verifies its actual production dependency exclusions
and the default extractor's required owners.
make install-host-tools and make install-ic-tools are explicit setup commands;
their offline checks never install tools. make install-hooks activates the
repository-local formatter after provisioning cargo-sort 2.1.4.
The optional make install-rust-tools bundle has its own offline
make rust-tools-check; neither runs as part of the aggregate setup/check targets.
The common make/tools.mk owns setup/check commands and selects pinned jq, yq,
ripgrep with PCRE2 and cloc. CI uses those same targets. Run
make install-host-tools after this snapshot update to prepare the expanded set;
make host-tools-check verifies it offline without installing anything.
make cloc reports this workspace's Rust runtime/test lines; make cloc-tooling
inventories sibling tooling and separates matching shared snapshots from local
code. CLOC_PARENT selects the latter's parent directory. Direct shell commands
need their own PATH setup as described in local setup.
Shared Tooling owns rules, hooks, installers and the common release runner.
This workspace consumes an exact snapshot; library ownership stays here.
make ci is the complete configured gate, not an automatic development command.
The standard release entry points use the shared runner for version preparation,
commit, tag and atomic branch/tag push with RELEASE_DELIVERY=direct.
This consumer rejects other delivery selections before starting a command;
Shared Tooling's optional PR release flow needs separate adapter qualification.
Registry publication is separate:
make publish-check performs a Cargo dry run, and make publish uploads the
committed workspace to crates.io. Read the publication procedure
for prerequisites, retained evidence and partial-upload recovery.
Prepare the pinned host set with make install-host-tools before release version
queries or release entry points. make release-version uses the shared read-only
Cargo/TOML reader; parser checks never install missing tools. Release preflight
refreshes only host tools. The IC executable bundle remains available through
make install-ic-tools and its offline check.