cageforge-command 0.3.0

Validated command, environment, and stdio requests for Rust sandboxes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

// SPDX-License-Identifier: Apache-2.0

//! Typed construction errors shared by [`crate::CommandSpec`],
//! [`crate::EnvironmentSpec`], and [`crate::CommandRequest`].

use std::path::PathBuf;

use crate::EnvironmentBase;
use thiserror::Error;

/// Errors raised while constructing a portable command request.
#[derive(Debug, Error, Clone, PartialEq, Eq)]
pub enum CommandError {
    /// The command program was empty.
    #[error("command program must not be empty")]
    EmptyProgram,
    /// The command program contained a NUL character.
    #[error("command program must not contain a NUL character")]
    ProgramContainsNul,
    /// A command argument contained a NUL character.
    #[error("command argument must not contain a NUL character")]
    ArgumentContainsNul,
    /// The working-directory path was empty.
    #[error("working directory must not be empty")]
    EmptyWorkingDirectory,
    /// The working-directory path contained a NUL character.
    #[error("working directory must not contain a NUL character")]
    WorkingDirectoryContainsNul,
    /// The working-directory path contained a parent traversal component.
    #[error(
        "working directory must not contain parent traversal: {}",
        path.display()
    )]
    WorkingDirectoryParentTraversal {
        /// The working-directory path that attempted parent traversal.
        path: PathBuf,
    },
    /// An environment variable name was empty.
    #[error("environment variable name must not be empty")]
    EmptyEnvironmentName,
    /// An environment variable name contained `=`.
    #[error("environment variable name must not contain '='")]
    EnvironmentNameContainsEquals,
    /// An environment variable name contained a NUL character.
    #[error("environment variable name must not contain a NUL character")]
    EnvironmentNameContainsNul,
    /// An environment variable value contained a NUL character.
    #[error("environment variable value must not contain a NUL character")]
    EnvironmentValueContainsNul,
    /// An environment-variable filter pattern was empty.
    #[error("environment variable pattern must not be empty")]
    EmptyEnvironmentPattern,
    /// An environment-variable filter pattern contained a NUL character.
    #[error("environment variable pattern must not contain a NUL character")]
    EnvironmentPatternContainsNul,
    /// An environment-variable filter pattern contained `=`.
    #[error("environment variable pattern must not contain '='")]
    EnvironmentPatternContainsEquals,
    /// The supplied environment snapshot is broader than this specification's base.
    #[error("environment input base {supplied:?} is broader than required base {required:?}")]
    EnvironmentBaseTooPermissive {
        /// The base requested by this specification.
        required: EnvironmentBase,
        /// The base represented by the supplied variables.
        supplied: EnvironmentBase,
    },
}