1# RustCrypto: SHA-1
2
3[![crate][crate-image]][crate-link]
4[![Docs][docs-image]][docs-link]
5![Apache2/MIT licensed][license-image]
6![Rust Version][rustc-image]
7[![Project Chat][chat-image]][chat-link]
8[![Build Status][build-image]][build-link]
9
10Pure Rust implementation of the [SHA-1 hash function][1].
11
12[Documentation][docs-link]
13
14## �� Warning: Cryptographically Broken ��
15
16The SHA-1 hash function should be considered cryptographically broken and
17unsuitable for further use in any security critical capacity, as it is
18[practically vulnerable to chosen-prefix collisions][2].
19
20We provide this crate for legacy interoperability purposes only.
21
22## Minimum Supported Rust Version
23
24Rust **1.41** or higher.
25
26Minimum supported Rust version can be changed in the future, but it will be
27done with a minor version bump.
28
29## SemVer Policy
30
31- All on-by-default features of this library are covered by SemVer
32- MSRV is considered exempt from SemVer as noted above
33
34## License
35
36Licensed under either of:
37
38 * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
39 * [MIT license](http://opensource.org/licenses/MIT)
40
41at your option.
42
43### Contribution
44
45Unless you explicitly state otherwise, any contribution intentionally submitted
46for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
47dual licensed as above, without any additional terms or conditions.
48
49[//]: # (badges)
50
51[crate-image]: https://img.shields.io/crates/v/sha-1.svg
52[crate-link]: https://crates.io/crates/sha-1
53[docs-image]: https://docs.rs/sha-1/badge.svg
54[docs-link]: https://docs.rs/sha-1/
55[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
56[rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg
57[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
58[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260041-hashes
59[build-image]: https://github.com/RustCrypto/hashes/workflows/sha1/badge.svg?branch=master
60[build-link]: https://github.com/RustCrypto/hashes/actions?query=workflow%3Asha1
61
62[//]: # (general links)
63
64[1]: https://en.wikipedia.org/wiki/SHA-1
65[2]: https://sha-mbles.github.io/
66