Struct Context 

pub struct Context { /* private fields */ }

Holds platform-specific contextual state required to display an authentication prompt.

Implementations

impl Context

pub fn new(raw: RawContext) -> Self

Creates a new context from the given “raw” context.

Examples found in repository

examples/simple_authentication.rs (line 53)

fn main() {
    let context = Context::new(());
    let mut policy = PolicyBuilder::new()
        // On Linux You need to set action_ids.
        // See: ./org.robius.authentication.policy file settings and (README: "Usage on Linux").
        .action_ids([
            "org.robius.authentication",
            "org.robius.authentication.settings",
        ])
        .biometrics(Some(BiometricStrength::Strong))
        .password(true)
        .companion(true)
        .build()
        .unwrap();

    if let Err(e) = policy.set_action_id("org.robius.authentication.settings") {
        eprintln!("Invalid action_id: {:?}", e);
        return;
    }

    let (tx, rx) = mpsc::channel();

    // Start authentication. `res` only indicates whether the request was successfully
    // initiated; the final result is delivered via the callback.
    let res = context.authenticate(TEXT, &policy, move |result| {
        let _ = tx.send(result);
    });

    if let Err(e) = res {
        eprintln!("Failed to start authentication: {:?}", e);
        return;
    }

    // Block until the callback produces a result.
    match rx.recv() {
        Ok(Ok(_)) => println!("Authentication successful"),
        Ok(Err(e)) => println!("Authentication failed: {:?}", e),
        Err(e) => eprintln!("Failed to receive auth result: {:?}", e),
    }
}

pub fn authenticate<F>( &self, message: Text<'_, '_, '_, '_, '_, '_>, policy: &Policy, callback: F, ) -> Result<()>

where F: Fn(Result<()>) + Send + 'static,

Displays an authentication prompt using the provided policy and message.

Note that the returned Result does not indicate whether authentication was successful. This function returns Ok(()) to indicate that the authentication request was successfully initiated (i.e., the prompt was or will be shown), not that the user successfully authenticated. On some platforms (Android, Linux, Windows) the prompt is shown asynchronously after this function has already returned.

For that purpose, the given callback will be called with a Result indicating whether authentication succeeded. If this function returns an error, the callback may never be invoked; if it returns Ok(()), the callback will eventually be invoked with the result of the authentication attempt.

On Linux: message is unused because polkit looks up the prompt text from the action definition in the installed .policy file (its <message>/<description>). The client only supplies an action ID to CheckAuthorization, and there is no stable, cross-agent way to override that UI text at runtime. If you need multiple prompt strings, define multiple actions in the policy file and select the desired one via PolicyBuilder::action_ids and Policy::set_action_id before each authentication.

Thus, authentication failed if this function returns an error OR if the callback is invoked with Err(_).

Examples found in repository

examples/simple_authentication.rs (lines 76-78)

fn main() {
    let context = Context::new(());
    let mut policy = PolicyBuilder::new()
        // On Linux You need to set action_ids.
        // See: ./org.robius.authentication.policy file settings and (README: "Usage on Linux").
        .action_ids([
            "org.robius.authentication",
            "org.robius.authentication.settings",
        ])
        .biometrics(Some(BiometricStrength::Strong))
        .password(true)
        .companion(true)
        .build()
        .unwrap();

    if let Err(e) = policy.set_action_id("org.robius.authentication.settings") {
        eprintln!("Invalid action_id: {:?}", e);
        return;
    }

    let (tx, rx) = mpsc::channel();

    // Start authentication. `res` only indicates whether the request was successfully
    // initiated; the final result is delivered via the callback.
    let res = context.authenticate(TEXT, &policy, move |result| {
        let _ = tx.send(result);
    });

    if let Err(e) = res {
        eprintln!("Failed to start authentication: {:?}", e);
        return;
    }

    // Block until the callback produces a result.
    match rx.recv() {
        Ok(Ok(_)) => println!("Authentication successful"),
        Ok(Err(e)) => println!("Authentication failed: {:?}", e),
        Err(e) => eprintln!("Failed to receive auth result: {:?}", e),
    }
}

Trait Implementations

impl Debug for Context

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.