Struct AuthClient

pub struct AuthClient { /* private fields */ }

C3A Authentication & Authorization Client.

Implementations

impl AuthClient

pub async fn new( app_name: impl ToString, app_keypair: SignKeypair, authnz_base_url: impl ToString, ) -> MResult<Self>

Create C3A client.

This method ensures that C3A server is alive by health check.

pub fn change_cookie_names(&mut self, new_names: [&'static str; 3])

Changes default cookie names.

pub fn change_challenge_header_names(&mut self, new_names: [&'static str; 3])

Changes default challenge header names.

pub async fn get_config(&mut self) -> MResult<AppAuthConfiguration>

Checks if the application exists in C3A server and returns application config.

pub async fn app_register( &self, invite: Invite, config: AppAuthConfiguration, ) -> MResult<()>

Registers the application with given invite code and config.

pub async fn update_config( &mut self, actual_config: &AppAuthConfiguration, ) -> MResult<()>

Edits appliaction config.

pub async fn force_register_user( &self, user_id: Id, flows: Vec<Vec<AdminAuthenticationStep>>, tags: &[impl Into<AccessTag> + Clone], ) -> MResult<()>

Registers an account without authentication flow approvals.

impl AuthClient

pub async fn prepare_sign_up( &self, login: Id, ) -> MResult<(PreregistrationRequirementsResponse, String)>

Prepares a user registration and returns requirements and registration state.

For successful registration you should provide given registration state in perform_sign_up method.

pub async fn perform_sign_up( &self, login: Id, state: String, authentication_flows: AuthenticationFlows, cli_pkey: Option<Vec<u8>>, cba_challenge_sign: Option<CBAChallengeSign>, ) -> MResult<TokenBundle>

Performs a user registration with given registration state and returns token triple for authorization.

pub async fn prepare_login(&self, login: Id) -> MResult<PrefetchLoginResponse>

Prepares a user authentication and returns login requirements.

pub async fn perform_login( &self, login: Id, authentication_flow: AuthenticationFlow, cli_pkey: Option<Vec<u8>>, cba_challenge_sign: Option<CBAChallengeSign>, ) -> MResult<TokenBundle>

Performs a user authentication and returns token triple for authorization.

pub async fn check_user_exists(&self, user_id: Id) -> MResult<()>

Checks if the user exists.

pub async fn get_user_tags(&self, user_id: Id) -> MResult<Vec<AccessTag>>

Gets user tags.

pub async fn edit_user_tags( &self, user_id: Id, add_tags: &[AccessTag], remove_tags: &[AccessTag], ) -> MResult<()>

Edits user tags.

pub async fn delete_user(&self, user_id: Id) -> MResult<()>

Deletes the user.

pub async fn authorize( &self, tokens: TokenBundle, cba_challenge_state: Option<String>, cba_challenge_sign: Option<CBAChallengeSign>, tags: &[impl Into<AccessTag> + Clone], ) -> MResult<(UserAuthorizeResponse, Option<String>)>

Authorizes a user by given token triple for given tags.

pub async fn request_cba_update( &self, tokens: TokenBundle, cba_challenge_state: Option<String>, cba_challenge_sign: Option<CBAChallengeSign>, ) -> MResult<(CBAUpdateResponse, Option<String>)>

Requests an update for client-based authorization token.

This method is intended to be run twice:

1. You should get cba_challenge in CBAUpdateResponse and the signed lmpaat_cba_challenge to store at client side.
2. You should set lmpaat_cba_challenge and provide cba_challenge_sign from the client.

For successful update client should sign the challenge with the same private key which public part is stored at triple.

pub async fn perform_logout(&self, bundle: TokenBundle) -> MResult<()>

Logs a user out by his tokens.

impl AuthClient

pub fn lifetimes(&self) -> TokenLifetimes

Returns token lifetimes.

pub async fn check_signed_in( &self, req: &mut Request, res: &mut Response, ) -> MResult<ApplicationAuthorizeResponse>

Just checks if a user is authenticated.

pub async fn check_authorized_to( &self, req: &mut Request, res: &mut Response, tags: &[impl Into<AccessTag> + Clone], ) -> MResult<ApplicationAuthorizeResponse>

Checks if a user is authorized to given action tags.

pub async fn update_client_token( &self, req: &mut Request, res: &mut Response, ) -> MResult<OK>

Forces to update client token.

pub async fn logout(&self, req: &mut Request, res: &mut Response) -> MResult<()>

Requests a logout.

After this, refresh token is no longer available, and access token stays alive up to 15 minutes.

pub fn deploy_triple_to_cookies( &self, bundle: &TokenBundle, res: &mut Response, ) -> MResult<()>

This method sets up token triple to cookies.

Trait Implementations

impl Clone for AuthClient

fn clone(&self) -> AuthClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.