Struct PermissionsPolicy 

pub struct PermissionsPolicy { /* private fields */ }

A Permissions-Policy header, built feature by feature, and the layer that sends it.

Rails’ permissions_policy initializer: it turns browser features (camera, microphone, geolocation, …) off for the app and for the frames it embeds. Add it with .layer(policy); like ContentSecurityPolicy, a handler’s own header wins, so routes can override it.

In allowlists, SELF (or "self") and "*" are keywords; other entries are origins, quoted in the header.

Free plan

One header per response; no binding call.

Examples

use axum::{Router, routing::get};
use ocre::security::{PermissionsPolicy, SELF};

let policy = PermissionsPolicy::new()
    .deny(&["camera", "microphone", "geolocation"])
    .allow("fullscreen", &[SELF, "https://player.example"]);
assert_eq!(
    policy.header_value(),
    r#"camera=(), microphone=(), geolocation=(), fullscreen=(self "https://player.example")"#
);

let app: Router = Router::new().route("/", get(|| async { "home" })).layer(policy);

Implementations

impl PermissionsPolicy

pub fn new() -> Self

An empty policy: add features with allow and deny.

Examples

assert_eq!(ocre::security::PermissionsPolicy::new().header_value(), "");

pub fn allow(self, feature: &str, allowlist: &[&str]) -> Self

Allows feature for the listed origins only; replaces a previous rule for it.

Examples

use ocre::security::{PermissionsPolicy, SELF};

assert_eq!(PermissionsPolicy::new().allow("geolocation", &[SELF]).header_value(), "geolocation=(self)");
assert_eq!(PermissionsPolicy::new().allow("autoplay", &["*"]).header_value(), "autoplay=*");

pub fn deny(self, features: &[&str]) -> Self

Turns features off everywhere: camera=().

Examples

use ocre::security::PermissionsPolicy;

assert_eq!(PermissionsPolicy::new().deny(&["camera", "usb"]).header_value(), "camera=(), usb=()");

pub fn header_value(&self) -> String

The header value.

Examples

let policy = ocre::security::PermissionsPolicy::new().deny(&["payment"]);
assert_eq!(policy.header_value(), "payment=()");

Trait Implementations

impl Clone for PermissionsPolicy

fn clone(&self) -> PermissionsPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PermissionsPolicy

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

Formats the value using the given formatter.

impl Default for PermissionsPolicy

fn default() -> PermissionsPolicy

Returns the “default value” for a type.

impl Eq for PermissionsPolicy

impl<S> Layer<S> for PermissionsPolicy

type Service = PolicyService<S, PermissionsPolicy>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

impl PartialEq for PermissionsPolicy

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PermissionsPolicy