Skip to main content

ShellConfig

Struct ShellConfig 

Source
pub struct ShellConfig {
    pub allow: Vec<String>,
    pub deny: Vec<String>,
    pub timeout_ms: Option<u64>,
    pub max_output_bytes: Option<usize>,
}
Expand description

Package-level [shell] configuration: what a workflow’s script may be, and how long it may run.

[shell]
# when non-empty, only a script matching one of these may run
allow = ["ls", "ls *", "cat *.txt", "nu *"]
# always refused, allow or not
deny = ["*rm -rf*", "*sudo *", "*> /etc/*"]
# deadline of one shell act; defaults to 300000 (1..=3600000)
timeout-ms = 300000
# bytes captured per stream before the act fails; default 1048576
# (1..=67108864)
max-output-bytes = 1048576

Patterns are globs over the whole script text* matches any run of characters, newlines and / included, ? matches one, [abc] one of a set — so rm * matches a script that starts with rm and *rm * matches one that contains it anywhere. Matching the script rather than a parsed command is deliberate: the package does not parse a shell (that is the shell’s job, and no two shells agree), so the rule is the one thing it can state exactly — “this text, or not”.

deny wins over allow. Both lists empty means no restriction, which is the behaviour of a deployment that says nothing; the moment either is written, the policy is the judgement. A pattern that does not compile is a startup error, never a silent allow: a policy that cannot be enforced must not run.

timeout-ms and max-output-bytes bound one act’s resources. They are the deployment’s decision and always in force — no value disables them, a value outside the range is a startup error rather than a silent clamp, and an act has no param that widens them.

This is a policy, not a sandbox. A glob over script text cannot see what the script will do — a=rm; $a -rf / names no forbidden word, and a script can do anything the server’s own account may do that confine_script does not name either. The lists are for making intent explicit and for refusing the obvious, in the spirit of the workdir check below them; a hostile workflow still needs an OS boundary (a container or a namespace around the server).

Fields§

§allow: Vec<String>

Script globs that may run. Empty means “anything not denied”.

§deny: Vec<String>

Script globs that never run; wins over ShellConfig::allow.

§timeout_ms: Option<u64>

Deadline of one shell act in milliseconds. None uses DEFAULT_TIMEOUT_MS; the accepted range is 1..=MAX_TIMEOUT_MS.

§max_output_bytes: Option<usize>

Bytes captured from each of stdout and stderr before the act fails. None uses DEFAULT_MAX_OUTPUT_BYTES; the accepted range is 1..=MAX_OUTPUT_BYTES.

Trait Implementations§

Source§

impl Clone for ShellConfig

Source§

fn clone(&self) -> ShellConfig

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 ShellConfig

Source§

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

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

impl Default for ShellConfig

Source§

fn default() -> ShellConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ShellConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ParallelSend for T
where T: Send,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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