diff --git a/Cargo.lock b/Cargo.lock index 5c27f3f80..aba5091f0 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2382,9 +2382,9 @@ checksum = "0cc23270f6e1808e30a928bdc84dea0b9b4136a8bc82338574f23baf47bbd280" [[package]] name = "globset" -version = "0.4.16" +version = "0.4.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "54a1028dfc5f5df5da8a56a73e6c153c9a9708ec57232470703592a3f18e49f5" +checksum = "e47d37d2ae4464254884b60ab7071be2b876a9c35b696bd018ddcc76847309cd" dependencies = [ "aho-corasick", "bstr", @@ -2791,7 +2791,7 @@ dependencies = [ "libc", "percent-encoding", "pin-project-lite", - "socket2 0.5.10", + "socket2 0.6.4", "system-configuration", "tokio", "tower-service", @@ -2959,9 +2959,9 @@ dependencies = [ [[package]] name = "ignore" -version = "0.4.23" +version = "0.4.29" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6d89fd380afde86567dfba715db065673989d6253f42b88179abd3eae47bda4b" +checksum = "d4ffa3a0547a138e59ddd6fa3b7c672ed47e6ad6a3cd177984ff1116aa5ba742" dependencies = [ "crossbeam-deque", "globset", @@ -4305,7 +4305,7 @@ dependencies = [ "quinn-udp", "rustc-hash 2.1.1", "rustls", - "socket2 0.5.10", + "socket2 0.6.4", "thiserror 2.0.18", "tokio", "tracing", @@ -4342,7 +4342,7 @@ dependencies = [ "cfg_aliases", "libc", "once_cell", - "socket2 0.5.10", + "socket2 0.6.4", "tracing", "windows-sys 0.60.2", ] @@ -5410,6 +5410,7 @@ dependencies = [ "hex", "home", "humantime", + "ignore", "indexmap 2.11.0", "itertools 0.10.5", "jsonrpsee-types", @@ -5450,6 +5451,7 @@ dependencies = [ "strsim", "strum 0.17.1", "strum_macros 0.17.1", + "tar", "tempfile", "termcolor", "termcolor_output", @@ -5463,7 +5465,6 @@ dependencies = [ "tracing-subscriber", "ulid", "url", - "walkdir", "wasm-gen", "wasm-opt", "wasmparser 0.116.1", @@ -6088,6 +6089,17 @@ version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "55937e1799185b12863d447f42597ed69d9928686b8d88a1df17376a097d8369" +[[package]] +name = "tar" +version = "0.4.46" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f6221d9a6003c78398e3b239969f352578258df48c8eb051caadae0015bc840" +dependencies = [ + "filetime", + "libc", + "xattr", +] + [[package]] name = "temp-dir" version = "0.1.16" diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index fbdd59db0..f5b1b7dab 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -84,6 +84,7 @@ Tools for smart contract developers - `asset` — Utilities to deploy a Stellar Asset Contract or get its id - `alias` — Utilities to manage contract aliases - `bindings` — Generate code client bindings for a contract +- `archive` — Generate the reproducible source archive used by verifiable builds - `build` — Build a contract from source - `extend` — Extend the time to live ledger of a contract-data ledger entry - `deploy` — Deploy a wasm contract @@ -344,6 +345,17 @@ Generate PHP bindings **Usage:** `stellar contract bindings php` +## `stellar contract archive` + +Generate the reproducible source archive used by verifiable builds + +**Usage:** `stellar contract archive [OPTIONS]` + +###### **Options:** + +- `-o`, `--out-file ` — Where to write the gzipped tarball. Required unless `--dry-run` is used +- `--dry-run` — List the entries that would be archived and the computed source_sha256, without writing any file + ## `stellar contract build` Build a contract from source @@ -356,6 +368,18 @@ To view the commands that will be executed, without executing them, use the --pr **Usage:** `stellar contract build [OPTIONS]` +###### **Container Options:** + +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +- `--engine ` — Container engine to use [default: docker] + + Possible values: + - `docker`: Docker, or any Docker-compatible CLI + - `apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon) + +- `--cpus ` — Limit the number of CPUs available to the container, e.g. `2`. A whole number: Apple's `container` engine does not accept fractional CPUs +- `--memory ` — Limit the memory available to the container, e.g. `2g` or `512m` + ###### **Features:** - `--features ` — Build with the list of features activated, space or comma separated @@ -384,6 +408,7 @@ To view the commands that will be executed, without executing them, use the --pr If ommitted, wasm files are written only to the cargo target directory. - `--locked` — Assert that `Cargo.lock` will remain unchanged +- `--env ` — Set an environment variable for the build (repeatable), e.g. `--env NAME=VALUE`. It's set on the build process; for a verifiable build it's passed to the container and recorded as a `bldopt`, so avoid secrets there - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` @@ -394,6 +419,13 @@ To view the commands that will be executed, without executing them, use the --pr - `--print-commands-only` — Print commands to build without executing them +###### **Verifiable Options:** + +- `--verifiable` — Build inside a trusted Docker container and record SEP-58 metadata (`bldimg`, `source_uri`, `source_sha256`, `bldopt`) so the resulting WASM can be reproduced and verified by third parties. Implies `--locked`. Requires a clean git working tree +- `--image ` — Override the auto-selected container image used by `--verifiable`. Must be digest-pinned, e.g. `docker.io/stellar/stellar-cli@sha256:...`. Tag-only refs are rejected because SEP-58 requires content addressing +- `--source-sha256 ` — SEP-58 source identification: SHA-256 of the source archive (recorded as the `source_sha256` meta entry). Optional with `--verifiable`: the archive is always generated and its SHA-256 computed for you. When supplied it's treated as a pin — the build fails if it doesn't match the generated archive +- `--source-uri ` — SEP-58 source identification: URI where the source can be obtained, e.g. `https://example.com/src.tar.gz` (recorded as the `source_uri` meta entry). Optional; when set it must accompany `--source-sha256` + ## `stellar contract extend` Extend the time to live ledger of a contract-data ledger entry. @@ -481,6 +513,7 @@ Deploy a wasm contract Default value: `false` - `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation +- `--env ` — Set an environment variable for the build (repeatable), e.g. `--env NAME=VALUE`. It's set on the build process; for a verifiable build it's passed to the container and recorded as a `bldopt`, so avoid secrets there - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` @@ -855,6 +888,7 @@ Install a WASM file to the ledger without creating a contract instance Default value: `false` +- `--env ` — Set an environment variable for the build (repeatable), e.g. `--env NAME=VALUE`. It's set on the build process; for a verifiable build it's passed to the container and recorded as a `bldopt`, so avoid secrets there - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` @@ -918,6 +952,7 @@ Install a WASM file to the ledger without creating a contract instance Default value: `false` +- `--env ` — Set an environment variable for the build (repeatable), e.g. `--env NAME=VALUE`. It's set on the build process; for a verifiable build it's passed to the container and recorded as a `bldopt`, so avoid secrets there - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` diff --git a/cmd/crates/soroban-test/tests/it/build.rs b/cmd/crates/soroban-test/tests/it/build.rs index b5f7631ca..6d1ba0290 100644 --- a/cmd/crates/soroban-test/tests/it/build.rs +++ b/cmd/crates/soroban-test/tests/it/build.rs @@ -69,6 +69,47 @@ fn build_package_by_current_dir() { )); } +// `--env` is repeatable and sets env vars on the local cargo process; they +// surface in the printed command in --print-commands-only. +#[test] +fn build_with_env_vars() { + let sandbox = TestEnv::default(); + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add"); + sandbox + .new_assert_cmd("contract") + .current_dir(fixture_path) + .arg("build") + .arg("--print-commands-only") + .arg("--env") + .arg("FOO=bar") + .arg("--env") + .arg("BAZ=qux") + .assert() + .success() + .stdout(predicate::str::contains("FOO=bar").and(predicate::str::contains("BAZ=qux"))); +} + +// An invalid `--env` name is rejected before building. +#[test] +fn build_rejects_invalid_env_name() { + let sandbox = TestEnv::default(); + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add"); + sandbox + .new_assert_cmd("contract") + .current_dir(fixture_path) + .arg("build") + .arg("--print-commands-only") + .arg("--env") + .arg("1FOO=bar") + .assert() + .failure() + .stderr(predicate::str::contains( + "not a valid environment variable name", + )); +} + #[test] fn build_with_locked() { let sandbox = TestEnv::default(); @@ -993,3 +1034,322 @@ fn build_always_injects_cli_version() { "CLI version should not be empty" ); } + +const ZERO_DIGEST: &str = + "docker.io/stellar/stellar-cli@sha256:0000000000000000000000000000000000000000000000000000000000000000"; + +// Convenience: drive a git command in a fixture directory. +fn git_in(dir: &Path, args: &[&str]) { + std::process::Command::new("git") + .args(args) + .current_dir(dir) + .env("GIT_AUTHOR_NAME", "Test") + .env("GIT_AUTHOR_EMAIL", "test@example.com") + .env("GIT_COMMITTER_NAME", "Test") + .env("GIT_COMMITTER_EMAIL", "test@example.com") + .status() + .unwrap(); +} + +// Init a tempdir copy of the workspace fixture and return the workspace path. +fn fresh_workspace() -> (TempDir, PathBuf) { + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace"); + let temp = TempDir::new().unwrap(); + fs_extra::dir::copy(&fixture_path, temp.path(), &CopyOptions::new()).unwrap(); + let workspace = temp.path().join("workspace"); + (temp, workspace) +} + +// `--verifiable` cannot accept reserved `--meta` keys that the cli writes itself. +#[test] +fn verifiable_meta_conflict_errors() { + let sandbox = TestEnv::default(); + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add"); + + sandbox + .new_assert_cmd("contract") + .current_dir(fixture_path) + .arg("build") + .arg("--verifiable") + .arg("--image") + .arg(ZERO_DIGEST) + .arg("--source-sha256") + .arg("a".repeat(64)) + .arg("--meta") + .arg("bldimg=not-allowed") + .assert() + .failure() + .stderr(predicate::str::contains("reserved key: bldimg")); +} + +// `--image` is validated against the SEP-58 bldimg regex; tag-only refs fail. +#[test] +fn verifiable_image_must_be_digest_pinned() { + let sandbox = TestEnv::default(); + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add"); + + sandbox + .new_assert_cmd("contract") + .current_dir(fixture_path) + .arg("build") + .arg("--verifiable") + .arg("--image") + .arg("docker.io/stellar/stellar-cli:latest") + .arg("--source-sha256") + .arg("a".repeat(64)) + .assert() + .failure() + .stderr(predicate::str::contains("bldimg format")); +} + +// SEP-58 bldimg requires an explicit registry host (e.g. `docker.io/...`). +// Implicit Docker-Hub-style short refs are rejected. +#[test] +fn verifiable_image_requires_explicit_registry_host() { + let sandbox = TestEnv::default(); + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add"); + + let short_ref = format!("stellar/stellar-cli@sha256:{}", "0".repeat(64)); + + sandbox + .new_assert_cmd("contract") + .current_dir(fixture_path) + .arg("build") + .arg("--verifiable") + .arg("--image") + .arg(short_ref) + .arg("--source-sha256") + .arg("a".repeat(64)) + .assert() + .failure() + .stderr(predicate::str::contains("bldimg format")); +} + +// `--verifiable` always generates the source archive (and computes +// source_sha256) before the docker stage, so the "Wrote source archive" line +// appears even though the build then fails to reach a real image. +#[test] +fn verifiable_always_writes_source_archive() { + let sandbox = TestEnv::default(); + let (_temp, workspace) = fresh_workspace(); + git_in(&workspace, &["init", "-q", "-b", "main"]); + git_in(&workspace, &["add", "-A"]); + git_in(&workspace, &["commit", "-q", "-m", "init"]); + + sandbox + .new_assert_cmd("contract") + .current_dir(workspace.join("contracts").join("add")) + .arg("build") + .arg("--verifiable") + .arg("--image") + .arg(ZERO_DIGEST) + .assert() + .failure() + .stderr( + predicate::str::contains("Wrote source archive") + .and(predicate::str::contains("source_sha256")), + ); +} + +// `contract archive --out` writes the gzipped tarball and prints its +// source_sha256. +#[test] +fn contract_archive_writes_out() { + let sandbox = TestEnv::default(); + let (temp, workspace) = fresh_workspace(); + git_in(&workspace, &["init", "-q", "-b", "main"]); + git_in(&workspace, &["add", "-A"]); + git_in(&workspace, &["commit", "-q", "-m", "init"]); + + let out = temp.path().join("src.tar.gz"); + + sandbox + .new_assert_cmd("contract") + .current_dir(&workspace) + .arg("archive") + .arg("--out-file") + .arg(&out) + .assert() + .success() + .stderr( + predicate::str::contains("Wrote source archive") + .and(predicate::str::contains("source_sha256")), + ); + + assert!(out.exists(), "the archive should be written to --out"); + assert!( + std::fs::metadata(&out).unwrap().len() > 0, + "the archive should not be empty" + ); +} + +// `contract archive --dry-run` lists the archived entries and the +// source_sha256 without writing any file. +#[test] +fn contract_archive_dry_run_lists_entries() { + let sandbox = TestEnv::default(); + let (temp, workspace) = fresh_workspace(); + git_in(&workspace, &["init", "-q", "-b", "main"]); + git_in(&workspace, &["add", "-A"]); + git_in(&workspace, &["commit", "-q", "-m", "init"]); + + let out = temp.path().join("should-not-exist.tar.gz"); + + sandbox + .new_assert_cmd("contract") + .current_dir(&workspace) + .arg("archive") + .arg("--dry-run") + .assert() + .success() + .stdout(predicate::str::contains("source/Cargo.toml")) + .stderr(predicate::str::contains("source_sha256")); + + assert!(!out.exists(), "--dry-run must not write an archive"); +} + +// `--out-file` must name a gzipped tarball (.tar.gz / .tgz). +#[test] +fn contract_archive_rejects_bad_out_file_extension() { + let sandbox = TestEnv::default(); + let (temp, workspace) = fresh_workspace(); + git_in(&workspace, &["init", "-q", "-b", "main"]); + git_in(&workspace, &["add", "-A"]); + git_in(&workspace, &["commit", "-q", "-m", "init"]); + + let out = temp.path().join("src.zip"); + + sandbox + .new_assert_cmd("contract") + .current_dir(&workspace) + .arg("archive") + .arg("--out-file") + .arg(&out) + .assert() + .failure() + .stderr(predicate::str::contains(".tar.gz or .tgz")); + + assert!( + !out.exists(), + "no archive should be written on a bad extension" + ); +} + +// `--out-file` is required unless `--dry-run` is passed. +#[test] +fn contract_archive_requires_out_file_without_dry_run() { + let sandbox = TestEnv::default(); + let (_temp, workspace) = fresh_workspace(); + + sandbox + .new_assert_cmd("contract") + .current_dir(&workspace) + .arg("archive") + .assert() + .failure() + .stderr(predicate::str::contains("--out-file")); +} + +// A dirty git tree is a hard fail for `contract archive` too, matching +// `--verifiable`: the source_sha256 must describe a committed state. +#[test] +fn contract_archive_dirty_tree_errors() { + let sandbox = TestEnv::default(); + let (temp, workspace) = fresh_workspace(); + git_in(&workspace, &["init", "-q", "-b", "main"]); + git_in(&workspace, &["add", "-A"]); + git_in(&workspace, &["commit", "-q", "-m", "init"]); + // Dirty the tree after committing so status is non-empty. + std::fs::write(workspace.join("dirty.txt"), b"uncommitted").unwrap(); + + let out = temp.path().join("src.tar.gz"); + + sandbox + .new_assert_cmd("contract") + .current_dir(&workspace) + .arg("archive") + .arg("--out-file") + .arg(&out) + .assert() + .failure() + .stderr(predicate::str::contains("dirty")); + + assert!( + !out.exists(), + "no archive should be written for a dirty tree" + ); +} + +// `--source-sha256` value must match the 64-hex regex. +#[test] +fn verifiable_source_sha256_format_errors() { + let sandbox = TestEnv::default(); + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add"); + + sandbox + .new_assert_cmd("contract") + .current_dir(fixture_path) + .arg("build") + .arg("--verifiable") + .arg("--image") + .arg(ZERO_DIGEST) + .arg("--source-sha256") + .arg("not-a-sha") + .assert() + .failure() + .stderr(predicate::str::contains("source_sha256 format")); +} + +// `--source-uri` value must be a URI with a scheme. +#[test] +fn verifiable_source_uri_format_errors() { + let sandbox = TestEnv::default(); + let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add"); + + sandbox + .new_assert_cmd("contract") + .current_dir(fixture_path) + .arg("build") + .arg("--verifiable") + .arg("--image") + .arg(ZERO_DIGEST) + .arg("--source-sha256") + .arg("a".repeat(64)) + .arg("--source-uri") + .arg("not a uri") + .assert() + .failure() + .stderr(predicate::str::contains("source_uri format")); +} + +// A dirty git tree is a hard fail under `--verifiable` (the recorded +// source_sha256 would not describe the bytes built). +#[test] +fn verifiable_dirty_tree_errors() { + let sandbox = TestEnv::default(); + let (_temp, workspace) = fresh_workspace(); + git_in(&workspace, &["init", "-q", "-b", "main"]); + git_in(&workspace, &["add", "-A"]); + git_in(&workspace, &["commit", "-q", "-m", "init"]); + // Dirty the tree after committing so status is non-empty. + std::fs::write(workspace.join("dirty.txt"), b"uncommitted").unwrap(); + + sandbox + .new_assert_cmd("contract") + .current_dir(workspace.join("contracts").join("add")) + .arg("build") + .arg("--verifiable") + .arg("--image") + .arg(ZERO_DIGEST) + .arg("--source-sha256") + .arg("a".repeat(64)) + .assert() + .failure() + .stderr(predicate::str::contains("dirty").or(predicate::str::contains("clean tree"))); +} diff --git a/cmd/soroban-cli/Cargo.toml b/cmd/soroban-cli/Cargo.toml index 76d6fc032..9cf393047 100644 --- a/cmd/soroban-cli/Cargo.toml +++ b/cmd/soroban-cli/Cargo.toml @@ -128,6 +128,8 @@ keyring = { version = "3", features = ["apple-native", "windows-native", "sync-s whoami = "1.5.2" serde_with = "3.11.0" rustc_version = "0.4.1" +tar = "0.4.40" +ignore = "0.4.26" [build-dependencies] crate-git-revision = "0.0.9" @@ -139,6 +141,5 @@ thiserror.workspace = true assert_cmd = "2.0.4" assert_fs = "1.0.7" predicates = { workspace = true } -walkdir = "2.5.0" mockito = "1.5.0" serial_test = "3.0.0" diff --git a/cmd/soroban-cli/src/commands/container/shared.rs b/cmd/soroban-cli/src/commands/container/shared.rs index b621aea9c..af44909d5 100644 --- a/cmd/soroban-cli/src/commands/container/shared.rs +++ b/cmd/soroban-cli/src/commands/container/shared.rs @@ -1,6 +1,8 @@ use core::fmt; +use std::process::Stdio; use clap::ValueEnum; +use tokio::io::{AsyncBufReadExt, AsyncReadExt, BufReader}; use tokio::process::Command; use crate::print::Print; @@ -20,6 +22,9 @@ pub enum Error { program: String, source: std::io::Error, }, + + #[error("could not pull image {image}: {stderr}")] + PullImageFailed { image: String, stderr: String }, } /// Container runtime to shell out to. @@ -94,6 +99,44 @@ impl Engine { Engine::AppleContainer => stderr.contains("not found"), } } + + /// The `inspect`-family argv (after the engine binary and any host flag) + /// that prints an image's digest metadata: docker's `RepoDigests` Go + /// template vs Apple's `image inspect` JSON (Apple groups image operations + /// under the `image` subcommand and has no `--format` templates). + fn image_inspect_args(self, image: &str) -> Vec<&str> { + match self { + Engine::Docker => vec!["inspect", "--format", "{{index .RepoDigests 0}}", image], + Engine::AppleContainer => vec!["image", "inspect", image], + } + } + + /// Parse the stdout of [`image_inspect_args`] into a content-addressed + /// `@sha256:` reference, or `None` when the engine reports no + /// digest (e.g. a locally-built image never pushed or pulled). + fn parse_repo_digest(self, stdout: &[u8], image: &str) -> Option { + match self { + Engine::Docker => { + let digest = String::from_utf8_lossy(stdout).trim().to_string(); + (!digest.is_empty() && digest != "").then_some(digest) + } + // Apple emits a JSON array whose first entry carries the manifest-list + // descriptor at `configuration.descriptor.digest` — the equivalent of + // docker's `RepoDigests`. The per-platform `variants[].digest` is + // deliberately not used. `None` if the output doesn't have that shape. + Engine::AppleContainer => { + let value: serde_json::Value = serde_json::from_slice(stdout).ok()?; + let digest = value + .as_array()? + .first()? + .get("configuration")? + .get("descriptor")? + .get("digest")? + .as_str()?; + Some(format!("{}@{digest}", repo_of(image))) + } + } + } } impl fmt::Display for Engine { @@ -108,7 +151,7 @@ impl fmt::Display for Engine { } } -#[derive(Debug, clap::Parser, Clone)] +#[derive(Debug, clap::Parser, Clone, Default)] pub struct Args { /// Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock #[arg(short = 'd', long, help = DOCKER_HOST_HELP, env = "DOCKER_HOST")] @@ -191,7 +234,7 @@ impl Args { /// `--docker-host` (or `DOCKER_HOST` env) value is passed as `-H `; the /// `-H` flag outranks `DOCKER_CONTEXT`, so the override is honored even when a /// docker context is active. Host resolution is otherwise left to the CLI. - fn base_command(&self) -> Command { + pub(crate) fn base_command(&self) -> Command { let engine = self.engine(); let mut cmd = Command::new(engine.program()); if engine.supports_docker_host() { @@ -227,6 +270,16 @@ impl Args { cmd } + /// Immediately terminate a running container (SIGKILL), with no graceful + /// grace period — unlike `stop`, which waits up to 10s before force-killing. + /// Used to tear down a build container the instant the CLI is interrupted. + /// Both docker and Apple's `container` accept `kill `. + pub(crate) fn kill_command(&self, name: &str) -> Command { + let mut cmd = self.base_command(); + cmd.args(["kill", name]); + cmd + } + pub(crate) fn logs_command(&self, name: &str) -> Command { let mut cmd = self.base_command(); match self.engine() { @@ -236,6 +289,99 @@ impl Args { }; cmd } + + /// Pull `image`, streaming the engine's high-level status lines ("Pulling + /// from", "Digest", "Status") through `print`. Per-layer progress written to + /// stderr is captured rather than shown and surfaced only when the pull + /// fails, as `PullImageFailed` — callers that need to explain a failed pull + /// (e.g. the verifiable build's tag-listing hint) rely on that captured text. + /// A missing engine binary surfaces via `io_error` as `NotFound`. + pub(crate) async fn pull_image(&self, image: &str, print: &Print) -> Result<(), Error> { + let mut child = self + .pull_command(image) + .stdout(Stdio::piped()) + .stderr(Stdio::piped()) + .spawn() + .map_err(|e| self.io_error(e))?; + + let stdout = child.stdout.take(); + let stderr = child.stderr.take(); + + let stream_stdout = async { + if let Some(stdout) = stdout { + let mut lines = BufReader::new(stdout).lines(); + while let Ok(Some(line)) = lines.next_line().await { + if line.contains("Pulling from") + || line.contains("Digest") + || line.contains("Status") + { + print.infoln(line); + } + } + } + }; + + let capture_stderr = async { + let mut buf = String::new(); + if let Some(mut stderr) = stderr { + let _ = stderr.read_to_string(&mut buf).await; + } + buf + }; + + // Drain both pipes concurrently so a full stderr buffer can't deadlock + // the child while we're reading stdout. + let ((), stderr) = tokio::join!(stream_stdout, capture_stderr); + + if child.wait().await.map_err(|e| self.io_error(e))?.success() { + Ok(()) + } else { + Err(Error::PullImageFailed { + image: image.to_string(), + stderr: stderr.trim().to_string(), + }) + } + } + + /// The engine's executable name (`docker`, `container`), for rendering + /// copy-pasteable reproduce commands that name the same binary the CLI ran. + pub(crate) fn program(&self) -> &'static str { + self.engine().program() + } + + /// Resolve a locally-present image to its content-addressed repo digest + /// (`@sha256:`), so a caller can pin the exact bytes rather than a + /// mutable tag. Returns `Ok(None)` when the engine reports no digest (e.g. a + /// locally-built image that was never pushed or pulled). The per-engine + /// `inspect` argv and output parsing live on [`Engine`]; this owns only the + /// command execution (the engine binary and `--docker-host`). + pub(crate) async fn image_repo_digest(&self, image: &str) -> Result, Error> { + let engine = self.engine(); + let output = self + .base_command() + .args(engine.image_inspect_args(image)) + .output() + .await + .map_err(|e| self.io_error(e))?; + if !output.status.success() { + return Ok(None); + } + Ok(engine.parse_repo_digest(&output.stdout, image)) + } +} + +/// The repo portion of an image reference: everything before the `:tag` (or +/// `@digest`). A `:` only separates a tag when it appears after the last `/`, so +/// a registry host's `:port` (e.g. `localhost:5000/foo`) is preserved. +fn repo_of(image: &str) -> &str { + if let Some((repo, _)) = image.split_once('@') { + return repo; + } + let last_slash = image.rfind('/').map_or(0, |i| i + 1); + match image[last_slash..].find(':') { + Some(colon) => &image[..last_slash + colon], + None => image, + } } /// Resource limits for commands that *run* a container (e.g. `container start`). @@ -458,7 +604,7 @@ mod test { let not_found = std::io::Error::from(std::io::ErrorKind::NotFound); match args(None, Some(Engine::AppleContainer)).io_error(not_found) { Error::NotFound { program, .. } => assert_eq!(program, "container"), - Error::Command { .. } => panic!("expected NotFound, got Command"), + other => panic!("expected NotFound, got {other:?}"), } } @@ -487,6 +633,63 @@ mod test { assert!(!apple.is_container_not_found("some unrelated failure")); } + #[test] + fn program_matches_engine_binary() { + assert_eq!(args(None, None).program(), "docker"); + assert_eq!( + args(None, Some(Engine::AppleContainer)).program(), + "container" + ); + } + + #[test] + fn repo_of_strips_tag_but_keeps_registry_port() { + assert_eq!( + repo_of("docker.io/stellar/stellar-cli:26.1.0-rust1.90.0"), + "docker.io/stellar/stellar-cli" + ); + assert_eq!(repo_of("localhost:5000/foo:bar"), "localhost:5000/foo"); + assert_eq!(repo_of("localhost:5000/foo"), "localhost:5000/foo"); + // An already digest-pinned ref keeps its repo. + assert_eq!( + repo_of(&format!( + "docker.io/stellar/stellar-cli@sha256:{}", + "a".repeat(64) + )), + "docker.io/stellar/stellar-cli" + ); + } + + #[test] + fn apple_repo_digest_reads_manifest_list_descriptor() { + // Shape mirrors real `container image inspect` output: the top-level + // manifest-list digest lives at [0].configuration.descriptor.digest, + // while the per-platform digest under variants[] must be ignored. + let list = format!("sha256:{}", "8d".repeat(32)); + let variant = format!("sha256:{}", "85".repeat(32)); + let json = format!( + r#"[{{"configuration":{{"descriptor":{{"digest":"{list}","mediaType":"application/vnd.docker.distribution.manifest.list.v2+json","size":743}},"name":"docker.io/stellar/quickstart:latest"}},"id":"8ddf","variants":[{{"digest":"{variant}","platform":{{"architecture":"arm64","os":"linux"}}}}]}}]"# + ); + assert_eq!( + Engine::AppleContainer + .parse_repo_digest(json.as_bytes(), "docker.io/stellar/quickstart:latest"), + Some(format!("docker.io/stellar/quickstart@{list}")) + ); + } + + #[test] + fn docker_parse_repo_digest_trims_and_rejects_no_value() { + assert_eq!( + Engine::Docker.parse_repo_digest(b" docker.io/stellar/cli@sha256:abc\n", "ignored"), + Some("docker.io/stellar/cli@sha256:abc".to_string()) + ); + assert_eq!( + Engine::Docker.parse_repo_digest(b"\n", "ignored"), + None + ); + assert_eq!(Engine::Docker.parse_repo_digest(b" \n", "ignored"), None); + } + #[test] fn run_args_flags_emit_only_set_limits() { assert!(RunArgs::default().flags().is_empty()); @@ -507,4 +710,16 @@ mod test { ["--cpus", "2", "--memory", "2g"] ); } + + #[test] + fn apple_repo_digest_none_when_shape_unexpected() { + let apple = Engine::AppleContainer; + assert_eq!(apple.parse_repo_digest(b"[]", "foo:bar"), None); + assert_eq!(apple.parse_repo_digest(b"not json", "foo:bar"), None); + // Missing the configuration.descriptor.digest path. + assert_eq!( + apple.parse_repo_digest(br#"[{"id":"8ddf"}]"#, "foo:bar"), + None + ); + } } diff --git a/cmd/soroban-cli/src/commands/contract/archive.rs b/cmd/soroban-cli/src/commands/contract/archive.rs new file mode 100644 index 000000000..34248fb5f --- /dev/null +++ b/cmd/soroban-cli/src/commands/contract/archive.rs @@ -0,0 +1,115 @@ +use std::path::PathBuf; + +use clap::Parser; +use sha2::{Digest, Sha256}; + +use crate::{commands::global, print::Print}; + +use super::build::source_archive; + +/// Accepted `--out-file` suffixes (lower-case). The archive is always a gzipped +/// tarball, so the filename must say so. +const ARCHIVE_EXTENSIONS: &[&str] = &[".tar.gz", ".tgz"]; + +/// Generate (or inspect) the reproducible source archive for a contract. +/// +/// Produces the same gzipped tarball that `stellar contract build --verifiable` +/// builds from, and prints its SHA-256 (the SEP-58 `source_sha256`). Use +/// `--dry-run` to list exactly what would be archived without writing anything — +/// handy for confirming the contents before a verifiable build, or for +/// producing the archive to host at a `--source-uri`. +/// +/// The archive is the current working directory, honoring the project's +/// `.gitignore` and `.ignore` files (the `.git` directory itself is always +/// skipped). Run this from the project (or workspace) root you want archived. +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + /// Where to write the gzipped tarball. Required unless `--dry-run` is used. + #[arg(long, short = 'o', required_unless_present = "dry_run")] + pub out_file: Option, + + /// List the entries that would be archived and the computed source_sha256, + /// without writing any file. + #[arg(long)] + pub dry_run: bool, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + SourceArchive(#[from] source_archive::Error), + + #[error( + "--out-file {0} must end in .tar.gz or .tgz (the archive is always a gzipped tarball)" + )] + OutFileExtension(String), +} + +impl Cmd { + pub fn run(&self, global_args: &global::Args) -> Result<(), Error> { + let print = Print::new(global_args.quiet); + + let source_root = source_archive::resolve_source_root(); + + // The archive is the working tree, so a dirty repo would bake uncommitted + // changes into the bytes and the printed source_sha256 — refuse it, so the + // hash always corresponds to a committed state (matching --verifiable). + source_archive::ensure_clean_tree(&source_root, &print)?; + + // The dry-run listing itself reveals the contents, so skip the + // "not a git repository" warning there. + let bytes = source_archive::build_source_archive(&source_root, &print, !self.dry_run)?; + let sha = hex::encode(Sha256::digest(&bytes)); + + if self.dry_run { + let names = source_archive::entry_names(&bytes)?; + let prefix = print.compute_emoji("📄"); + + for name in &names { + println!("{prefix} {name}"); + } + print.infoln(format!("{} files", names.len())); + print.infoln(format!("source_sha256 {sha}")); + return Ok(()); + } + + // `--out-file` is required when not `--dry-run`, so this is always set here. + let out = self + .out_file + .as_ref() + .expect("--out-file is required without --dry-run"); + + // The output is always a gzipped tarball, so require a matching + // extension to keep the filename honest. + let name = out + .file_name() + .unwrap_or_default() + .to_string_lossy() + .to_ascii_lowercase(); + if !ARCHIVE_EXTENSIONS.iter().any(|ext| name.ends_with(ext)) { + return Err(Error::OutFileExtension(out.display().to_string())); + } + + if let Some(parent) = out.parent() { + if !parent.as_os_str().is_empty() { + std::fs::create_dir_all(parent).map_err(|source| { + source_archive::Error::ArchiveWrite { + path: out.clone(), + source, + } + })?; + } + } + std::fs::write(out, &bytes).map_err(|source| source_archive::Error::ArchiveWrite { + path: out.clone(), + source, + })?; + print.checkln(format!( + "Wrote source archive {} (source_sha256 {sha})", + out.display() + )); + + Ok(()) + } +} diff --git a/cmd/soroban-cli/src/commands/contract/build.rs b/cmd/soroban-cli/src/commands/contract/build.rs index ed3ce7e1b..b52bf057e 100644 --- a/cmd/soroban-cli/src/commands/contract/build.rs +++ b/cmd/soroban-cli/src/commands/contract/build.rs @@ -20,11 +20,17 @@ use stellar_xdr::{Limited, Limits, ScMetaEntry, ScMetaV0, StringM, WriteXdr}; #[cfg(feature = "additional-libs")] use crate::commands::contract::optimize; use crate::{ - commands::{global, version}, + commands::{ + container::shared::{Args as ContainerArgs, RunArgs as ContainerRunArgs}, + global, version, HEADING_CONTAINER, HEADING_VERIFIABLE, + }, print::Print, wasm, }; +pub(crate) mod source_archive; +pub mod verifiable; + /// A built WASM artifact with its package name and file path. #[derive(Debug, Clone)] pub struct BuiltContract { @@ -96,8 +102,52 @@ pub struct Cmd { #[arg(long, conflicts_with = "out_dir", help_heading = "Other")] pub print_commands_only: bool, + /// Build inside a trusted Docker container and record SEP-58 metadata + /// (`bldimg`, `source_uri`, `source_sha256`, `bldopt`) so the resulting + /// WASM can be reproduced and verified by third parties. Implies + /// `--locked`. Requires a clean git working tree. + #[arg(long, help_heading = HEADING_VERIFIABLE)] + pub verifiable: bool, + + /// Override the auto-selected container image used by `--verifiable`. + /// Must be digest-pinned, e.g. `docker.io/stellar/stellar-cli@sha256:...`. + /// Tag-only refs are rejected because SEP-58 requires content addressing. + #[arg(long, requires = "verifiable", help_heading = HEADING_VERIFIABLE)] + pub image: Option, + + /// SEP-58 source identification: SHA-256 of the source archive + /// (recorded as the `source_sha256` meta entry). Optional with + /// `--verifiable`: the archive is always generated and its SHA-256 computed + /// for you. When supplied it's treated as a pin — the build fails if it + /// doesn't match the generated archive. + #[arg(long, requires = "verifiable", help_heading = HEADING_VERIFIABLE)] + pub source_sha256: Option, + + /// SEP-58 source identification: URI where the source can be obtained, e.g. + /// `https://example.com/src.tar.gz` (recorded as the `source_uri` meta + /// entry). Optional; when set it must accompany `--source-sha256`. + #[arg( + long, + requires = "verifiable", + requires = "source_sha256", + help_heading = HEADING_VERIFIABLE + )] + pub source_uri: Option, + #[command(flatten)] pub build_args: BuildArgs, + + // Declared last so their `next_help_heading` groups them under the Container + // heading without leaking it onto the ungrouped `build_args` flags above. + /// Container connection options (`--engine`, `--docker-host`) used by + /// `--verifiable`. `--docker-host` is honored only by the docker engine. + #[command(flatten, next_help_heading = HEADING_CONTAINER)] + pub container_args: ContainerArgs, + + /// Container resource limits (`--cpus`, `--memory`) applied to the + /// `--verifiable` build container. + #[command(flatten, next_help_heading = HEADING_CONTAINER)] + pub run_args: ContainerRunArgs, } /// Shared build options for meta and optimization, reused by deploy and upload. @@ -107,6 +157,18 @@ pub struct BuildArgs { #[arg(long, num_args=1, value_parser=parse_meta_arg, action=clap::ArgAction::Append, help_heading = "Metadata")] pub meta: Vec<(String, String)>, + /// Set an environment variable for the build (repeatable), e.g. + /// `--env NAME=VALUE`. It's set on the build process; for a verifiable build + /// it's passed to the container and recorded as a `bldopt`, so avoid secrets + /// there. + #[arg( + long = "env", + num_args = 1, + value_parser = parse_env_arg, + action = clap::ArgAction::Append + )] + pub env: Vec<(String, String)>, + /// Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature. #[arg( long, @@ -124,6 +186,7 @@ impl Default for BuildArgs { fn default() -> Self { Self { meta: Vec::new(), + env: Vec::new(), optimize: true, } } @@ -140,6 +203,35 @@ pub fn parse_meta_arg(s: &str) -> Result<(String, String), Error> { Ok((key.to_string(), value.to_string())) } +/// Parse a `--env NAME=VALUE` argument. The name must be a valid environment +/// variable name (`[A-Za-z_][A-Za-z0-9_]*`, no surrounding whitespace); the +/// value is kept verbatim, since the shell has already resolved any quoting and +/// env values can carry significant whitespace. +pub fn parse_env_arg(s: &str) -> Result<(String, String), Error> { + let (name, value) = s + .split_once('=') + .ok_or_else(|| Error::EnvArg(format!("{s:?} must be in the form 'NAME=VALUE'")))?; + + if !is_valid_env_name(name) { + return Err(Error::EnvArg(format!( + "{name:?} is not a valid environment variable name (expected [A-Za-z_][A-Za-z0-9_]*)" + ))); + } + + Ok((name.to_string(), value.to_string())) +} + +/// Whether `name` is a valid environment variable name: a leading letter or +/// underscore followed by letters, digits, or underscores. +fn is_valid_env_name(name: &str) -> bool { + let mut chars = name.chars(); + match chars.next() { + Some(c) if c.is_ascii_alphabetic() || c == '_' => {} + _ => return false, + } + chars.all(|c| c.is_ascii_alphanumeric() || c == '_') +} + #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] @@ -181,6 +273,9 @@ pub enum Error { #[error("invalid meta entry: {0}")] MetaArg(String), + #[error("invalid env entry: {0}")] + EnvArg(String), + #[error( "use a rust version other than 1.81, 1.82, 1.83 or 1.91.0 to build contracts (got {0})" )] @@ -204,6 +299,9 @@ pub enum Error { #[error("wasm parsing error: {0}")] WasmParsing(String), + + #[error(transparent)] + Verifiable(#[from] verifiable::Error), } const WASM_TARGET: &str = "wasm32v1-none"; @@ -222,6 +320,12 @@ impl Default for Cmd { out_dir: None, locked: false, print_commands_only: false, + verifiable: false, + image: None, + source_sha256: None, + source_uri: None, + container_args: ContainerArgs::default(), + run_args: ContainerRunArgs::default(), build_args: BuildArgs::default(), } } @@ -230,8 +334,13 @@ impl Default for Cmd { impl Cmd { /// Builds the project and returns the built WASM artifacts. #[allow(clippy::too_many_lines)] - pub fn run(&self, global_args: &global::Args) -> Result, Error> { + pub async fn run(&self, global_args: &global::Args) -> Result, Error> { let print = Print::new(global_args.quiet); + + if self.verifiable { + return verifiable::run(self, global_args, &print).await; + } + let working_dir = env::current_dir().map_err(Error::GettingCurrentDir)?; let metadata = self.metadata()?; let packages = self.packages(&metadata)?; @@ -296,6 +405,11 @@ impl Cmd { // optimization using markers. cmd.env("SOROBAN_SDK_BUILD_SYSTEM_SUPPORTS_SPEC_SHAKING_V2", "1"); + // User-supplied build env vars (--env NAME=VALUE). + for (name, value) in &self.build_args.env { + cmd.env(name, value); + } + let cmd_str = serialize_command(&cmd); if self.print_commands_only { @@ -546,10 +660,7 @@ impl Cmd { &wasm_bytes }; - print.blankln(format!( - "Wasm File: {path} ({size_description})", - path = rel_path.display() - )); + print.blankln(format!("Wasm File: {path}", path = rel_path.display())); print.blankln(format!("Wasm Hash: {}", hex::encode(Sha256::digest(bytes)))); print.blankln(format!("Wasm Size: {size_description}")); @@ -862,4 +973,49 @@ mod tests { "shlex round-trip failed: {raw_arg:?} not found as a single token in {tokens:?}" ); } + + #[test] + fn parse_env_arg_parses_name_value() { + assert_eq!( + parse_env_arg("FOO=bar").unwrap(), + ("FOO".to_string(), "bar".to_string()) + ); + assert_eq!( + parse_env_arg("_FOO_BAR2=bar").unwrap(), + ("_FOO_BAR2".to_string(), "bar".to_string()) + ); + // Only the first `=` splits; the value keeps the rest verbatim. + assert_eq!( + parse_env_arg("FOO=a=b=c").unwrap(), + ("FOO".to_string(), "a=b=c".to_string()) + ); + // An empty value is allowed. + assert_eq!( + parse_env_arg("FOO=").unwrap(), + ("FOO".to_string(), String::new()) + ); + // The value is kept verbatim (the shell already handled quoting), so + // significant whitespace survives. + assert_eq!( + parse_env_arg("FOO= 1 ").unwrap(), + ("FOO".to_string(), " 1 ".to_string()) + ); + } + + #[test] + fn parse_env_arg_rejects_invalid() { + for bad in [ + "FOO", // no `=` + "=bar", // empty name + " FOO = 1 ", // whitespace in name + "1FOO=x", // leading digit + "FO-O=x", // invalid char + "FOO BAR=x", // space in name + ] { + assert!( + matches!(parse_env_arg(bad).unwrap_err(), Error::EnvArg(_)), + "expected {bad:?} to be rejected" + ); + } + } } diff --git a/cmd/soroban-cli/src/commands/contract/build/source_archive.rs b/cmd/soroban-cli/src/commands/contract/build/source_archive.rs new file mode 100644 index 000000000..b266cc81c --- /dev/null +++ b/cmd/soroban-cli/src/commands/contract/build/source_archive.rs @@ -0,0 +1,473 @@ +//! Reproducible source-archive generation for verifiable builds. +//! +//! Produces a gzipped tarball of a contract's source tree, rooted under a +//! top-level `source/` prefix (so it extracts to a `source/` dir, mirroring the +//! container's `/source` mount). The working directory is walked and tarred, +//! honoring the project's own `.gitignore`/`.ignore` files (the `.git` directory +//! itself is always skipped). The output is byte-reproducible, so the same tree +//! always hashes to the same `source_sha256`. +//! +//! Shared by `contract build --verifiable` (which builds from the extracted +//! archive) and the standalone `contract archive` command (which generates and +//! inspects it). + +use std::{ + io::Write, + path::{Path, PathBuf}, + process::Command, +}; + +use ignore::WalkBuilder; + +use crate::print::Print; + +/// Names that usually shouldn't end up in a source archive — VCS metadata of +/// other systems, secrets/local env, build/cache/transient dirs, and editor/OS/ +/// AI-assistant junk. These don't *exclude* anything (selection is driven +/// entirely by `.gitignore`/`.ignore`); instead, if any of them slip into the +/// archive because the project didn't ignore them, we warn the user so they can +/// add an ignore rule. Matched against each path component. +pub(crate) const ARCHIVE_WARN_LIST: &[&str] = &[ + // version control (other systems) + ".svn", + ".hg", + // secrets / local environment + ".env", + // build output / dependencies + "target", + "node_modules", + // transient + "log", + "logs", + "tmp", + "temp", + // OS / editor junk + ".DS_Store", + "Thumbs.db", + ".idea", + ".vscode", + // AI assistant dirs + ".claude", + ".cursor", + ".windsurf", + ".aider", +]; + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error("could not read git state at {path}: {source}")] + GitInvoke { + path: PathBuf, + source: std::io::Error, + }, + + #[error( + "refusing to archive a dirty git working tree at {path}; commit or stash your changes and try again." + )] + GitDirty { path: PathBuf }, + + #[error("could not write source archive to {path}: {source}")] + ArchiveWrite { + path: PathBuf, + source: std::io::Error, + }, + + #[error("could not extract source archive: {0}")] + ArchiveExtract(std::io::Error), +} + +/// The source tree's root: always the current working directory. The archive is +/// rooted there as-is — we do NOT search upward for a git repository or anchor on +/// `--manifest-path`'s directory, since for a workspace member the build needs +/// the whole workspace (its root `Cargo.toml`/`Cargo.lock`), which lives at the +/// cwd, not the member's directory. So run `contract archive`/`build +/// --verifiable` from the project (or workspace) root you want archived; +/// `--manifest-path`, when given, is interpreted relative to it. +pub(crate) fn resolve_source_root() -> PathBuf { + std::env::current_dir().unwrap_or_else(|_| PathBuf::from(".")) +} + +/// Warn about and reject a dirty git working tree. Both `contract archive` and +/// `build --verifiable` archive the working tree as-is, so uncommitted changes +/// would be baked into the recorded `source_sha256`; refuse them (after +/// explaining why) so an archive always corresponds to a committed state. A +/// no-op when `source_root` isn't a git repo (we can't check, e.g. archive +/// sources) — the user owns the bytes they produce there. +pub(crate) fn ensure_clean_tree(source_root: &Path, print: &Print) -> Result<(), Error> { + if tree_is_dirty(source_root)? { + print.warnln(format!( + "git working tree at {} is dirty; the archive would include uncommitted changes.", + source_root.display(), + )); + return Err(Error::GitDirty { + path: source_root.to_path_buf(), + }); + } + Ok(()) +} + +/// Whether `source_root` is a git work tree with uncommitted changes. Returns +/// `Ok(false)` when it isn't a git repo (git ran but refused) — callers can't +/// verify cleanliness there, so they proceed. Errors only when git can't be +/// invoked at all. +fn tree_is_dirty(source_root: &Path) -> Result { + let status = Command::new("git") + .arg("-C") + .arg(source_root) + .arg("status") + .arg("--porcelain") + .output() + .map_err(|source| Error::GitInvoke { + path: source_root.to_path_buf(), + source, + })?; + + // Not a git repo (or git refused): can't verify cleanliness, proceed. + if !status.status.success() { + return Ok(false); + } + + Ok(!status.stdout.is_empty()) +} + +/// Produce the gzipped source tarball bytes. The working directory under +/// `source_root` is walked and tarred, honoring the project's `.gitignore`/ +/// `.ignore` files; entries are rooted under a top-level `source/` prefix. +/// +/// `warn` controls whether to warn about archived paths that usually shouldn't +/// be shipped (see `ARCHIVE_WARN_LIST`). Callers that only inspect the result +/// (e.g. `contract archive --dry-run`) pass `false`, since the listing itself +/// reveals the contents. +pub(crate) fn build_source_archive( + source_root: &Path, + print: &Print, + warn: bool, +) -> Result, Error> { + let tar = walk_tar(source_root, print, warn)?; + gzip(&tar) +} + +/// Tar entry paths inside the gzipped archive bytes, in archive order. Used by +/// `contract archive --dry-run` to list exactly what the bytes that hash to +/// `source_sha256` contain. +pub(crate) fn entry_names(bytes: &[u8]) -> Result, Error> { + let dec = flate2::read::GzDecoder::new(bytes); + let mut archive = tar::Archive::new(dec); + let mut names = Vec::new(); + for entry in archive.entries().map_err(Error::ArchiveExtract)? { + let entry = entry.map_err(Error::ArchiveExtract)?; + let path = entry.path().map_err(Error::ArchiveExtract)?; + names.push(path.to_string_lossy().into_owned()); + } + Ok(names) +} + +/// Tar the working tree under `source_root`, honoring the project's `.gitignore`/ +/// `.ignore` files and always skipping the `.git` directory. Each entry is +/// prefixed with `source/`. When `warn` is set, archived paths matching +/// `ARCHIVE_WARN_LIST` (e.g. `.env`, `target/`) trigger a warning so the user can +/// add an ignore rule. +/// +/// Selection depends only on the in-tree files plus the `.gitignore`/`.ignore` +/// files inside the archived tree — never on machine-specific state (the global +/// gitignore, `.git/info/exclude`, or ignore files in parent directories are not +/// consulted) — so the archive stays byte-reproducible across machines. +/// +/// The output is reproducible, following GNU tar's reproducibility guidance +/// () +/// with the portable equivalents available via the `tar` crate (the system +/// `tar` can't be relied on — macOS ships bsdtar, which lacks `--sort`, +/// `--mtime`, `--pax-option`, …): entries are sorted by name (`--sort=name`) +/// using locale-independent path ordering (`LC_ALL=C`), and `HeaderMode::Deterministic` +/// zeroes mtime (`--mtime`/`--clamp-mtime`), sets uid/gid to 0 with empty owner +/// names (`--owner=0 --group=0 --numeric-owner`), and normalizes mode +/// (`--mode=go+u,go-w`). ustar headers carry no atime/ctime or tar PID. The gzip +/// wrapper (see `gzip`) is likewise deterministic. +fn walk_tar(source_root: &Path, print: &Print, warn: bool) -> Result, Error> { + let walk = WalkBuilder::new(source_root) + .hidden(false) // include dotfiles; let .gitignore decide + .git_ignore(true) // honor in-tree .gitignore + .ignore(true) // honor .ignore + .git_global(false) // not the machine's global gitignore (not reproducible) + .git_exclude(false) // not .git/info/exclude (not in the archive) + .require_git(false) // apply .gitignore/.ignore even without a .git dir + .parents(false) // only ignore files inside the archived tree + .filter_entry(|e| e.file_name() != ".git") // never archive VCS internals + .build(); + + let mut files: Vec = Vec::new(); + for entry in walk { + let entry = entry.map_err(|source| Error::ArchiveWrite { + path: source_root.to_path_buf(), + source: std::io::Error::other(source), + })?; + if entry.file_type().is_some_and(|t| t.is_file()) { + files.push(entry.path().to_path_buf()); + } + } + files.sort(); + + if warn { + warn_unexpected_paths(&files, source_root, print); + } + + let mut builder = tar::Builder::new(Vec::new()); + builder.mode(tar::HeaderMode::Deterministic); + for path in &files { + let rel = path.strip_prefix(source_root).unwrap_or(path); + let name = Path::new("source").join(rel); + let mut f = std::fs::File::open(path).map_err(|source| Error::ArchiveWrite { + path: path.clone(), + source, + })?; + builder + .append_file(&name, &mut f) + .map_err(|source| Error::ArchiveWrite { + path: path.clone(), + source, + })?; + } + builder.into_inner().map_err(|source| Error::ArchiveWrite { + path: source_root.to_path_buf(), + source, + }) +} + +/// Whether a path component matches the warn list: it equals an entry, or — for +/// dotted entries, which double as extension filters (e.g. `.swp`, `.log`) — it +/// ends with that entry. Plain names (`target`, `node_modules`) match exactly +/// only, so `mytarget` is not flagged. +fn is_warned(name: &std::ffi::OsStr) -> bool { + let name = name.to_string_lossy(); + ARCHIVE_WARN_LIST + .iter() + .any(|d| name == *d || (d.starts_with('.') && name.ends_with(d))) +} + +/// Warn about archived paths that usually shouldn't be shipped (secrets, build +/// output, editor/OS junk; see `ARCHIVE_WARN_LIST`). Selection is driven by +/// `.gitignore`/`.ignore`, so these slipped in only because the project didn't +/// ignore them — point that out so the user can add a rule. Reports the path up +/// to each matched component once (so a flagged directory is named once, not per +/// file under it), each on its own line since paths can be long. +fn warn_unexpected_paths(files: &[PathBuf], source_root: &Path, print: &Print) { + let mut hits: Vec = Vec::new(); + for path in files { + let rel = path.strip_prefix(source_root).unwrap_or(path); + let mut prefix = PathBuf::new(); + for comp in rel.components() { + prefix.push(comp); + if is_warned(comp.as_os_str()) { + let hit = prefix.to_string_lossy().into_owned(); + if !hits.contains(&hit) { + hits.push(hit); + } + break; + } + } + } + if hits.is_empty() { + return; + } + hits.sort(); + print.warnln( + "archive includes paths usually excluded; add them to .gitignore or .ignore if unintended:", + ); + for hit in &hits { + print.blankln(hit); + } +} + +/// Gzip with a default (mtime-zeroed) header so the same tar bytes always hash +/// the same. +fn gzip(bytes: &[u8]) -> Result, Error> { + let mut enc = flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::default()); + enc.write_all(bytes).map_err(|source| Error::ArchiveWrite { + path: PathBuf::new(), + source, + })?; + enc.finish().map_err(|source| Error::ArchiveWrite { + path: PathBuf::new(), + source, + }) +} + +/// Decompress gzip and unpack the tar into `dest`. Entries are `source/…`, so +/// they land at `/source/…`. +pub(crate) fn unpack_targz(bytes: &[u8], dest: &Path) -> Result<(), Error> { + let dec = flate2::read::GzDecoder::new(bytes); + tar::Archive::new(dec) + .unpack(dest) + .map_err(Error::ArchiveExtract) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::config::locator::enforce_hardened_tree; + use sha2::{Digest, Sha256}; + + #[test] + fn is_warned_matches_names_and_dotted_suffixes() { + use std::ffi::OsStr; + // exact name matches + assert!(is_warned(OsStr::new("target"))); + assert!(is_warned(OsStr::new(".env"))); + assert!(is_warned(OsStr::new(".DS_Store"))); + // plain names match exactly only + assert!(!is_warned(OsStr::new("mytarget"))); + assert!(!is_warned(OsStr::new("targets"))); + // dotted entries also match as suffix (extension-style) + assert!(is_warned(OsStr::new("backup.svn"))); + // `.git`/`.gitignore` are not warned: `.git` is skipped structurally and + // `.gitignore` is legitimately archived like any other tracked file. + assert!(!is_warned(OsStr::new(".git"))); + assert!(!is_warned(OsStr::new(".gitignore"))); + // unrelated files pass through + assert!(!is_warned(OsStr::new("Cargo.toml"))); + assert!(!is_warned(OsStr::new("lib.rs"))); + } + + // Initialize a git repo at `root` with one commit of everything present. + #[cfg(unix)] + fn git_init_commit(root: &Path) { + for args in [ + &["init", "-q", "-b", "main"][..], + &["add", "-A"][..], + &["commit", "-q", "-m", "init"][..], + ] { + let ok = Command::new("git") + .arg("-C") + .arg(root) + .args(args) + .env("GIT_AUTHOR_NAME", "T") + .env("GIT_AUTHOR_EMAIL", "t@e.x") + .env("GIT_COMMITTER_NAME", "T") + .env("GIT_COMMITTER_EMAIL", "t@e.x") + .status() + .unwrap() + .success(); + assert!(ok); + } + } + + #[test] + #[cfg(unix)] + fn build_source_archive_git_is_prefixed_and_deterministic() { + use std::os::unix::fs::PermissionsExt; + let print = Print::new(true); + let temp = tempfile::TempDir::new().unwrap(); + let root = temp.path(); + std::fs::write(root.join("Cargo.toml"), b"# crate").unwrap(); + std::fs::create_dir_all(root.join("src")).unwrap(); + std::fs::write(root.join("src/lib.rs"), b"// code").unwrap(); + git_init_commit(root); + + let a = build_source_archive(root, &print, true).unwrap(); + let b = build_source_archive(root, &print, true).unwrap(); + assert!(!a.is_empty()); + assert_eq!(a, b, "same tree should produce identical bytes"); + + // The `.git` dir git_init_commit created is never archived. + assert!(entry_names(&a) + .unwrap() + .iter() + .all(|n| !n.starts_with("source/.git/"))); + + let sha = hex::encode(Sha256::digest(&a)); + assert_eq!(sha.len(), 64); + + // The listing reflects exactly the archived entries. + let names = entry_names(&a).unwrap(); + assert!(names.iter().any(|n| n == "source/Cargo.toml")); + assert!(names.iter().any(|n| n == "source/src/lib.rs")); + + // Unpack and confirm the `source/` prefix + hardened perms. + let dest = tempfile::TempDir::new().unwrap(); + unpack_targz(&a, dest.path()).unwrap(); + assert!(dest.path().join("source/Cargo.toml").exists()); + assert!(dest.path().join("source/src/lib.rs").exists()); + + enforce_hardened_tree(dest.path()).unwrap(); + let file_mode = std::fs::metadata(dest.path().join("source/Cargo.toml")) + .unwrap() + .permissions() + .mode() + & 0o777; + let dir_mode = std::fs::metadata(dest.path().join("source")) + .unwrap() + .permissions() + .mode() + & 0o777; + assert_eq!(file_mode, 0o600); + assert_eq!(dir_mode, 0o700); + } + + #[test] + fn build_source_archive_skips_git_dir_and_is_reproducible() { + let print = Print::new(true); + let temp = tempfile::TempDir::new().unwrap(); + let root = temp.path(); + std::fs::write(root.join("Cargo.toml"), b"# crate").unwrap(); + std::fs::create_dir_all(root.join("src")).unwrap(); + std::fs::write(root.join("src/lib.rs"), b"// code").unwrap(); + // A `.git` dir is always skipped, even without a real repo. + std::fs::create_dir_all(root.join(".git")).unwrap(); + std::fs::write(root.join(".git/config"), b"junk").unwrap(); + // No `.gitignore`, so `target/` is NOT excluded — selection is driven by + // ignore files only. + std::fs::create_dir_all(root.join("target/debug")).unwrap(); + std::fs::write(root.join("target/debug/x"), b"junk").unwrap(); + + let bytes = build_source_archive(root, &print, true).unwrap(); + let dest = tempfile::TempDir::new().unwrap(); + unpack_targz(&bytes, dest.path()).unwrap(); + + assert!(dest.path().join("source/Cargo.toml").exists()); + assert!(dest.path().join("source/src/lib.rs").exists()); + assert!(!dest.path().join("source/.git").exists()); + // Un-ignored `target/` is included (and would have triggered a warning). + assert!(dest.path().join("source/target/debug/x").exists()); + assert_eq!(hex::encode(Sha256::digest(&bytes)).len(), 64); + + // Reproducible: a second run over the same tree yields identical bytes + // (sorted entries + zeroed header fields + deterministic gzip). + let again = build_source_archive(root, &print, true).unwrap(); + assert_eq!(bytes, again); + } + + #[test] + fn build_source_archive_respects_gitignore_and_dot_ignore() { + let print = Print::new(true); + let temp = tempfile::TempDir::new().unwrap(); + let root = temp.path(); + std::fs::write(root.join("Cargo.toml"), b"# crate").unwrap(); + std::fs::create_dir_all(root.join("src")).unwrap(); + std::fs::write(root.join("src/lib.rs"), b"// code").unwrap(); + // `.gitignore` and `.ignore` are honored even without a git repo. + std::fs::write(root.join(".gitignore"), b"target/\n").unwrap(); + std::fs::write(root.join(".ignore"), b"secret.txt\n").unwrap(); + std::fs::create_dir_all(root.join("target/debug")).unwrap(); + std::fs::write(root.join("target/debug/x"), b"junk").unwrap(); + std::fs::write(root.join("secret.txt"), b"shh").unwrap(); + + let bytes = build_source_archive(root, &print, true).unwrap(); + let dest = tempfile::TempDir::new().unwrap(); + unpack_targz(&bytes, dest.path()).unwrap(); + + assert!(dest.path().join("source/Cargo.toml").exists()); + assert!(dest.path().join("source/src/lib.rs").exists()); + // Excluded by the in-tree ignore files. + assert!(!dest.path().join("source/target").exists()); + assert!(!dest.path().join("source/secret.txt").exists()); + // The ignore files themselves are archived like any other tracked file. + assert!(dest.path().join("source/.gitignore").exists()); + } + + #[test] + fn resolve_source_root_is_cwd() { + // The root is always the current working directory — no upward search, + // no manifest anchoring. + assert_eq!(resolve_source_root(), std::env::current_dir().unwrap()); + } +} diff --git a/cmd/soroban-cli/src/commands/contract/build/verifiable.rs b/cmd/soroban-cli/src/commands/contract/build/verifiable.rs new file mode 100644 index 000000000..9baea2cdf --- /dev/null +++ b/cmd/soroban-cli/src/commands/contract/build/verifiable.rs @@ -0,0 +1,1473 @@ +use std::path::{Path, PathBuf}; +use std::process::Stdio; + +use cargo_metadata::MetadataCommand; +use regex::Regex; +use semver::Version; +use serde::Deserialize; +use sha2::{Digest, Sha256}; + +use crate::{ + commands::{ + container::shared::{self, Error as ConnectionError}, + global, + }, + config::{data, locator::enforce_hardened_tree}, + print::Print, +}; + +use super::{source_archive, BuiltContract, Cmd, WASM_TARGET}; + +const REGISTRY: &str = "docker.io/stellar/stellar-cli"; +const HUB_TAGS_URL: &str = + "https://hub.docker.com/v2/repositories/stellar/stellar-cli/tags/?page_size=100"; +const RESERVED_META_KEYS: &[&str] = &["bldimg", "source_uri", "source_sha256", "bldopt"]; + +/// First cli release that accepts `--optimize=false` as an explicit value +/// (added by commit `b17d3f0b`). Containers older than this only accept bare +/// `--optimize`; we probe the container's `stellar version --only-version` to +/// pick the right syntax for `--optimize=false`. +const OPTIMIZE_NEW_SYNTAX_MIN: &str = "26.1.0"; + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + DockerConnection(#[from] ConnectionError), + + #[error("--image value {value:?} does not match the SEP-58 bldimg format `/@sha256:<64-hex>`. Examples: docker.io/stellar/stellar-cli@sha256:<64-hex>, localhost:5000/foo@sha256:<64-hex>. Tag-only refs and implicit Docker-Hub short refs are not accepted.")] + BldimgFormat { value: String }, + + #[error("could not determine the running rustc version: {0}")] + RustcVersion(String), + + #[error("could not pull image {tag}: {detail}\n\nAvailable tags for this CLI version: {available_for_cli}\nAll published cli/rust pairs: {all_grouped}\n\nFix: install a matching rustc, or pass --image docker.io/stellar/stellar-cli@sha256: with one of the listed tags resolved to a digest.")] + ImageNotFound { + tag: String, + available_for_cli: String, + all_grouped: String, + detail: String, + }, + + #[error("could not list published images on docker hub: {0}")] + TagListUnavailable(String), + + #[error("image {tag} has no repo digest after pull; cannot record a content-addressed bldimg")] + NoRepoDigest { tag: String }, + + #[error("cargo metadata failed: {0}")] + Metadata(#[from] cargo_metadata::Error), + + #[error(transparent)] + SourceArchive(#[from] source_archive::Error), + + #[error( + "the cli sets bldimg, source_uri, source_sha256, and bldopt automatically when --verifiable is used; remove them from --meta. Got reserved key: {key}" + )] + ReservedMetaKey { key: String }, + + #[error("--source-sha256 value {value:?} does not match the SEP-58 source_sha256 format `^[0-9a-f]{{64}}$` (64-char lower-case hex).")] + SourceSha256Format { value: String }, + + #[error("--source-uri value {value:?} does not match the SEP-58 source_uri format `^[a-zA-Z][a-zA-Z0-9+.-]*:\\S+$` (a URI with a scheme, e.g. https://example.com/src.tar.gz).")] + SourceUriFormat { value: String }, + + #[error("--source-sha256 {provided} does not match the SHA-256 of the generated archive {computed}. Omit --source-sha256 to record the computed value, or fix the value.")] + SourceSha256Mismatch { provided: String, computed: String }, + + #[error(transparent)] + Data(#[from] data::Error), + + #[error("container build exited with status {status}. To reproduce manually:\n {command}")] + ContainerExit { status: i64, command: String }, + + #[error("verifiable build interrupted; stopped the build container")] + Interrupted, +} + +pub async fn run( + cmd: &Cmd, + global_args: &global::Args, + print: &Print, +) -> Result, super::Error> { + // Stage 1: pure validation, no I/O. + for (k, _) in &cmd.build_args.meta { + if RESERVED_META_KEYS.iter().any(|r| r == k) { + return Err(Error::ReservedMetaKey { key: k.clone() }.into()); + } + } + if let Some(img) = &cmd.image { + if !bldimg_regex().is_match(img) { + return Err(Error::BldimgFormat { value: img.clone() }.into()); + } + } + + // Stage 2: local filesystem + git, no network. + let workspace_root = resolve_workspace_root(cmd)?; + validate_source_formats(cmd)?; + + // The source root is the current working directory: it's bind-mounted into + // the container and the `--manifest-path` bldopt is relativized against it. + // Run from the project/workspace root you want built. We do NOT validate that + // it matches source_uri — a wrong source produces different bytes, and verify + // catches that at byte-comparison time. + let source_root = source_archive::resolve_source_root(); + + // The archive is the working tree, so refuse a dirty repo: a verifiable build + // should be deliberate, off a committed state, not whatever happens to be on + // disk. Skipped when the source root isn't a git repo (we can't check, e.g. + // archive sources). + source_archive::ensure_clean_tree(&source_root, print).map_err(Error::from)?; + + // Always build the source archive, record its hash, and build from the + // *extracted* archive (in a hardened tempdir) so the WASM is produced from + // exactly the bytes that were hashed. A `--source-sha256` passed by the user + // is treated as a pin and validated against the computed hash. + let resolved = { + let a = resolve_archive(cmd, &source_root, print)?; + // The extracted `source/` dir mirrors `source_root` exactly and is both + // the container mount and the tree the build writes `target/` into, so + // it's what `collect_built_contracts` resolves artifacts against. + let mount_root = a.extracted_root.join("source"); + ResolvedSource { + source_sha256: a.source_sha256, + extracted_root: Some(mount_root.clone()), + mount_root, + _tmp: Some(a.tmp), + } + }; + + let source_ids = SourceIds { + source_uri: cmd.source_uri.clone(), + source_sha256: Some(resolved.source_sha256.clone()), + }; + + // Stage 3: the container engine. Every interaction shells out through these + // `container_args`, which select the engine binary (`--engine`/ + // `STELLAR_CONTAINER_ENGINE`, default docker) and honor `--docker-host` where + // the engine supports it; `run_args` carries the build container's resource + // limits. + let docker = cmd.container_args.clone(); + docker.warn_if_host_ignored(print); + let image_ref = resolve_image(cmd, &docker, print).await?; + + // Only probe the container's cli version when we need to pick between + // `--optimize=false` (new syntax) and not-forwarded-at-all (old default). + // Bare `--optimize` is universally accepted, so the true path skips this. + let supports_explicit_optimize_false = if cmd.build_args.optimize { + true + } else { + probe_supports_optimize_false_syntax(&image_ref, &docker, print).await + }; + + // `--locked` is implied by `--verifiable`, but it was only added to + // `contract build` in cli 25.2.0. Probe the image before adding it so a + // build against an older, still-valid bldimg doesn't fail on an unknown + // flag. When the flag is unavailable we drop it and warn that the rebuild + // can't be pinned against dependency drift. + let supports_locked = probe_supports_locked(&image_ref, &docker, print).await; + if supports_locked { + if !cmd.locked { + print.infoln("Implying --locked because --verifiable was passed"); + } + } else { + print.warnln( + "The build image's `contract build` does not support --locked; \ + building without it. Dependency drift may affect reproducibility.", + ); + } + + // Build once per package, each with its own `--package` forwarded and + // recorded as a `bldopt`, so every WASM is independently reproducible. With + // no explicit `--package` the targets are inferred like a regular build. + let packages = resolve_build_packages(cmd)?; + if cmd.package.is_none() && !packages.is_empty() { + print.infoln(format!("Inferred packages: {}", packages.join(", "))); + } + let targets: Vec> = if packages.is_empty() { + vec![None] + } else { + packages.iter().map(|p| Some(p.as_str())).collect() + }; + let container_cmds: Vec> = targets + .iter() + .map(|target| { + let (forwarded_args, bldopts) = build_forwarded_args( + cmd, + &source_root, + *target, + supports_explicit_optimize_false, + supports_locked, + ); + let metadata_args = build_metadata_args(&image_ref, &source_ids, &bldopts); + compose_container_args(&forwarded_args, &metadata_args) + }) + .collect(); + + // Always stream the container's cargo output during `contract build + // --verifiable`, matching how a non-verifiable `contract build` shows + // cargo output by default. The verify-side caller gates this on + // `--verbose` because verifications are run as part of pipelines. All + // per-package builds run in one container so the crates download, compiled + // deps, and target/ are shared. + let env: Vec = cmd + .build_args + .env + .iter() + .map(|(name, value)| format!("{name}={value}")) + .collect(); + + run_in_container( + &image_ref, + &resolved.mount_root, + &container_cmds, + &env, + &docker, + &cmd.run_args, + print, + true, + ) + .await?; + + let _ = global_args; + let _ = workspace_root; + collect_built_contracts(cmd, &source_root, resolved.extracted_root.as_deref(), print) +} + +/// The recorded `source_sha256`, the directory bind-mounted at `/source`, the +/// extracted-archive root, and its tempdir guard — held so the temp dir +/// outlives the container build and artifact collection. +struct ResolvedSource { + source_sha256: String, + mount_root: PathBuf, + extracted_root: Option, + _tmp: Option, +} + +fn resolve_workspace_root(cmd: &Cmd) -> Result { + let mut mc = MetadataCommand::new(); + mc.no_deps(); + if let Some(p) = &cmd.manifest_path { + mc.manifest_path(p); + } + let md = mc.exec()?; + Ok(md.workspace_root.into_std_path_buf()) +} + +/// Source-identification fields recorded as SEP-58 meta. `source_sha256` is +/// always `Some` by the time these are built in `run()` (resolved from +/// `--source-sha256` or computed from the generated archive). `source_uri` is +/// `Some` only when the user passed `--source-uri`. +#[derive(Debug, Default, Clone)] +struct SourceIds { + source_uri: Option, + source_sha256: Option, +} + +/// Format-validate the user-supplied source flags. Both are optional under +/// `--verifiable`; `--source-sha256`, when present, is validated as a pin in +/// `resolve_archive`. +fn validate_source_formats(cmd: &Cmd) -> Result<(), Error> { + if let Some(sha) = &cmd.source_sha256 { + if !source_sha256_regex().is_match(sha) { + return Err(Error::SourceSha256Format { value: sha.clone() }); + } + } + if let Some(uri) = &cmd.source_uri { + if !source_uri_regex().is_match(uri) { + return Err(Error::SourceUriFormat { value: uri.clone() }); + } + } + Ok(()) +} + +/// Outcome of archiving: the generated archive's SHA-256 and the directory it +/// was extracted into (held alive by `tmp`). +struct ArchiveResult { + source_sha256: String, + extracted_root: PathBuf, + tmp: tempfile::TempDir, +} + +/// Build the source archive, record its hash, write it to the managed archives +/// dir (content-addressed, so the bytes are available to upload for +/// `--source-uri`), and extract it into a permission-hardened tempdir that the +/// container then builds from. +fn resolve_archive(cmd: &Cmd, source_root: &Path, print: &Print) -> Result { + let bytes = source_archive::build_source_archive(source_root, print, true)?; + let computed = hex::encode(Sha256::digest(&bytes)); + + // If the user pinned a hash, it must match what we produced. + if let Some(provided) = &cmd.source_sha256 { + if provided != &computed { + return Err(Error::SourceSha256Mismatch { + provided: provided.clone(), + computed, + }); + } + } + + // Content-addressed name under the managed archives dir. + let out_path = data::archives_dir()?.join(format!("{computed}.tar.gz")); + if let Some(parent) = out_path.parent() { + std::fs::create_dir_all(parent).map_err(|source| source_archive::Error::ArchiveWrite { + path: out_path.clone(), + source, + })?; + } + std::fs::write(&out_path, &bytes).map_err(|source| source_archive::Error::ArchiveWrite { + path: out_path.clone(), + source, + })?; + print.infoln(format!( + "Wrote source archive {} (source_sha256 {computed})", + out_path.display() + )); + + // Extract and harden, then build from the extracted copy so the WASM is + // produced from exactly the archived bytes. + // + // Extract under the data dir, NOT the OS temp dir: on macOS `$TMPDIR` lives + // under /var/folders, which container VMs (Docker Desktop, Colima, …) don't + // share by default, so a bind mount of it would be empty inside the + // container. The data dir lives under the user's home, which is shared. + let base = data::data_local_dir()?; + std::fs::create_dir_all(&base).map_err(|source| source_archive::Error::ArchiveWrite { + path: base.clone(), + source, + })?; + let tmp = tempfile::Builder::new() + .prefix("verifiable-src-") + .tempdir_in(&base) + .map_err(source_archive::Error::ArchiveExtract)?; + source_archive::unpack_targz(&bytes, tmp.path())?; + enforce_hardened_tree(tmp.path()).map_err(source_archive::Error::ArchiveExtract)?; + + let extracted_root = tmp.path().to_path_buf(); + Ok(ArchiveResult { + source_sha256: computed, + extracted_root, + tmp, + }) +} + +fn bldimg_regex() -> Regex { + Regex::new(r"^(?:localhost(?::\d+)?|[^\s@/]*[.:][^\s@/]*)/[^\s@]+@sha256:[0-9a-f]{64}$") + .unwrap() +} + +fn source_sha256_regex() -> Regex { + Regex::new(r"^[0-9a-f]{64}$").unwrap() +} + +fn source_uri_regex() -> Regex { + Regex::new(r"^[a-zA-Z][a-zA-Z0-9+.-]*:\S+$").unwrap() +} + +/// Resolve every package the build will produce, so each can be pinned with its +/// own `--package` (and recorded as a `bldopt`) — making each WASM independently +/// reproducible even if the workspace's default members change later. An +/// explicit `--package` wins; otherwise infer the default-member cdylibs exactly +/// like a regular `stellar contract build` does. May be empty (no cdylib default +/// members), in which case the caller falls back to a single no-`--package` +/// build. +fn resolve_build_packages(cmd: &Cmd) -> Result, Error> { + if let Some(pkg) = &cmd.package { + return Ok(vec![pkg.clone()]); + } + let mut mc = MetadataCommand::new(); + mc.no_deps(); + if let Some(p) = &cmd.manifest_path { + mc.manifest_path(p); + } + let md = mc.exec().map_err(Error::Metadata)?; + let mut names: Vec = md + .packages + .iter() + .filter(|p| md.workspace_default_members.contains(&p.id)) + .filter(|p| { + p.targets + .iter() + .any(|t| t.crate_types.iter().any(|c| c == "cdylib")) + }) + .map(|p| p.name.clone()) + .collect(); + names.sort(); + names.dedup(); + Ok(names) +} + +/// The flags forwarded to the container's `stellar contract build`, plus the +/// bldopt strings recorded into SEP-58 metadata. Every build-affecting flag +/// becomes one bldopt entry so a verifier can replay the same invocation. +/// `manifest_path` (when set) is recorded relative to the workspace root so it's +/// valid inside `/source`. +/// +/// `supports_locked`: whether the container's `contract build` accepts +/// `--locked` (added in cli 25.2.0). When false the flag is neither forwarded +/// nor recorded, so a build against an older image doesn't fail on an unknown +/// argument. +/// +/// `supports_explicit_optimize_false`: whether the container's cli accepts +/// `--optimize=false`. When false, the optimize=false case records the flag +/// in bldopt but does not forward it (the older container's cli default of +/// `false` already produces the desired state). +fn build_forwarded_args( + cmd: &Cmd, + workspace_root: &Path, + package: Option<&str>, + supports_explicit_optimize_false: bool, + supports_locked: bool, +) -> (Vec, Vec) { + let mut forwarded: Vec = Vec::new(); + let mut bldopts: Vec = Vec::new(); + + // Record a build option. `None` means a bare flag (`--locked`); `Some(v)` + // means `--flag=v`. The forwarded copy keeps the value raw (the container + // gets it as argv, and `compose_shell_command` re-escapes it for the + // multi-package `sh -c`); the bldopt copy shell-escapes the value once, here + // at the source, so every recorded option is valid shell on its own and no + // consumer has to split a flag from its value later. For `key=value` + // payloads (`--meta`, `--env`) the key goes in `key` (`--meta=home_domain`) + // and only the value is escaped, keeping `--env=B='nice value'` rather than + // `'--env=B=nice value'`. + let mut record = |key: &str, value: Option<&str>| { + if let Some(v) = value { + forwarded.push(format!("{key}={v}")); + bldopts.push(format!("{key}={}", shell_escape::escape(v.into()))); + } else { + forwarded.push(key.to_string()); + bldopts.push(key.to_string()); + } + }; + + if supports_locked { + record("--locked", None); + } + + if let Some(path) = &cmd.manifest_path { + let abs = std::path::absolute(path).unwrap_or_else(|_| path.clone()); + let rel = abs + .strip_prefix(workspace_root) + .map(Path::to_path_buf) + .unwrap_or(abs); + record("--manifest-path", Some(rel.display().to_string().as_str())); + } + if cmd.profile != "release" { + record("--profile", Some(cmd.profile.as_str())); + } + if let Some(features) = &cmd.features { + record("--features", Some(features.as_str())); + } + if cmd.all_features { + record("--all-features", None); + } + if cmd.no_default_features { + record("--no-default-features", None); + } + // Always pin the package when it can be resolved (explicit `--package`, or + // a workspace that builds exactly one cdylib by default) so the recorded + // bldopt stays reproducible even if workspace default members change later. + if let Some(pkg) = package { + record("--package", Some(pkg)); + } + for (k, v) in &cmd.build_args.meta { + record(&format!("--meta={k}"), Some(v.as_str())); + } + + // `--optimize` true is recorded as a bare flag (universally accepted). + // `--optimize=false` is only emitted when the container's cli accepts it + // (added in `b17d3f0b`); on older containers, false is the default and + // we record/forward nothing — passing `--optimize=false` there would fail. + if cmd.build_args.optimize { + record("--optimize", None); + } else if supports_explicit_optimize_false { + record("--optimize", Some("false")); + } + + // Build env vars are applied via docker `-e` (see run_in_container), not as + // arguments to the inner `stellar contract build`, so they're recorded as + // bldopts only — never forwarded. A verifier replays them with `--env`. The + // value is escaped (the name is a validated identifier) so the recorded + // option stays valid shell. + for (name, value) in &cmd.build_args.env { + bldopts.push(format!( + "--env={name}={}", + shell_escape::escape(value.as_str().into()) + )); + } + + (forwarded, bldopts) +} + +fn build_metadata_args(image_ref: &str, ids: &SourceIds, bldopts: &[String]) -> Vec { + let mut out = Vec::new(); + + let push = |out: &mut Vec, key: &str, val: &str| { + out.push("--meta".to_string()); + out.push(format!("{key}={val}")); + }; + + push(&mut out, "bldimg", image_ref); + + if let Some(v) = &ids.source_uri { + push(&mut out, "source_uri", v); + } + if let Some(v) = &ids.source_sha256 { + push(&mut out, "source_sha256", v); + } + + // bldopts already arrive as valid shell (escaped at the source in + // `build_forwarded_args`), so they're recorded verbatim: a verifier + // reconstructs the build by joining the recorded values and running them + // through a shell. + for o in bldopts { + push(&mut out, "bldopt", o); + } + + out +} + +fn compose_container_args(forwarded: &[String], metadata: &[String]) -> Vec { + let mut args = vec!["contract".to_string(), "build".to_string()]; + args.extend_from_slice(forwarded); + args.extend_from_slice(metadata); + args +} + +pub async fn resolve_image( + cmd: &Cmd, + docker: &shared::Args, + print: &Print, +) -> Result { + if let Some(s) = &cmd.image { + if !bldimg_regex().is_match(s) { + return Err(Error::BldimgFormat { value: s.clone() }); + } + // Always pull, even when the digest is user-supplied. Docker requires + // the image to be locally present before `docker run` will accept it, + // and the user typically expects the cli to fetch whatever they asked + // for. + docker.pull_image(s, print).await?; + return Ok(s.clone()); + } + + let cli_v = env!("CARGO_PKG_VERSION"); + let rust_v = rustc_version::version() + .map_err(|e| Error::RustcVersion(e.to_string()))? + .to_string(); + let tag = format!("{REGISTRY}:{cli_v}-rust{rust_v}"); + + print.infoln(format!("Pulling verifiable build image {tag}")); + + match docker.pull_image(&tag, print).await { + Ok(()) => {} + // A failed pull of the derived cli/rust tag usually means no image was + // published for this pair; turn it into the tag-listing hint. A missing + // `docker` binary (or other connection failure) propagates as-is. + Err(ConnectionError::PullImageFailed { stderr, .. }) => { + let (available_for_cli, all_grouped) = match list_published_tags().await { + Ok(tags) => format_available(&tags, cli_v), + Err(list_err) => ( + "".to_string(), + format!(""), + ), + }; + return Err(Error::ImageNotFound { + tag, + available_for_cli, + all_grouped, + detail: stderr, + }); + } + Err(e) => return Err(Error::DockerConnection(e)), + } + + // Pin the mutable tag to the content-addressed digest the engine resolved, + // so the recorded `bldimg` names the exact bytes that were pulled. + docker + .image_repo_digest(&tag) + .await? + .ok_or(Error::NoRepoDigest { tag }) +} + +#[derive(Debug, Clone)] +pub struct PublishedTag { + pub cli: Version, + pub rust: Version, + pub raw: String, +} + +#[derive(Deserialize)] +struct HubPage { + results: Vec, + next: Option, +} + +#[derive(Deserialize)] +struct HubTag { + name: String, +} + +pub async fn list_published_tags() -> Result, Error> { + let re = Regex::new(r"^(\d+\.\d+\.\d+)-rust(\d+\.\d+\.\d+)$").unwrap(); + let mut out = Vec::new(); + let mut next = Some(HUB_TAGS_URL.to_string()); + let client = reqwest::Client::builder() + .user_agent("stellar-cli") + .build() + .map_err(|e| Error::TagListUnavailable(e.to_string()))?; + while let Some(url) = next { + let page: HubPage = client + .get(&url) + .send() + .await + .map_err(|e| Error::TagListUnavailable(e.to_string()))? + .error_for_status() + .map_err(|e| Error::TagListUnavailable(e.to_string()))? + .json() + .await + .map_err(|e| Error::TagListUnavailable(e.to_string()))?; + for t in page.results { + if let Some(c) = re.captures(&t.name) { + let cli = Version::parse(&c[1]); + let rust = Version::parse(&c[2]); + if let (Ok(cli), Ok(rust)) = (cli, rust) { + out.push(PublishedTag { + cli, + rust, + raw: t.name, + }); + } + } + } + next = page.next; + } + Ok(out) +} + +fn format_available(tags: &[PublishedTag], current_cli: &str) -> (String, String) { + let current = Version::parse(current_cli).ok(); + let mut for_this_cli: Vec<&PublishedTag> = tags + .iter() + .filter(|t| Some(&t.cli) == current.as_ref()) + .collect(); + for_this_cli.sort_by(|a, b| b.rust.cmp(&a.rust)); + let available_for_cli = if for_this_cli.is_empty() { + "".to_string() + } else { + for_this_cli + .iter() + .map(|t| t.raw.as_str()) + .collect::>() + .join(", ") + }; + + let mut by_cli: std::collections::BTreeMap> = + std::collections::BTreeMap::new(); + for t in tags { + by_cli + .entry(t.cli.to_string()) + .or_default() + .push(t.rust.to_string()); + } + let all_grouped = by_cli + .into_iter() + .map(|(cli, rusts)| format!("{cli}: [{}]", rusts.join(", "))) + .collect::>() + .join("; "); + + (available_for_cli, all_grouped) +} + +/// Probe the container's `stellar` binary for its self-reported version with +/// `stellar version --only-version`. Returns true if the parsed version is +/// at or above the cutoff where `--optimize=false` was accepted. On any +/// probe failure (network, unparseable output, missing subcommand), returns +/// false — the conservative assumption that the container is old. +async fn probe_supports_optimize_false_syntax( + image_ref: &str, + docker: &shared::Args, + print: &Print, +) -> bool { + match probe_cli_version(image_ref, docker).await { + Ok(v) => { + let cutoff = Version::parse(OPTIMIZE_NEW_SYNTAX_MIN).unwrap(); + v >= cutoff + } + Err(e) => { + print.warnln(format!( + "Could not probe container cli version ({e}); assuming pre-{OPTIMIZE_NEW_SYNTAX_MIN} syntax" + )); + false + } + } +} + +/// Run `cmd` in a throwaway `docker run --rm` container (optionally overriding +/// the entrypoint) and return its captured stdout. Only stdout is collected; +/// stderr and the exit status are ignored, matching how every probe treats a +/// missing subcommand or unexpected output as "unsupported". Shared by every +/// image probe (cli version, active toolchain, flag support). +async fn run_probe( + image_ref: &str, + docker: &shared::Args, + entrypoint: Option<&str>, + cmd: Vec, +) -> Result { + let mut command = docker.base_command(); + command.args(["run", "--rm"]); + if let Some(entrypoint) = entrypoint { + command.args(["--entrypoint", entrypoint]); + } + command.arg(image_ref); + command.args(&cmd); + + let output = command.output().await.map_err(|e| docker.io_error(e))?; + Ok(String::from_utf8_lossy(&output.stdout).into_owned()) +} + +async fn probe_cli_version(image_ref: &str, docker: &shared::Args) -> Result { + let stdout = run_probe( + image_ref, + docker, + None, + vec!["version".to_string(), "--only-version".to_string()], + ) + .await?; + Version::parse(stdout.trim()) + .map_err(|e| Error::TagListUnavailable(format!("unparseable version {stdout:?}: {e}"))) +} + +/// Probe whether the container's `stellar contract build` accepts `--locked`. +/// The flag was added in cli 25.2.0 (commit `6115b818`); older images reject it +/// outright, which would fail the build. Rather than map versions, ask the +/// container's own `contract build --help` whether the flag exists. On any probe +/// failure returns false — the conservative assumption that the flag is absent, +/// so the build proceeds without it rather than erroring. +pub(crate) async fn probe_supports_locked( + image_ref: &str, + docker: &shared::Args, + print: &Print, +) -> bool { + match run_probe( + image_ref, + docker, + None, + vec![ + "contract".to_string(), + "build".to_string(), + "--help".to_string(), + ], + ) + .await + { + Ok(help) => help.contains("--locked"), + Err(e) => { + print.warnln(format!( + "Could not probe whether the container's `contract build` supports --locked ({e}); building without it" + )); + false + } + } +} + +/// Probe the image for the toolchain rustup uses by default, so it can be +/// pinned via `RUSTUP_TOOLCHAIN` (see `run_in_container`). Overrides the +/// entrypoint to run `rustup show active-toolchain` and returns the toolchain +/// name — the first whitespace-delimited token, dropping any trailing +/// `(default)` marker (e.g. `1.93.0-x86_64-unknown-linux-gnu`). Returns `None` +/// on any failure (e.g. an image without rustup), so the build proceeds without +/// the pin rather than failing. +async fn probe_active_toolchain(image_ref: &str, docker: &shared::Args) -> Option { + let stdout = run_probe( + image_ref, + docker, + Some("rustup"), + vec!["show".to_string(), "active-toolchain".to_string()], + ) + .await + .ok()?; + stdout.split_whitespace().next().map(str::to_string) +} + +/// Render the per-package `stellar contract build …` commands into a single +/// `sh -c` script (`stellar … && stellar …`), shell-escaping every token so meta +/// values with spaces survive. Used when more than one package is built so they +/// share one container (and its crates download / compiled deps / `target/`). +fn compose_shell_command(cmds: &[Vec]) -> String { + cmds.iter() + .map(|cmd| { + std::iter::once("stellar") + .chain(cmd.iter().map(String::as_str)) + .map(|tok| shell_escape::escape(tok.into()).into_owned()) + .collect::>() + .join(" ") + }) + .collect::>() + .join(" && ") +} + +/// Shell-escape each token of a single-package container command so a value +/// with spaces (a `--meta` value, or an `--env=` recorded as a `bldopt`) +/// survives when the reproduce line is copy-pasted into a shell. The +/// single-package path runs the image's default `stellar` entrypoint directly, +/// so there's no `sh -c` wrapper as in `compose_shell_command`. +fn escape_container_args(cmd: &[String]) -> String { + cmd.iter() + .map(|tok| shell_escape::escape(tok.into()).into_owned()) + .collect::>() + .join(" ") +} + +/// Resolve once the process receives any catchable signal that would otherwise +/// terminate it, so the caller can stop the build container before exiting. +/// `SIGKILL` can't be caught, so a `kill -9` still orphans the container — +/// nothing in-process can prevent that. On non-Unix platforms only Ctrl-C is +/// observable. +#[cfg(unix)] +async fn wait_for_termination_signal() { + use tokio::signal::unix::{signal, SignalKind}; + + // If any handler fails to install we simply never resolve on that signal; + // the build still runs, it just won't self-clean on that particular signal. + let mut sigint = signal(SignalKind::interrupt()); + let mut sigterm = signal(SignalKind::terminate()); + let mut sighup = signal(SignalKind::hangup()); + let mut sigquit = signal(SignalKind::quit()); + + tokio::select! { + () = recv_signal(&mut sigint) => {}, + () = recv_signal(&mut sigterm) => {}, + () = recv_signal(&mut sighup) => {}, + () = recv_signal(&mut sigquit) => {}, + } +} + +/// Await one delivery of an installed signal. When the handler failed to +/// install, never resolves, so it drops out of the `select!` above rather than +/// firing spuriously. +#[cfg(unix)] +async fn recv_signal(s: &mut std::io::Result) { + match s { + Ok(s) => { + s.recv().await; + } + Err(_) => std::future::pending().await, + } +} + +#[cfg(not(unix))] +async fn wait_for_termination_signal() { + let _ = tokio::signal::ctrl_c().await; +} + +#[allow(clippy::too_many_arguments)] +async fn run_in_container( + image_ref: &str, + workspace_root: &Path, + container_cmds: &[Vec], + env: &[String], + docker: &shared::Args, + run_args: &shared::RunArgs, + print: &Print, + verbose: bool, +) -> Result<(), Error> { + let bind = format!("{}:/source", workspace_root.display()); + + // Pin rustup to the image's own toolchain (per SEP-58): without this, a + // `rust-toolchain.toml` in the source could make rustup switch toolchains + // mid-build, defeating the digest-pinned image. Probe the image for its + // active toolchain and pass it through with `-e`, unless the caller already + // set RUSTUP_TOOLCHAIN. Skipped silently when the image has no rustup. + let mut env = env.to_vec(); + if !env.iter().any(|e| e.starts_with("RUSTUP_TOOLCHAIN=")) { + if let Some(toolchain) = probe_active_toolchain(image_ref, docker).await { + env.push(format!("RUSTUP_TOOLCHAIN={toolchain}")); + } + } + + // `-e KEY=VALUE` flags for the reproduce command, mirroring the env passed + // to the container below. + let mut env_flags = String::new(); + for e in &env { + env_flags.push_str(" -e "); + env_flags.push_str(&shell_escape::escape(e.as_str().into())); + } + + // Render the reproduce line against the engine binary the CLI actually ran + // (`docker`, `container`), so a third party can replay the exact build. + let program = docker.program(); + + // Resource limits go right after `--rm`, matching where they're applied to + // the spawned command below, so the reproduce line stays copy-paste faithful. + let mut run_flags = String::new(); + for f in run_args.flags() { + run_flags.push(' '); + run_flags.push_str(&shell_escape::escape(f.into())); + } + + // One package → run the image's default `stellar` entrypoint directly, so + // `post_image` is just the `contract build …` argv. Several → override the + // entrypoint to a shell and chain the builds so they all run in this one + // container; `--entrypoint` takes only the executable, so the `-c ` + // arguments follow the image name in `post_image`. + let (entrypoint, post_image, reproduce) = if container_cmds.len() > 1 { + let chain = compose_shell_command(container_cmds); + let reproduce = format!( + "{program} run --rm{run_flags} -v {bind}{env_flags} --entrypoint /bin/sh {image_ref} -c {}", + shell_escape::escape(chain.clone().into()) + ); + (Some("/bin/sh"), vec!["-c".to_string(), chain], reproduce) + } else { + let cmd = container_cmds.first().cloned().unwrap_or_default(); + let reproduce = format!( + "{program} run --rm{run_flags} -v {bind}{env_flags} {image_ref} {}", + escape_container_args(&cmd) + ); + (None, cmd, reproduce) + }; + + print.infoln(format!( + "Running verifiable build in {image_ref} (mount {bind})" + )); + if verbose { + print.infoln(format!("Running: {reproduce}")); + } + + // Name the build container so it can be stopped if the CLI is interrupted. + // Without a name there's no handle to target: on a termination signal the + // CLI process dies, but the container the daemon owns keeps running (the + // engine client exiting doesn't stop it, and signal-forwarding through the + // client is unreliable for a long cargo build). `--rm` removes it once + // stopped. The name is unique per invocation (pid + random) so concurrent + // builds don't collide, and it's kept out of the reproduce line — a fixed + // name there would clash on re-run. + let container_name = format!( + "stellar-verifiable-build-{}-{:08x}", + std::process::id(), + rand::random::() + ); + + let mut command = docker.base_command(); + command.args(["run", "--rm", "--name", &container_name]); + run_args.apply(&mut command); + command.args(["-v", &bind, "-w", "/source"]); + for e in &env { + command.args(["-e", e]); + } + if let Some(entrypoint) = entrypoint { + command.args(["--entrypoint", entrypoint]); + } + command.arg(image_ref); + command.args(&post_image); + + // Stream the build's cargo output straight to the terminal when verbose + // (matching a non-verifiable `contract build`); otherwise discard it (the + // verify pipeline suppresses per-build noise). `quiet` overrides verbose. + let show_output = verbose && !print.quiet; + let (stdout, stderr) = if show_output { + (Stdio::inherit(), Stdio::inherit()) + } else { + (Stdio::null(), Stdio::null()) + }; + command.stdout(stdout).stderr(stderr); + + let mut child = command.spawn().map_err(|e| docker.io_error(e))?; + + // Race the build against any catchable termination signal. On a signal, + // stop the named container (best-effort) so it doesn't outlive the CLI, + // kill the engine client we spawned, then surface the interruption. + let status = tokio::select! { + result = child.wait() => result.map_err(|e| docker.io_error(e))?, + () = wait_for_termination_signal() => { + print.warnln("Interrupted; stopping build container"); + // `kill` (SIGKILL, immediate) rather than `stop` (SIGTERM + 10s + // grace): otherwise the container keeps building for the whole grace + // period while we block here. + let _ = docker.kill_command(&container_name).output().await; + let _ = child.start_kill(); + return Err(Error::Interrupted); + } + }; + if !status.success() { + return Err(Error::ContainerExit { + status: status.code().unwrap_or(-1).into(), + command: reproduce, + }); + } + + Ok(()) +} + +/// Collect the built WASM artifacts. Package names and the host target dir come +/// from host `cargo metadata`. `extracted_root` is set when the build ran +/// against an extracted archive (step: `--archive`): the artifacts then live +/// under that tree's target dir and must be copied out before its tempdir +/// drops. `source_root` is the host source root the extracted tree mirrors, so +/// the target dir's position relative to it carries over. +fn collect_built_contracts( + cmd: &Cmd, + source_root: &Path, + extracted_root: Option<&Path>, + _print: &Print, +) -> Result, super::Error> { + let mut mc = MetadataCommand::new(); + mc.no_deps(); + if let Some(p) = &cmd.manifest_path { + mc.manifest_path(p); + } + let md = mc.exec().map_err(Error::Metadata)?; + let host_target = md.target_directory.as_std_path(); + + // Where the build actually wrote artifacts. For an extracted-archive build + // that's `/`; otherwise the + // host target dir (the working tree was bind-mounted directly). + let src_target = match extracted_root { + Some(er) => er.join(host_target.strip_prefix(source_root).unwrap_or(host_target)), + None => host_target.to_path_buf(), + }; + + let mut out = Vec::new(); + for p in &md.packages { + let is_cdylib = p + .targets + .iter() + .any(|t| t.crate_types.iter().any(|c| c == "cdylib")); + if !is_cdylib { + continue; + } + if let Some(name) = &cmd.package { + if &p.name != name { + continue; + } + } else if !md.workspace_default_members.contains(&p.id) { + continue; + } + let wasm_name = p.name.replace('-', "_"); + let rel = Path::new(WASM_TARGET) + .join(&cmd.profile) + .join(format!("{wasm_name}.wasm")); + let src = src_target.join(&rel); + + // Destination: --out-dir wins; else if the build ran in a tempdir, copy + // into the host target dir so the artifact survives; else leave in + // place (the working tree was mounted, so it's already on the host). + let dest = if let Some(out_dir) = &cmd.out_dir { + Some(out_dir.join(format!("{wasm_name}.wasm"))) + } else if extracted_root.is_some() { + Some(host_target.join(&rel)) + } else { + None + }; + + let path = match dest { + Some(dest) if src.exists() => { + if let Some(parent) = dest.parent() { + std::fs::create_dir_all(parent).map_err(super::Error::CreatingOutDir)?; + } + std::fs::copy(&src, &dest).map_err(super::Error::CopyingWasmFile)?; + dest + } + // Source missing: report the intended dest (matches prior leniency). + Some(dest) => dest, + None => src, + }; + out.push(BuiltContract { + name: p.name.clone(), + path, + }); + } + Ok(out) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn ws() -> &'static Path { + Path::new("/tmp/ws") + } + + #[test] + fn build_forwarded_args_defaults() { + let cmd = Cmd::default(); + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), true, true); + // Default optimize=true → bare `--optimize` recorded + forwarded. + assert_eq!( + forwarded, + vec!["--locked".to_string(), "--optimize".to_string()] + ); + assert_eq!( + bldopts, + vec!["--locked".to_string(), "--optimize".to_string()] + ); + } + + #[test] + fn build_forwarded_args_omits_locked_when_unsupported() { + // Older images (< cli 25.2.0) reject `--locked`; when the probe reports + // it's unsupported, the flag is neither forwarded nor recorded. + let cmd = Cmd::default(); + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), true, false); + assert!(!forwarded.iter().any(|a| a == "--locked")); + assert!(!bldopts.iter().any(|a| a == "--locked")); + // Everything else is still recorded (default optimize=true here). + assert!(forwarded.contains(&"--optimize".to_string())); + } + + #[test] + fn build_forwarded_args_features_and_package() { + let cmd = Cmd { + features: Some("a,b".to_string()), + package: Some("contract-a".to_string()), + ..Cmd::default() + }; + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), true, true); + assert!(forwarded.contains(&"--features=a,b".to_string())); + assert!(forwarded.contains(&"--package=contract-a".to_string())); + assert!(bldopts.contains(&"--features=a,b".to_string())); + assert!(bldopts.contains(&"--package=contract-a".to_string())); + assert!(bldopts.contains(&"--locked".to_string())); + } + + #[test] + fn build_forwarded_args_records_resolved_package_when_unspecified() { + // No `--package` on the cmd, but the caller resolved one (single + // default cdylib); it must still be forwarded and recorded. + let cmd = Cmd::default(); + assert!(cmd.package.is_none()); + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), Some("hello-world"), true, true); + assert!(forwarded.contains(&"--package=hello-world".to_string())); + assert!(bldopts.contains(&"--package=hello-world".to_string())); + } + + #[test] + fn build_forwarded_args_omits_package_when_unresolved() { + let cmd = Cmd::default(); + let (forwarded, bldopts) = build_forwarded_args(&cmd, ws(), None, true, true); + assert!(!forwarded.iter().any(|a| a.starts_with("--package"))); + assert!(!bldopts.iter().any(|a| a.starts_with("--package"))); + } + + #[test] + fn build_forwarded_args_records_meta_and_manifest() { + let cmd = Cmd { + manifest_path: Some(PathBuf::from("/tmp/ws/contracts/add/Cargo.toml")), + build_args: super::super::BuildArgs { + meta: vec![ + ("home_domain".to_string(), "fnando.com".to_string()), + ("author".to_string(), "alice".to_string()), + ], + env: vec![], + optimize: true, + }, + ..Cmd::default() + }; + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), true, true); + assert!(forwarded.contains(&"--meta=home_domain=fnando.com".to_string())); + assert!(forwarded.contains(&"--meta=author=alice".to_string())); + assert!(forwarded.contains(&"--manifest-path=contracts/add/Cargo.toml".to_string())); + assert!(bldopts.contains(&"--meta=home_domain=fnando.com".to_string())); + assert!(bldopts.contains(&"--meta=author=alice".to_string())); + assert!(bldopts.contains(&"--manifest-path=contracts/add/Cargo.toml".to_string())); + } + + #[test] + fn build_forwarded_args_records_env_as_bldopt_only() { + let cmd = Cmd { + build_args: super::super::BuildArgs { + env: vec![ + ("FOO".to_string(), "bar".to_string()), + ("BAZ".to_string(), "qux".to_string()), + ], + ..super::super::BuildArgs::default() + }, + ..Cmd::default() + }; + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), true, true); + // Env vars are applied via docker `-e`, so they're recorded as bldopts + // for the verifier but never forwarded as build arguments. + assert!(bldopts.contains(&"--env=FOO=bar".to_string())); + assert!(bldopts.contains(&"--env=BAZ=qux".to_string())); + assert!(!forwarded.iter().any(|a| a.starts_with("--env"))); + } + + #[test] + fn build_forwarded_args_optimize_false_new_container() { + let cmd = Cmd { + build_args: super::super::BuildArgs { + meta: vec![], + env: vec![], + optimize: false, + }, + ..Cmd::default() + }; + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), true, true); + assert!(forwarded.contains(&"--optimize=false".to_string())); + assert!(bldopts.contains(&"--optimize=false".to_string())); + } + + #[test] + fn build_forwarded_args_optimize_false_old_container() { + let cmd = Cmd { + build_args: super::super::BuildArgs { + meta: vec![], + env: vec![], + optimize: false, + }, + ..Cmd::default() + }; + let (forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), false, true); + // Old container's default is already false; record nothing. + // Passing `--optimize=false` to a pre-26.1.0 cli would fail. + assert!(!forwarded.iter().any(|a| a.starts_with("--optimize"))); + assert!(!bldopts.iter().any(|a| a.starts_with("--optimize"))); + } + + fn pairs(args: &[String]) -> Vec<(&str, &str)> { + args.chunks(2) + .map(|c| (c[0].as_str(), c[1].as_str())) + .collect() + } + + #[test] + fn build_metadata_args_uri_and_sha256() { + let ids = SourceIds { + source_uri: Some("https://example.com/src.tar.gz".to_string()), + source_sha256: Some("a".repeat(64)), + }; + let m = build_metadata_args( + "docker.io/stellar/stellar-cli@sha256:abc", + &ids, + &["--locked".to_string(), "--features=a".to_string()], + ); + let p = pairs(&m); + // bldimg first; source_uri then source_sha256; bldopts last. + assert_eq!( + p[0], + ("--meta", "bldimg=docker.io/stellar/stellar-cli@sha256:abc") + ); + assert_eq!( + p[1], + ("--meta", "source_uri=https://example.com/src.tar.gz") + ); + assert_eq!(p[2].0, "--meta"); + assert!(p[2].1.starts_with("source_sha256=")); + assert_eq!(p[3], ("--meta", "bldopt=--locked")); + assert_eq!(p[4], ("--meta", "bldopt=--features=a")); + } + + #[test] + fn build_forwarded_args_escapes_bldopt_values_as_shell() { + // Values with shell metacharacters are escaped at the source so each + // recorded bldopt is valid shell on its own. Only the value side is + // quoted: `--env=B='this is very nice'`, never `'--env=B=this is very + // nice'` (which would quote the flag and key too). + let cmd = Cmd { + features: Some("a,b".to_string()), + build_args: super::super::BuildArgs { + meta: vec![("note".to_string(), "added on build".to_string())], + env: vec![ + ("B".to_string(), "this is very nice".to_string()), + ("C".to_string(), "it's a \"trap\"".to_string()), + ], + optimize: true, + }, + ..Cmd::default() + }; + let (_forwarded, bldopts) = + build_forwarded_args(&cmd, ws(), cmd.package.as_deref(), true, true); + + // The flag and key stay outside the quotes; only the value is escaped. + assert!(bldopts.contains(&"--env=B='this is very nice'".to_string())); + assert!(bldopts.contains(&"--meta=note='added on build'".to_string())); + // No-metacharacter values stay verbatim. + assert!(bldopts.contains(&"--features=a,b".to_string())); + + // Every recorded bldopt is valid shell that parses back to one argv token. + for o in &bldopts { + let tokens = shlex::split(o).expect("each bldopt must be valid shell"); + assert_eq!(tokens.len(), 1, "{o} must be a single shell token"); + } + } + + #[test] + fn build_metadata_args_sha256_only_omits_uri() { + let ids = SourceIds { + source_sha256: Some("f".repeat(64)), + ..SourceIds::default() + }; + let m = build_metadata_args("docker.io/stellar/stellar-cli@sha256:abc", &ids, &[]); + assert!(m + .iter() + .any(|s| s == &format!("source_sha256={}", "f".repeat(64)))); + assert!(!m.iter().any(|s| s.starts_with("source_uri="))); + } + + #[test] + fn validate_source_formats_rejects_bad_sha256() { + let cmd = Cmd { + source_sha256: Some("not-a-sha".to_string()), + ..Cmd::default() + }; + let err = validate_source_formats(&cmd).unwrap_err(); + assert!(matches!(err, Error::SourceSha256Format { .. })); + } + + #[test] + fn validate_source_formats_rejects_bad_uri() { + let cmd = Cmd { + source_uri: Some("not a uri".to_string()), // no scheme + source_sha256: Some("a".repeat(64)), + ..Cmd::default() + }; + let err = validate_source_formats(&cmd).unwrap_err(); + assert!(matches!(err, Error::SourceUriFormat { .. })); + } + + #[test] + fn validate_source_formats_accepts_valid_and_absent() { + // Both absent is fine here — requiredness is enforced in run(). + validate_source_formats(&Cmd::default()).unwrap(); + let cmd = Cmd { + source_uri: Some("https://example.com/src.tar.gz".to_string()), + source_sha256: Some("f".repeat(64)), + ..Cmd::default() + }; + validate_source_formats(&cmd).unwrap(); + } + + #[test] + fn bldimg_regex_accepts_docker_hub_full_ref() { + assert!(bldimg_regex().is_match(&format!( + "docker.io/stellar/stellar-cli@sha256:{}", + "a".repeat(64) + ))); + } + + #[test] + fn bldimg_regex_accepts_localhost_registry() { + assert!(bldimg_regex().is_match(&format!("localhost:5000/foo@sha256:{}", "0".repeat(64)))); + } + + #[test] + fn bldimg_regex_rejects_implicit_hub_short_ref() { + // Implicit Docker Hub short ref: no registry host prefix. + assert!(!bldimg_regex().is_match(&format!("stellar/stellar-cli@sha256:{}", "a".repeat(64)))); + } + + #[test] + fn bldimg_regex_rejects_tag_only() { + assert!(!bldimg_regex().is_match("docker.io/stellar/stellar-cli:latest")); + } + + #[test] + fn bldimg_regex_rejects_short_sha() { + assert!(!bldimg_regex().is_match("docker.io/stellar/stellar-cli@sha256:abc")); + } + + #[test] + fn source_sha256_regex_matches_64_hex() { + assert!(source_sha256_regex().is_match(&"f".repeat(64))); + assert!(!source_sha256_regex().is_match(&"f".repeat(63))); + assert!(!source_sha256_regex().is_match(&"F".repeat(64))); // upper-case rejected + } + + #[test] + fn source_uri_regex_accepts_any_scheme() { + assert!(source_uri_regex().is_match("https://example.com/src.tar.gz")); + assert!(source_uri_regex().is_match("http://example.com/foo.git")); + assert!(source_uri_regex().is_match("ipfs://Qm...abc")); + assert!(source_uri_regex().is_match("github:foo/bar")); + assert!(!source_uri_regex().is_match("foo/bar")); // no scheme + assert!(!source_uri_regex().is_match("https://has space")); // whitespace + } + + #[test] + fn compose_container_args_prefixes_subcommand() { + let composed = compose_container_args( + &["--locked".to_string()], + &["--meta".to_string(), "bldimg=x".to_string()], + ); + assert_eq!(composed[..2], ["contract".to_string(), "build".to_string()]); + assert!(composed.contains(&"--locked".to_string())); + assert!(composed.contains(&"bldimg=x".to_string())); + } + + #[test] + fn reserved_meta_keys_list() { + for key in ["bldimg", "source_uri", "source_sha256", "bldopt"] { + assert!(RESERVED_META_KEYS.contains(&key)); + } + } + + #[test] + fn compose_shell_command_chains_and_escapes() { + let a = vec![ + "contract".to_string(), + "build".to_string(), + "--package=another".to_string(), + "--meta".to_string(), + "home_domain=fnando.com".to_string(), + ]; + let b = vec![ + "contract".to_string(), + "build".to_string(), + "--package=hello-world".to_string(), + ]; + let s = compose_shell_command(&[a, b]); + assert_eq!( + s, + "stellar contract build --package=another --meta home_domain=fnando.com \ + && stellar contract build --package=hello-world" + ); + + // A meta value with a space must be quoted so it stays one token. + let c = vec![ + "contract".to_string(), + "build".to_string(), + "--meta".to_string(), + "note=added on build".to_string(), + ]; + let s = compose_shell_command(&[c]); + assert!( + s.contains("'note=added on build'") || s.contains("\"note=added on build\""), + "expected the spaced value to be quoted, got: {s}" + ); + } + + #[test] + fn escape_container_args_quotes_spaced_tokens() { + // An `--env=` recorded as a bldopt carries the env value verbatim, so a + // spaced value lands in a single `--meta bldopt=…` token. The reproduce + // line must quote it so a copy-paste round-trips back to one argv token. + let cmd = vec![ + "contract".to_string(), + "build".to_string(), + "--package=hello-world".to_string(), + "--meta".to_string(), + "bldopt=--env=B=this is very nice".to_string(), + ]; + let s = escape_container_args(&cmd); + let tokens = shlex::split(&s).expect("reproduce args must be valid shell"); + assert_eq!( + tokens, + vec![ + "contract", + "build", + "--package=hello-world", + "--meta", + "bldopt=--env=B=this is very nice", + ], + "spaced token must survive a shlex round-trip as one argument" + ); + } +} diff --git a/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs b/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs index 9afdada05..5ba2d37aa 100644 --- a/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs +++ b/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs @@ -193,7 +193,7 @@ impl Cmd { return Err(Error::BuildOnlyNotSupported); } - let built_contracts = self.resolve_contracts(global_args)?; + let built_contracts = self.resolve_contracts(global_args).await?; // Aliases derived from workspace package names are assigned per-iteration // inside the deploy loop, so validate them all up front: a package named @@ -286,7 +286,7 @@ impl Cmd { Ok(()) } - fn resolve_contracts( + async fn resolve_contracts( &self, global_args: &global::Args, ) -> Result, Error> { @@ -309,7 +309,7 @@ impl Cmd { build_args: self.build_args.clone(), ..build::Cmd::default() }; - let contracts = build_cmd.run(global_args).map_err(|e| match e { + let contracts = build_cmd.run(global_args).await.map_err(|e| match e { build::Error::Metadata(_) => Error::NotInCargoProject, other => other.into(), })?; diff --git a/cmd/soroban-cli/src/commands/contract/fetch.rs b/cmd/soroban-cli/src/commands/contract/fetch.rs index a02bf9886..2905b8e37 100644 --- a/cmd/soroban-cli/src/commands/contract/fetch.rs +++ b/cmd/soroban-cli/src/commands/contract/fetch.rs @@ -22,14 +22,18 @@ pub struct Cmd { /// Contract ID to fetch #[arg(long = "id", env = "STELLAR_CONTRACT_ID")] pub contract_id: Option, + /// Wasm to fetch #[arg(long = "wasm-hash", conflicts_with = "contract_id")] pub wasm_hash: Option, + /// Where to write output otherwise stdout is used #[arg(long, short = 'o')] pub out_file: Option, + #[command(flatten)] pub locator: locator::Args, + #[command(flatten)] pub network: network::Args, } diff --git a/cmd/soroban-cli/src/commands/contract/mod.rs b/cmd/soroban-cli/src/commands/contract/mod.rs index a5e6ce181..ee140be93 100644 --- a/cmd/soroban-cli/src/commands/contract/mod.rs +++ b/cmd/soroban-cli/src/commands/contract/mod.rs @@ -1,4 +1,5 @@ pub mod alias; +pub mod archive; pub mod arg_parsing; pub mod asset; pub mod bindings; @@ -33,6 +34,9 @@ pub enum Cmd { #[command(subcommand)] Bindings(bindings::Cmd), + /// Generate the reproducible source archive used by verifiable builds + Archive(archive::Cmd), + Build(build::Cmd), /// Extend the time to live ledger of a contract-data ledger entry. @@ -113,6 +117,9 @@ pub enum Error { #[error(transparent)] Bindings(#[from] bindings::Error), + #[error(transparent)] + Archive(#[from] archive::Error), + #[error(transparent)] Build(#[from] build::Error), @@ -163,8 +170,9 @@ impl Cmd { match &self { Cmd::Asset(asset) => asset.run(global_args).await?, Cmd::Bindings(bindings) => bindings.run().await?, + Cmd::Archive(archive) => archive.run(global_args)?, Cmd::Build(build) => { - build.run(global_args)?; + build.run(global_args).await?; } Cmd::Extend(extend) => extend.run(global_args).await?, Cmd::Alias(alias) => alias.run(global_args)?, diff --git a/cmd/soroban-cli/src/commands/contract/upload.rs b/cmd/soroban-cli/src/commands/contract/upload.rs index 55b8e308b..9a843880d 100644 --- a/cmd/soroban-cli/src/commands/contract/upload.rs +++ b/cmd/soroban-cli/src/commands/contract/upload.rs @@ -144,7 +144,7 @@ impl Cmd { return Err(Error::BuildOnlyNotSupported); } - let wasm_paths = self.resolve_wasm_paths(global_args)?; + let wasm_paths = self.resolve_wasm_paths(global_args).await?; for wasm_path in &wasm_paths { let res = self @@ -181,7 +181,7 @@ impl Cmd { self.upload_wasm(&wasm_path, config, quiet, no_cache).await } - fn resolve_wasm_paths(&self, global_args: &global::Args) -> Result, Error> { + async fn resolve_wasm_paths(&self, global_args: &global::Args) -> Result, Error> { if let Some(wasm) = &self.wasm { Ok(vec![wasm.clone()]) } else { @@ -190,7 +190,7 @@ impl Cmd { build_args: self.build_args.clone(), ..build::Cmd::default() }; - let contracts = build_cmd.run(global_args).map_err(|e| match e { + let contracts = build_cmd.run(global_args).await.map_err(|e| match e { build::Error::Metadata(_) => Error::NotInCargoProject, other => other.into(), })?; diff --git a/cmd/soroban-cli/src/commands/mod.rs b/cmd/soroban-cli/src/commands/mod.rs index 936746362..2e879e8f0 100644 --- a/cmd/soroban-cli/src/commands/mod.rs +++ b/cmd/soroban-cli/src/commands/mod.rs @@ -32,6 +32,8 @@ pub const HEADING_ARCHIVE: &str = "Archive Options"; pub const HEADING_GLOBAL: &str = "Global Options"; pub const HEADING_SIGNING: &str = "Signing Options"; pub const HEADING_TRANSACTION: &str = "Transaction Options"; +pub const HEADING_CONTAINER: &str = "Container Options"; +pub const HEADING_VERIFIABLE: &str = "Verifiable Options"; const ABOUT: &str = "Work seamlessly with Stellar accounts, contracts, and assets from the command line. diff --git a/cmd/soroban-cli/src/config/data.rs b/cmd/soroban-cli/src/config/data.rs index e310ebf13..6e49f1926 100644 --- a/cmd/soroban-cli/src/config/data.rs +++ b/cmd/soroban-cli/src/config/data.rs @@ -58,6 +58,12 @@ pub fn bucket_dir() -> Result { Ok(dir) } +pub fn archives_dir() -> Result { + let dir = data_local_dir()?.join("archives"); + std::fs::create_dir_all(&dir)?; + Ok(dir) +} + pub fn write(action: Action, rpc_url: &Url) -> Result { let data = Data { action, @@ -211,6 +217,18 @@ mod test { use crate::test_utils::with_env_set; use serial_test::serial; + #[test] + #[serial] + fn archives_dir_under_data_home_and_created() { + let t = assert_fs::TempDir::new().unwrap(); + with_env_set("STELLAR_DATA_HOME", t.path(), || { + let dir = archives_dir().unwrap(); + assert!(dir.ends_with("archives")); + assert!(dir.starts_with(t.path())); + assert!(dir.is_dir(), "archives_dir() should create the directory"); + }); + } + #[test] #[serial] fn test_write_read() { diff --git a/cmd/soroban-cli/src/config/locator.rs b/cmd/soroban-cli/src/config/locator.rs index e557d3074..d3e6c41f4 100644 --- a/cmd/soroban-cli/src/config/locator.rs +++ b/cmd/soroban-cli/src/config/locator.rs @@ -623,52 +623,66 @@ impl Pwd for Args { } } -#[cfg(unix)] -fn fix_config_permissions(root: std::path::PathBuf) { - use std::os::unix::fs::PermissionsExt; - - let mut bad_dirs = Vec::new(); - let mut bad_files = Vec::new(); - let mut stack = vec![root]; - - while let Some(dir) = stack.pop() { - if let Ok(meta) = std::fs::metadata(&dir) { - if meta.permissions().mode() & 0o777 != 0o700 { - bad_dirs.push(dir.clone()); +/// Walk `root` recursively. For every regular entry whose permissions don't +/// already match the hardened mode (0o700 for dirs, 0o600 for files), set +/// them. Returns the dirs and files that were changed so callers can decide +/// whether to surface a warning. Symlinks are skipped — mode bits aren't +/// meaningful for them and `set_permissions` would follow them. +/// +/// On non-unix platforms this is a no-op; tempdirs / config dirs there rely +/// on filesystem ACLs created by the higher-level APIs. +#[allow(clippy::unnecessary_wraps)] +pub(crate) fn enforce_hardened_tree(root: &Path) -> io::Result<(Vec, Vec)> { + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt; + let mut changed_dirs = Vec::new(); + let mut changed_files = Vec::new(); + let mut stack = vec![root.to_path_buf()]; + while let Some(p) = stack.pop() { + let Ok(meta) = std::fs::symlink_metadata(&p) else { + continue; + }; + if meta.file_type().is_symlink() { + continue; } - } - - if let Ok(entries) = std::fs::read_dir(&dir) { - for entry in entries.filter_map(Result::ok) { - let path = entry.path(); - - if path.is_dir() { - stack.push(path); - } else if let Ok(meta) = std::fs::metadata(&path) { - if meta.permissions().mode() & 0o777 != 0o600 { - bad_files.push(path); + let current = meta.permissions().mode() & 0o777; + if meta.is_dir() { + if current != 0o700 { + set_hardened_permissions(&p)?; + changed_dirs.push(p.clone()); + } + if let Ok(entries) = std::fs::read_dir(&p) { + for entry in entries.filter_map(Result::ok) { + stack.push(entry.path()); } } + } else if current != 0o600 { + set_hardened_permissions(&p)?; + changed_files.push(p); } } + Ok((changed_dirs, changed_files)) } + #[cfg(not(unix))] + { + let _ = root; + Ok((Vec::new(), Vec::new())) + } +} - let print = Print::new(false); +#[cfg(unix)] +fn fix_config_permissions(root: std::path::PathBuf) { + let Ok((dirs, files)) = enforce_hardened_tree(&root) else { + return; + }; - if !bad_dirs.is_empty() { + let print = Print::new(false); + if !dirs.is_empty() { print.warnln("Updated config directories permissions to 0700."); - - for dir in bad_dirs { - let _ = set_hardened_permissions(&dir); - } } - - if !bad_files.is_empty() { + if !files.is_empty() { print.warnln("Updated config files permissions to 0600."); - - for file in bad_files { - let _ = set_hardened_permissions(&file); - } } }