sos-platform-authenticator 0.17.0

Platform authenticator and keyring suppport for the Save Our Secrets SDK.
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Interface to the platform authenticator.

#[cfg(not(target_os = "linux"))]
mod supported {
    use robius_authentication::{
        AndroidText, BiometricStrength, Context, Policy, PolicyBuilder, Text,
        WindowsText,
    };

    /// Options for platform authentication.
    pub struct AuthenticateOptions {
        /// Biometrics strength.
        pub biometrics: BiometricStrength,
        /// Password fallback.
        pub password: bool,
        /// Text for android.
        pub android: AndroidText<'static, 'static, 'static>,
        /// Text for apple.
        pub apple: &'static str,
        /// Text for windows.
        pub windows: WindowsText<'static, 'static>,
    }

    impl Default for AuthenticateOptions {
        fn default() -> Self {
            Self {
                biometrics: BiometricStrength::Strong,
                password: true,
                android: AndroidText {
                    title: "Authenticate",
                    subtitle: None,
                    description: None,
                },
                apple: "authenticate",
                windows: WindowsText::new(
                    "Save Our Secrets",
                    "Verify your identity to authenticate",
                )
                .unwrap(),
            }
        }
    }

    /// Authenticate using the platform authenticator.
    pub fn authenticate(options: AuthenticateOptions) -> bool {
        let policy: Policy = PolicyBuilder::new()
            .biometrics(Some(options.biometrics))
            .password(options.password)
            .watch(true)
            .build()
            .unwrap();

        let text: Text = Text {
            android: options.android,
            apple: options.apple,
            windows: options.windows,
        };

        let context = Context::new(());
        context.blocking_authenticate(text, &policy).is_ok()
    }

    /// Determine if local platform authentication is supported.
    pub fn supported() -> bool {
        true
    }
}
#[cfg(not(target_os = "linux"))]
pub use supported::*;

#[cfg(target_os = "linux")]
mod unsupported {
    /// Options for platform authentication.
    #[derive(Default)]
    pub struct AuthenticateOptions {}

    /// Authenticate using the platform authenticator.
    pub fn authenticate(_options: AuthenticateOptions) -> bool {
        false
    }

    /// Determine if local platform authentication is supported.
    pub fn supported() -> bool {
        false
    }
}

#[cfg(target_os = "linux")]
pub use unsupported::*;