Struct PolicyEngine 

pub struct PolicyEngine { /* private fields */ }

Implementations

impl PolicyEngine

pub fn new() -> Self

Create an empty engine that defaults to denying requests when no policy applies.

pub fn from_policies<I>(policies: I) -> Self

where I: IntoIterator<Item = Policy>,

Build an engine from an iterator of policies.

Examples found in repository

examples/basic.rs (line 15)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let policy = Policy::builder("document-read")
        .target(Target::action("document:read"))
        .condition(Condition::equals("resource.owner_id", "actor.id"))
        .effect(Effect::Permit)
        .build()?;

    let engine = PolicyEngine::from_policies([policy]);

    let request = Request::new()
        .action("document:read")
        .actor_attr("id", "user-123")
        .resource_attr("owner_id", "user-123");

    let decision = engine.evaluate(&request)?;
    println!("decision: {:?}", decision);
    assert_eq!(decision, Decision::Permit);

    Ok(())
}

examples/default_deny.rs (lines 10-13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Engine denies by default when no policy matches.
    let engine = PolicyEngine::from_policies([Policy::builder("allow-write")
        .target(Target::action("document:write"))
        .effect(Effect::Permit)
        .build()?]);

    let read_request = Request::new()
        .action("document:read")
        .actor_attr("id", "user-123");

    let decision = engine.evaluate(&read_request)?;
    println!("decision: {:?}", decision);
    assert_eq!(decision, Decision::Deny);

    // Override the default effect to allow unmatched requests.
    let permissive_engine = PolicyEngine::from_policies(Vec::<Policy>::new())
        .with_default_effect(Effect::Permit);

    let read_request = Request::new().action("document:read");
    let decision = permissive_engine.evaluate(&read_request)?;
    println!("permissive decision: {:?}", decision);
    assert_eq!(decision, Decision::Permit);

    Ok(())
}

pub fn with_default_effect(self, effect: Effect) -> Self

Set the default effect returned when no policy matches.

Examples found in repository

examples/default_deny.rs (line 25)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Engine denies by default when no policy matches.
    let engine = PolicyEngine::from_policies([Policy::builder("allow-write")
        .target(Target::action("document:write"))
        .effect(Effect::Permit)
        .build()?]);

    let read_request = Request::new()
        .action("document:read")
        .actor_attr("id", "user-123");

    let decision = engine.evaluate(&read_request)?;
    println!("decision: {:?}", decision);
    assert_eq!(decision, Decision::Deny);

    // Override the default effect to allow unmatched requests.
    let permissive_engine = PolicyEngine::from_policies(Vec::<Policy>::new())
        .with_default_effect(Effect::Permit);

    let read_request = Request::new().action("document:read");
    let decision = permissive_engine.evaluate(&read_request)?;
    println!("permissive decision: {:?}", decision);
    assert_eq!(decision, Decision::Permit);

    Ok(())
}

pub fn add_policy(&mut self, policy: Policy)

Add a policy to the engine.

pub fn evaluate(&self, request: &Request) -> Result<Decision>

Evaluate the request against the configured policies.

Examples found in repository

examples/basic.rs (line 22)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let policy = Policy::builder("document-read")
        .target(Target::action("document:read"))
        .condition(Condition::equals("resource.owner_id", "actor.id"))
        .effect(Effect::Permit)
        .build()?;

    let engine = PolicyEngine::from_policies([policy]);

    let request = Request::new()
        .action("document:read")
        .actor_attr("id", "user-123")
        .resource_attr("owner_id", "user-123");

    let decision = engine.evaluate(&request)?;
    println!("decision: {:?}", decision);
    assert_eq!(decision, Decision::Permit);

    Ok(())
}

examples/default_deny.rs (line 19)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Engine denies by default when no policy matches.
    let engine = PolicyEngine::from_policies([Policy::builder("allow-write")
        .target(Target::action("document:write"))
        .effect(Effect::Permit)
        .build()?]);

    let read_request = Request::new()
        .action("document:read")
        .actor_attr("id", "user-123");

    let decision = engine.evaluate(&read_request)?;
    println!("decision: {:?}", decision);
    assert_eq!(decision, Decision::Deny);

    // Override the default effect to allow unmatched requests.
    let permissive_engine = PolicyEngine::from_policies(Vec::<Policy>::new())
        .with_default_effect(Effect::Permit);

    let read_request = Request::new().action("document:read");
    let decision = permissive_engine.evaluate(&read_request)?;
    println!("permissive decision: {:?}", decision);
    assert_eq!(decision, Decision::Permit);

    Ok(())
}

Trait Implementations

impl Debug for PolicyEngine

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

Formats the value using the given formatter.

impl Default for PolicyEngine

fn default() -> Self

Returns the “default value” for a type.