diff --git a/README.md b/README.md index e830d9f6..ca3810af 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ -# RustCrypto traits [![Build Status](https://travis-ci.org/RustCrypto/traits.svg?branch=master)](https://travis-ci.org/RustCrypto/traits) +# RustCrypto: Traits ![Rust Version][rustc-image] + Collection of traits which describe functionality of cryptographic primitives. ## Crates -| Name | Crates.io | Documentation | -| ------- | :---------:| :-------------:| -| [`aead`](https://en.wikipedia.org/wiki/Authenticated_encryption)| [![crates.io](https://img.shields.io/crates/v/aead.svg)](https://crates.io/crates/aead) | [![Documentation](https://docs.rs/aead/badge.svg)](https://docs.rs/aead) | -| [`block-cipher-trait`](https://en.wikipedia.org/wiki/Block_cipher)| [![crates.io](https://img.shields.io/crates/v/block-cipher-trait.svg)](https://crates.io/crates/block-cipher-trait) | [![Documentation](https://docs.rs/block-cipher-trait/badge.svg)](https://docs.rs/block-cipher-trait) | -| [`crypto-mac`](https://en.wikipedia.org/wiki/Message_authentication_code) | [![crates.io](https://img.shields.io/crates/v/crypto-mac.svg)](https://crates.io/crates/crypto-mac) | [![Documentation](https://docs.rs/crypto-mac/badge.svg)](https://docs.rs/crypto-mac) | -| [`digest`](https://en.wikipedia.org/wiki/Cryptographic_hash_function) | [![crates.io](https://img.shields.io/crates/v/digest.svg)](https://crates.io/crates/digest) | [![Documentation](https://docs.rs/digest/badge.svg)](https://docs.rs/digest) | -| [`signature`](https://en.wikipedia.org/wiki/Digital_signature) | [![crates.io](https://img.shields.io/crates/v/signature.svg)](https://crates.io/crates/signature) | [![Documentation](https://docs.rs/signature/badge.svg)](https://docs.rs/signature) | -| [`stream-cipher`](https://en.wikipedia.org/wiki/Stream_cipher) | [![crates.io](https://img.shields.io/crates/v/stream-cipher.svg)](https://crates.io/crates/stream-cipher) | [![Documentation](https://docs.rs/stream-cipher/badge.svg)](https://docs.rs/stream-cipher) | -| [`universal-hash`](https://en.wikipedia.org/wiki/Universal_hashing) | [![crates.io](https://img.shields.io/crates/v/universal-hash.svg)](https://crates.io/crates/universal-hash) | [![Documentation](https://docs.rs/universal-hash/badge.svg)](https://docs.rs/universal-hash) | + +| Name | Algorithm | Crates.io | Documentation | Build | +|--------------------|-------------------------------|-----------|----------------|-------| +| [`aead`] | [Authenticated encryption] | [![crates.io](https://img.shields.io/crates/v/aead.svg)](https://crates.io/crates/aead) | [![Documentation](https://docs.rs/aead/badge.svg)](https://docs.rs/aead) | N/A | +| [`block-cipher-trait`] | [Block cipher] | [![crates.io](https://img.shields.io/crates/v/block-cipher-trait.svg)](https://crates.io/crates/block-cipher-trait) | [![Documentation](https://docs.rs/block-cipher-trait/badge.svg)](https://docs.rs/block-cipher-trait) | ![block-cipher-trait](https://github.com/RustCrypto/traits/workflows/block-cipher-trait/badge.svg?branch=master&event=push) | +| [`crypto-mac`] | [Message authentication code] | [![crates.io](https://img.shields.io/crates/v/crypto-mac.svg)](https://crates.io/crates/crypto-mac) | [![Documentation](https://docs.rs/crypto-mac/badge.svg)](https://docs.rs/crypto-mac) | ![crypto-mac](https://github.com/RustCrypto/traits/workflows/crypto-mac/badge.svg?branch=master&event=push) | +| [`digest`] | [Cryptographic hash function] | [![crates.io](https://img.shields.io/crates/v/digest.svg)](https://crates.io/crates/digest) | [![Documentation](https://docs.rs/digest/badge.svg)](https://docs.rs/digest) | ![digest](https://github.com/RustCrypto/traits/workflows/digest/badge.svg?branch=master&event=push) | +| [`signature`] | [Digital signature] | [![crates.io](https://img.shields.io/crates/v/signature.svg)](https://crates.io/crates/signature) | [![Documentation](https://docs.rs/signature/badge.svg)](https://docs.rs/signature) | ![signature](https://github.com/RustCrypto/traits/workflows/signature/badge.svg?branch=master&event=push) | +| [`stream-cipher`] | [Stream cipher] | [![crates.io](https://img.shields.io/crates/v/stream-cipher.svg)](https://crates.io/crates/stream-cipher) | [![Documentation](https://docs.rs/stream-cipher/badge.svg)](https://docs.rs/stream-cipher) | ![stream-cipher](https://github.com/RustCrypto/traits/workflows/stream-cipher/badge.svg?branch=master&event=push) | +| [`universal-hash`] | [Universal hash function] | [![crates.io](https://img.shields.io/crates/v/universal-hash.svg)](https://crates.io/crates/universal-hash) | [![Documentation](https://docs.rs/universal-hash/badge.svg)](https://docs.rs/universal-hash) | ![universal-hash](https://github.com/RustCrypto/traits/workflows/universal-hash/badge.svg?branch=master&event=push) | ### Minimum Rust version @@ -33,3 +35,27 @@ at your option. 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) + +[rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg + +[//]: # (crates) + +[`aead`]: https://github.com/RustCrypto/traits/tree/master/aead +[`block-cipher-trait`]: https://github.com/RustCrypto/traits/tree/master/block-cipher-trait +[`crypto-mac`]: https://github.com/RustCrypto/traits/tree/master/crypto-mac +[`digest`]: https://github.com/RustCrypto/traits/tree/master/digest +[`signature`]: https://github.com/RustCrypto/traits/tree/master/signature +[`stream-cipher`]: https://github.com/RustCrypto/traits/tree/master/stream-cipher +[`universal-hash`]: https://github.com/RustCrypto/traits/tree/master/universal-hash + +[//]: # (algorithms) + +[Authenticated encryption]: https://en.wikipedia.org/wiki/Authenticated_encryption +[Block cipher]: https://en.wikipedia.org/wiki/Block_cipher +[Message authentication code]: https://en.wikipedia.org/wiki/Message_authentication_code +[Cryptographic hash function]: https://en.wikipedia.org/wiki/Cryptographic_hash_function +[Digital signature]: https://en.wikipedia.org/wiki/Digital_signature +[Stream cipher]: https://en.wikipedia.org/wiki/Stream_cipher +[Universal hash function]: https://en.wikipedia.org/wiki/Universal_hashing diff --git a/signature/README.md b/signature/README.md index fc39609f..0a46de4a 100644 --- a/signature/README.md +++ b/signature/README.md @@ -53,8 +53,9 @@ dual licensed as above, without any additional terms or conditions. [docs-link]: https://docs.rs/signature/ [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg [rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg -[build-image]: https://travis-ci.org/RustCrypto/traits.svg?branch=master -[build-link]: https://travis-ci.org/RustCrypto/traits +[build-image]: https://github.com/RustCrypto/traits/workflows/signature/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/Atraits/actions + [//]: # (general links)