Move ChaCha and HC128 RNG to dedicated crates

This commit is contained in:
Vinzent Steinberg
2018-09-14 14:33:08 +02:00
parent a55ba3feb4
commit 37a69fbd95
32 changed files with 803 additions and 46 deletions
+11 -1
View File
@@ -56,7 +56,9 @@ sudo: false
# `cargo test --package rand_core --no-default-features`
# `cargo test --package rand_isaac --features=serde1`
# `cargo test --package rand_xorshift --features=serde1`
#
# `cargo test --package rand_chacha`
# `cargo test --package rand_hc128`
#
# TODO: SIMD support on stable releases
# NOTE: SIMD support is unreliable on nightly; we track the latest release
matrix:
@@ -72,6 +74,8 @@ matrix:
- cargo test --package rand_core --no-default-features
- cargo test --package rand_isaac --features=serde1
# - cargo test --package rand_xorshift --features=serde1
- cargo test --package rand_chacha
- cargo test --package rand_hc128
- rust: stable
env: DESCRIPTION="stable Rust release, macOS, iOS (cross-compile only)"
@@ -87,6 +91,8 @@ matrix:
- cargo test --package rand_core --no-default-features
- cargo test --package rand_isaac --features=serde1
- cargo test --package rand_xorshift --features=serde1
- cargo test --package rand_chacha
- cargo test --package rand_hc128
- cargo build --target=aarch64-apple-ios
- rust: beta
@@ -101,6 +107,8 @@ matrix:
- cargo test --package rand_core --no-default-features
- cargo test --package rand_isaac --features=serde1
- cargo test --package rand_xorshift --features=serde1
- cargo test --package rand_chacha
- cargo test --package rand_hc128
- rust: nightly
env: DESCRIPTION="nightly features, benchmarks, documentation"
@@ -118,6 +126,8 @@ matrix:
- cargo test --package rand_core --no-default-features --features=alloc
- cargo test --package rand_isaac --features=serde1
# - cargo test --package rand_xorshift --features=serde1
- cargo test --package rand_chacha
- cargo test --package rand_hc128
# remove cached documentation, otherwise files from previous PRs can get included
- rm -rf target/doc
- cargo doc --no-deps --all --all-features
+3 -1
View File
@@ -28,12 +28,14 @@ simd_support = ["packed_simd"] # enables SIMD support
serde1 = ["rand_core/serde1", "rand_isaac/serde1", "rand_xorshift/serde1"] # enables serialization for PRNGs
[workspace]
members = ["rand_core", "rand_isaac", "rand_xorshift"]
members = ["rand_core", "rand_isaac", "rand_chacha", "rand_hc128", "rand_xorshift"]
[dependencies]
rand_core = { path = "rand_core", version = "0.3", default-features = false }
# only for deprecations and benches:
rand_isaac = { path = "rand_isaac", version = "0.1" }
rand_chacha = { path = "rand_chacha", version = "0.1" }
rand_hc128 = { path = "rand_hc128", version = "0.1" }
rand_xorshift = { path = "rand_xorshift", version = "0.1" }
log = { version = "0.4", optional = true }
+2
View File
@@ -41,3 +41,5 @@ test_script:
- cargo test --package rand_core --no-default-features --features=alloc
- cargo test --package rand_isaac --features=serde1
- cargo test --package rand_xorshift --features=serde1
- cargo test --package rand_chacha
- cargo test --package rand_hc128
+4 -2
View File
@@ -11,6 +11,8 @@
extern crate test;
extern crate rand;
extern crate rand_isaac;
extern crate rand_chacha;
extern crate rand_hc128;
extern crate rand_xorshift;
const RAND_BENCH_N: u64 = 1000;
@@ -20,11 +22,11 @@ use std::mem::size_of;
use test::{black_box, Bencher};
use rand::prelude::*;
use rand::prng::{Hc128Rng, ChaChaRng};
use rand::prng::hc128::Hc128Core;
use rand::rngs::adapter::ReseedingRng;
use rand::rngs::{OsRng, JitterRng, EntropyRng};
use rand_isaac::{IsaacRng, Isaac64Rng};
use rand_chacha::ChaChaRng;
use rand_hc128::{Hc128Rng, Hc128Core};
use rand_xorshift::XorShiftRng;
macro_rules! gen_bytes {
+8
View File
@@ -0,0 +1,8 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.1.0] - 2018-09-??
- Initial release
+12
View File
@@ -0,0 +1,12 @@
Copyrights in the Rand project are retained by their contributors. No
copyright assignment is required to contribute to the Rand project.
For full authorship information, see the version control history.
Except as otherwise noted (below and/or in individual files), Rand is
licensed under the Apache License, Version 2.0 <LICENSE-APACHE> or
<http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
<LICENSE-MIT> or <http://opensource.org/licenses/MIT>, at your option.
The Rand project includes code from the Rust project
published under these same licenses.
+25
View File
@@ -0,0 +1,25 @@
[package]
name = "rand_chacha"
version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
authors = ["The Rand Project Developers", "The Rust Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
documentation = "https://docs.rs/rand_chacha"
homepage = "https://crates.io/crates/rand_chacha"
description = """
ChaCha random number generator
"""
keywords = ["random", "rng", "chacha"]
categories = ["algorithms", "no-std"]
build = "build.rs"
[badges]
travis-ci = { repository = "rust-random/rand" }
appveyor = { repository = "dhardy/rand" }
[dependencies]
rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false }
[build-dependencies]
rustc_version = "0.2"
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
https://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+26
View File
@@ -0,0 +1,26 @@
Copyright 2018 Developers of the Rand project
Copyright (c) 2014 The Rust Project Developers
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
+44
View File
@@ -0,0 +1,44 @@
# rand_chacha
[![Build Status](https://travis-ci.org/rust-random/rand.svg)](https://travis-ci.org/rust-random/rand)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/dhardy/rand)
[![Latest version](https://img.shields.io/crates/v/rand_chacha.svg)](https://crates.io/crates/rand_chacha)
[![Documentation](https://docs.rs/rand_chacha/badge.svg)](https://docs.rs/rand_chacha)
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-yellow.svg)](https://github.com/rust-random/rand#rust-version-requirements)
[![License](https://img.shields.io/crates/l/rand_chacha.svg)](https://github.com/rust-random/rand/tree/master/rand_chacha#license)
A cryptographically secure random number generator that uses the ChaCha
algorithm.
ChaCha is a stream cipher designed by Daniel J. Bernstein[^1], that we use
as an RNG. It is an improved variant of the Salsa20 cipher family, which was
selected as one of the "stream ciphers suitable for widespread adoption" by
eSTREAM[^2].
Documentation:
[master branch](https://rust-random.github.io/rand/rand_chacha/index.html),
[by release](https://docs.rs/rand_chacha)
[Changelog](CHANGELOG.md)
[rand]: https://crates.io/crates/rand
[^1]: D. J. Bernstein, [*ChaCha, a variant of Salsa20*](
https://cr.yp.to/chacha.html)
[^2]: [eSTREAM: the ECRYPT Stream Cipher Project](
http://www.ecrypt.eu.org/stream/)
## Crate Features
`rand_chacha` is `no_std` compatible. It does not require any functionality
outside of the `core` lib, thus there are no features to configure.
# License
`rand_chacha` is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and
[COPYRIGHT](COPYRIGHT) for details.
+8
View File
@@ -0,0 +1,8 @@
extern crate rustc_version;
use rustc_version::{version, Version};
fn main() {
if version().unwrap() >= Version::parse("1.26.0").unwrap() {
println!("cargo:rustc-cfg=rust_1_26");
}
}
@@ -64,8 +64,8 @@ const STATE_WORDS: usize = 16;
///
/// [`set_word_pos`]: #method.set_word_pos
/// [`set_stream`]: #method.set_stream
/// [`BlockRng`]: ../../../rand_core/block/struct.BlockRng.html
/// [`RngCore`]: ../../trait.RngCore.html
/// [`BlockRng`]: ../rand_core/block/struct.BlockRng.html
/// [`RngCore`]: ../rand_core/trait.RngCore.html
#[derive(Clone, Debug)]
pub struct ChaChaRng(BlockRng<ChaChaCore>);
@@ -107,12 +107,12 @@ impl CryptoRng for ChaChaRng {}
impl ChaChaRng {
/// Get the offset from the start of the stream, in 32-bit words.
///
///
/// Since the generated blocks are 16 words (2<sup>4</sup>) long and the
/// counter is 64-bits, the offset is a 68-bit number. Sub-word offsets are
/// not supported, hence the result can simply be multiplied by 4 to get a
/// byte-offset.
///
///
/// Note: this function is currently only available with Rust 1.26 or later.
#[cfg(rust_1_26)]
pub fn get_word_pos(&self) -> u128 {
@@ -129,11 +129,11 @@ impl ChaChaRng {
}
/// Set the offset from the start of the stream, in 32-bit words.
///
///
/// As with `get_word_pos`, we use a 68-bit number. Since the generator
/// simply cycles at the end of its period (1 ZiB), we ignore the upper
/// 60 bits.
///
///
/// Note: this function is currently only available with Rust 1.26 or later.
#[cfg(rust_1_26)]
pub fn set_word_pos(&mut self, word_offset: u128) {
@@ -152,7 +152,7 @@ impl ChaChaRng {
///
/// This is initialized to zero; 2<sup>64</sup> unique streams of output
/// are available per seed/key.
///
///
/// Note that in order to reproduce ChaCha output with a specific 64-bit
/// nonce, one can convert that nonce to a `u64` in little-endian fashion
/// and pass to this function. In theory a 96-bit nonce can be used by
@@ -268,7 +268,7 @@ impl From<ChaChaCore> for ChaChaRng {
#[cfg(test)]
mod test {
use {RngCore, SeedableRng};
use ::rand_core::{RngCore, SeedableRng};
use super::ChaChaRng;
#[test]
@@ -358,7 +358,7 @@ mod test {
for i in results.iter_mut() { *i = rng2.next_u32(); }
assert_eq!(results, expected);
assert_eq!(rng2.get_word_pos(), expected_end);
// Test skipping behaviour with other types
let mut buf = [0u8; 32];
rng2.fill_bytes(&mut buf[..]);
@@ -436,7 +436,7 @@ mod test {
for _ in 0..16 {
assert_eq!(rng.next_u64(), clone.next_u64());
}
rng.set_stream(51);
for _ in 0..7 {
assert!(rng.next_u32() != clone.next_u32());
+25
View File
@@ -0,0 +1,25 @@
// Copyright 2018 Developers of the Rand project.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! The ChaCha random number generator.
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
html_root_url = "https://docs.rs/rand_chacha/0.1.0")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![doc(test(attr(allow(unused_variables), deny(warnings))))]
#![no_std]
extern crate rand_core;
mod chacha;
pub use chacha::{ChaChaRng, ChaChaCore};
+8
View File
@@ -0,0 +1,8 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.1.0] - 2018-09-??
- Initial release
+12
View File
@@ -0,0 +1,12 @@
Copyrights in the Rand project are retained by their contributors. No
copyright assignment is required to contribute to the Rand project.
For full authorship information, see the version control history.
Except as otherwise noted (below and/or in individual files), Rand is
licensed under the Apache License, Version 2.0 <LICENSE-APACHE> or
<http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
<LICENSE-MIT> or <http://opensource.org/licenses/MIT>, at your option.
The Rand project includes code from the Rust project
published under these same licenses.
+21
View File
@@ -0,0 +1,21 @@
[package]
name = "rand_hc128"
version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
authors = ["The Rand Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
documentation = "https://docs.rs/rand_hc128"
homepage = "https://crates.io/crates/rand_hc128"
description = """
HC128 random number generator
"""
keywords = ["random", "rng", "hc128"]
categories = ["algorithms", "no-std"]
[badges]
travis-ci = { repository = "rust-random/rand" }
appveyor = { repository = "dhardy/rand" }
[dependencies]
rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false }
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
https://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+25
View File
@@ -0,0 +1,25 @@
Copyright 2018 Developers of the Rand project
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
+44
View File
@@ -0,0 +1,44 @@
# rand_hc128
[![Build Status](https://travis-ci.org/rust-random/rand.svg)](https://travis-ci.org/rust-random/rand)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/dhardy/rand)
[![Latest version](https://img.shields.io/crates/v/rand_hc128.svg)](https://crates.io/crates/rand_hc128)
[![Documentation](https://docs.rs/rand_hc128/badge.svg)](https://docs.rs/rand_hc128)
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-yellow.svg)](https://github.com/rust-random/rand#rust-version-requirements)
[![License](https://img.shields.io/crates/l/rand_hc128.svg)](https://github.com/rust-random/rand/tree/master/rand_hc128#license)
A cryptographically secure random number generator that uses the HC-128
algorithm.
HC-128 is a stream cipher designed by Hongjun Wu[^1], that we use as an
RNG. It is selected as one of the "stream ciphers suitable for widespread
adoption" by eSTREAM[^2].
Documentation:
[master branch](https://rust-random.github.io/rand/rand_hc128/index.html),
[by release](https://docs.rs/rand_hc128)
[Changelog](CHANGELOG.md)
[rand]: https://crates.io/crates/rand
[^1]: Hongjun Wu (2008). ["The Stream Cipher HC-128"](
http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc128_p3.pdf).
*The eSTREAM Finalists*, LNCS 4986, pp. 3947, Springer-Verlag.
[^2]: [eSTREAM: the ECRYPT Stream Cipher Project](
http://www.ecrypt.eu.org/stream/)
## Crate Features
`rand_hc128` is `no_std` compatible. It does not require any functionality
outside of the `core` lib, thus there are no features to configure.
# License
`rand_hc128` is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and
[COPYRIGHT](COPYRIGHT) for details.
@@ -64,8 +64,8 @@ const SEED_WORDS: usize = 8; // 128 bit key followed by 128 bit iv
/// [^5]: Internet Engineering Task Force (February 2015),
/// ["Prohibiting RC4 Cipher Suites"](https://tools.ietf.org/html/rfc7465).
///
/// [`BlockRng`]: ../../../rand_core/block/struct.BlockRng.html
/// [`RngCore`]: ../../trait.RngCore.html
/// [`BlockRng`]: ../rand_core/block/struct.BlockRng.html
/// [`RngCore`]: ../rand_core/trait.RngCore.html
#[derive(Clone, Debug)]
pub struct Hc128Rng(BlockRng<Hc128Core>);
@@ -334,7 +334,7 @@ impl CryptoRng for Hc128Core {}
#[cfg(test)]
mod test {
use {RngCore, SeedableRng};
use ::rand_core::{RngCore, SeedableRng};
use super::Hc128Rng;
#[test]
+25
View File
@@ -0,0 +1,25 @@
// Copyright 2018 Developers of the Rand project.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! The HC128 random number generator.
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
html_root_url = "https://docs.rs/rand_hc128/0.1.0")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![doc(test(attr(allow(unused_variables), deny(warnings))))]
#![no_std]
extern crate rand_core;
mod hc128;
pub use hc128::{Hc128Rng, Hc128Core};
+1 -1
View File
@@ -21,7 +21,7 @@ appveyor = { repository = "dhardy/rand" }
serde1 = ["serde", "serde_derive", "rand_core/serde1"]
[dependencies]
rand_core = { path = "../rand_core", version = "0.3", default-features=false }
rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false }
serde = { version = "1", optional = true }
serde_derive = { version = "^1.0.38", optional = true }
+1 -1
View File
@@ -86,7 +86,7 @@ const RAND_SIZE: usize = 1 << RAND_SIZE_LEN;
/// [^3]: Jean-Philippe Aumasson, [*On the pseudo-random generator ISAAC*](
/// https://eprint.iacr.org/2006/438)
///
/// [`Hc128Rng`]: ../../rand/prng//hc128/struct.Hc128Rng.html
/// [`Hc128Rng`]: ../../rand_hc128/struct.Hc128Rng.html
/// [`BlockRng`]: ../../rand_core/block/struct.BlockRng.html
/// [`RngCore`]: ../../rand_core/trait.RngCore.html
#[derive(Clone, Debug)]
+1 -1
View File
@@ -76,7 +76,7 @@ const RAND_SIZE: usize = 1 << RAND_SIZE_LEN;
/// http://burtleburtle.net/bob/rand/isaac.html)
///
/// [`IsaacRng`]: ../isaac/struct.IsaacRng.html
/// [`Hc128Rng`]: ../../rand/prng/hc128/struct.Hc128Rng.html
/// [`Hc128Rng`]: ../../rand_hc128/struct.Hc128Rng.html
/// [`BlockRng64`]: ../../rand_core/block/struct.BlockRng64.html
/// [`RngCore`]: ../../rand_core/trait.RngCore.html
#[derive(Clone, Debug)]
+49 -6
View File
@@ -10,10 +10,12 @@
#![allow(deprecated)]
use {prng, rngs};
use rngs;
use {RngCore, CryptoRng, SeedableRng, Error};
use rand_core::block::BlockRngCore;
use rand_isaac;
use rand_chacha;
use rand_hc128;
#[cfg(feature="std")]
use std::io::Read;
@@ -111,8 +113,8 @@ impl Isaac64Rng {
#[derive(Clone, Debug)]
#[deprecated(since="0.6.0", note="import with rand::prng::ChaChaRng instead")]
pub struct ChaChaRng(prng::ChaChaRng);
#[deprecated(since="0.6.0", note="import from rand_chacha crate instead")]
pub struct ChaChaRng(rand_chacha::ChaChaRng);
impl RngCore for ChaChaRng {
#[inline(always)]
@@ -137,14 +139,14 @@ impl RngCore for ChaChaRng {
}
impl SeedableRng for ChaChaRng {
type Seed = <prng::ChaChaRng as SeedableRng>::Seed;
type Seed = <rand_chacha::ChaChaRng as SeedableRng>::Seed;
fn from_seed(seed: Self::Seed) -> Self {
ChaChaRng(prng::ChaChaRng::from_seed(seed))
ChaChaRng(rand_chacha::ChaChaRng::from_seed(seed))
}
fn from_rng<R: RngCore>(rng: R) -> Result<Self, Error> {
prng::ChaChaRng::from_rng(rng).map(ChaChaRng)
rand_chacha::ChaChaRng::from_rng(rng).map(ChaChaRng)
}
}
@@ -167,6 +169,47 @@ impl ChaChaRng {
impl CryptoRng for ChaChaRng {}
#[derive(Clone, Debug)]
#[deprecated(since="0.6.0", note="import from rand_hc128 crate instead")]
pub struct Hc128Rng(rand_hc128::Hc128Rng);
impl RngCore for Hc128Rng {
#[inline(always)]
fn next_u32(&mut self) -> u32 {
self.0.next_u32()
}
#[inline(always)]
fn next_u64(&mut self) -> u64 {
self.0.next_u64()
}
#[inline(always)]
fn fill_bytes(&mut self, dest: &mut [u8]) {
self.0.fill_bytes(dest);
}
#[inline(always)]
fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error> {
self.0.try_fill_bytes(dest)
}
}
impl SeedableRng for Hc128Rng {
type Seed = <rand_hc128::Hc128Rng as SeedableRng>::Seed;
fn from_seed(seed: Self::Seed) -> Self {
Hc128Rng(rand_hc128::Hc128Rng::from_seed(seed))
}
fn from_rng<R: RngCore>(rng: R) -> Result<Self, Error> {
rand_hc128::Hc128Rng::from_rng(rng).map(Hc128Rng)
}
}
impl CryptoRng for Hc128Rng {}
#[derive(Clone, Debug)]
#[deprecated(since="0.6.0", note="import from rand_xorshift crate instead")]
pub struct XorShiftRng(::rand_xorshift::XorShiftRng);
+2
View File
@@ -243,6 +243,8 @@ extern crate wasm_bindgen;
extern crate rand_core;
extern crate rand_isaac; // only for deprecations
extern crate rand_chacha; // only for deprecations
extern crate rand_hc128;
extern crate rand_xorshift;
#[cfg(feature = "log")] #[macro_use] extern crate log;
+12 -9
View File
@@ -298,8 +298,8 @@
//! [basic PRNGs]: #basic-pseudo-random-number-generators-prngs
//! [CSPRNGs]: #cryptographically-secure-pseudo-random-number-generators-csprngs
//! [`XorShiftRng`]: ../../rand_xorshift/struct.XorShiftRng.html
//! [`ChaChaRng`]: chacha/struct.ChaChaRng.html
//! [`Hc128Rng`]: hc128/struct.Hc128Rng.html
//! [`ChaChaRng`]: ../../rand_chacha/struct.ChaChaRng.html
//! [`Hc128Rng`]: ../../rand_hc128/struct.Hc128Rng.html
//! [`IsaacRng`]: ../../rand_isaac/isaac/struct.IsaacRng.html
//! [`Isaac64Rng`]: ../../rand_isaac/isaac64/struct.Isaac64Rng.html
//! [`ThreadRng`]: ../rngs/struct.ThreadRng.html
@@ -313,13 +313,6 @@
//! [RustCrypto libraries]: https://github.com/RustCrypto
//! [next-bit test]: https://en.wikipedia.org/wiki/Next-bit_test
pub mod chacha;
pub mod hc128;
pub use self::chacha::ChaChaRng;
pub use self::hc128::Hc128Rng;
// Deprecations (to be removed in 0.7)
#[doc(hidden)] #[allow(deprecated)]
pub use deprecated::XorShiftRng;
@@ -331,3 +324,13 @@ pub use deprecated::XorShiftRng;
#[allow(deprecated)] pub use deprecated::Isaac64Rng;
}
#[doc(hidden)] #[allow(deprecated)] pub use deprecated::{IsaacRng, Isaac64Rng};
#[doc(hidden)] pub mod chacha {
// Note: we miss `ChaChaCore` here but probably unimportant.
#[allow(deprecated)] pub use deprecated::ChaChaRng;
}
#[doc(hidden)] #[allow(deprecated)] pub use deprecated::ChaChaRng;
#[doc(hidden)] pub mod hc128 {
// Note: we miss `Hc128Core` here but probably unimportant.
#[allow(deprecated)] pub use deprecated::Hc128Rng;
}
#[doc(hidden)] #[allow(deprecated)] pub use deprecated::Hc128Rng;
+9 -5
View File
@@ -57,9 +57,12 @@ use rand_core::block::{BlockRngCore, BlockRng};
/// # Example
///
/// ```
/// # extern crate rand;
/// # extern crate rand_chacha;
/// # fn main() {
/// use rand::prelude::*;
/// use rand::prng::chacha::ChaChaCore; // Internal part of ChaChaRng that
/// // implements BlockRngCore
/// use rand_chacha::ChaChaCore; // Internal part of ChaChaRng that
/// // implements BlockRngCore
/// use rand::rngs::OsRng;
/// use rand::rngs::adapter::ReseedingRng;
///
@@ -73,10 +76,11 @@ use rand_core::block::{BlockRngCore, BlockRng};
///
/// let mut cloned_rng = reseeding_rng.clone();
/// assert!(reseeding_rng.gen::<u64>() != cloned_rng.gen::<u64>());
/// # }
/// ```
///
/// [`ChaChaCore`]: ../../prng/chacha/struct.ChaChaCore.html
/// [`Hc128Core`]: ../../prng/hc128/struct.Hc128Core.html
/// [`ChaChaCore`]: ../../../rand_chacha/struct.ChaChaCore.html
/// [`Hc128Core`]: ../../../rand_hc128/struct.Hc128Core.html
/// [`BlockRngCore`]: ../../../rand_core/block/trait.BlockRngCore.html
/// [`ReseedingRng::new`]: struct.ReseedingRng.html#method.new
/// [`reseed()`]: struct.ReseedingRng.html#method.reseed
@@ -329,7 +333,7 @@ mod fork {
#[cfg(test)]
mod test {
use {Rng, SeedableRng};
use prng::chacha::ChaChaCore;
use rand_chacha::ChaChaCore;
use rngs::mock::StepRng;
use super::ReseedingRng;
+1 -1
View File
@@ -161,7 +161,7 @@
//! [`mock::StepRng`]: mock/struct.StepRng.html
//! [`adapter::ReadRng`]: adapter/struct.ReadRng.html
//! [`adapter::ReseedingRng`]: adapter/struct.ReseedingRng.html
//! [`ChaChaRng`]: ../prng/chacha/struct.ChaChaRng.html
//! [`ChaChaRng`]: ../../rand_chacha/struct.ChaChaRng.html
pub mod adapter;
+3 -3
View File
@@ -9,7 +9,7 @@
//! The standard RNG
use {RngCore, CryptoRng, Error, SeedableRng};
use prng::Hc128Rng;
use rand_hc128::Hc128Rng;
/// The standard RNG. The PRNG algorithm in `StdRng` is chosen to be efficient
/// on the current platform, to be statistically strong and unpredictable
@@ -23,8 +23,8 @@ use prng::Hc128Rng;
/// produce different output depending on the architecture. If you require
/// reproducible output, use a named RNG, for example [`ChaChaRng`].
///
/// [HC-128]: ../prng/hc128/struct.Hc128Rng.html
/// [`ChaChaRng`]: ../prng/chacha/struct.ChaChaRng.html
/// [HC-128]: ../../rand_hc128/struct.Hc128Rng.html
/// [`ChaChaRng`]: ../../rand_chacha/struct.ChaChaRng.html
#[derive(Clone, Debug)]
pub struct StdRng(Hc128Rng);
+2 -2
View File
@@ -13,7 +13,7 @@ use std::cell::UnsafeCell;
use {RngCore, CryptoRng, SeedableRng, Error};
use rngs::adapter::ReseedingRng;
use rngs::EntropyRng;
use prng::hc128::Hc128Core;
use rand_hc128::Hc128Core;
// Rationale for using `UnsafeCell` in `ThreadRng`:
//
@@ -68,7 +68,7 @@ const THREAD_RNG_RESEED_THRESHOLD: u64 = 32*1024*1024; // 32 MiB
/// [`ReseedingRng`]: adapter/struct.ReseedingRng.html
/// [`StdRng`]: struct.StdRng.html
/// [`EntropyRng`]: struct.EntropyRng.html
/// [HC-128]: ../prng/hc128/struct.Hc128Rng.html
/// [HC-128]: ../../rand_hc128/struct.Hc128Rng.html
#[derive(Clone, Debug)]
pub struct ThreadRng {
// use of raw pointer implies type is neither Send nor Sync
+4
View File
@@ -19,6 +19,8 @@ main() {
cross test --package rand_core --target $TARGET
cross test --package rand_core --no-default-features --features=alloc --target $TARGET
cross test --package rand_isaac --features=serde1 --target $TARGET
cross test --package rand_chacha --target $TARGET
cross test --package rand_hc128 --target $TARGET
cross test --package rand_xorshift --features=serde1 --target $TARGET
else # have stable Rust
cross test --lib --no-default-features --target $TARGET
@@ -27,6 +29,8 @@ main() {
cross test --package rand_core --target $TARGET
cross test --package rand_core --no-default-features --target $TARGET
cross test --package rand_isaac --features=serde1 --target $TARGET
cross test --package rand_chacha --target $TARGET
cross test --package rand_hc128 ---target $TARGET
cross test --package rand_xorshift --features=serde1 --target $TARGET
fi
}