Skip to main content

Policy

Struct Policy 

Source
pub struct Policy {
Show 22 fields pub path: Option<String>, pub fail_mode: FailMode, pub allow_bypass_env: bool, pub allow_bypass_env_noninteractive: bool, pub paranoia: u8, pub severity_overrides: HashMap<String, Severity>, pub additional_known_domains: Vec<String>, pub allowlist: Vec<String>, pub blocklist: Vec<String>, pub approval_rules: Vec<ApprovalRule>, pub network_deny: Vec<String>, pub network_allow: Vec<String>, pub webhooks: Vec<WebhookConfig>, pub checkpoints: CheckpointPolicyConfig, pub scan: ScanPolicyConfig, pub allowlist_rules: Vec<AllowlistRule>, pub custom_rules: Vec<CustomRule>, pub dlp_custom_patterns: Vec<String>, pub policy_server_url: Option<String>, pub policy_server_api_key: Option<String>, pub policy_fetch_fail_mode: Option<String>, pub enforce_fail_mode: Option<bool>,
}
Expand description

Policy configuration loaded from YAML.

Fields§

§path: Option<String>

Path this policy was loaded from.

§fail_mode: FailMode

Fail mode: “open” (default) or “closed”.

§allow_bypass_env: bool

Allow TIRITH=0 bypass in interactive mode.

§allow_bypass_env_noninteractive: bool

Allow TIRITH=0 bypass in non-interactive mode.

§paranoia: u8

Paranoia tier (1-4).

§severity_overrides: HashMap<String, Severity>

Severity overrides per rule.

§additional_known_domains: Vec<String>

Additional known domains (extends built-in list).

§allowlist: Vec<String>

Allowlist: URL patterns that are always allowed.

§blocklist: Vec<String>

Blocklist: URL patterns that are always blocked.

§approval_rules: Vec<ApprovalRule>

Approval rules: commands matching these rules require human approval.

§network_deny: Vec<String>

Network deny list: block commands targeting these hosts/CIDRs.

§network_allow: Vec<String>

Network allow list: exempt these hosts/CIDRs from network deny.

§webhooks: Vec<WebhookConfig>

Webhook endpoints to notify on findings.

§checkpoints: CheckpointPolicyConfig

Checkpoint configuration (Pro+).

§scan: ScanPolicyConfig

Scan configuration overrides.

§allowlist_rules: Vec<AllowlistRule>

Per-rule allowlist scoping (Team).

§custom_rules: Vec<CustomRule>

Custom detection rules defined in YAML (Team).

§dlp_custom_patterns: Vec<String>

Custom DLP redaction patterns (Team). Regex patterns applied alongside built-in patterns when redacting commands in audit logs and webhooks.

§policy_server_url: Option<String>

URL of the centralized policy server (e.g., “https://policy.example.com”).

§policy_server_api_key: Option<String>

API key for authenticating with the policy server.

§policy_fetch_fail_mode: Option<String>

Fail mode for remote policy fetch: “open” (default), “closed”, or “cached”.

§enforce_fail_mode: Option<bool>

Whether to enforce the fetch fail mode strictly (ignore local fallback on auth errors).

Implementations§

Source§

impl Policy

Source

pub fn discover_partial(cwd: Option<&str>) -> Self

Discover and load partial policy (just bypass + fail_mode fields). Used in Tier 2 for fast bypass resolution.

Source

pub fn discover(cwd: Option<&str>) -> Self

Discover and load full policy.

Resolution order:

  1. Local policy (TIRITH_POLICY_ROOT, walk-up discovery, user-level)
  2. Team+ only: if TIRITH_SERVER_URL + TIRITH_API_KEY are set (or policy has policy_server_url), try remote fetch. On success the remote policy replaces the local one entirely and is cached.
  3. On remote failure, apply policy_fetch_fail_mode:
    • "open" (default): warn and use local policy
    • "closed": return a fail-closed default (all actions = Block)
    • "cached": try cached remote policy, else fall back to local
  4. Auth errors (401/403) always fail closed regardless of mode.
Source

pub fn severity_override(&self, rule_id: &RuleId) -> Option<Severity>

Get severity override for a rule.

Source

pub fn is_blocklisted(&self, url: &str) -> bool

Check if a URL is in the blocklist.

Source

pub fn is_allowlisted(&self, url: &str) -> bool

Check if a URL is in the allowlist.

Source

pub fn load_user_lists(&mut self)

Load and merge user-level lists (allowlist/blocklist flat text files).

Source

pub fn load_org_lists(&mut self, cwd: Option<&str>)

Load and merge org-level lists from a repo root’s .tirith/ dir.

Note: Org-level policies are committed to the repository and may be controlled by other contributors. A diagnostic is emitted so the user knows that repo-level policy is active.

Trait Implementations§

Source§

impl Clone for Policy

Source§

fn clone(&self) -> Policy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Policy

Source§

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

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

impl Default for Policy

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Policy
where Policy: Default,

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Policy

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<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> 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> 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: 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> 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<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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,