Struct telescope::web::services::auth::rpi_cas::RpiCas

pub struct RpiCas;

Zero-Sized struct representing the RPI CAS identity provider

Trait Implementations

impl IdentityProvider for RpiCas

const SERVICE_NAME: &'static str

The lowercase, one word name of the service. This is used in generating redirect paths and registering the service with actix. It must be unique.

const USER_ACCOUNT_TY: UserAccountType

The type of user account represented by this authentication service.

type LoginResponse = HttpResponse

The type used to respond to login requests.

type RegistrationResponse = HttpResponse

The type used to respond to registration requests.

type LinkResponse = Result<HttpResponse, TelescopeError>

The type used to respond to account linking requests.

type LoginFut = Ready<Self::LoginResponse>

The type of future returned by the login handler.

type RegistrationFut = Ready<Self::RegistrationResponse>

The type of the future returned by the registration handler.

type LinkFut = LocalBoxFuture<'static, Self::LinkResponse>

The type of the future returned by the account linking handler.

type LoginAuthenticatedFut = LocalBoxFuture<'static, Result<HttpResponse, TelescopeError>>

The type of future returned by the login authenticated response handler.

type RegistrationAuthenticatedFut = LocalBoxFuture<'static, Result<HttpResponse, TelescopeError>>

The type of future returned by the registration authenticated response handler.

type LinkAuthenticatedFut = LocalBoxFuture<'static, Result<HttpResponse, TelescopeError>>

The type of future returned by the registration authenticated response handler.

fn login_handler(req: HttpRequest) -> Self::LoginFut

Actix-web handler for the route that redirects to authentication for login. Guarded by this trait to GET requests.

fn registration_handler(req: HttpRequest) -> Self::RegistrationFut

Actix-web handler for the route that redirects to authentication for account creation (user registration). Guarded by this trait to GET requests.

fn link_handler(req: HttpRequest, ident: Identity) -> Self::LinkFut

Actix-web handler for the route that redirects to the authentication provider to link an account.

fn login_authenticated_handler(req: HttpRequest) -> Self::LoginAuthenticatedFut

Actix-web handler for authentication callback to login. Guarded by this trait to GET requests.

fn registration_authenticated_handler(
    req: HttpRequest
) -> Self::RegistrationAuthenticatedFut

Actix-web handler for authentication callback to account creation. Guarded by this trait to GET requests.

fn linking_authenticated_handler(
    req: HttpRequest,
    ident: Identity
) -> Self::LinkAuthenticatedFut

Actix-web handler

fn login_path() -> String

Get the login path of this service. This is the route in actix that will redirect to the authorization page using the handler function also defined in this trait.

fn register_path() -> String

Get the registration path of this service. This is the route in actix that will redirect to the authorization page using the handler also defined by this trait. This is similar to Self::login_path but is for account registration rather than sign in.

fn link_path() -> String

The path to link this identity service. This is similar to the other two, but is intended to be used to link an existing account.

fn unlink_path() -> String

The path to unlink this service from the user’s account.

fn login_redirect_path() -> String

The path for the identity provider to redirect back to after authenticating a user for login. This path is also registered under actix with the authentication callback handler defined by this trait.

fn registration_redirect_path() -> String

The path for the identity provider to redirect back to after authenticating a user for account creation. This path is also registered under actix with the authentication callback handler defined by this trait.

fn link_redirect_path() -> String

The path to redirect back to after account linking success. This is similar to the login and registration authenticated redirect paths.

fn register_services(config: &mut ServiceConfig)

Register the necessary actix services to support this identity provider.

fn unlink_handler(
    id: Identity,
    cookie: AuthenticationCookie
) -> LocalBoxFuture<'static, Result<HttpResponse, TelescopeError>>

Actix-web handler for the route that unlinks an identity service.