rnp-rs 0.1.2

Idiomatic Rust binding to the RNP OpenPGP C FFI (librnp)
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

//! Password + key provider traits.

use crate::context::Context;
use crate::key::KeyIdentifier;

use super::types::{KeyRequestOutcome, RequestedKeyType};

/// What the library calls when it needs a passphrase to unlock a secret key.
///
/// Implementations return the password as `Cow<str>`; it is copied into the
/// librnp-provided buffer before the callback returns.
pub trait PasswordProvider: Send + Sync {
    fn get_password(
        &self,
        key: Option<&crate::key::Key>,
        context: &str,
    ) -> Option<std::borrow::Cow<'_, str>>;
}

/// Trait implemented by the consumer to feed keys into librnp on demand.
///
/// Called by librnp during verify/decrypt when the keyring doesn't have a
/// key the operation needs. The implementation typically inspects `id`
/// and `kind`, fetches the key bytes from some external store, and calls
/// [`Context::load_keys`](crate::Context::load_keys) on the supplied
/// `ctx`. Returns [`KeyRequestOutcome::Found`] if a key was loaded,
/// [`KeyRequestOutcome::NotFound`] otherwise.
pub trait KeyProvider: Send + Sync {
    fn on_key_request(
        &self,
        ctx: &Context,
        id: KeyIdentifier<'_>,
        kind: RequestedKeyType,
    ) -> KeyRequestOutcome;
}