Struct SecurityPlugin 

pub struct SecurityPlugin { /* private fields */ }

CSRF + security-headers plugin. Configure via SecurityConfig.

Implementations

impl SecurityPlugin

pub fn new() -> Self

Secure, dev-safe defaults (see SecurityConfig).

pub fn with_config(config: SecurityConfig) -> Self

Construct from an explicit config — the preferred entry point.

pub fn production_hardened() -> Self

The production-hardening preset — HSTS + a strict CSP + CORP + Secure CSRF cookie in one call. See SecurityConfig::production_hardened for exactly what it flips.

pub fn config(&self) -> &SecurityConfig

Borrow the active config.

pub fn with_hsts(self, hsts: bool) -> Self

One-flag convenience for SecurityConfig::hsts. Equivalent to with_config(SecurityConfig { hsts, ..Default::default() }).

pub fn csrf_exempt<I, S>(self, paths: I) -> Self

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

Exempt path prefixes from CSRF protection — the chainable shorthand for the single most common security config (gaps4 #41). Every token-authenticated or POST-only-transport surface needs it (/api, /graphql), and before this every app performed the with_config(SecurityConfig { csrf_exempt_paths: vec![...], ..Default::default() }) struct-update ceremony to say so.

Appends to (never replaces) previously configured exemptions, so it composes with with_config and with repeated calls:

SecurityPlugin::new().csrf_exempt(["/api", "/graphql"])

Exempting a prefix is safe exactly when nothing under it relies on cookie/session auth — bearer-token and explicitly-CORS’d JSON APIs qualify; HTML form routes never do.

Trait Implementations

impl Clone for SecurityPlugin

fn clone(&self) -> SecurityPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityPlugin

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

Formats the value using the given formatter.

impl Default for SecurityPlugin

fn default() -> SecurityPlugin

Returns the “default value” for a type.

impl Plugin for SecurityPlugin

fn name(&self) -> &'static str

A stable identifier. Used as the key in the migration tracking table, in dependency lists, and as the directory name under migrations/. Plugin names live in the same namespace as migrate::APP_PLUGIN_NAME ("app"), so user crates must not pick the name "app".

fn wrap_router(&self, router: Router) -> Router

Wrap the app router with the plugin’s middleware layers.

fn on_ready(&self, _ctx: &AppContext) -> Result<(), PluginError>

Wire signals, start background work, seal admin registrations. Called after phase 4 (system checks) passes, in topological dependency order. Sync, on purpose; spawn async work via ctx.runtime() when the runtime handle lands.

fn dependencies(&self) -> &'static [&'static str]

Names of plugins that must load before this one. The App::builder() topological sort uses this; cycles surface as BuildError::PluginCycle. The default is no dependencies.

fn models(&self) -> Vec<ModelMeta>

The plugin’s models, in declaration order. The M7 migration engine collects these across every registered plugin and uses them as the diff target for makemigrations.

fn routes(&self) -> Router

The plugin’s HTTP routes. Merged into the app router after the hand-written one passed to AppBuilder::routes(). Plugins choose their own path prefixes (spec 02 §“What a plugin can contribute”: routes are flat, not auto-prefixed).

fn routes_builder(&self) -> Option<Routes>

The drift-free alternative to routes + route_paths (gaps4 #31): mount routes through the recording Routes builder and the framework takes BOTH the axum router and the declared RouteSpecs from that ONE source, so the route registry can never fall out of sync with what’s mounted.

fn route_paths(&self) -> Vec<RouteSpec>

Declared URL routes this plugin contributes — a companion to routes used for surfacing route lists outside the request flow (currently: the dev-mode default 404 page). axum doesn’t expose its internal route table, so plugins report what they declare here; the framework treats this as informational only — not a source of truth for routing.

fn openapi_paths(&self) -> Vec<(String, Value)>

OpenAPI path items the plugin contributes. Returned as a Vec<(path, value)> where path is the URL template (/api/auth/login, /api/foo/{id}) and value is the matching OpenAPI 3.0 Path Item Object serialised as a serde_json::Value.

fn system_checks(&self) -> Vec<SystemCheck>

Boot-time checks the plugin needs to pass. Run in phase 4 of App::build() alongside the framework’s built-in checks. Severity::Error blocks boot; Severity::Warning logs and continues.

fn provides_storage(&self) -> bool

true if this plugin registers a Storage backend (e.g. StoragePlugin, which calls crate::storage::set_storage in Plugin::on_ready).

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

The database alias every model this plugin contributes should be read from and written to. Returns None to use the "default" pool (the same one umbral::db::pool() returns).

fn templates_dirs(&self) -> Vec<PathBuf>

Template directories this plugin contributes.

fn template_registrars( &self, ) -> Vec<Box<dyn Fn(&mut Environment<'static>) + Send + Sync>>

Custom template tags / filters this plugin contributes (feature #67 - a loadable template tag/filter library).

fn middleware(&self) -> Vec<Arc<dyn Middleware>>

Framework-level request/response middleware this plugin contributes (feature #68).

fn static_files(&self) -> Vec<StaticFile>

Static files the plugin ships baked into its binary.

fn static_dirs(&self) -> Vec<StaticDir>

On-disk source directories this plugin contributes to the unified static pipeline.

fn static_root_dirs(&self) -> Vec<PathBuf>

On-disk directories served at the root of static_url — with no namespace segment.

fn commands(&self) -> Vec<Box<dyn PluginCommand>>

CLI subcommands the plugin contributes.

fn api_endpoints(&self) -> Vec<ApiEndpoint>

Callable HTTP endpoints this plugin wants advertised in a machine-readable index (e.g. a REST API root, or a client’s service-discovery fetch).