Struct AifEncodedScope 

pub struct AifEncodedScope(/* private fields */);

A scope encoded using the Authorization Information Format (AIF) for ACE.

More specifically, this uses the specific instantiation of AIF intended for REST resources which are identified by URI paths, as described in RFC 9237, section 2.1. An AIF-encoded scope consists of AifEncodedScopeElements, each describing a URI path (the object of the scope) and a set of REST methods (the permissions of the scope).

Note that the libdcaf implementation uses a format in which only a single AifEncodedScopeElement is used in the scope. To use this format, please use the LibdcafEncodedScope instead.

Example

For example, say you want to create a scope consisting of two elements:

• A scope for the local path /restricted, consisting only of “read-only” methods GET and FETCH.
• A scope for the local path /unrestricted, allowing every method.

This would look like the following:

let restricted = AifEncodedScopeElement::new("restricted", AifRestMethod::Get | AifRestMethod::Fetch);
let unrestricted = AifEncodedScopeElement::new("unrestricted", AifRestMethodSet::all());
let scope = AifEncodedScope::new(vec![restricted, unrestricted]);
assert_eq!(scope.elements(), &vec![restricted, unrestricted])

Encoding

The scope from the example above would be encoded like this (given in JSON):

[["restricted", 17], ["unrestricted", 545460846719]]

As specified in RFC 9237, section 3, GET to iPATCH are encoded from 2⁰ to 2⁶, while the dynamic variants go from 2³² to 2³⁸. This is why in restricted, the number equals 17 (2⁰ + 2⁴), and in unrestricted equals the sum of all these numbers. AifRestMethod does the work on this (including encoding and decoding bitmasks given as numbers), clients do not need to handle this themselves and can simply use its methods together with the methods provided by AifRestMethodSet.

Implementations

impl AifEncodedScope

pub fn new(elements: Vec<AifEncodedScopeElement>) -> AifEncodedScope

Creates a new AifEncodedScope consisting of the given elements.

pub fn elements(&self) -> &Vec<AifEncodedScopeElement>

Returns a reference to the AifEncodedScopeElements of this scope.

Example

let first = AifEncodedScopeElement::new("first", AifRestMethodSet::empty());
let second = AifEncodedScopeElement::new("second", AifRestMethod::Patch);
// We only clone here for the assert call below. This is usually not required.
let scope = AifEncodedScope::new(vec![first.clone(), second.clone()]);
assert_eq!(scope.elements(), &vec![first, second]);

pub fn to_elements(self) -> Vec<AifEncodedScopeElement>

Returns the AifEncodedScopeElements of this scope.

Example

let first = AifEncodedScopeElement::new("first", AifRestMethodSet::empty());
let second = AifEncodedScopeElement::new("second", AifRestMethod::Patch);
// We only clone here for the assert call below. This is usually not required.
let scope = AifEncodedScope::new(vec![first.clone(), second.clone()]);
assert_eq!(scope.to_elements(), vec![first, second]);

Trait Implementations

impl Clone for AifEncodedScope

fn clone(&self) -> AifEncodedScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AifEncodedScope

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

Formats the value using the given formatter.

impl From<AifEncodedScope> for Scope

fn from(value: AifEncodedScope) -> Self

Converts to this type from the input type.

impl<T> From<Vec<(T, BitFlags<AifRestMethod>)>> for AifEncodedScope

where T: Into<String>,

fn from(value: Vec<(T, BitFlags<AifRestMethod>)>) -> Self

Converts to this type from the input type.

impl Hash for AifEncodedScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AifEncodedScope

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for AifEncodedScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Scope> for AifEncodedScope

type Error = WrongSourceTypeError<Scope>

The type returned in the event of a conversion error.

fn try_from(value: Scope) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, u64)>> for AifEncodedScope

type Error = InvalidAifEncodedScopeError

The type returned in the event of a conversion error.

fn try_from(value: Vec<(String, u64)>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for AifEncodedScope

impl StructuralPartialEq for AifEncodedScope