vendor/signature/README.md

   1 # [RustCrypto]: Digital Signature Algorithms
   2
   3 [![crate][crate-image]][crate-link]
   4 [![Docs][docs-image]][docs-link]
   5 [![Build Status][build-image]][build-link]
   6 ![Apache2/MIT licensed][license-image]
   7 ![Rust Version][rustc-image]
   8 [![Project Chat][chat-image]][chat-link]
   9
  10 This crate contains traits which provide generic, object-safe APIs for
  11 generating and verifying [digital signatures].
  12
  13 Used by the [`dsa`], [`ecdsa`], [`ed25519`], and [`rsa`] crates maintained by
  14 the [RustCrypto] organization, as well as [`ed25519-dalek`].
  15
  16 [Documentation][docs-link]
  17
  18 ## Minimum Supported Rust Version
  19
  20 Rust **1.56** or higher.
  21
  22 Minimum supported Rust version can be changed in the future, but it will be
  23 done with a minor version bump.
  24
  25 ## SemVer Policy
  26
  27 - All on-by-default features of this library are covered by SemVer
  28 - MSRV is considered exempt from SemVer as noted above
  29 - The `derive` feature is stable and covered by SemVer
  30 - The off-by-default features `digest` and `rand_core` are unstable features
  31   which are also considered exempt from SemVer as they correspond to pre-1.0
  32   crates which are still subject to changes. Breaking changes to these features
  33   will, like MSRV, be done with a minor version bump.
  34
  35 ## License
  36
  37 Licensed under either of
  38
  39  * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
  40  * [MIT license](http://opensource.org/licenses/MIT)
  41
  42 at your option.
  43
  44 ### Contribution
  45
  46 Unless you explicitly state otherwise, any contribution intentionally submitted
  47 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
  48 dual licensed as above, without any additional terms or conditions.
  49
  50 [//]: # (badges)
  51
  52 [crate-image]:  https://buildstats.info/crate/signature
  53 [crate-link]: https://crates.io/crates/signature
  54 [docs-image]: https://docs.rs/signature/badge.svg
  55 [docs-link]: https://docs.rs/signature/
  56 [build-image]: https://github.com/RustCrypto/traits/actions/workflows/signature.yml/badge.svg
  57 [build-link]: https://github.com/RustCrypto/traits/actions/workflows/signature.yml
  58 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
  59 [rustc-image]: https://img.shields.io/badge/rustc-1.56+-blue.svg
  60 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
  61 [chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260048-signatures
  62
  63 [//]: # (links)
  64
  65 [RustCrypto]: https://github.com/RustCrypto/
  66 [digital signatures]: https://en.wikipedia.org/wiki/Digital_signature
  67 [`dsa`]: https://github.com/RustCrypto/signatures/tree/master/dsa
  68 [`ecdsa`]: https://github.com/RustCrypto/signatures/tree/master/ecdsa
  69 [`ed25519`]: https://github.com/RustCrypto/signatures/tree/master/ed25519
  70 [`ed25519-dalek`]: https://github.com/dalek-cryptography/ed25519-dalek
  71 [`rsa`]: https://github.com/RustCrypto/RSA