rnp-rs 0.1.3

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
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
90
91
92
93

//! Encryption and decryption.
//!
//! ## Module layout
//!
//! | Sub-module    | Concern                                              |
//! |---------------|------------------------------------------------------|
//! | `encryptor`   | `Encryptor` builder + `apply_config`                 |
//! | `decryptor`   | `Decryptor` builder + `DecryptResult` + free funcs   |
//!
//! Shared types (`EncryptFlags`, `AeadType`, `AddPasswordOptions`) live in
//! this file.

use crate::algorithm::{Cipher, Hash};
use crate::ffi;

mod decryptor;
mod encryptor;

pub use decryptor::{decrypt, decrypt_to, DecryptResult, Decryptor};
pub use encryptor::Encryptor;

// ---------------------------------------------------------------------------
// Shared types
// ---------------------------------------------------------------------------

/// Flags for [`Encryptor::set_flags`](crate::Encryptor::set_flags). Wraps `RNP_ENCRYPT_*`.
#[derive(Clone, Copy, Debug, Default)]
pub struct EncryptFlags(pub u32);

impl EncryptFlags {
    /// Don't wrap plaintext in a literal-data packet — used when encrypting
    /// already-signed data. Wraps `RNP_ENCRYPT_NOWRAP`.
    pub const NOWRAP: Self = Self(ffi::RNP_ENCRYPT_NOWRAP as u32);

    pub fn bits(self) -> u32 {
        self.0
    }
}

impl std::ops::BitOr for EncryptFlags {
    type Output = Self;
    fn bitor(self, rhs: Self) -> Self {
        Self(self.0 | rhs.0)
    }
}

/// AEAD algorithm. Pass to [`Encryptor::aead`](crate::Encryptor::aead).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum AeadType {
    Ocb,
    Eax,
    Gcm,
}

impl AeadType {
    pub fn as_str(self) -> &'static str {
        match self {
            AeadType::Ocb => "OCB",
            AeadType::Eax => "EAX",
            AeadType::Gcm => "GCM",
        }
    }
}

/// S2K / encryption config for a password added via
/// [`Encryptor::add_password`](crate::Encryptor::add_password).
///
/// Built via [`AddPasswordOptions::default`] then chained setters. OCP —
/// adding a new S2K parameter doesn't break call sites.
#[derive(Default)]
pub struct AddPasswordOptions {
    pub(crate) hash: Option<Hash>,
    pub(crate) iterations: Option<usize>,
    pub(crate) cipher: Option<Cipher>,
}

impl AddPasswordOptions {
    pub fn hash(mut self, h: Hash) -> Self {
        self.hash = Some(h);
        self
    }

    pub fn iterations(mut self, n: usize) -> Self {
        self.iterations = Some(n);
        self
    }

    pub fn cipher(mut self, c: Cipher) -> Self {
        self.cipher = Some(c);
        self
    }
}