The `getrandom` crate by m-ou-se · Pull Request #1 · m-ou-se/getrandom

m-ou-se · 2021-04-11T10:32:47Z

No description provided.

per rust-random#6 (comment)

Crate implementation

Add getrandom wrapper func and documentation

8 Update Solaris getrandom

Some of these tests will fail for now!

Arguably the doc links and root URL are wrong, but they avoid broken links and will do for now.

Also new: impl From<NonZeroU32> for Error

- Cleanup `tests.yml` - Add better binary downloads - Add minimal dependancies check - Add tests for `custom` feature - Build/Link for iOS - Run cross tests on aarch64 linux and Android - Link on Solaris and Netbsd - Test wasm code on Node, Chrome, Firefox - Test WASI - No need for RDRAND feature on VxWorks Signed-off-by: Joe Richey <joerichey@google.com>

Most of the advantages from testing various Rust versions already come from running those tests on Linux and Windows. There's very little gain from also running these tests on macOS, while macOS jobs are the slowest to schedule. Signed-off-by: Joe Richey <joerichey@google.com>

Signed-off-by: Joe Richey <joerichey@google.com>

Update Github Actions CI for the master branch

Signed-off-by: Joe Richey <joerichey@google.com>

See rust-random#194 This installs (and caches) the emsdk toolchain at the last version compatible w/ stable rust. It also tests on both asmjs and wasm32, uses node by default, and works around an asm.js bug.

See rust-random#194 This uses the fact that `wasm32-unknown-unknown` is an "unsupported" target. This means we can use the `"custom"` feature to define a custom handler, and then write tests to make sure that function is called.

Signed-off-by: Joe Richey <joerichey@google.com>

Add fixes for Caching and rustc-dep-of-std feature

Signed-off-by: Joe Richey <joerichey@google.com>

Use doc_cfg to improve register_custom_getrandom docs

…m#209) Signed-off-by: Joe Richey <joerichey@google.com>

DragonFly BSD supports the getrandom system call since version 5.7 [1]. Use it if available, otherwise fall back to /dev/random. [1] https://leaf.dragonflybsd.org/cgi/web-man?command=getrandom Signed-off-by: Tobias Klauser <tklauser@distanz.ch>

src/error_impls.rs

m-ou-se · 2021-04-11T10:50:22Z

src/fuchsia.rs

+#[link(name = "zircon")]
+extern "C" {
+    fn zx_cprng_draw(buffer: *mut u8, length: usize);
+}
+
+pub fn getrandom_inner(dest: &mut [u8]) -> Result<(), Error> {
+    unsafe { zx_cprng_draw(dest.as_mut_ptr(), dest.len()) }
+    Ok(())
+}


src/ios.rs

m-ou-se · 2021-04-11T10:53:40Z

src/ios.rs

+#[link(name = "Security", kind = "framework")]
+extern "C" {
+    fn SecRandomCopyBytes(rnd: *const c_void, count: usize, bytes: *mut u8) -> i32;
+}


m-ou-se · 2021-04-11T10:57:38Z

src/js.rs

+    static RNG_SOURCE: Result<RngSource, Error> = getrandom_init();
+);
+
+pub(crate) fn getrandom_inner(dest: &mut [u8]) -> Result<(), Error> {


Not reviewed, since the "js" feature will not be enabled when this is used in std.

This is correct, std for wasm32-unknown-unknown cannot assume JavaScript exists.

m-ou-se · 2021-04-11T12:02:21Z

src/use_file.rs

+// Returns the file descriptor for the device file used to retrieve random
+// bytes. The file will be opened exactly once. All successful calls will
+// return the same file descriptor. This file descriptor is never closed.
+fn get_rng_fd() -> Result<libc::c_int, Error> {
+    static FD: AtomicUsize = AtomicUsize::new(LazyUsize::UNINIT);
+    fn get_fd() -> Option<libc::c_int> {
+        match FD.load(Relaxed) {
+            LazyUsize::UNINIT => None,
+            val => Some(val as libc::c_int),
+        }
+    }
+
+    // Use double-checked locking to avoid acquiring the lock if possible.
+    if let Some(fd) = get_fd() {
+        return Ok(fd);
+    }
+
+    // SAFETY: We use the mutex only in this method, and we always unlock it
+    // before returning, making sure we don't violate the pthread_mutex_t API.
+    static MUTEX: Mutex = Mutex::new();
+    unsafe { MUTEX.lock() };
+    let _guard = DropGuard(|| unsafe { MUTEX.unlock() });
+
+    if let Some(fd) = get_fd() {
+        return Ok(fd);
+    }


m-ou-se · 2021-04-11T12:08:46Z

src/dragonfly.rs

+    static GETRANDOM: Weak = unsafe { Weak::new("getrandom\0") };
+    type GetRandomFn = unsafe extern "C" fn(*mut u8, libc::size_t, libc::c_uint) -> libc::ssize_t;


Might be good to add a note that getrandom only appeared in DragonFly 5.7.

m-ou-se · 2021-04-11T12:10:41Z

src/bsd_arandom.rs

+    #[cfg(target_os = "freebsd")]
+    {
+        use crate::util_libc::Weak;
+        static GETRANDOM: Weak = unsafe { Weak::new("getrandom\0") };


Might be good to add a note that getrandom is only available since FreeBSD 12.0.

Agreed. Here and anywhere else we use a fallback implementation, we should note why we use that implementation.

m-ou-se · 2021-04-11T12:12:32Z

src/bsd_arandom.rs

+fn kern_arnd(buf: &mut [u8]) -> libc::ssize_t {
+    static MIB: [libc::c_int; 2] = [libc::CTL_KERN, libc::KERN_ARND];
+    let mut len = buf.len();
+    let ret = unsafe {
+        libc::sysctl(
+            MIB.as_ptr(),
+            MIB.len() as libc::c_uint,
+            buf.as_mut_ptr() as *mut _,
+            &mut len,
+            ptr::null(),
+            0,
+        )
+    };
+    if ret == -1 {
+        -1
+    } else {
+        len as libc::ssize_t
+    }
+}


m-ou-se · 2021-04-11T12:15:07Z

src/linux_android.rs

+    static HAS_GETRANDOM: LazyBool = LazyBool::new();
+    if HAS_GETRANDOM.unsync_init(is_getrandom_available) {
+        sys_fill_exact(dest, |buf| unsafe {
+            getrandom(buf.as_mut_ptr() as *mut libc::c_void, buf.len(), 0)


In std, we call this with GRND_NONBLOCK. See my comment in src/use_file.rs.

… r=m-ou-se updating docs to mention usage of AtomicBool Mouse mentioned we should point out that atomic bool is used by the std lib these days. ( m-ou-se/getrandom#1 )

dhardy and others added 30 commits January 19, 2019 12:56

Add library skeleton

c9440a2

first commit

71a3cb8

remove fuchsia loop

9420df9

per rust-random#6 (comment)

use fuchsia-cprng

99a1310

remove wasm-bindgen shims

d8c356b

add benchmarks

8f6edad

review updates

1049ce8

remove redundant extern crate

39ba5d2

change test cfg

9855b52

remove unsafe and newlines, add notice

5ebbaf7

use atomic bool to check RNG initialization

f860bde

new error

1e2a5aa

remove unsafe

9871d55

remove unused feature

af5035f

Merge pull request rust-random#6 from newpavlov/init

24e7f8f

Crate implementation

Add getrandom wrapper func and documentation

4374fd7

Impl From not Into

9ba1d37

Error doc; fix for Solaris

7ff3aff

Rename getrandom_os → getrandom_inner; more WASM doc

0f371be

Merge pull request rust-random#7 from dhardy/master

10fdedd

Add getrandom wrapper func and documentation

8 Update Solaris getrandom

819fb3f

Merge pull request rust-random#9 from jasonbking/illumos

7f68c78

8 Update Solaris getrandom

Add note on min Rustc version

ae1e2aa

Add CI configuration

b6e859c

Some of these tests will fail for now!

CI fix: do not test benches on stable

557ee8f

Fix doc links

25bc1ac

Arguably the doc links and root URL are wrong, but they avoid broken links and will do for now.

Fix cross-compilation script; disable non-existant Fuchsia target

446cff3

Fix Mac OSX implementation

5607368

Implement on WASM via stdweb and bindgen; add tests

51303b5

Fixes for CI, CloudABI, 32-bit Linux, MacOS, WASM

a40d3de

Also new: impl From<NonZeroU32> for Error

josephlr and others added 21 commits January 3, 2021 20:46

Clarify use of .cargo/config

e593f43

Signed-off-by: Joe Richey <joerichey@google.com>

Note that installed binaries are precompiled

7b8f2ba

Merge pull request rust-random#192 from rust-random/ci

1c6749e

Update Github Actions CI for the master branch

Move tests to tests/ directory (rust-random#195)

e29ed04

Signed-off-by: Joe Richey <joerichey@google.com>

Add Emscripten tests (rust-random#196)

9d7a76c

See rust-random#194 This installs (and caches) the emsdk toolchain at the last version compatible w/ stable rust. It also tests on both asmjs and wasm32, uses node by default, and works around an asm.js bug.

Add test for custom RNG handler (rust-random#197)

347a300

See rust-random#194 This uses the fact that `wasm32-unknown-unknown` is an "unsupported" target. This means we can use the `"custom"` feature to define a custom handler, and then write tests to make sure that function is called.

Cache Cargo index and Rust build directory

03cc4f7

Signed-off-by: Joe Richey <joerichey@google.com>

Properly forward rustc-dep-of-std feature

3661e9d

Signed-off-by: Joe Richey <joerichey@google.com>

Merge pull request rust-random#198 from rust-random/hermit

9a48bfa

Add fixes for Caching and rustc-dep-of-std feature

Use doc_cfg to improve register_custom_getrandom docs

69634b7

Modify doc tests to set docsrs

2cfbd8e

Signed-off-by: Joe Richey <joerichey@google.com>

Set doc(cfg(feature = "std")) on std trait impls

d7a0d58

Signed-off-by: Joe Richey <joerichey@google.com>

Merge pull request rust-random#200 from rust-random/doc_feature

27b5172

Use doc_cfg to improve register_custom_getrandom docs

Release v0.2.2 (rust-random#201)

d79de0c

Fix WASI function name and doc link (rust-random#202)

9b2d558

Replace build.rs with link attributes (rust-random#205)

c4a0004

Update docs and compile_errors for wasm32-unknown-unknown (rust-rando…

0eb0be1

…m#209) Signed-off-by: Joe Richey <joerichey@google.com>

Merge branch 'main'

3d60f91

m-ou-se commented Apr 11, 2021

View reviewed changes

m-ou-se mentioned this pull request Apr 11, 2021

Use getrandom for generating HashMap seed rust-lang/rust#80149

Closed

josephlr mentioned this pull request Oct 15, 2021

Towards rand 1.0 rust-random/getrandom#232

Closed

gilescope mentioned this pull request Oct 15, 2021

updating docs to mention usage of AtomicBool rust-lang/rust#89925

Merged

josephlr mentioned this pull request Mar 25, 2023

Draft: Options API rust-random/getrandom#353

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The `getrandom` crate#1

The `getrandom` crate#1
m-ou-se wants to merge 248 commits intomainfrom
master

m-ou-se commented Apr 11, 2021

Uh oh!

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

josephlr Apr 29, 2021

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

josephlr Apr 29, 2021

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

m-ou-se Apr 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

		static GETRANDOM: Weak = unsafe { Weak::new("getrandom\0") };
		type GetRandomFn = unsafe extern "C" fn(*mut u8, libc::size_t, libc::c_uint) -> libc::ssize_t;

Conversation

m-ou-se commented Apr 11, 2021

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants