Struct telescope::web::services::auth::identity::AuthenticationCookie

pub struct AuthenticationCookie {
    pub root: RootIdentity,
    pub github: Option<GitHubIdentity>,
    pub discord: Option<DiscordIdentity>,
}

The top level object stored in the identity cookie.

Fields

root: RootIdentity

The root authenticated identity. This identity must always exist.

github: Option<GitHubIdentity>

An optional GitHub access token.

discord: Option<DiscordIdentity>

An optional Discord access and refresh token.

Implementations

impl AuthenticationCookie

pub async fn refresh(self) -> Result<Self, TelescopeError>

If necessary, refresh an identity cookie. This could include getting a new access token from an OAuth API for example.

pub async fn get_user_id(&self) -> Result<Option<Uuid>, TelescopeError>

Get the RCOS user ID of an authenticated user. This is the same as just getting the RCOS user ID of the root identity.

pub async fn get_user_id_or_error(&self) -> Result<Uuid, TelescopeError>

Get the authenticated user’s RCOS user ID via the root identity or throw an internal server error.

pub fn get_discord(&self) -> Option<&DiscordIdentity>

Get discord credentials if authenticated.

pub fn get_github(&self) -> Option<&GitHubIdentity>

Get the github credentials if authenticated.

pub async fn get_rcs_id(&self) -> Result<Option<String>, TelescopeError>

Get the RCS ID of the authenticated user. Error if there is not an account associated with this authentication cookie or if there is an issue communicating with the RCOS API. Return Ok(None) if there is an account but RPI CAS is not linked.

fn replace_root_with_github(&mut self) -> bool

Try to replace the root identity with the secondary GitHub identity. Return true on success.

fn replace_root_with_discord(&mut self) -> bool

Try to replace the root identity with the discord token. Return true on success. See Self::replace_root_with_github.

async fn replace_root_with_rpi_cas(&mut self) -> Result<bool, TelescopeError>

Try to get the user’s RCS id from the RCOS database and replace the root identity with it. Return true on success.

async fn remove_root(&mut self) -> Result<bool, TelescopeError>

Try to remove the root identity from this authentication cookie and replace it with one of the secondary ones. Return false if there is no secondary cookie to replace the root. This may try to access the RCOS API to look for an RCS ID to replace the root.

If the root can successfully be replaced, return true.

pub async fn remove_platform(
    &mut self,
    platform: UserAccountType
) -> Result<bool, TelescopeError>

Try to remove a specific platform’s identity and authentication from this cookie. This is similar to Self::remove_root.

Trait Implementations

impl Clone for AuthenticationCookie

fn clone(&self) -> AuthenticationCookie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticationCookie

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthenticationCookie

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromRequest for AuthenticationCookie

type Error = TelescopeError

The associated error which can be returned.

type Future = LocalBoxFuture<'static, Result<Self, Self::Error>>

Future that resolves to a Self

type Config = ()

Configuration for this extractor

fn from_request(
    req: &HttpRequest,
    _: &mut Payload<PayloadStream>
) -> Self::Future

Convert request to a Self

fn extract(req: &HttpRequest) -> Self::Future

Convert request to a Self

fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.

impl Serialize for AuthenticationCookie

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

Serialize this value into the given Serde serializer.