Struct ReferencePolicy 

#[non_exhaustive]
pub struct ReferencePolicy { /* private fields */ }

The external resources a config of one origin may reach.

Every dimension is either open (None — anything) or an allow-list (Some(list); an empty list allows nothing). ReferencePolicy::default is ReferencePolicy::deny_all: a policy only allows what it is told to.

Implementations

impl ReferencePolicy

pub fn open() -> Self

Everything allowed: any path, URL, variable and secret, and programs.

pub fn deny_all() -> Self

Nothing allowed.

pub fn with_path_roots<I, P>(self, roots: I) -> Self

where I: IntoIterator<Item = P>, P: Into<PathBuf>,

Allow local paths only under these directories.

pub fn any_path(self) -> Self

Allow any local path.

pub fn with_url_schemes<I, S>(self, schemes: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Allow URLs only with these schemes (https, postgres, …).

pub fn any_url_scheme(self) -> Self

Allow URLs of any scheme.

pub fn with_url_hosts<I, S>(self, hosts: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Allow URLs only to these hosts (api.example.com, *.example.com, 10.0.0.5). A link-local or metadata host is reachable only when listed.

pub fn any_url_host(self) -> Self

Allow URLs to any host except link-local and metadata endpoints.

pub fn with_env<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Allow only these environment variables (NAME or PREFIX*).

pub fn any_env(self) -> Self

Allow any environment variable.

pub fn with_secret_schemes<I, S>(self, schemes: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Allow only these secret-manager schemes (vault, aws-sm, …).

pub fn any_secret_scheme(self) -> Self

Allow any secret-manager scheme.

pub fn with_subprocess(self, allowed: bool) -> Self

Whether connectors that run a program are allowed.

pub fn path_roots(&self) -> Option<&[PathBuf]>

The allowed path roots, None when any path is allowed.

pub fn url_schemes(&self) -> Option<&BTreeSet<String>>

The allowed URL schemes, None when any scheme is allowed.

pub fn url_host_patterns(&self) -> Option<&[String]>

The allowed URL hosts, None when any host is allowed.

pub fn env_patterns(&self) -> Option<&[String]>

The allowed environment variables, None when any is allowed.

pub fn secret_schemes(&self) -> Option<&BTreeSet<String>>

The allowed secret-manager schemes, None when any is allowed.

pub fn allows_subprocess(&self) -> bool

Whether connectors that run a program are allowed.

pub fn check_env(&self, name: &str) -> Result<(), Refusal>

Check an ${env:NAME} / ${secret:NAME} reference.

pub fn check_file(&self, path: &str) -> Result<(), Refusal>

Check a ${file:PATH} reference.

pub fn check_secret(&self, scheme: &str, reference: &str) -> Result<(), Refusal>

Check a secret-manager reference (${vault:…}, …).

pub fn check_path(&self, value: &str) -> Result<(), Refusal>

Check a path a connector reads or writes. A value with a remote scheme (s3://…) is checked as a URL.

pub fn check_url(&self, value: &str) -> Result<(), Refusal>

Check a URL a connector connects to. file: / sqlite: URLs are checked as paths, a scheme-less host[:port] as a host, and a relative reference (/jobs, ./x) names no host of its own and passes.

pub fn check_command(&self, value: &str) -> Result<(), Refusal>

Check a program a connector runs.

pub fn check(&self, r: &ResourceRef) -> Result<(), Refusal>

Check one annotated resource.

Trait Implementations

impl Clone for ReferencePolicy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferencePolicy

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

Formats the value using the given formatter.

impl Default for ReferencePolicy

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ReferencePolicy

impl PartialEq for ReferencePolicy

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ReferencePolicy