pubky 0.11.0

Pubky SDK
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
36
37
38
39
40
41
42
43

//! Minimal, auth-agnostic session metadata.

use pubky_common::{capabilities::Capability, crypto::PublicKey};

/// Minimal, auth-agnostic session metadata.
///
/// Carries only the fields that every credential type can produce and that
/// callers actually consume: the user's public key and the capabilities
/// granted to the session.
///
/// Credential-specific details live behind the capability views:
/// - Grant: [`GrantSessionInfo`](pubky_common::auth::grant_session_responses::GrantSessionInfo)
///   via `session.as_grant().session_info()`
/// - Cookie: [`CookieSessionRecord`](pubky_common::session::CookieSessionRecord)
///   via `session.as_cookie().session_info()`
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct SessionInfo {
    public_key: PublicKey,
    capabilities: Vec<Capability>,
}

impl SessionInfo {
    /// Create a new minimal session info.
    #[must_use]
    pub fn new(public_key: PublicKey, capabilities: Vec<Capability>) -> Self {
        Self {
            public_key,
            capabilities,
        }
    }

    /// Returns the public key this session authorizes for.
    #[must_use]
    pub fn public_key(&self) -> &PublicKey {
        &self.public_key
    }

    /// Returns the capabilities this session provides.
    #[must_use]
    pub fn capabilities(&self) -> &[Capability] {
        &self.capabilities
    }
}