Skip to main content

WitnessSubcommand

Enum WitnessSubcommand 

Source
pub enum WitnessSubcommand {
    Up {
        port: u16,
        data_dir: PathBuf,
        accept_file_key: bool,
        image: Option<String>,
        build_attestation: Option<PathBuf>,
    },
    Down {
        data_dir: PathBuf,
        port: u16,
    },
    Status {
        port: u16,
    },
    VerifyReceipt {
        receipt: PathBuf,
    },
    Register {
        endpoint: String,
    },
    Logs {
        data_dir: PathBuf,
    },
    Start {
        bind: SocketAddr,
        db_path: PathBuf,
        identity: Option<PathBuf>,
        generate: bool,
        curve: String,
    },
    Add {
        url: String,
    },
    Remove {
        url: String,
    },
    List,
    Publish,
}
Expand description

Witness subcommands.

Variants§

§

Up

Stand up a witness node (and its monitor) from a clean box, one command.

Brings up the node via the embedded standup manifest, mints the node identity at first boot, and prints a health URL. The node runs the released, attested witness image — never a source build.

Fields

§port: u16

Host port to publish the node’s endpoint on.

§data_dir: PathBuf

Host directory for the node’s persistent data volume.

§accept_file_key: bool

Acknowledge file-backed key custody when no managed key store (KMS/enclave) is available. Without this, a node refuses to fall back to a file key rather than silently weaken custody.

§image: Option<String>

Override the node image to run. Defaults to the released, attested image the platform ships. Use this only to pin a specific released tag or to run an image already present on an air-gapped host.

§build_attestation: Option<PathBuf>

Path to the released image’s signed build attestation (auths artifact sign output). When supplied, the node serves a proof of which binary it runs, and status verifies it. Operators pin the attestation that ships with the released image.

§

Down

Tear a stood-up witness node down.

Fields

§data_dir: PathBuf

Host directory of the node to tear down.

§port: u16

Host port the node to tear down was published on.

§

Status

Report a stood-up node’s health, identity, receipts, and peers.

Fields

§port: u16

Host port the node publishes its endpoint on.

§

VerifyReceipt

Verify a witness receipt offline, on this machine alone.

Reads a receipt bundle (a witness’s signed receipt paired with the witness’s published identity) and checks it with no network and no registry — everything needed is in the bundle. Exits non-zero, with a distinct reason, if the receipt does not verify (a tampered or foreign receipt). This is how a third party who does not trust the node confirms a receipt is genuine corroboration.

Fields

§receipt: PathBuf

Path to the receipt bundle JSON file (- reads from stdin).

§

Register

Open a signed candidate entry to register this node in the directory.

Fields

§endpoint: String

Public base URL operators will reach this node at.

§

Logs

Stream a stood-up node’s logs.

Fields

§data_dir: PathBuf

Host directory of the node whose logs to show.

§

Start

Start the witness HTTP server.

Fields

§bind: SocketAddr

Address to bind to (e.g., “127.0.0.1:3333”).

§db_path: PathBuf

Path to the SQLite database for witness storage.

§identity: Option<PathBuf>

Path to the persisted witness signing-key keystore. The advertised AID derives from this key and is stable across restarts. Without it the witness runs with an EPHEMERAL (unpinnable) identity. The AUTHS_WITNESS_SEED env var (hex seed) takes precedence for containers.

§generate: bool

Create the keystore at --identity if it does not exist. Without this, a missing keystore fails closed (never silently mints a fresh key).

§curve: String

Signing curve for a newly generated identity: “p256” (default) or “ed25519”.

§

Add

Add a witness URL to the identity configuration.

Fields

§url: String

Witness server URL (e.g., “http://127.0.0.1:3333”).

§

Remove

Remove a witness URL from the identity configuration.

Fields

§url: String

Witness server URL to remove.

§

List

List configured witnesses for the current identity.

§

Publish

Publish this identity’s full KEL to its configured witnesses, collecting receipts for every event.

Witness submission is idempotent, so republishing is always safe — use it to backfill a witness added after inception, or to confirm your backers hold what your KEL declares they witness.

Trait Implementations§

Source§

impl Clone for WitnessSubcommand

Source§

fn clone(&self) -> WitnessSubcommand

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
Source§

impl Debug for WitnessSubcommand

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for WitnessSubcommand

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for WitnessSubcommand

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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: Sized + 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: Sized + 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> 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