From 37a69fbd9547693de36aaab240b291b4f7e30d4c Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Fri, 14 Sep 2018 14:33:08 +0200 Subject: [PATCH 1/6] Move ChaCha and HC128 RNG to dedicated crates --- .travis.yml | 12 +- Cargo.toml | 4 +- appveyor.yml | 2 + benches/generators.rs | 6 +- rand_chacha/CHANGELOG.md | 8 + rand_chacha/COPYRIGHT | 12 ++ rand_chacha/Cargo.toml | 25 +++ rand_chacha/LICENSE-APACHE | 201 ++++++++++++++++++++++++ rand_chacha/LICENSE-MIT | 26 +++ rand_chacha/README.md | 44 ++++++ rand_chacha/build.rs | 8 + {src/prng => rand_chacha/src}/chacha.rs | 20 +-- rand_chacha/src/lib.rs | 25 +++ rand_hc128/CHANGELOG.md | 8 + rand_hc128/COPYRIGHT | 12 ++ rand_hc128/Cargo.toml | 21 +++ rand_hc128/LICENSE-APACHE | 201 ++++++++++++++++++++++++ rand_hc128/LICENSE-MIT | 25 +++ rand_hc128/README.md | 44 ++++++ {src/prng => rand_hc128/src}/hc128.rs | 6 +- rand_hc128/src/lib.rs | 25 +++ rand_isaac/Cargo.toml | 2 +- rand_isaac/src/isaac.rs | 2 +- rand_isaac/src/isaac64.rs | 2 +- src/deprecated.rs | 55 ++++++- src/lib.rs | 2 + src/prng/mod.rs | 21 +-- src/rngs/adapter/reseeding.rs | 14 +- src/rngs/mod.rs | 2 +- src/rngs/std.rs | 6 +- src/rngs/thread.rs | 4 +- utils/ci/script.sh | 4 + 32 files changed, 803 insertions(+), 46 deletions(-) create mode 100644 rand_chacha/CHANGELOG.md create mode 100644 rand_chacha/COPYRIGHT create mode 100644 rand_chacha/Cargo.toml create mode 100644 rand_chacha/LICENSE-APACHE create mode 100644 rand_chacha/LICENSE-MIT create mode 100644 rand_chacha/README.md create mode 100644 rand_chacha/build.rs rename {src/prng => rand_chacha/src}/chacha.rs (98%) create mode 100644 rand_chacha/src/lib.rs create mode 100644 rand_hc128/CHANGELOG.md create mode 100644 rand_hc128/COPYRIGHT create mode 100644 rand_hc128/Cargo.toml create mode 100644 rand_hc128/LICENSE-APACHE create mode 100644 rand_hc128/LICENSE-MIT create mode 100644 rand_hc128/README.md rename {src/prng => rand_hc128/src}/hc128.rs (99%) create mode 100644 rand_hc128/src/lib.rs diff --git a/.travis.yml b/.travis.yml index 3a423c4b926..36fadafa987 100644 --- a/.travis.yml +++ b/.travis.yml @@ -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 diff --git a/Cargo.toml b/Cargo.toml index 423ab85b7cd..a144088bc3d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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 } diff --git a/appveyor.yml b/appveyor.yml index 03b539c231c..3ac30f41e1a 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -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 diff --git a/benches/generators.rs b/benches/generators.rs index 2c527d065b1..977a1beed78 100644 --- a/benches/generators.rs +++ b/benches/generators.rs @@ -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 { diff --git a/rand_chacha/CHANGELOG.md b/rand_chacha/CHANGELOG.md new file mode 100644 index 00000000000..2d5d78dbc74 --- /dev/null +++ b/rand_chacha/CHANGELOG.md @@ -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 diff --git a/rand_chacha/COPYRIGHT b/rand_chacha/COPYRIGHT new file mode 100644 index 00000000000..468d907caf9 --- /dev/null +++ b/rand_chacha/COPYRIGHT @@ -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 or + or the MIT license + or , at your option. + +The Rand project includes code from the Rust project +published under these same licenses. diff --git a/rand_chacha/Cargo.toml b/rand_chacha/Cargo.toml new file mode 100644 index 00000000000..86c28237117 --- /dev/null +++ b/rand_chacha/Cargo.toml @@ -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" diff --git a/rand_chacha/LICENSE-APACHE b/rand_chacha/LICENSE-APACHE new file mode 100644 index 00000000000..17d74680f8c --- /dev/null +++ b/rand_chacha/LICENSE-APACHE @@ -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. diff --git a/rand_chacha/LICENSE-MIT b/rand_chacha/LICENSE-MIT new file mode 100644 index 00000000000..d93b5baf341 --- /dev/null +++ b/rand_chacha/LICENSE-MIT @@ -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. diff --git a/rand_chacha/README.md b/rand_chacha/README.md new file mode 100644 index 00000000000..44ccbf4ece1 --- /dev/null +++ b/rand_chacha/README.md @@ -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. diff --git a/rand_chacha/build.rs b/rand_chacha/build.rs new file mode 100644 index 00000000000..cb3ae20d2c6 --- /dev/null +++ b/rand_chacha/build.rs @@ -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"); + } +} diff --git a/src/prng/chacha.rs b/rand_chacha/src/chacha.rs similarity index 98% rename from src/prng/chacha.rs rename to rand_chacha/src/chacha.rs index b84bfeb98db..3e9040956c0 100644 --- a/src/prng/chacha.rs +++ b/rand_chacha/src/chacha.rs @@ -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); @@ -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 (24) 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; 264 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 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()); diff --git a/rand_chacha/src/lib.rs b/rand_chacha/src/lib.rs new file mode 100644 index 00000000000..c473dcecadc --- /dev/null +++ b/rand_chacha/src/lib.rs @@ -0,0 +1,25 @@ +// Copyright 2018 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , 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}; diff --git a/rand_hc128/CHANGELOG.md b/rand_hc128/CHANGELOG.md new file mode 100644 index 00000000000..2d5d78dbc74 --- /dev/null +++ b/rand_hc128/CHANGELOG.md @@ -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 diff --git a/rand_hc128/COPYRIGHT b/rand_hc128/COPYRIGHT new file mode 100644 index 00000000000..468d907caf9 --- /dev/null +++ b/rand_hc128/COPYRIGHT @@ -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 or + or the MIT license + or , at your option. + +The Rand project includes code from the Rust project +published under these same licenses. diff --git a/rand_hc128/Cargo.toml b/rand_hc128/Cargo.toml new file mode 100644 index 00000000000..62c7f4a736c --- /dev/null +++ b/rand_hc128/Cargo.toml @@ -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 } diff --git a/rand_hc128/LICENSE-APACHE b/rand_hc128/LICENSE-APACHE new file mode 100644 index 00000000000..17d74680f8c --- /dev/null +++ b/rand_hc128/LICENSE-APACHE @@ -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. diff --git a/rand_hc128/LICENSE-MIT b/rand_hc128/LICENSE-MIT new file mode 100644 index 00000000000..cf656074cbf --- /dev/null +++ b/rand_hc128/LICENSE-MIT @@ -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. diff --git a/rand_hc128/README.md b/rand_hc128/README.md new file mode 100644 index 00000000000..dfbcaf5658f --- /dev/null +++ b/rand_hc128/README.md @@ -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. 39–47, 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. diff --git a/src/prng/hc128.rs b/rand_hc128/src/hc128.rs similarity index 99% rename from src/prng/hc128.rs rename to rand_hc128/src/hc128.rs index 67005fb80ab..d1dadcc9083 100644 --- a/src/prng/hc128.rs +++ b/rand_hc128/src/hc128.rs @@ -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); @@ -334,7 +334,7 @@ impl CryptoRng for Hc128Core {} #[cfg(test)] mod test { - use {RngCore, SeedableRng}; + use ::rand_core::{RngCore, SeedableRng}; use super::Hc128Rng; #[test] diff --git a/rand_hc128/src/lib.rs b/rand_hc128/src/lib.rs new file mode 100644 index 00000000000..80419fc65d2 --- /dev/null +++ b/rand_hc128/src/lib.rs @@ -0,0 +1,25 @@ +// Copyright 2018 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , 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}; diff --git a/rand_isaac/Cargo.toml b/rand_isaac/Cargo.toml index 99ec5ac5f45..1cd3341ff30 100644 --- a/rand_isaac/Cargo.toml +++ b/rand_isaac/Cargo.toml @@ -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 } diff --git a/rand_isaac/src/isaac.rs b/rand_isaac/src/isaac.rs index eee3d55285b..98bdd2bef57 100644 --- a/rand_isaac/src/isaac.rs +++ b/rand_isaac/src/isaac.rs @@ -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)] diff --git a/rand_isaac/src/isaac64.rs b/rand_isaac/src/isaac64.rs index 839fbbc4960..d5353008d23 100644 --- a/rand_isaac/src/isaac64.rs +++ b/rand_isaac/src/isaac64.rs @@ -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)] diff --git a/src/deprecated.rs b/src/deprecated.rs index c144e1a6b44..5b2482abaa9 100644 --- a/src/deprecated.rs +++ b/src/deprecated.rs @@ -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 = ::Seed; + type Seed = ::Seed; fn from_seed(seed: Self::Seed) -> Self { - ChaChaRng(prng::ChaChaRng::from_seed(seed)) + ChaChaRng(rand_chacha::ChaChaRng::from_seed(seed)) } fn from_rng(rng: R) -> Result { - 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 = ::Seed; + + fn from_seed(seed: Self::Seed) -> Self { + Hc128Rng(rand_hc128::Hc128Rng::from_seed(seed)) + } + + fn from_rng(rng: R) -> Result { + 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); diff --git a/src/lib.rs b/src/lib.rs index cb8d134285a..33b2509b267 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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; diff --git a/src/prng/mod.rs b/src/prng/mod.rs index 68479faf57f..7c8c69dbb10 100644 --- a/src/prng/mod.rs +++ b/src/prng/mod.rs @@ -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; diff --git a/src/rngs/adapter/reseeding.rs b/src/rngs/adapter/reseeding.rs index 3417eb4b3d6..03e5b2c903d 100644 --- a/src/rngs/adapter/reseeding.rs +++ b/src/rngs/adapter/reseeding.rs @@ -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::() != cloned_rng.gen::()); +/// # } /// ``` /// -/// [`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; diff --git a/src/rngs/mod.rs b/src/rngs/mod.rs index 3c8de06850d..6888517d98e 100644 --- a/src/rngs/mod.rs +++ b/src/rngs/mod.rs @@ -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; diff --git a/src/rngs/std.rs b/src/rngs/std.rs index 74a69fb4876..ac52387107d 100644 --- a/src/rngs/std.rs +++ b/src/rngs/std.rs @@ -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); diff --git a/src/rngs/thread.rs b/src/rngs/thread.rs index 3837ce729f0..1b84489be4f 100644 --- a/src/rngs/thread.rs +++ b/src/rngs/thread.rs @@ -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 diff --git a/utils/ci/script.sh b/utils/ci/script.sh index 7e1478e2408..f45c4356d79 100644 --- a/utils/ci/script.sh +++ b/utils/ci/script.sh @@ -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 } From f186df47142499ca3d995573e9c5e7c6ec26ea23 Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Fri, 14 Sep 2018 15:02:14 +0200 Subject: [PATCH 2/6] Clean up whitespaces --- src/seq/index.rs | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/src/seq/index.rs b/src/seq/index.rs index d46d8044bc9..3d4df3acd42 100644 --- a/src/seq/index.rs +++ b/src/seq/index.rs @@ -20,7 +20,7 @@ use Rng; /// A vector of indices. -/// +/// /// Multiple internal representations are possible. #[derive(Clone, Debug)] pub enum IndexVec { @@ -36,9 +36,9 @@ impl IndexVec { &IndexVec::USize(ref v) => v.len(), } } - + /// Return the value at the given `index`. - /// + /// /// (Note: we cannot implement `std::ops::Index` because of lifetime /// restrictions.) pub fn index(&self, index: usize) -> usize { @@ -63,7 +63,7 @@ impl IndexVec { &IndexVec::USize(ref v) => IndexVecIter::USize(v.iter()), } } - + /// Convert into an iterator over the indices as a sequence of `usize` values pub fn into_iter(self) -> IndexVecIntoIter { match self { @@ -115,7 +115,7 @@ impl<'a> Iterator for IndexVecIter<'a> { &mut USize(ref mut iter) => iter.next().cloned(), } } - + fn size_hint(&self) -> (usize, Option) { match self { &IndexVecIter::U32(ref v) => v.size_hint(), @@ -135,7 +135,7 @@ pub enum IndexVecIntoIter { impl Iterator for IndexVecIntoIter { type Item = usize; - + fn next(&mut self) -> Option { use self::IndexVecIntoIter::*; match self { @@ -143,7 +143,7 @@ impl Iterator for IndexVecIntoIter { &mut USize(ref mut v) => v.next(), } } - + fn size_hint(&self) -> (usize, Option) { use self::IndexVecIntoIter::*; match self { @@ -191,7 +191,7 @@ pub fn sample(rng: &mut R, length: usize, amount: usize) -> IndexVec } let amount = amount as u32; let length = length as u32; - + // Choice of algorithm here depends on both length and amount. See: // https://github.com/rust-random/rand/pull/479 // We do some calculations with f32. Accuracy is not very important. @@ -222,7 +222,7 @@ pub fn sample(rng: &mut R, length: usize, amount: usize) -> IndexVec /// Randomly sample exactly `amount` indices from `0..length`, using Floyd's /// combination algorithm. -/// +/// /// The output values are fully shuffled. (Overhead is under 50%.) /// /// This implementation uses `O(amount)` memory and `O(amount^2)` time. @@ -233,7 +233,7 @@ fn sample_floyd(rng: &mut R, length: u32, amount: u32) -> IndexVec // amounts this is slow due to Vec::insert performance, so we shuffle // afterwards. Benchmarks show little overhead from extra logic. let floyd_shuffle = amount < 50; - + debug_assert!(amount <= length); let mut indices = Vec::with_capacity(amount as usize); for j in length - amount .. length { @@ -267,7 +267,7 @@ fn sample_floyd(rng: &mut R, length: u32, amount: u32) -> IndexVec /// /// This allocates the entire `length` of indices and randomizes only the first `amount`. /// It then truncates to `amount` and returns. -/// +/// /// This method is not appropriate for large `length` and potentially uses a lot /// of memory; because of this we only implement for `u32` index (which improves /// performance in all cases). @@ -309,7 +309,7 @@ fn sample_rejection(rng: &mut R, length: usize, amount: usize) -> IndexVec } indices.push(pos); } - + debug_assert_eq!(indices.len(), amount); IndexVec::from(indices) } @@ -317,11 +317,11 @@ fn sample_rejection(rng: &mut R, length: usize, amount: usize) -> IndexVec #[cfg(test)] mod test { use super::*; - + #[test] fn test_sample_boundaries() { let mut r = ::test::rng(404); - + assert_eq!(sample_inplace(&mut r, 0, 0).len(), 0); assert_eq!(sample_inplace(&mut r, 1, 0).len(), 0); assert_eq!(sample_inplace(&mut r, 1, 1).into_vec(), vec![0]); @@ -331,17 +331,17 @@ mod test { assert_eq!(sample_floyd(&mut r, 0, 0).len(), 0); assert_eq!(sample_floyd(&mut r, 1, 0).len(), 0); assert_eq!(sample_floyd(&mut r, 1, 1).into_vec(), vec![0]); - + // These algorithms should be fast with big numbers. Test average. let sum: usize = sample_rejection(&mut r, 1 << 25, 10) .into_iter().sum(); assert!(1 << 25 < sum && sum < (1 << 25) * 25); - + let sum: usize = sample_floyd(&mut r, 1 << 25, 10) .into_iter().sum(); assert!(1 << 25 < sum && sum < (1 << 25) * 25); } - + #[test] fn test_sample_alg() { let seed_rng = ::test::rng; @@ -349,25 +349,25 @@ mod test { // We can't test which algorithm is used directly, but Floyd's alg // should produce different results from the others. (Also, `inplace` // and `cached` currently use different sizes thus produce different results.) - + // A small length and relatively large amount should use inplace let (length, amount): (usize, usize) = (100, 50); let v1 = sample(&mut seed_rng(420), length, amount); let v2 = sample_inplace(&mut seed_rng(420), length as u32, amount as u32); assert!(v1.iter().all(|e| e < length)); assert_eq!(v1, v2); - + // Test Floyd's alg does produce different results let v3 = sample_floyd(&mut seed_rng(420), length as u32, amount as u32); assert!(v1 != v3); - + // A large length and small amount should use Floyd let (length, amount): (usize, usize) = (1<<20, 50); let v1 = sample(&mut seed_rng(421), length, amount); let v2 = sample_floyd(&mut seed_rng(421), length as u32, amount as u32); assert!(v1.iter().all(|e| e < length)); assert_eq!(v1, v2); - + // A large length and larger amount should use cache let (length, amount): (usize, usize) = (1<<20, 600); let v1 = sample(&mut seed_rng(422), length, amount); From f98869b13ab416920f23cd13c7382214eeeba1cb Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Tue, 25 Sep 2018 15:02:47 +0200 Subject: [PATCH 3/6] docs: Fix a broken link --- src/distributions/uniform.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/distributions/uniform.rs b/src/distributions/uniform.rs index 449ee972448..2b712bb3d08 100644 --- a/src/distributions/uniform.rs +++ b/src/distributions/uniform.rs @@ -107,7 +107,7 @@ //! [`UniformInt`]: struct.UniformInt.html //! [`UniformFloat`]: struct.UniformFloat.html //! [`UniformDuration`]: struct.UniformDuration.html -//! [`Borrow::borrow`]: trait.SampleBorrow.html +//! [`SampleBorrow::borrow`]: trait.SampleBorrow.html#method.borrow #[cfg(feature = "std")] use std::time::Duration; From bb831f38d5d253e685ae93bab09c8328d9e54a02 Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Tue, 25 Sep 2018 16:12:23 +0200 Subject: [PATCH 4/6] RNG crates: Mention they are pulled out of rand --- rand_chacha/CHANGELOG.md | 2 +- rand_hc128/CHANGELOG.md | 2 +- rand_isaac/CHANGELOG.md | 2 +- rand_xorshift/CHANGELOG.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/rand_chacha/CHANGELOG.md b/rand_chacha/CHANGELOG.md index 2d5d78dbc74..5c83b3a71c3 100644 --- a/rand_chacha/CHANGELOG.md +++ b/rand_chacha/CHANGELOG.md @@ -5,4 +5,4 @@ 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 +- Pulled out of the Rand crate diff --git a/rand_hc128/CHANGELOG.md b/rand_hc128/CHANGELOG.md index 2d5d78dbc74..5c83b3a71c3 100644 --- a/rand_hc128/CHANGELOG.md +++ b/rand_hc128/CHANGELOG.md @@ -5,4 +5,4 @@ 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 +- Pulled out of the Rand crate diff --git a/rand_isaac/CHANGELOG.md b/rand_isaac/CHANGELOG.md index e47d6e86532..9a896a50863 100644 --- a/rand_isaac/CHANGELOG.md +++ b/rand_isaac/CHANGELOG.md @@ -5,4 +5,4 @@ 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-07-16 -- Initial release +- Pulled out of the Rand crate diff --git a/rand_xorshift/CHANGELOG.md b/rand_xorshift/CHANGELOG.md index e47d6e86532..9a896a50863 100644 --- a/rand_xorshift/CHANGELOG.md +++ b/rand_xorshift/CHANGELOG.md @@ -5,4 +5,4 @@ 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-07-16 -- Initial release +- Pulled out of the Rand crate From c869087c50f9a138d0ebe2e48e118ca43ee00148 Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Tue, 25 Sep 2018 16:15:49 +0200 Subject: [PATCH 5/6] Use rust-random for appveyor --- Cargo.toml | 2 +- rand_chacha/Cargo.toml | 2 +- rand_chacha/README.md | 2 +- rand_core/Cargo.toml | 2 +- rand_hc128/Cargo.toml | 2 +- rand_hc128/README.md | 2 +- rand_isaac/Cargo.toml | 2 +- rand_xorshift/Cargo.toml | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index a144088bc3d..db23831b40a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -16,7 +16,7 @@ build = "build.rs" [badges] travis-ci = { repository = "rust-random/rand" } -appveyor = { repository = "dhardy/rand" } +appveyor = { repository = "rust-random/rand" } [features] default = ["std" ] # without "std" rand uses libcore diff --git a/rand_chacha/Cargo.toml b/rand_chacha/Cargo.toml index 86c28237117..5629cfc077c 100644 --- a/rand_chacha/Cargo.toml +++ b/rand_chacha/Cargo.toml @@ -16,7 +16,7 @@ build = "build.rs" [badges] travis-ci = { repository = "rust-random/rand" } -appveyor = { repository = "dhardy/rand" } +appveyor = { repository = "rust-random/rand" } [dependencies] rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false } diff --git a/rand_chacha/README.md b/rand_chacha/README.md index 44ccbf4ece1..30fede2e1b7 100644 --- a/rand_chacha/README.md +++ b/rand_chacha/README.md @@ -1,7 +1,7 @@ # 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) +[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/rust-random/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) diff --git a/rand_core/Cargo.toml b/rand_core/Cargo.toml index f93669dbfae..6f4e79f063d 100644 --- a/rand_core/Cargo.toml +++ b/rand_core/Cargo.toml @@ -15,7 +15,7 @@ categories = ["algorithms", "no-std"] [badges] travis-ci = { repository = "rust-random/rand" } -appveyor = { repository = "dhardy/rand" } +appveyor = { repository = "rust-random/rand" } [features] default = ["std"] diff --git a/rand_hc128/Cargo.toml b/rand_hc128/Cargo.toml index 62c7f4a736c..855c4bebf55 100644 --- a/rand_hc128/Cargo.toml +++ b/rand_hc128/Cargo.toml @@ -15,7 +15,7 @@ categories = ["algorithms", "no-std"] [badges] travis-ci = { repository = "rust-random/rand" } -appveyor = { repository = "dhardy/rand" } +appveyor = { repository = "rust-random/rand" } [dependencies] rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false } diff --git a/rand_hc128/README.md b/rand_hc128/README.md index dfbcaf5658f..b8475404ea5 100644 --- a/rand_hc128/README.md +++ b/rand_hc128/README.md @@ -1,7 +1,7 @@ # 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) +[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/rust-random/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) diff --git a/rand_isaac/Cargo.toml b/rand_isaac/Cargo.toml index 1cd3341ff30..676df963f44 100644 --- a/rand_isaac/Cargo.toml +++ b/rand_isaac/Cargo.toml @@ -15,7 +15,7 @@ categories = ["algorithms", "no-std"] [badges] travis-ci = { repository = "rust-random/rand" } -appveyor = { repository = "dhardy/rand" } +appveyor = { repository = "rust-random/rand" } [features] serde1 = ["serde", "serde_derive", "rand_core/serde1"] diff --git a/rand_xorshift/Cargo.toml b/rand_xorshift/Cargo.toml index 2de9f512894..d5cf477a82a 100644 --- a/rand_xorshift/Cargo.toml +++ b/rand_xorshift/Cargo.toml @@ -15,7 +15,7 @@ categories = ["algorithms", "no-std"] [badges] travis-ci = { repository = "rust-random/rand" } -appveyor = { repository = "dhardy/rand" } +appveyor = { repository = "rust-random/rand" } [features] serde1 = ["serde", "serde_derive"] From b079ada47d53ff80ef8df304d65a537010e52b33 Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Thu, 27 Sep 2018 13:10:16 +0200 Subject: [PATCH 6/6] Disable the HC128 cross-compilation tests They fail to link for unknown reasons. Also see #607. --- utils/ci/script.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utils/ci/script.sh b/utils/ci/script.sh index f45c4356d79..cd55885b2dc 100644 --- a/utils/ci/script.sh +++ b/utils/ci/script.sh @@ -30,7 +30,7 @@ main() { 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_hc128 ---target $TARGET # fails for unknown reasons cross test --package rand_xorshift --features=serde1 --target $TARGET fi }