Skip to main content

Session

Struct Session 

Source
pub struct Session { /* private fields */ }
Expand description

An active security context combining identity and privilege.

A Session represents the current state of an actor in the system:

§Immutability

Sessions are immutable value types. Methods like elevate and drop_privilege return new sessions rather than modifying the existing one. This enables:

  • Safe sharing across threads
  • Clear audit trails (old session vs new session)
  • Simple Clone

§Dynamic Permissions

Dynamic command permissions (grant/revoke) are managed separately via GrantPolicy, not by Session. Session only carries identity and privilege level.

§Why No Default?

DO NOT implement Default for Session.

A session requires a valid Principal. There is no sensible default identity. Always construct with Session::new.

§Example

use orcs_auth::{Session, PrivilegeLevel};
use orcs_types::{Principal, PrincipalId};
use std::time::Duration;

// Create a session for a user
let user = Principal::User(PrincipalId::new());
let session = Session::new(user);

// Check current state
assert!(!session.is_elevated());

// Elevate for privileged operations
let elevated = session.elevate(Duration::from_secs(300));
assert!(elevated.is_elevated());

// Drop back to standard when done
let standard = elevated.drop_privilege();
assert!(!standard.is_elevated());

Implementations§

Source§

impl Session

Source

pub fn new(principal: Principal) -> Session

Creates a new session with Standard privilege level.

All sessions start in Standard mode. Use elevate to gain elevated privileges.

§Example
use orcs_auth::Session;
use orcs_types::{Principal, PrincipalId};

let session = Session::new(Principal::User(PrincipalId::new()));
assert!(!session.is_elevated());
Source

pub fn principal(&self) -> &Principal

Returns a reference to the principal.

Source

pub fn privilege(&self) -> &PrivilegeLevel

Returns a reference to the current privilege level.

Source

pub fn is_elevated(&self) -> bool

Returns true if currently elevated (and not expired).

§Example
use orcs_auth::Session;
use orcs_types::{Principal, PrincipalId};
use std::time::Duration;

let session = Session::new(Principal::User(PrincipalId::new()));
assert!(!session.is_elevated());

let elevated = session.elevate(Duration::from_secs(60));
assert!(elevated.is_elevated());
Source

pub fn elevate(&self, duration: Duration) -> Session

Returns a new session with elevated privileges.

The elevation lasts for the specified duration, after which the session automatically behaves as Standard.

§Arguments
  • duration - How long the elevation should last
§Example
use orcs_auth::Session;
use orcs_types::{Principal, PrincipalId};
use std::time::Duration;

let session = Session::new(Principal::User(PrincipalId::new()));

// Elevate for 5 minutes
let elevated = session.elevate(Duration::from_secs(300));
assert!(elevated.is_elevated());

// Original session is unchanged
assert!(!session.is_elevated());
Source

pub fn drop_privilege(&self) -> Session

Returns a new session with Standard privilege level.

Use this to explicitly drop elevated privileges before the automatic expiration.

§Example
use orcs_auth::Session;
use orcs_types::{Principal, PrincipalId};
use std::time::Duration;

let session = Session::new(Principal::User(PrincipalId::new()));
let elevated = session.elevate(Duration::from_secs(300));

// Explicitly drop privileges
let standard = elevated.drop_privilege();
assert!(!standard.is_elevated());
Source

pub fn remaining_elevation(&self) -> Option<Duration>

Returns the remaining elevation time, or None if not elevated.

Trait Implementations§

Source§

impl Clone for Session

Source§

fn clone(&self) -> Session

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Session

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Session

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more