Struct oso::Oso

pub struct Oso { /* fields omitted */ }

Oso is the main struct you interact with. It is an instance of the Oso authorization library and contains the polar language knowledge base and query engine.

Implementations

impl Oso

pub fn new() -> Self

Create a new instance of Oso. Each instance is separate and can have different rules and classes loaded into it.

pub fn is_allowed<Actor, Action, Resource>(
    &self,
    actor: Actor,
    action: Action,
    resource: Resource
) -> Result<bool> where
    Actor: ToPolar,
    Action: ToPolar,
    Resource: ToPolar, 

High level interface for authorization decisions. Makes an allow query with the given actor, action and resource and returns true or false.

pub fn get_allowed_actions<Actor, Resource, T>(
    &self,
    actor: Actor,
    resource: Resource
) -> Result<HashSet<T>> where
    Actor: ToPolar,
    Resource: ToPolar,
    T: FromPolar + Eq + Hash, 

Get the actions actor is allowed to take on resource. Returns a std::collections::HashSet of actions, typed according the return value.

Examples

oso.load_str(r#"allow(actor: Actor{name: "sally"}, action, resource: Widget{id: 1}) if
              action in ["CREATE", "READ"];"#);

// get a HashSet of oso::Actions
let actions: HashSet<Action> = oso.get_allowed_actions(actor, resource)?;

// or Strings
let actions: HashSet<String> = oso.get_allowed_actions(actor, resource)?;

pub fn clear_rules(&self)

Clear out all files and rules that have been loaded.

pub fn load_file<P: AsRef<Path>>(&self, file: P) -> Result<()>

Load a file containing polar rules. All polar files must end in .polar

pub fn load_str(&self, s: &str) -> Result<()>

Load a string of polar source directly.

Examples

oso.load_str("allow(a, b, c) if true;");

pub fn query(&self, s: &str) -> Result<Query>

Query the knowledge base. This can be an allow query or any other polar expression.

Examples

oso.query("x = 1 or x = 2");

#[must_use = "Query that is not consumed does nothing."]

pub fn query_rule(&self, name: &str, args: impl ToPolarList) -> Result<Query>

Query the knowledge base but with a rule name and argument list. This allows you to pass in rust values.

Examples

oso.query_rule("is_admin", vec![User{name: "steve"}]);

pub fn register_class(&mut self, class: Class) -> Result<()>

Register a rust type as a Polar class. See [oso::Class] docs.

pub fn register_constant<V: ToPolar + Send + Sync>(
    &mut self,
    value: V,
    name: &str
) -> Result<()>

Register a rust type as a Polar constant. See [oso::Class] docs.

Trait Implementations

impl Clone for Oso

fn clone(&self) -> Oso

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Oso

fn default() -> Self

Returns the “default value” for a type.