Struct kvarn::extensions::Extensions

pub struct Extensions { /* private fields */ }

Contains all extensions. See kvarn.org on extensions for more info.

Implementations

impl Extensions

pub fn with_disallow_cors(&mut self) -> &mut Self

Adds extensions to disallow all CORS requests. This is added when calling Extensions::new.

pub fn with_cors(&mut self, cors_settings: Arc<Cors>) -> &mut Self

Overrides the default handling (deny all) of CORS requests to be cors_settings.

See Cors for an example and more info.

impl Extensions

pub fn with_csp(&mut self, csp: Arc<Csp>) -> &mut Self

Sets the set of rules to handle CSP.

impl Extensions

pub fn empty() -> Self

Creates a empty Extensions.

It is strongly recommended to use Extensions::new() instead.

pub fn new() -> Self

Creates a new Extensions and adds a few essential extensions.

For now the following extensions are added. The number in parentheses is the priority.

• A Prime extension (-64) redirecting the user from <path>/ to <path>/index.html and <path>. to <path>.html. This was earlier part of parsing of the path, but was moved to an extension for consistency and performance; now /, index., and index.html is the same entity in cache.
• A Package extension (8) to set referrer-policy header to no-referrer for max security and privacy. This is only done when no other referrer-policy header has been set earlier in the response.
• A CORS extension to deny all CORS requests. See Self::with_cors for CORS management.
• A nonce implementation for easy nonce setup. (requires nonce feature).
• The default Csp which only allows requests from self and allows unsafe inline styles. This should to a large extent mitigate XSS.

pub fn with_uri_redirect(&mut self) -> &mut Self

Adds a prime extension to redirect Uris ending with . and /.

This routs the requests according to host::Options::folder_default and host::Options::extension_default. See respective documentation for more info.

pub fn with_no_referrer(&mut self) -> &mut Self

Adds a Package extension to set the referrer-policy to no-referrer for maximum privacy and security. This is added when calling Extensions::new.

pub fn with_http_to_https_redirect(&mut self) -> &mut Self

Available on crate feature https only.

Adds a Prepare and a Prime extension (with a priority of 4) which redirects requests using HTTP to HTTPS with a StatusCode::TEMPORARY_REDIRECT.

For more info about how it works, see the source of this function.

pub fn with_nonce(&mut self) -> &mut Self

Available on crate feature nonce only.

Adds a Present extension triggered by the internal extension nonce which adds nonce tags to all scripts with nonce= tags. You MUST NOT have server caching enabled.

This integrates with your csp - if any nonce extension is added, the corresponding information is added to the content-security-policy header.

See kvarn.org for more details.

pub fn add_prime(&mut self, extension: Prime, id: Id)

Adds a Prime extension.

pub fn remove_prime(&mut self, id: Id)

Removes the Prime extension (if any) with id.

pub fn get_prime(&self) -> &[(Id, Prime)]

Get a reference to the Prime extensions.

pub fn add_prepare_single(&mut self, path: impl AsRef<str>, extension: Prepare)

Adds a Prepare extension for a single URI.

pub fn remove_prepare_single(&mut self, path: impl AsRef<str>)

Removes the Prepare extension (if any) at path.

pub fn get_prepare_single(&self) -> &HashMap<String, Prepare>

Get a reference to the Prepare extensions bound to a path.

pub fn add_prepare_fn(&mut self, predicate: If, extension: Prepare, id: Id)

Adds a Prepare extension run if function return true. Higher Id::priority() extensions are ran first.

pub fn remove_prepare_fn(&mut self, id: Id)

Removes the Prepare extension (if any) with id.

pub fn get_prepare_fn(&self) -> &[(Id, If, Prepare)]

Get a reference to the Prepare extensions using predicates.

pub fn add_present_internal(
    &mut self,
    name: impl AsRef<str>,
    extension: Present
)

Adds a Present internal extension, called with files starting with !> .

pub fn remove_present_internal(&mut self, path: impl AsRef<str>)

Removes the Present internal extension (if any) at path.

pub fn get_present_internal(&self) -> &HashMap<String, Present>

Get a reference to the Present internal extensions bound to a path.

pub fn add_present_file(&mut self, name: impl AsRef<str>, extension: Present)

Adds a Present file extension, called with file extensions matching name.

pub fn remove_present_file(&mut self, path: impl AsRef<str>)

Removes the Present file extension (if any) at path.

pub fn get_present_file(&self) -> &HashMap<String, Present>

Get a reference to the Present file extensions bound to a path.

pub fn add_package(&mut self, extension: Package, id: Id)

Adds a Package extension, used to make last-minute changes to response. Higher Id::priority() extensions are ran first.

pub fn remove_package(&mut self, id: Id)

Removes the Package extension (if any) with id.

pub fn get_package(&self) -> &[(Id, Package)]

Get a reference to the Package extensions.

pub fn add_post(&mut self, extension: Post, id: Id)

Adds a Post extension, used for HTTP/2 push Higher Id::priority() extensions are ran first.

pub fn remove_post(&mut self, id: Id)

Removes the Post extension (if any) with id.

pub fn get_post(&self) -> &[(Id, Post)]

Get a reference to the Package extensions.

Trait Implementations

impl Debug for Extensions

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

Formats the value using the given formatter.

impl Default for Extensions

fn default() -> Self

Returns the “default value” for a type.