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