Add OsRng to getrandom

.github/workflows/tests.yml

@@ -37,7 +37,10 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       - run: cargo test
       # Make sure enabling the std feature doesn't break anything
-      - run: cargo test --features=std
+      - run: |
+          cargo test --features=std
+          cargo test --features=rng
+          cargo test --features=std,rng
       - if: ${{ matrix.toolchain == 'nightly' }}
         run: cargo test --benches
 
@@ -53,27 +56,27 @@ jobs:
         with:
           targets: ${{ matrix.target }}
       - uses: Swatinem/rust-cache@v2
-      - run: cargo test --target=${{ matrix.target }} --features=std
+      - run: cargo test --target=${{ matrix.target }} --features=std,rng
       - env:
           RUSTFLAGS: -Dwarnings --cfg getrandom_backend="linux_getrandom"
           RUSTDOCFLAGS: -Dwarnings --cfg getrandom_backend="linux_getrandom"
-        run: cargo test --target=${{ matrix.target }} --features=std
+        run: cargo test --target=${{ matrix.target }} --features=std,rng
       - env:
           RUSTFLAGS: -Dwarnings --cfg getrandom_backend="linux_raw"
           RUSTDOCFLAGS: -Dwarnings --cfg getrandom_backend="linux_raw"
-        run: cargo test --target=${{ matrix.target }} --features=std
+        run: cargo test --target=${{ matrix.target }} --features=std,rng
       - env:
           RUSTFLAGS: -Dwarnings --cfg getrandom_test_linux_fallback
           RUSTDOCFLAGS: -Dwarnings --cfg getrandom_test_linux_fallback
-        run: cargo test --features=std
+        run: cargo test --features=std,rng
       - env:
           RUSTFLAGS: -Dwarnings --cfg getrandom_test_linux_without_fallback
           RUSTDOCFLAGS: -Dwarnings --cfg getrandom_test_linux_without_fallback
-        run: cargo test --features=std
+        run: cargo test --features=std,rng
       - env:
           RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rdrand"
           RUSTDOCFLAGS: -Dwarnings --cfg getrandom_backend="rdrand"
-        run: cargo test --features=std
+        run: cargo test --features=std,rng
 
   ios:
     name: iOS Simulator
@@ -123,7 +126,7 @@ jobs:
         with:
           toolchain: ${{ matrix.toolchain }}
       - uses: Swatinem/rust-cache@v2
-      - run: cargo test --features=std
+      - run: cargo test --features=std,rng
 
   windows7:
     name: Windows 7 (on Windows 10)
@@ -136,8 +139,8 @@ jobs:
           toolchain: nightly-2025-09-28
           components: rust-src
       - uses: Swatinem/rust-cache@v2
-      - run: cargo test --target=x86_64-win7-windows-msvc -Z build-std --features=std
-      - run: cargo test --target=i686-win7-windows-msvc -Z build-std --features=std
+      - run: cargo test --target=x86_64-win7-windows-msvc -Z build-std --features=std,rng
+      - run: cargo test --target=i686-win7-windows-msvc -Z build-std --features=std,rng
 
   sanitizer-linux:
     name: Sanitizer Linux
@@ -216,7 +219,7 @@ jobs:
           wget -O - $URL | tar -xz -C ~/.cargo/bin
           cross --version
       - name: Test
-        run: cross test --no-fail-fast --target=${{ matrix.target }} --features=std
+        run: cross test --no-fail-fast --target=${{ matrix.target }} --features=std,rng
 
   freebsd:
     name: FreeBSD VM
@@ -273,14 +276,14 @@ jobs:
               description: Web,
               version: stable,
               flags: '-Dwarnings --cfg getrandom_backend="wasm_js"',
-              args: '--features=std,wasm_js',
+              args: '--features=std,rng,wasm_js',
             }
           - {
               description: Web with Atomics,
               version: nightly,
               components: rust-src,
               flags: '-Dwarnings --cfg getrandom_backend="wasm_js" -Ctarget-feature=+atomics,+bulk-memory',
-              args: '--features=std,wasm_js -Zbuild-std=panic_abort,std',
+              args: '--features=std,rng,wasm_js -Zbuild-std=panic_abort,std',
             }
     steps:
       - uses: actions/checkout@v5

Cargo.toml

@@ -11,6 +11,9 @@ repository = "https://github.com/rust-random/getrandom"
 categories = ["os", "no-std"]
 exclude = [".*"]
 
+[package.metadata.docs.rs]
+features = ["std", "rng"]
+
 [features]
 # Implement From<getrandom::Error> for std::io::Error and
 # use std to retrieve OS error descriptions
@@ -23,8 +26,12 @@ std = []
 # i.e. avoid unconditionally enabling it in library crates.
 wasm_js = ["dep:wasm-bindgen", "dep:js-sys"]
 
+# Provide OsRng over rand_core
+rng = ["dep:rand_core"]
+
 [dependencies]
 cfg-if = "1"
+rand_core = { version = "0.10.0-rc-2", optional = true }
 
 # getrandom / linux_android_with_fallback
 [target.'cfg(all(any(target_os = "linux", target_os = "android"), not(any(all(target_os = "linux", target_env = ""), getrandom_backend = "custom", getrandom_backend = "linux_raw", getrandom_backend = "rdrand", getrandom_backend = "rndr"))))'.dependencies]
@@ -85,9 +92,6 @@ check-cfg = [
   'cfg(target_os, values("cygwin"))', # TODO(MSRV 1.86): Remove this.
 ]
 
-[package.metadata.docs.rs]
-features = ["std"]
-
 # workaround for https://github.com/cross-rs/cross/issues/1345
 [package.metadata.cross.target.x86_64-unknown-netbsd]
 pre-build = [

src/lib.rs

@@ -39,6 +39,13 @@ mod util;
 #[cfg(feature = "std")]
 mod error_std_impls;
 
+#[cfg(feature = "rng")]
+mod rng;
+#[cfg(feature = "rng")]
+pub use rand_core;
+#[cfg(feature = "rng")]
+pub use rng::OsRng;
+
 pub use crate::error::{Error, RawOsError};
 
 /// Fill `dest` with random bytes from the system's preferred random number source.

src/rng.rs

@@ -0,0 +1,74 @@
+//! rand_core adapter
+
+use crate::Error;
+use rand_core::{TryCryptoRng, TryRngCore};
+
+/// An RNG over the operating-system's random data source
+///
+/// This is a zero-sized struct. It can be freely constructed with just `OsRng`.
+///
+/// This struct is also available as [`rand::rngs::OsRng`] when using [rand].
+///
+/// # Usage example
+///
+/// `OsRng` implements [`TryRngCore`]:
+/// ```
+/// use getrandom::{rand_core::TryRngCore, OsRng};
+///
+/// let mut key = [0u8; 32];
+/// OsRng.try_fill_bytes(&mut key).unwrap();
+/// ```
+///
+/// Using it as an [`RngCore`] is possible using [`TryRngCore::unwrap_err`]:
+/// ```
+/// use getrandom::rand_core::{TryRngCore, RngCore};
+/// use getrandom::OsRng;
+///
+/// let mut rng = OsRng.unwrap_err();
+/// let random_u64 = rng.next_u64();
+/// ```
+///
+/// [rand]: https://crates.io/crates/rand
+/// [`rand::rngs::OsRng`]: https://docs.rs/rand/latest/rand/rngs/struct.OsRng.html
+/// [`RngCore`]: rand_core::RngCore
+#[derive(Clone, Copy, Debug, Default)]
+pub struct OsRng;
+
+impl TryRngCore for OsRng {
+    type Error = Error;
+
+    #[inline]
+    fn try_next_u32(&mut self) -> Result<u32, Error> {
+        crate::u32()
+    }
+
+    #[inline]
+    fn try_next_u64(&mut self) -> Result<u64, Error> {
+        crate::u64()
+    }
+
+    #[inline]
+    fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error> {
+        crate::fill(dest)
+    }
+}
+
+impl TryCryptoRng for OsRng {}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_os_rng() {
+        let x = OsRng.try_next_u64().unwrap();
+        let y = OsRng.try_next_u64().unwrap();
+        assert!(x != 0);
+        assert!(x != y);
+    }
+
+    #[test]
+    fn test_construction() {
+        assert!(OsRng.try_next_u64().unwrap() != 0);
+    }
+}