Struct Request 

pub struct Request { /* private fields */ }

Authorization request under evaluation.

Implementations

impl Request

pub fn new() -> Self

Create an empty request.

Examples found in repository

examples/basic.rs (line 17)

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 15)

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 action(self, action: impl Into<String>) -> Self

Set the action verb for the request.

Examples found in repository

examples/basic.rs (line 18)

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 16)

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 actor_attr( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add an attribute that belongs to the actor (subject) performing the request.

Examples found in repository

examples/basic.rs (line 19)

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 17)

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 resource_attr( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add an attribute belonging to the resource being accessed.

Examples found in repository

examples/basic.rs (line 20)

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(())
}

pub fn environment_attr( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add an attribute describing the surrounding environment (time, IP, etc.).

pub fn action_name(&self) -> &str

Return the configured action, if any.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.