rustauth-plugins 0.2.0

Official RustAuth plugin modules.
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Phone number authentication plugin.

mod endpoints;
mod errors;
mod hooks;
mod options;
mod otp;
mod schema;
mod store;

use std::sync::Arc;

use rustauth_core::error::RustAuthError;
use rustauth_core::options::RateLimitRule;
use rustauth_core::plugin::{AuthPlugin, PluginRateLimitRule};

pub use errors::PHONE_NUMBER_ERROR_CODES;
pub use options::{
    PhoneNumberCallback, PhoneNumberOptions, PhoneNumberOptionsBuilder, PhoneNumberSender,
    PhoneNumberValidator, PhoneNumberVerifier, SignUpOnVerification,
};
pub use schema::PhoneNumberSchemaOptions;

pub const UPSTREAM_PLUGIN_ID: &str = "phone-number";

/// Build the phone number plugin.
pub fn phone_number(options: PhoneNumberOptions) -> Result<AuthPlugin, RustAuthError> {
    options.validate()?;
    let options = Arc::new(options.with_defaults());
    let schema = options.schema.clone();
    let plugin = AuthPlugin::new(UPSTREAM_PLUGIN_ID)
        .with_version(crate::VERSION)
        .with_endpoint(endpoints::sign_in::endpoint(Arc::clone(&options)))
        .with_endpoint(endpoints::send_otp::endpoint(Arc::clone(&options)))
        .with_endpoint(endpoints::verify::endpoint(Arc::clone(&options)))
        .with_endpoint(endpoints::password_reset::request_endpoint(Arc::clone(
            &options,
        )))
        .with_endpoint(endpoints::password_reset::reset_endpoint(options))
        .with_schema(schema::phone_number_field(&schema))
        .with_schema(schema::phone_number_verified_field(&schema))
        .with_rate_limit(PluginRateLimitRule::new(
            "/phone-number/*",
            RateLimitRule {
                window: time::Duration::seconds(60),
                max: 10,
            },
        ))
        .with_error_code(errors::invalid_phone_number())
        .with_error_code(errors::phone_number_exists())
        .with_error_code(errors::phone_number_not_exists())
        .with_error_code(errors::invalid_phone_number_or_password())
        .with_error_code(errors::unexpected_error())
        .with_error_code(errors::otp_not_found())
        .with_error_code(errors::otp_expired())
        .with_error_code(errors::invalid_otp())
        .with_error_code(errors::phone_number_not_verified())
        .with_error_code(errors::phone_number_cannot_be_updated())
        .with_error_code(errors::send_otp_not_implemented())
        .with_error_code(errors::too_many_attempts())
        .with_before_hook("/update-user", hooks::block_unsafe_update_user)
        .with_database_hook(hooks::reset_verified_when_clearing_phone());
    Ok(plugin)
}