sharpie 0.2.0

A simple digital signing and verification library based on ring
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

//! Sign and verify using _RSA_ or _ED25519_ with a focus on simplicity.
//!
//! Use a simple interface: `sign` or `verify`,
//! from either the [ed] or [rsa] modules supporting multiple key formats.
//!
//! To sign:
//!
//! 1. Get the key bytes using `PrivateKey::<type>(..source..).read()`
//! 2. Optionally, cache these bytes for reuse
//! 3. Use `sign`
//!
//! To verify:
//!
//! 1. Get the key bytes using `PublicKey::<type>(..source..).read()`
//! 2. Optionally, cache these bytes for reuse
//! 3. Use `verify`
//!
//! Here's a full sign-verify cycle using `ED25519`, with keys generated using OpenSSL in this way:
//!
//! ```ignore
//! $ openssl genpkey -algorithm ED25519 -out ed.private.pem
//! $ openssl pkey -in private-key-ed.pem -pubout -out ed.public.pem
//! ```
//! Sign and verify using [sharpie::ed](ed):
//!
//! ```ignore
#![doc = include_str!("../examples/sign.rs")]
//! ```
//!
//!
//!
///ED25519 signing and verification
pub mod ed;

/// RSA signing and verification
pub mod rsa;

use snafu::prelude::*;

#[derive(Debug, Snafu)]
pub enum Error {
    #[snafu(display("Unable to parse PEM: {}", source))]
    InvalidPem { source: pem::PemError },
    #[snafu(display("Signature operation failed"))]
    SignatureFailed { source: ring::error::Unspecified },
    #[cfg(feature = "base64")]
    #[snafu(display("Decoding data failed"))]
    DecodeFailed { source: base64::DecodeError },
    #[snafu(display("Cannot read key: {}", source))]
    InvalidKey { source: ring::error::KeyRejected },
}
type Result<T, E = Error> = std::result::Result<T, E>;