Struct actix_plus_auth::AuthenticationProvider

pub struct AuthenticationProvider<DataProviderImpl: DataProvider> { /* fields omitted */ }

A clone of this struct is provided to each App instance in Actix as Data, thus providing access to the authentication system in each route.

Implementations

impl<DataProviderImpl: DataProvider> AuthenticationProvider<DataProviderImpl>

pub fn new(provider: DataProviderImpl, jwt_secret: Vec<u8>) -> Self

Creates a new AuthenticationProvider with the provided jwt_secret and data provider. The jwt secret is used to sign and verify the json web tokens, so it should be secret, long enough to be secure, and persistent over a period of days. Changing this token will invalidate all current sessions, but they may not be cleanly logged out if you set your own cookies in addition to the token.

pub async fn register(
    &self,
    account: DataProviderImpl::AccountType,
    password: &str
) -> ResponseResult<RegistrationOutcome<DataProviderImpl::AccountType>>

Registers the provided account with the provided password. See the documentation on RegistrationOutcome for details on what to do next.

#[post("/register")]
async fn register(auth: Data<ExampleAuthProvider>, dto: Json<RegistrationDto>) -> Response {
    let dto = dto.into_inner();
    Ok(
        match auth.register(
            ExampleAccount {
                username: dto.username,
                email: dto.email,
            },
            &dto.password,
        )? {
            RegistrationOutcome::Successful(_account) => {
                HttpResponse::Ok()
                    .json(RegistrationResponseDto {
                        succeeded: true,
                        message: None,
                    })
                    .await?
            }
            RegistrationOutcome::InvalidEmail => {
                HttpResponse::Ok()
                    .json(RegistrationResponseDto {
                        succeeded: false,
                        message: Some("Invalid Email".into()),
                    })
                    .await?
            }
            RegistrationOutcome::EmailTaken => {
                HttpResponse::Ok()
                    .json(RegistrationResponseDto {
                        succeeded: false,
                        message: Some("Email is already taken".into()),
                    })
                    .await?
            }
        },
    )
}

pub async fn login(
    &self,
    email: &str,
    password: &str
) -> ResponseResult<LoginOutcome<DataProviderImpl::AccountType>>

Attempts to login to the specified account. See the documentation on LoginOutcome for details on what to do next.

#[post("/login")]
async fn login(auth: Data<ExampleAuthProvider>, dto: Json<LoginDto>) -> Response {
    Ok(match auth.login(&dto.email, &dto.password)? {
        LoginOutcome::Successful(account, cookie) => {
            HttpResponse::Ok()
                .cookie(CookieBuilder::new("username", account.username).finish()) //this is how you make information available to your frontend, note that anything in your account type is visible to users as it is encoded as a JWT!!!!!
                .cookie(cookie)
                .json(LoginResponseDto {
                    succeeded: true,
                    message: None,
                })
                .await?
        }
        LoginOutcome::InvalidEmailOrPassword => {
            HttpResponse::Ok()
                .json(LoginResponseDto {
                    succeeded: false,
                    message: Some("Invalid username or password".into()),
                })
                .await?
        }
    })
}

pub fn current_user(
    &self,
    request: &HttpRequest
) -> ResponseResult<DataProviderImpl::AccountType>

Gets the current user if a valid session is present on the provided HTTP request, otherwise returns a ResponseResult that when propagated with the actix-plus-error crate causes Actix web to return 401 Not Authorized.

#[get("/private_page")]
async fn private_page(request: HttpRequest, auth: Data<ExampleAuthProvider>) -> Response {
    let account = auth.current_user(&request)?;
    Ok(HttpResponse::Ok()
        .body(format!("Hello {}", account.username))
        .await?)
}

Trait Implementations

impl<DataProviderImpl: Clone + DataProvider> Clone for AuthenticationProvider<DataProviderImpl>

fn clone(&self) -> AuthenticationProvider<DataProviderImpl>

Returns a copy of the value.

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

Performs copy-assignment from source.