rpgpie 0.9.1

Experimental high level API for rPGP
Documentation 
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

// SPDX-FileCopyrightText: Heiko Schaefer <heiko@schaefer.name>
// SPDX-License-Identifier: MIT OR Apache-2.0

//! # rpgpie 🦀️🔐🥧
//!
//! rpgpie is an experimental higher level [OpenPGP](https://www.rfc-editor.org/rfc/rfc9850)
//! library based on [rPGP](https://github.com/rpgp/rpgp).
//!
//! It exposes a convenient API for some simple common OpenPGP operations.
//!
//! rpgpie implements semantics for OpenPGP expiration and revocation mechanisms, key flags,
//! and applies some amount of policy (to limit reliance on obsolete algorithms).
//!
//! Main goals of rpgpie include simplicity and collaboration 🥳.
//!
//! ## "OpenPGP for application developers"
//!
//! rpgpie aims to apply the terminology outlined in the
//! ["OpenPGP for application developers"](https://openpgp.dev/) documentation.
//!
//! ## Stateless OpenPGP (SOP)
//!
//! See [rsop](https://crates.io/crates/rsop) for a
//! [stateless OpenPGP (SOP)](https://datatracker.ietf.org/doc/draft-dkg-openpgp-stateless-cli/)
//! tool based on rpgpie.

pub mod certificate;
mod checked;
pub mod key;
pub mod lookup;
pub mod merge;
pub mod message;
pub mod model;
pub mod policy;
mod primary_userid;
pub mod signature;
pub mod tsk;
pub mod util;

/// rpgpie version, via Cargo.toml
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Version of the rPGP dependency we built against
pub const RPGP_VERSION: &str = pgp::VERSION;

/// Error type for this crate
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum Error {
    #[error("rPGP error: {0}")]
    Rpgp(#[from] pgp::errors::Error),

    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    #[error("Internal error: {0}")]
    Message(String),

    #[error("Primary key invalid: No valid binding signature found")]
    InvalidPrimary,
}

impl From<pgp::composed::SubkeyParamsBuilderError> for Error {
    fn from(value: pgp::composed::SubkeyParamsBuilderError) -> Self {
        Error::Message(format!("SubkeyParamsBuilderError: {value}"))
    }
}

impl From<pgp::composed::SecretKeyParamsBuilderError> for Error {
    fn from(value: pgp::composed::SecretKeyParamsBuilderError) -> Self {
        Error::Message(format!("SecretKeyParamsBuilderError: {value}"))
    }
}