rnp-rs 0.1.7

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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

//! `FromStr` and `Display` for the crate's model enums.
//!
//! Each enum's `as_str()` returns the C-side string; the impls here
//! provide the reverse mapping plus the standard Rust string-conversion
//! traits. This unlocks config-file parsers, CLI arg libraries, and
//! serde (via `#[serde(with = "...")]` patterns).
//!
//! Adding a new model enum: implement `as_str()` on it, then add a
//! `from_str` match arm + blanket `FromStr`/`Display` impls. The trait
//! is the same pattern for every enum — could be macro-generated, but
//! the manual form is clearer and lets each enum document its variants.

use crate::error::{unknown_variant, Error};
use crate::{
    encrypt::AeadType, Algorithm, ArmorType, Cipher, Compression, Curve, FeatureType, Hash,
    KeyUsage,
};
use std::str::FromStr;

// Helper: build an UnknownVariant error.
fn unknown(kind: &'static str, value: &str) -> Error {
    unknown_variant(kind, value)
}

// -----------------------------------------------------------------------
// Algorithm
// -----------------------------------------------------------------------

impl std::fmt::Display for Algorithm {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for Algorithm {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_uppercase().as_str() {
            "RSA" => Ok(Algorithm::Rsa),
            "ELGAMAL" => Ok(Algorithm::ElGamal),
            "DSA" => Ok(Algorithm::Dsa),
            "ECDH" => Ok(Algorithm::Ecdh),
            "ECDSA" => Ok(Algorithm::Ecdsa),
            "EDDSA" => Ok(Algorithm::Eddsa),
            "SM2" => Ok(Algorithm::Sm2),
            _ => Err(unknown("algorithm", s)),
        }
    }
}

// -----------------------------------------------------------------------
// Curve
// -----------------------------------------------------------------------

impl std::fmt::Display for Curve {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for Curve {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "NIST P-256" => Ok(Curve::P256),
            "NIST P-384" => Ok(Curve::P384),
            "NIST P-521" => Ok(Curve::P521),
            "Ed25519" => Ok(Curve::Ed25519),
            "Curve25519" => Ok(Curve::Curve25519),
            "brainpoolP256r1" => Ok(Curve::Bp256),
            "brainpoolP384r1" => Ok(Curve::Bp384),
            "brainpoolP512r1" => Ok(Curve::Bp512),
            "secp256k1" => Ok(Curve::Secp256k1),
            "SM2 P-256" => Ok(Curve::Sm2P256),
            _ => Err(unknown("curve", s)),
        }
    }
}

// -----------------------------------------------------------------------
// Hash
// -----------------------------------------------------------------------

impl std::fmt::Display for Hash {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for Hash {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_uppercase().as_str() {
            "SHA1" => Ok(Hash::Sha1),
            "SHA224" => Ok(Hash::Sha224),
            "SHA256" => Ok(Hash::Sha256),
            "SHA384" => Ok(Hash::Sha384),
            "SHA512" => Ok(Hash::Sha512),
            "SHA3-256" => Ok(Hash::Sha3_256),
            "SHA3-512" => Ok(Hash::Sha3_512),
            "MD5" => Ok(Hash::Md5),
            "RIPEMD160" => Ok(Hash::Ripemd160),
            "SM3" => Ok(Hash::Sm3),
            _ => Err(unknown("hash", s)),
        }
    }
}

// -----------------------------------------------------------------------
// Cipher
// -----------------------------------------------------------------------

impl std::fmt::Display for Cipher {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for Cipher {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_uppercase().as_str() {
            "IDEA" => Ok(Cipher::Idea),
            "TRIPLEDES" => Ok(Cipher::Tripledes),
            "CAST5" => Ok(Cipher::Cast5),
            "BLOWFISH" => Ok(Cipher::Blowfish),
            "AES128" => Ok(Cipher::Aes128),
            "AES192" => Ok(Cipher::Aes192),
            "AES256" => Ok(Cipher::Aes256),
            "TWOFISH" => Ok(Cipher::Twofish),
            "CAMELLIA128" => Ok(Cipher::Camellia128),
            "CAMELLIA192" => Ok(Cipher::Camellia192),
            "CAMELLIA256" => Ok(Cipher::Camellia256),
            "SM4" => Ok(Cipher::Sm4),
            _ => Err(unknown("cipher", s)),
        }
    }
}

// -----------------------------------------------------------------------
// Compression
// -----------------------------------------------------------------------

impl std::fmt::Display for Compression {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for Compression {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_uppercase().as_str() {
            "ZIP" => Ok(Compression::Zip),
            "ZLIB" => Ok(Compression::Zlib),
            "BZIP2" => Ok(Compression::Bzip2),
            _ => Err(unknown("compression", s)),
        }
    }
}

// -----------------------------------------------------------------------
// KeyUsage
// -----------------------------------------------------------------------

impl std::fmt::Display for KeyUsage {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for KeyUsage {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "certify" => Ok(KeyUsage::Certify),
            "sign" => Ok(KeyUsage::Sign),
            "encrypt" => Ok(KeyUsage::EncryptComms),
            _ => Err(unknown("key usage", s)),
        }
    }
}

// -----------------------------------------------------------------------
// AeadType
// -----------------------------------------------------------------------

impl std::fmt::Display for AeadType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for AeadType {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_uppercase().as_str() {
            "OCB" => Ok(AeadType::Ocb),
            "EAX" => Ok(AeadType::Eax),
            "GCM" => Ok(AeadType::Gcm),
            _ => Err(unknown("aead", s)),
        }
    }
}

// -----------------------------------------------------------------------
// ArmorType
// -----------------------------------------------------------------------

impl std::fmt::Display for ArmorType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for ArmorType {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "message" => Ok(ArmorType::Message),
            "public key" => Ok(ArmorType::PublicKey),
            "secret key" => Ok(ArmorType::SecretKey),
            "signature" => Ok(ArmorType::Signature),
            "cleartext signed message" => Ok(ArmorType::Cleartext),
            _ => Err(unknown("armor type", s)),
        }
    }
}

// -----------------------------------------------------------------------
// FeatureType
// -----------------------------------------------------------------------

impl std::fmt::Display for FeatureType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for FeatureType {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        // The RNP_FEATURE_* constants are &[u8; N] with a trailing NUL.
        // Strip the NUL before comparing.
        let strip_nul = |b: &'static [u8]| -> &'static str {
            let end = b.iter().position(|&x| x == 0).unwrap_or(b.len());
            std::str::from_utf8(&b[..end]).expect("RNP_FEATURE_* is ASCII")
        };
        let symm = strip_nul(crate::ffi::RNP_FEATURE_SYMM_ALG);
        let aead = strip_nul(crate::ffi::RNP_FEATURE_AEAD_ALG);
        let prot = strip_nul(crate::ffi::RNP_FEATURE_PROT_MODE);
        let pk = strip_nul(crate::ffi::RNP_FEATURE_PK_ALG);
        let hash = strip_nul(crate::ffi::RNP_FEATURE_HASH_ALG);
        let comp = strip_nul(crate::ffi::RNP_FEATURE_COMP_ALG);
        let curve = strip_nul(crate::ffi::RNP_FEATURE_CURVE);
        match s {
            x if x == symm => Ok(FeatureType::SymmetricAlgorithm),
            x if x == aead => Ok(FeatureType::AeadAlgorithm),
            x if x == prot => Ok(FeatureType::ProtectionMode),
            x if x == pk => Ok(FeatureType::PublicKeyAlgorithm),
            x if x == hash => Ok(FeatureType::HashAlgorithm),
            x if x == comp => Ok(FeatureType::CompressionAlgorithm),
            x if x == curve => Ok(FeatureType::Curve),
            _ => Err(unknown("feature type", s)),
        }
    }
}

// -----------------------------------------------------------------------
// KeyringFormat (in context.rs)
// -----------------------------------------------------------------------

impl std::fmt::Display for crate::context::KeyringFormat {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for crate::context::KeyringFormat {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_uppercase().as_str() {
            "GPG" => Ok(crate::context::KeyringFormat::Gpg),
            "KBX" => Ok(crate::context::KeyringFormat::Kbx),
            "G10" => Ok(crate::context::KeyringFormat::G10),
            "JSON" => Ok(crate::context::KeyringFormat::Json),
            _ => Err(unknown("keyring format", s)),
        }
    }
}

// Suppress unused warning for the trait import we use implicitly.
#[allow(dead_code)]
fn _silence() {}