Skip to main content

BinaryCache

Struct BinaryCache 

Source
pub struct BinaryCache { /* private fields */ }
Expand description

On-disk cache for downloaded, signature-verified upgrade archives.

Implementations§

Source§

impl BinaryCache

Source

pub fn new(cache_dir: PathBuf) -> Self

Create a new binary cache backed by the given directory.

Production constructor: the cache verifies cached archives against the pinned release public key embedded in the binary.

Source

pub fn cached_archive_path(&self, version: &str) -> PathBuf

Path of the cached archive for version.

Source

pub fn get_verified_archive( &self, version: &str, private_dir: &Path, ) -> Option<PathBuf>

Copy the cached archive into the caller-private private_dir, cryptographically re-verify that private copy, and return its path — or None if there is no usable, trusted cache entry.

On every call this:

  1. loads the sibling metadata and checks the version matches,
  2. copies the cached archive + signature into private_dir (a location only this process writes, e.g. the per-upgrade temp dir),
  3. SHA-256 pre-checks the private copy against the metadata (fast corruption check), then
  4. re-verifies the ML-DSA-65 signature over the private copy with the pinned release key — the actual security gate.

Verifying the private copy (not the shared cache file) closes the TOCTOU window: an attacker with write access to the shared cache dir cannot swap the bytes between verification and extraction, because the caller extracts from the returned private path, which is the exact byte sequence that was verified and is unreachable to the attacker.

Any failure (missing/corrupt metadata, copy error, hash mismatch, missing signature, or — critically — a signature that does not verify against the pinned release key) returns None, forcing a fresh, fully verified download.

The caller MUST extract the binary from the returned (private) archive path, so the executed bytes always derive from signature-verified input that no other principal could have modified post-verification.

private_dir is a load-bearing security invariant: it MUST be a process-private, mode-0o700 directory that no other principal can write to. The caller in apply.rs creates it via tempfile::Builder::permissions(0o700).tempdir_in(binary_dir) — any future caller MUST uphold the same invariant, otherwise the reopens by path in sha256_file and verify_archive would re- introduce a TOCTOU window.

Source

pub fn store_archive( &self, version: &str, archive_path: &Path, signature_path: &Path, ) -> Result<()>

Store a signature-verified archive in the cache.

Both files are persisted (via write-to-temp-then-rename so readers never observe partial writes); the metadata file is written last so get_verified_archive only succeeds once every file is complete.

Defence in depth: this re-verifies the archive against its signature before caching, so a poisoned entry cannot be created through the supported path even if a caller forgot to verify first.

§Errors

Returns an error if the signature does not verify, the inputs cannot be read, or the cache files cannot be written.

Source

pub fn acquire_download_lock(&self) -> Result<DownloadLockGuard>

Acquire an exclusive download lock and return the guard.

This prevents multiple nodes from downloading the same archive concurrently — the first acquires the lock and downloads, the rest wait and then find the archive already cached.

The lock is released when the returned guard is dropped.

Note: lock_exclusive() blocks the calling thread. Callers in async contexts should wrap this call in tokio::task::spawn_blocking.

§Errors

Returns an error if the lock file cannot be created or acquired.

Trait Implementations§

Source§

impl Clone for BinaryCache

Source§

fn clone(&self) -> BinaryCache

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more