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

//! Signatory: a multi-provider digital signature library
//!
//! This crate provides a thread-and-object-safe API for both creating and
//! verifying elliptic curve digital signatures, using either software-based
//! or hardware-based providers.
//!
//! ECDSA ([FIPS 186-4]) and Ed25519 ([RFC 8032]) are the supported digital
//! signature algorithms.
//!
//! [FIPS 186-4]: https://csrc.nist.gov/publications/detail/fips/186/4/final
//! [RFC 8032]: https://tools.ietf.org/html/rfc8032
//!
//! There are several backend providers available, which need to be enabled
//! using Cargo features. For more information, please see the `providers`
//! module documentation. A brief summary of available providers follows:
//!
//! * `dalek-provider`: Ed25519 signing/verification using the pure-Rust
//!   ed25519-dalek crate. This provider is enabled-by-default.
//! * `ring-provider`: Ed25519 signing/verification with the *ring*
//!   cryptography library.
//! * `secp256k1-provider`: ECDSA signing/verification for the secp256k1
//!    elliptic curve (commonly used by Bitcoin and other cryptocurrrencies)
//!    which wraps the libsecp256k1 library from Bitcoin Core.
//! * `sodiumoxide-provider`: Ed25519 signing/verification with the
//!   sodiumoxide crate, a Rust wrapper for libsodium (NOTE: requires
//!   libsodium to be installed on the system)
//! * `yubihsm-provider`: Ed25519 signing-only provider using private keys
//!   stored in a `YubiHSM2` hardware device, via the yubihsm-rs crate.

#![crate_name = "signatory"]
#![crate_type = "lib"]
#![no_std]
#![deny(warnings, missing_docs, trivial_casts, trivial_numeric_casts)]
#![deny(unsafe_code, unused_import_braces, unused_qualifications)]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/tendermint/signatory/master/img/signatory-rustacean.png",
    html_root_url = "https://docs.rs/signatory/0.6.0"
)]

#[cfg(any(feature = "std", test))]
#[macro_use]
extern crate std;

#[cfg(feature = "ed25519")]
extern crate clear_on_drop;
#[cfg(feature = "dalek-provider")]
extern crate ed25519_dalek;
#[cfg(feature = "ecdsa")]
pub extern crate generic_array;
#[cfg(feature = "secp256k1-provider")]
#[macro_use]
extern crate lazy_static;
#[cfg(feature = "rand")]
extern crate rand;
#[cfg(feature = "ring-provider")]
extern crate ring;
#[cfg(feature = "secp256k1-provider")]
extern crate secp256k1;
#[cfg(feature = "sha2")]
extern crate sha2;
#[cfg(feature = "sodiumoxide-provider")]
extern crate sodiumoxide;
#[cfg(feature = "ring-provider")]
extern crate untrusted;
#[cfg(feature = "yubihsm-provider")]
extern crate yubihsm as yubihsm_crate;

#[macro_use]
mod error;

#[cfg(feature = "ecdsa")]
pub mod ecdsa;
#[cfg(feature = "ed25519")]
#[macro_use]
pub mod ed25519;
pub mod providers;
#[cfg(feature = "test-vectors")]
pub mod test_vector;
mod util;

pub use error::Error;