Skip to content

Commit

Permalink
Make HashMap fall back to RtlGenRandom if BCryptGenRandom fails
Browse files Browse the repository at this point in the history
Issue rust-lang#84096 changed the hashmap RNG to use BCryptGenRandom instead of
RtlGenRandom on Windows.

Mozilla Firefox started experiencing random failures in
env_logger::Builder::new() (Issue rust-lang#94098) during initialization of their
unsandboxed main process with an "Access Denied" error message from
BCryptGenRandom(), which is used by the HashMap contained in
env_logger::Builder

The root cause appears to be a virus scanner or other software interfering
with BCrypt DLLs loading.

This change adds a fallback option if BCryptGenRandom is unusable for
whatever reason. It will fallback to RtlGenRandom in this case.

Fixes rust-lang#94098
  • Loading branch information
marti4d committed May 10, 2022
1 parent e209e85 commit 0c92519
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 4 deletions.
4 changes: 4 additions & 0 deletions library/std/src/sys/windows/c.rs
Original file line number Diff line number Diff line change
Expand Up @@ -788,6 +788,10 @@ if #[cfg(not(target_vendor = "uwp"))] {

#[link(name = "advapi32")]
extern "system" {
// Forbidden when targeting UWP
#[link_name = "SystemFunction036"]
pub fn RtlGenRandom(RandomBuffer: *mut u8, RandomBufferLength: ULONG) -> BOOLEAN;

// Allowed but unused by UWP
pub fn OpenProcessToken(
ProcessHandle: HANDLE,
Expand Down
83 changes: 79 additions & 4 deletions library/std/src/sys/windows/rand.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,69 @@
use crate::io;
use crate::mem;
use crate::sync;
use crate::sys::c;

// The kinds of HashMap RNG that may be available
#[derive(Clone, Copy, Debug, PartialEq)]
enum HashMapRng {
Preferred,
Fallback,
}

pub fn hashmap_random_keys() -> (u64, u64) {
match get_hashmap_rng() {
HashMapRng::Preferred => {
preferred_rng().expect("couldn't generate random bytes with preferred RNG")
}
HashMapRng::Fallback => {
fallback_rng().unwrap().expect("couldn't generate random bytes with fallback RNG")
}
}
}

// Returns the HashMap RNG that should be used
//
// Panics if they are both broken
fn get_hashmap_rng() -> HashMapRng {
// Assume that if the preferred RNG is broken the first time we use it, it likely means
// that: the DLL has failed to load, there is no point to calling it over-and-over again,
// and we should cache the result
static INIT: sync::Once = sync::Once::new();
static mut HASHMAP_RNG: HashMapRng = HashMapRng::Preferred;

unsafe {
INIT.call_once(|| HASHMAP_RNG = choose_hashmap_rng());
HASHMAP_RNG
}
}

// Test whether we should use the preferred or fallback RNG
//
// If the preferred RNG is successful, we choose it. Otherwise, if the fallback RNG is successful,
// we choose that
//
// Panics if both the preferred and the fallback RNG are both non-functional
fn choose_hashmap_rng() -> HashMapRng {
let preferred_error = match preferred_rng() {
Ok(_) => return HashMapRng::Preferred,
Err(e) => e,
};

// On UWP, there is no fallback
let fallback_result = fallback_rng()
.unwrap_or_else(|| panic!("preferred RNG broken: `{}`, no fallback", preferred_error));

match fallback_result {
Ok(_) => return HashMapRng::Fallback,
Err(fallback_error) => panic!(
"preferred RNG broken: `{}`, fallback RNG broken: `{}`",
preferred_error, fallback_error
),
}
}

// Generate random numbers using the preferred RNG function (BCryptGenRandom)
fn preferred_rng() -> Result<(u64, u64), io::Error> {
use crate::ptr;

let mut v = (0, 0);
Expand All @@ -14,8 +75,22 @@ pub fn hashmap_random_keys() -> (u64, u64) {
c::BCRYPT_USE_SYSTEM_PREFERRED_RNG,
)
};
if ret != 0 {
panic!("couldn't generate random bytes: {}", io::Error::last_os_error());
}
return v;

if ret == 0 { Ok(v) } else { Err(io::Error::last_os_error()) }
}

// Generate random numbers using the fallback RNG function (RtlGenRandom)
#[cfg(not(target_vendor = "uwp"))]
fn fallback_rng() -> Option<Result<(u64, u64), io::Error>> {
let mut v = (0, 0);
let ret =
unsafe { c::RtlGenRandom(&mut v as *mut _ as *mut u8, mem::size_of_val(&v) as c::ULONG) };

Some(if ret != 0 { Ok(v) } else { Err(io::Error::last_os_error()) })
}

// We can't use RtlGenRandom with UWP, so there is no fallback
#[cfg(target_vendor = "uwp")]
fn fallback_rng() -> Option<Result<(u64, u64), io::Error>> {
None
}

0 comments on commit 0c92519

Please sign in to comment.