pub struct Oso { /* private fields */ }
Expand description
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
sourceimpl Oso
impl Oso
sourcepub fn new() -> Self
pub fn new() -> Self
Create a new instance of Oso. Each instance is separate and can have different rules and classes loaded into it.
sourcepub fn is_allowed<Actor, Action, Resource>(
&self,
actor: Actor,
action: Action,
resource: Resource
) -> Result<bool> where
Actor: ToPolar,
Action: ToPolar,
Resource: ToPolar,
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.
sourcepub fn get_allowed_actions<Actor, Resource, T>(
&self,
actor: Actor,
resource: Resource
) -> Result<HashSet<T>> where
Actor: ToPolar,
Resource: ToPolar,
T: FromPolar + Eq + Hash,
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)?;
sourcepub fn clear_rules(&mut self) -> Result<()>
pub fn clear_rules(&mut self) -> Result<()>
Clear out all files and rules that have been loaded.
sourcepub fn load_file<P: AsRef<Path>>(&mut self, filename: P) -> Result<()>
👎 Deprecated since 0.20.1: Oso::load_file
has been deprecated in favor of Oso::load_files
as of the 0.20 release.
Please see changelog for migration instructions: https://docs.osohq.com/project/changelogs/2021-09-15.html
pub fn load_file<P: AsRef<Path>>(&mut self, filename: P) -> Result<()>
Oso::load_file
has been deprecated in favor of Oso::load_files
as of the 0.20 release.
Please see changelog for migration instructions: https://docs.osohq.com/project/changelogs/2021-09-15.html
Load a file containing Polar rules. All Polar files must end in .polar
.
sourcepub fn load_files<P: AsRef<Path>>(&mut self, filenames: Vec<P>) -> Result<()>
pub fn load_files<P: AsRef<Path>>(&mut self, filenames: Vec<P>) -> Result<()>
Load files containing Polar rules. All Polar files must end in .polar
.
sourcepub fn query(&self, s: &str) -> Result<Query>
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");
sourcepub fn query_rule(&self, name: &str, args: impl ToPolarList) -> Result<Query>
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"}]);
sourcepub fn register_class(&mut self, class: Class) -> Result<()>
pub fn register_class(&mut self, class: Class) -> Result<()>
Register a rust type as a Polar class.
See [oso::Class
] docs.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Oso
impl Send for Oso
impl Sync for Oso
impl Unpin for Oso
impl !UnwindSafe for Oso
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more