Skip to main content

FileSandboxConfig

Struct FileSandboxConfig 

Source
pub struct FileSandboxConfig {
    pub enabled: bool,
    pub allowed_paths: Vec<PathBuf>,
}
Expand description

Security configuration for file system operations. Controls which paths can be accessed by BACKUP, COPY, and EXPORT commands.

Disabled by default for backward compatibility in embedded mode. MUST be enabled for server mode with untrusted clients.

Fields§

§enabled: bool

If true, file operations are restricted to allowed_paths. If false, all paths are allowed (NOT RECOMMENDED for server mode).

§allowed_paths: Vec<PathBuf>

List of allowed base directories for file operations. Paths must be absolute and canonical. File operations are only allowed within these directories.

Implementations§

Source§

impl FileSandboxConfig

Source

pub fn sandboxed(paths: Vec<PathBuf>) -> Self

Creates a sandboxed config that only allows operations in the specified directories.

Source

pub fn default_for_mode(mode: DeploymentMode) -> Self

Creates a config with appropriate defaults for the deployment mode.

§Security
  • Embedded mode: Sandbox disabled (host application controls access)
  • Server mode: Sandbox enabled with default paths /var/lib/uni/data and /var/lib/uni/backups

CWE-22 (Path Traversal): Server deployments MUST enable the sandbox to prevent arbitrary file read/write via BACKUP, COPY, and EXPORT commands.

Source

pub fn security_warning(&self) -> Option<&'static str>

Returns a security warning message if the sandbox is disabled.

Call this at startup to alert administrators about potential security risks. Returns Some(message) if a warning should be displayed, None otherwise.

§Security

CWE-22 (Path Traversal), CWE-73 (External Control of File Name): Disabled sandbox allows unrestricted filesystem access for BACKUP, COPY, and EXPORT commands, which can lead to:

  • Arbitrary file read/write in server deployments
  • Data exfiltration to attacker-controlled paths
  • Potential privilege escalation via file overwrites
§Example
if let Some(warning) = config.file_sandbox.security_warning() {
    tracing::warn!(target: "uni_db::security", "{}", warning);
}
Source

pub fn is_potentially_insecure(&self) -> bool

Returns whether the sandbox is in a potentially insecure state.

Returns true if the sandbox is disabled or enabled with no allowed paths.

Source

pub fn validate_path(&self, path: &str) -> Result<PathBuf, String>

Validate that a path is within the allowed sandbox. Returns Ok(canonical_path) if allowed, Err if not.

Trait Implementations§

Source§

impl Clone for FileSandboxConfig

Source§

fn clone(&self) -> FileSandboxConfig

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 FileSandboxConfig

Source§

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

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

impl Default for FileSandboxConfig

Source§

fn default() -> FileSandboxConfig

Returns the “default value” for a type. 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> 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<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