1# rand_hc
2
3[![Test Status](https://github.com/rust-random/rand/workflows/Tests/badge.svg?event=push)](https://github.com/rust-random/rand/actions)
4[![Latest version](https://img.shields.io/crates/v/rand_hc.svg)](https://crates.io/crates/rand_hc)
5[[![Book](https://img.shields.io/badge/book-master-yellow.svg)](https://rust-random.github.io/book/)
6[![API](https://img.shields.io/badge/api-master-yellow.svg)](https://rust-random.github.io/rand/rand_hc)
7[![API](https://docs.rs/rand_hc/badge.svg)](https://docs.rs/rand_hc)
8[![Minimum rustc version](https://img.shields.io/badge/rustc-1.36+-lightgray.svg)](https://github.com/rust-random/rand#rust-version-requirements)
9
10A cryptographically secure random number generator that uses the HC-128
11algorithm.
12
13HC-128 is a stream cipher designed by Hongjun Wu[^1], that we use as an
14RNG. It is selected as one of the "stream ciphers suitable for widespread
15adoption" by eSTREAM[^2].
16
17Links:
18
19-   [API documentation (master)](https://rust-random.github.io/rand/rand_hc)
20-   [API documentation (docs.rs)](https://docs.rs/rand_hc)
21-   [Changelog](https://github.com/rust-random/rand/blob/master/rand_hc/CHANGELOG.md)
22
23[rand]: https://crates.io/crates/rand
24[^1]: Hongjun Wu (2008). ["The Stream Cipher HC-128"](
25      http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc128_p3.pdf).
26      *The eSTREAM Finalists*, LNCS 4986, pp. 39–47, Springer-Verlag.
27
28[^2]: [eSTREAM: the ECRYPT Stream Cipher Project](
29      http://www.ecrypt.eu.org/stream/)
30
31
32## Crate Features
33
34`rand_hc` is `no_std` compatible. It does not require any functionality
35outside of the `core` lib, thus there are no features to configure.
36
37
38# License
39
40`rand_hc` is distributed under the terms of both the MIT license and the
41Apache License (Version 2.0).
42
43See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and
44[COPYRIGHT](COPYRIGHT) for details.
45