Skip to content

Commit

Permalink
Update root README (#38)
Browse files Browse the repository at this point in the history
Add `belt-kwp` to the algorithms table and fix MSRV for `aes-kw`.
  • Loading branch information
newpavlov authored Nov 5, 2024
1 parent d3f8237 commit 92cd9e1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ storage or transmitting keys over untrusted communications networks.

| Algorithm | Crate | Crates.io | Documentation | MSRV |
|-----------|--------|:-------------:|:-------------:|:----:|
| [AES-KW] and [AES-KWP] | [`aes‑kw`] | [![crates.io](https://img.shields.io/crates/v/aes-kw.svg)](https://crates.io/crates/aes-kw) | [![Documentation](https://docs.rs/aes-kw/badge.svg)](https://docs.rs/aes-kw) | ![MSRV 1.56][msrv-1.56] |
| [AES-KW] and [AES-KWP] | [`aes‑kw`] | [![crates.io](https://img.shields.io/crates/v/aes-kw.svg)](https://crates.io/crates/aes-kw) | [![Documentation](https://docs.rs/aes-kw/badge.svg)](https://docs.rs/aes-kw) | ![MSRV 1.81][msrv-1.81] |
| [`belt-kwp`][belt-kwp-spec] | [`belt-kwp`][belt-kwp-crate] | [![crates.io](https://img.shields.io/crates/v/belt-kwp.svg)](https://crates.io/crates/belt-kwp) | [![Documentation](https://docs.rs/belt-kwp/badge.svg)](https://docs.rs/belt-kwp) | ![MSRV 1.81][msrv-1.81] |

*NOTE: for modern proven KWs (e.g. AES-SIV, AES-GCM-SIV), please see [RustCrypto/AEADs]*

Expand All @@ -43,15 +44,17 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[deps-image]: https://deps.rs/repo/github/RustCrypto/key-wraps/status.svg
[deps-link]: https://deps.rs/repo/github/RustCrypto/key-wraps
[msrv-1.56]: https://img.shields.io/badge/rustc-1.56.0+-blue.svg
[msrv-1.81]: https://img.shields.io/badge/rustc-1.81.0+-blue.svg

[//]: # (crates)

[`aes‑kw`]: ./aes-kw
[belt-kwp-crate]: ./belt-kwp

[//]: # (algorithms)

[KW]: https://en.wikipedia.org/wiki/Key_Wrap
[AES-KW]: https://datatracker.ietf.org/doc/html/rfc3394
[AES-KWP]: https://datatracker.ietf.org/doc/html/rfc5649
[belt-kwp-spec]: https://apmi.bsu.by/assets/files/std/belt-spec371.pdf
[RustCrypto/AEADs]: https://github.com/RustCrypto/AEADs
4 changes: 2 additions & 2 deletions aes-kw/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Implemented for 128/192/256bit keys.

## Minimum Supported Rust Version

This crate requires **Rust 1.56** at a minimum.
This crate requires **Rust 1.81** at a minimum.

We may change the MSRV in the future, but it will be accompanied by a minor
version bump.
Expand All @@ -131,7 +131,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/aes-kw/badge.svg
[docs-link]: https://docs.rs/aes-kw/
[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
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[build-image]: https://github.com/RustCrypto/key-wraps/actions/workflows/aes-kw.yml/badge.svg
[build-link]: https://github.com/RustCrypto/key-wraps/actions/workflows/aes-kw.yml

Expand Down

0 comments on commit 92cd9e1

Please sign in to comment.