Skip to content

Commit

Permalink
Fix MSRV badges
Browse files Browse the repository at this point in the history
  • Loading branch information
newpavlov committed Nov 25, 2024
1 parent fa7df79 commit 61d08f8
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 40 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Collection of password hashing algorithms, otherwise known as password-based key

| Algorithm | Crate | Crates.io | Documentation | MSRV |
|----------------|------------------|--------------------------------------------------------------------------------------------------------|---------------|-------------------------|
| [Argon2] | [`argon2`] | [![crates.io](https://img.shields.io/crates/v/argon2.svg)](https://crates.io/crates/argon2) | [![Documentation](https://docs.rs/argon2/badge.svg)](https://docs.rs/argon2) | ![MSRV 1.65][msrv-1.65] |
| [Balloon] | [`balloon‑hash`] | [![crates.io](https://img.shields.io/crates/v/balloon-hash.svg)](https://crates.io/crates/balloon-hash) | [![Documentation](https://docs.rs/balloon-hash/badge.svg)](https://docs.rs/balloon-hash) | ![MSRV 1.65][msrv-1.65] |
| [bcrypt‑pbkdf] | [`bcrypt‑pbkdf`] | [![crates.io](https://img.shields.io/crates/v/bcrypt-pbkdf.svg)](https://crates.io/crates/bcrypt-pbkdf) | [![Documentation](https://docs.rs/bcrypt-pbkdf/badge.svg)](https://docs.rs/bcrypt-pbkdf) | ![MSRV 1.60][msrv-1.60] |
| [PBKDF2] | [`pbkdf2`] | [![crates.io](https://img.shields.io/crates/v/pbkdf2.svg)](https://crates.io/crates/pbkdf2) | [![Documentation](https://docs.rs/pbkdf2/badge.svg)](https://docs.rs/pbkdf2) | ![MSRV 1.60][msrv-1.60] |
| [scrypt] | [`scrypt`] | [![crates.io](https://img.shields.io/crates/v/scrypt.svg)](https://crates.io/crates/scrypt) | [![Documentation](https://docs.rs/scrypt/badge.svg)](https://docs.rs/scrypt) | ![MSRV 1.60][msrv-1.60] |
| [SHA-crypt] | [`sha‑crypt`] | [![crates.io](https://img.shields.io/crates/v/sha-crypt.svg)](https://crates.io/crates/sha-crypt) | [![Documentation](https://docs.rs/sha-crypt/badge.svg)](https://docs.rs/sha-crypt) | ![MSRV 1.60][msrv-1.60] |
| [Argon2] | [`argon2`] | [![crates.io](https://img.shields.io/crates/v/argon2.svg)](https://crates.io/crates/argon2) | [![Documentation](https://docs.rs/argon2/badge.svg)](https://docs.rs/argon2) | ![MSRV 1.81][msrv-1.81] |
| [Balloon] | [`balloon‑hash`] | [![crates.io](https://img.shields.io/crates/v/balloon-hash.svg)](https://crates.io/crates/balloon-hash) | [![Documentation](https://docs.rs/balloon-hash/badge.svg)](https://docs.rs/balloon-hash) | ![MSRV 1.81][msrv-1.81] |
| [bcrypt‑pbkdf] | [`bcrypt‑pbkdf`] | [![crates.io](https://img.shields.io/crates/v/bcrypt-pbkdf.svg)](https://crates.io/crates/bcrypt-pbkdf) | [![Documentation](https://docs.rs/bcrypt-pbkdf/badge.svg)](https://docs.rs/bcrypt-pbkdf) | ![MSRV 1.81][msrv-1.81] |
| [PBKDF2] | [`pbkdf2`] | [![crates.io](https://img.shields.io/crates/v/pbkdf2.svg)](https://crates.io/crates/pbkdf2) | [![Documentation](https://docs.rs/pbkdf2/badge.svg)](https://docs.rs/pbkdf2) | ![MSRV 1.81][msrv-1.81] |
| [scrypt] | [`scrypt`] | [![crates.io](https://img.shields.io/crates/v/scrypt.svg)](https://crates.io/crates/scrypt) | [![Documentation](https://docs.rs/scrypt/badge.svg)](https://docs.rs/scrypt) | ![MSRV 1.81][msrv-1.81] |
| [SHA-crypt] | [`sha‑crypt`] | [![crates.io](https://img.shields.io/crates/v/sha-crypt.svg)](https://crates.io/crates/sha-crypt) | [![Documentation](https://docs.rs/sha-crypt/badge.svg)](https://docs.rs/sha-crypt) | ![MSRV 1.81][msrv-1.81] |

Please see the [OWASP Password Storage Cheat Sheet] for assistance in selecting an appropriate algorithm for your use case.

Expand Down Expand Up @@ -67,8 +67,7 @@ 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/password-hashes/status.svg
[deps-link]: https://deps.rs/repo/github/RustCrypto/password-hashes
[msrv-1.60]: https://img.shields.io/badge/rustc-1.60.0+-blue.svg
[msrv-1.65]: https://img.shields.io/badge/rustc-1.65.0+-blue.svg
[msrv-1.81]: https://img.shields.io/badge/rustc-1.81.0+-blue.svg

[//]: # (crates)

Expand Down
6 changes: 2 additions & 4 deletions argon2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@

Pure Rust implementation of the [Argon2] password hashing function.

[Documentation][docs-link]

# About

Argon2 is a memory-hard [key derivation function] chosen as the winner of
Expand All @@ -27,7 +25,7 @@ ones without `alloc` support.

## Minimum Supported Rust Version

Rust **1.65** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand Down Expand Up @@ -59,7 +57,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/argon2/badge.svg
[docs-link]: https://docs.rs/argon2/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/workflows/argon2/badge.svg?branch=master&event=push
Expand Down
6 changes: 2 additions & 4 deletions balloon-hash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@

Pure Rust implementation of the [Balloon] password hashing function.

[Documentation][docs-link]

## About

This crate contains an implementation of the Balloon password hashing
Expand All @@ -26,7 +24,7 @@ This algorithm is first practical password hashing function that provides:

## Minimum Supported Rust Version

Rust **1.65** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand Down Expand Up @@ -58,7 +56,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/balloon-hash/badge.svg
[docs-link]: https://docs.rs/balloon-hash/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/workflows/balloon/badge.svg?branch=master&event=push
Expand Down
6 changes: 2 additions & 4 deletions bcrypt-pbkdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@
Pure Rust implementation of the [`bcrypt_pbkdf`] password-based key derivation
function, a custom derivative of PBKDF2 [used in OpenSSH].

[Documentation][docs-link]

## Minimum Supported Rust Version

Rust **1.60** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand Down Expand Up @@ -46,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/bcrypt-pbkdf/badge.svg
[docs-link]: https://docs.rs/bcrypt-pbkdf/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.60+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/workflows/bcrypt-pbkdf/badge.svg?branch=master&event=push
Expand Down
6 changes: 2 additions & 4 deletions password-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
Password authentication library with a focus on simplicity and ease-of-use,
with support for [Argon2], [PBKDF2], and [scrypt] password hashing algorithms.

[Documentation][docs-link]

## About

`password-auth` is a high-level password authentication library with a simple
Expand Down Expand Up @@ -42,7 +40,7 @@ scrypt as well, if you have them in your password database.

## Minimum Supported Rust Version

Rust **1.65** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand Down Expand Up @@ -74,7 +72,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/password-auth/badge.svg
[docs-link]: https://docs.rs/password-auth/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/workflows/password-auth/badge.svg?branch=master&event=push
Expand Down
6 changes: 2 additions & 4 deletions pbkdf2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@

Pure Rust implementation of the [Password-Based Key Derivation Function v2 (PBKDF2)][1].

[Documentation][docs-link]

## Minimum Supported Rust Version

Rust **1.60** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand Down Expand Up @@ -45,7 +43,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/pbkdf2/badge.svg
[docs-link]: https://docs.rs/pbkdf2/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.51+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/workflows/pbkdf2/badge.svg?branch=master&event=push
Expand Down
6 changes: 2 additions & 4 deletions scrypt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@

Pure Rust implementation of the [scrypt key derivation function][1].

[Documentation][docs-link]

## Minimum Supported Rust Version

Rust **1.60** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand Down Expand Up @@ -45,7 +43,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/scrypt/badge.svg
[docs-link]: https://docs.rs/scrypt/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.60+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/workflows/scrypt/badge.svg?branch=master&event=push
Expand Down
6 changes: 2 additions & 4 deletions sha-crypt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@ a legacy password hashing scheme supported by the [POSIX crypt C library][2].
Password hashes using this algorithm start with `$6$` when encoded using the
[PHC string format][3].

[Documentation][docs-link]

## Minimum Supported Rust Version

Rust **1.60** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand Down Expand Up @@ -49,7 +47,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/sha-crypt/badge.svg
[docs-link]: https://docs.rs/sha-crypt/
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.60+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/workflows/sha-crypt/badge.svg?branch=master&event=push
Expand Down
6 changes: 2 additions & 4 deletions yescrypt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@

Pure Rust implementation of the [yescrypt] password-based key derivation function.

[Documentation][docs-link]

## ⚠️ Security Warning

The implementation contained in this crate has never been independently audited!
Expand All @@ -19,7 +17,7 @@ USE AT YOUR OWN RISK!

## Minimum Supported Rust Version

Rust **1.72** or higher.
Rust **1.81** or higher.

Minimum supported Rust version can be changed in the future, but it will be
done with a minor version bump.
Expand All @@ -46,7 +44,7 @@ dual licensed as above, without any additional terms or conditions.
[docs-image]: https://docs.rs/yescrypt/badge.svg
[docs-link]: https://docs.rs/yescrypt/
[license-image]: https://img.shields.io/crates/l/yescrypt?style=flat-square
[rustc-image]: https://img.shields.io/badge/rustc-1.60+-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.81+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260046-password-hashes
[build-image]: https://github.com/RustCrypto/password-hashes/actions/workflows/yescrypt.yml/badge.svg
Expand Down

0 comments on commit 61d08f8

Please sign in to comment.