Skip to content

Commit

Permalink
Remove unnecessary error branch of ProcessPrng (#579)
Browse files Browse the repository at this point in the history
ProcessPrng is guaranteed to never fail during runtime, so there's no
need to handle that case. Also found that windows_targets declares all
extern functions as pub, so wrapped the link! macro in a local module to
prevent it from being accessible outside of windows.rs.
  • Loading branch information
silverstillisntgold authored Jan 12, 2025
1 parent 9fb4a9a commit 9f20e28
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 17 deletions.
29 changes: 14 additions & 15 deletions src/backends/windows.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Implementation for Windows 10 and later
//!
//! On Windows 10 and later, ProcessPrng "is the primary interface to the
//! user-mode per-processer PRNGs" and only requires bcryptprimitives.dll,
//! user-mode per-processor PRNGs" and only requires bcryptprimitives.dll,
//! making it a better option than the other Windows RNG APIs:
//! - BCryptGenRandom: https://learn.microsoft.com/en-us/windows/win32/api/bcrypt/nf-bcrypt-bcryptgenrandom
//! - Requires bcrypt.dll (which loads bcryptprimitives.dll anyway)
Expand All @@ -28,20 +28,19 @@ pub use crate::util::{inner_u32, inner_u64};
// Binding to the Windows.Win32.Security.Cryptography.ProcessPrng API. As
// bcryptprimitives.dll lacks an import library, we use the windows-targets
// crate to link to it.
windows_targets::link!("bcryptprimitives.dll" "system" fn ProcessPrng(pbdata: *mut u8, cbdata: usize) -> BOOL);
#[allow(clippy::upper_case_acronyms)]
pub type BOOL = i32;
pub const TRUE: BOOL = 1i32;
//
// TODO(MSRV 1.71): Migrate to linking as raw-dylib directly.
// https://github.com/joboet/rust/blob/5c1c72572479afe98734d5f78fa862abe662c41a/library/std/src/sys/pal/windows/c.rs#L119
// https://github.com/microsoft/windows-rs/blob/0.60.0/crates/libs/targets/src/lib.rs
windows_targets::link!("bcryptprimitives.dll" "system" fn ProcessPrng(pbdata: *mut u8, cbdata: usize) -> i32);

pub fn fill_inner(dest: &mut [MaybeUninit<u8>]) -> Result<(), Error> {
// ProcessPrng should always return TRUE, but we check just in case.
match unsafe { ProcessPrng(dest.as_mut_ptr().cast::<u8>(), dest.len()) } {
TRUE => Ok(()),
_ => Err(Error::WINDOWS_PROCESS_PRNG),
}
}

impl Error {
/// Calling Windows ProcessPrng failed.
pub(crate) const WINDOWS_PROCESS_PRNG: Error = Self::new_internal(10);
let result = unsafe { ProcessPrng(dest.as_mut_ptr().cast::<u8>(), dest.len()) };
// Since Windows 10, calls to the user-mode RNG are guaranteed to never
// fail during runtime (rare windows W); `ProcessPrng` will only ever
// return 1 (which is how windows represents TRUE).
// See the bottom of page 6 of the aforementioned Windows RNG
// whitepaper for more information.
debug_assert!(result == 1);
Ok(())
}
2 changes: 0 additions & 2 deletions src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,6 @@ impl Error {
target_os = "tvos",
))]
Error::IOS_RANDOM_GEN => "SecRandomCopyBytes: iOS Security framework failure",
#[cfg(all(windows, not(target_vendor = "win7")))]
Error::WINDOWS_PROCESS_PRNG => "ProcessPrng: Windows system function failure",
#[cfg(all(windows, target_vendor = "win7"))]
Error::WINDOWS_RTL_GEN_RANDOM => "RtlGenRandom: Windows system function failure",
#[cfg(getrandom_backend = "wasm_js")]
Expand Down

0 comments on commit 9f20e28

Please sign in to comment.