Struct rocket_cgi::CGIDir

pub struct CGIDir { /* private fields */ }

Custom handler to execute CGIScripts

This handler will execute any script within the directory

Implementations

impl CGIDir

pub fn new(path: impl Into<PathBuf>) -> Self

Generate a CGI script from the associated path

Examples found in repository

examples/cgi.rs (line 9)

async fn rocket() -> _ {
    Rocket::build().mount("/a", CGIDir::new("examples/"))
}

pub fn clear_file_types(self) -> Self

Clear file type associations, and disables directly running executables

pub fn add_file_type(
    self,
    extension: impl Into<Cow<'static, str>>,
    executable: impl Into<Cow<'static, Path>>
) -> Self

Add a file type association for executing a file

pub fn only_perl(self) -> Self

Only allow executing perl scripts

pub fn only_python(self) -> Self

Only allow executing python scripts

pub fn only_sh(self) -> Self

Only allow executing python scripts

pub fn shell_interpreter(self, executable: impl Into<Cow<'static, Path>>) -> Self

Sets the shell interpreter

Default is sh

pub fn add_windows_scripts(self) -> Self

Adds default Windows Shell Script types:

• cmd.exe: .cmd, .bat
• powershell.exe: .ps1
• cscript.exe: .wsf, .vbs, .js

pub fn direct_executables(self, allow: bool) -> Self

Whether to allow directly executable files. This may allow scripts with execute permissions and a shebang (#!) to be executed, on some systems.

The CGI spec requires this to be false, which is the default

pub fn unencoded_equals(self, allow: bool) -> Self

Whether to pass parameters that contain unencoded =

The CGI spec requires this to be false, which is the default

pub fn dot_files(self, allow: bool) -> Self

Whether to allow serving unix hidden files (files starting with a .)

Defaults to false

pub fn hidden_files(self, allow: bool) -> Self

Whether to allow serving hidden files

Defaults to false, only applies to Windows

pub fn setuid_files(self, allow: bool) -> Self

Whether to allow serving files with setuid & setgid bits set

Defaults to false, only has an effect on Unix systems. Note this does not prevent a script from executing a setuid bit binary, but rather only protects against Rocket starting a setuid binary

Trait Implementations

impl Clone for CGIDir

fn clone(&self) -> CGIDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CGIDir

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

Formats the value using the given formatter.

impl Handler for CGIDir

fn handle<'r, 'life0, 'life1, 'async_trait>(
    &'life0 self,
    request: &'r Request<'life1>,
    data: Data<'r>
) -> Pin<Box<dyn Future<Output = Outcome<'r>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'r: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Called by Rocket when a Request with its associated Data should be handled by this handler.

impl Into<Vec<Route, Global>> for CGIDir

fn into(self) -> Vec<Route>

Converts this type into the (usually inferred) input type.

impl PartialEq<CGIDir> for CGIDir

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CGIDir

impl StructuralEq for CGIDir

impl StructuralPartialEq for CGIDir