Struct scratchstack_aspen::Policy

pub struct Policy { /* private fields */ }

The top-level structure for holding an Aspen policy.

This does not directly derive Deserialize/Serialize to prevent serde from allowing this to be represented as an array.

Policy structures are immutable after creation.

Implementations

impl Policy

pub fn builder() -> PolicyBuilder

Returns a builder for a Policy.

pub fn version(&self) -> PolicyVersion

Returns the policy version.

pub fn id(&self) -> Option<&str>

Returns the user-specified identifier for the policy, or None if no identifier was specified.

pub fn statement(&self) -> &StatementList

Returns the policy statements associated with the policy.

pub fn evaluate(&self, context: &Context) -> Result<Decision, AspenError>

Evaluates the policy against the request Context.

Returns Decision::Deny if the policy denies the request, Decision::Allow if the policy allows the request, or Decision::DefaultDeny if the policy does not explicitly allow or deny the request.

Example

let action = Action::from_str("s3:ListBucket").unwrap();
let resource = Resource::from_str("arn:aws:s3:::examplebucket").unwrap();
let statement = Statement::builder().effect(Effect::Allow).action(action).resource(resource).build().unwrap();
let policy = Policy::builder().statement(statement).build().unwrap();

let actor = Principal::from(vec![User::from_str("arn:aws:iam::123456789012:user/exampleuser").unwrap().into()]);
let context = Context::builder().service("s3").api("ListBucket").actor(actor)
    .session_data(SessionData::new()).build().unwrap();
policy.evaluate(&context);

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Policy

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Policy, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Policy

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

Formats the value using the given formatter.

impl FromStr for Policy

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Policy> for Policy

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Policy

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Policy

impl StructuralEq for Policy

impl StructuralPartialEq for Policy