Signatory

crate Docs Build Status MIT/Apache2 licensed

A pure Rust multi-provider digital signature library with support for elliptic curve digital signature algorithms, namely ECDSA (described in [FIPS 186-4]) and Ed25519 (described in [RFC 8032]).

Signatory provides a thread-safe and object-safe API and implements providers for many popular Rust crates, including [ed25519-dalek], [secp256k1-rs], [ring], and [sodiumoxide].

Documentation

About

Signatory exposes a thread-and-object-safe API for creating digital signatures which allows several signature providers to be compiled-in and available with specific providers selected at runtime.

Provider Support

Signatory includes the following providers, which are each packaged into their own respective crates:

ECDSA providers

| Provider Crate | Backend Crate | Type | P-256 | secp256k1 | |-----------------------|----------------|------|-------|-----------| | [signatory-ring] | [ring] | Soft | ✅ | ⛔ | | [signatory-secp256k1] | [secp256k1-rs] | Soft | ⛔ | ✅ | | [signatory-yubihsm] | [yubihsm-rs] | Hard | ✅ | ✅ |

Ed25519 providers

| Provider Crate | Backend Crate | Type | Signing | Verification | |-------------------------|-----------------|------|---------|--------------| | [signatory-dalek] | [ed25519-dalek] | Soft | 51 k/s | 18 k/s | | [signatory-ring] | [ring] | Soft | 47 k/s | 16 k/s | | [signatory-sodiumoxide] | [sodiumoxide] | Soft | 38 k/s | 15 k/s | | [signatory-yubihsm] | [yubihsm-rs] | Hard | ~8/s | N/A |

Above benchmarks performed using cargo bench on an Intel Xeon E3-1225 v5 @ 3.30GHz.

YubiHSM2 Provider Notes

The [yubihsm-rs] crate depends on the aesni crate, which uses the new "stdsimd" API (coming soon to stable!) to invoke hardware AES instructions via core::arch.

To access these features, you will need both a relatively recent Rust nightly and to pass the following as RUSTFLAGS:

RUSTFLAGS=-Ctarget-feature=+aes`

You can configure your ~/.cargo/config to always pass these flags:

toml [build] rustflags = ["-Ctarget-feature=+aes"]

License

Signatory is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.