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
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

//! OpenPGP key handles.
//!
//! A [`Key`] wraps an `rnp_key_handle_t`. It borrows the [`Context`](crate::Context)
//! it came from for its lifetime. Child handles ([`crate::Uid`], [`crate::Subkey`],
//! [`crate::Signature`]) borrow the `Key` for *their* lifetime.
//!
//! ## Module layout
//!
//! | Sub-module    | Concern                                        |
//! |---------------|------------------------------------------------|
//! | `identifier`  | `KeyIdentifier` enum (lookup key for find_key) |
//! | `flags`       | Bitflag types consumed by export/remove/unload |
//! | `inspection`  | Read-only getters on `Key`                     |
//! | `mutation`    | Operations that change key state + option types|
//! | `lookup`      | `Context::find_key` / `Context::load_keys`     |

use crate::ffi;
use std::marker::PhantomData;
use std::ptr;

/// Borrowed handle to a key in the FFI's keyring.
pub struct Key<'ctx> {
    pub(crate) handle: ffi::rnp_key_handle_t,
    _ctx: PhantomData<&'ctx crate::Context>,
}

impl<'ctx> Key<'ctx> {
    /// Crate-internal constructor: wrap a raw handle, borrowing `ctx`.
    pub(crate) fn from_handle(handle: ffi::rnp_key_handle_t) -> Self {
        Key {
            handle,
            _ctx: PhantomData,
        }
    }
}

impl<'ctx> Drop for Key<'ctx> {
    fn drop(&mut self) {
        if !self.handle.is_null() {
            unsafe {
                let _ = ffi::rnp_key_handle_destroy(self.handle);
            }
            self.handle = ptr::null_mut();
        }
    }
}

// --- sub-modules -----------------------------------------------------------

mod identifier;
pub use identifier::KeyIdentifier;

mod flags;
pub use flags::{
    ExportFlags, LoadSaveFlags, RemoveFlags, RemoveSignaturesFlags, UnloadFlags,
};

mod inspection;

mod mutation;
pub use mutation::{AddUidOptions, ProtectOptions, RevocationCode, RevocationReason};
pub(crate) use mutation::export_revocation_impl;

mod lookup;