diff options
Diffstat (limited to 'vendor/signature/README.md')
| -rw-r--r-- | vendor/signature/README.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/vendor/signature/README.md b/vendor/signature/README.md new file mode 100644 index 000000000..a1a6fa4ae --- /dev/null +++ b/vendor/signature/README.md @@ -0,0 +1,72 @@ +# RustCrypto: Digital Signature Algorithms + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] + +This crate contains traits which provide generic, object-safe APIs for +generating and verifying [digital signatures][1]. + +Used by the [`ecdsa`][2] and [`ed25519`][3] crates, with forthcoming support +in the [`rsa`][4] crate. + +See also the [Signatory][5] crate for trait wrappers for using these traits +with many popular Rust cryptography crates, including `ed25519-dalek`, *ring*, +`secp256k1-rs`, and `sodiumoxide`. + +[Documentation][docs-link] + +## Minimum Supported Rust Version + +Rust **1.56** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## SemVer Policy + +- All on-by-default features of this library are covered by SemVer +- MSRV is considered exempt from SemVer as noted above +- The off-by-default features `derive-preview` and `digest-preview` are + unstable "preview" features which are also considered exempt from SemVer. + Breaking changes to these features will, like MSRV, be done with a minor + version bump. + +## License + +Licensed under either of + + * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[//]: # (badges) + +[crate-image]: https://buildstats.info/crate/signature +[crate-link]: https://crates.io/crates/signature +[docs-image]: https://docs.rs/signature/badge.svg +[docs-link]: https://docs.rs/signature/ +[build-image]: https://github.com/RustCrypto/traits/actions/workflows/signature.yml/badge.svg +[build-link]: https://github.com/RustCrypto/traits/actions/workflows/signature.yml +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.56+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260048-signatures + +[//]: # (general links) + +[1]: https://en.wikipedia.org/wiki/Digital_signature +[2]: https://github.com/RustCrypto/signatures/tree/master/ecdsa +[3]: https://github.com/RustCrypto/signatures/tree/master/ed25519 +[4]: https://github.com/RustCrypto/RSA +[5]: https://docs.rs/signatory |