| # RustCrypto: SHA-1 |
| |
| [![crate][crate-image]][crate-link] |
| [![Docs][docs-image]][docs-link] |
| ![Apache2/MIT licensed][license-image] |
| ![Rust Version][rustc-image] |
| [![Project Chat][chat-image]][chat-link] |
| [![Build Status][build-image]][build-link] |
| |
| Pure Rust implementation of the [SHA-1 hash function][1]. |
| |
| [Documentation][docs-link] |
| |
| ## 🚨 Warning: Cryptographically Broken 🚨 |
| |
| The SHA-1 hash function should be considered cryptographically broken and |
| unsuitable for further use in any security critical capacity, as it is |
| [practically vulnerable to chosen-prefix collisions][2]. |
| |
| We provide this crate for legacy interoperability purposes only. |
| |
| ## Minimum Supported Rust Version |
| |
| Rust **1.41** 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 |
| |
| ## 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://img.shields.io/crates/v/sha-1.svg |
| [crate-link]: https://crates.io/crates/sha-1 |
| [docs-image]: https://docs.rs/sha-1/badge.svg |
| [docs-link]: https://docs.rs/sha-1/ |
| [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 |
| [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg |
| [chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260041-hashes |
| [build-image]: https://github.com/RustCrypto/hashes/workflows/sha1/badge.svg?branch=master |
| [build-link]: https://github.com/RustCrypto/hashes/actions?query=workflow%3Asha1 |
| |
| [//]: # (general links) |
| |
| [1]: https://en.wikipedia.org/wiki/SHA-1 |
| [2]: https://sha-mbles.github.io/ |
