ic-auth 0.25.0

Portable authentication, delegation proof verification and local session machinery
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use super::SessionError;
use ic_auth_protocol_types::ScopeLabel;

/// Immutable scope requirements selected by a protected application operation.
/// Validate once at configuration/operation setup and reconstruct after decoding.
/// This proves grammar and bounds only: every call still checks the current
/// authority, session, revocation and scope membership. Empty sets, duplicates
/// and arbitrary order are accepted, as with raw operation requirements.
/// Requirements cannot be edited without re-admission:
/// ```compile_fail
/// use ic_auth::session::RequiredScopes;
/// fn change(scopes: &mut RequiredScopes) {
///     scopes.as_slice()[0].clear();
/// }
/// ```
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RequiredScopes(Vec<ScopeLabel>);

impl RequiredScopes {
    /// No operation-specific scopes; all other authorization checks still apply.
    pub const NONE: &'static Self = &Self(Vec::new());

    pub fn new(scopes: Vec<String>) -> Result<Self, SessionError> {
        if scopes.len() > crate::limits::MAX_SESSION_SCOPES {
            return Err(SessionError::InvalidPolicyOrRecord);
        }
        let scopes =
            ScopeLabel::from_strings(scopes).map_err(crate::canonical::CanonicalAuthError::from)?;
        Ok(Self(scopes))
    }

    pub fn as_slice(&self) -> &[ScopeLabel] {
        &self.0
    }
}