mirror of
https://github.com/lightningdevkit/rust-lightning.git
synced 2025-02-24 06:57:53 +01:00
Add a crate which wraps getrandom
but always compiles
In the next commit we'll drop the `ahash` dependency in favor of directly calling `getrandom` to seed our hash tables. However, we'd like to depend on `getrandom` only on certain platforms *and* only when certain features (no-std) are set. This introduces an indirection crate to do so, allowing us to depend on it only when `no-std` is set but only depending on `getrandom` on platforms which it supports.
This commit is contained in:
parent
73da722d18
commit
65108a022f
5 changed files with 65 additions and 0 deletions
|
@ -11,6 +11,7 @@ members = [
|
|||
"lightning-rapid-gossip-sync",
|
||||
"lightning-custom-message",
|
||||
"lightning-transaction-sync",
|
||||
"possiblyrandom",
|
||||
]
|
||||
|
||||
exclude = [
|
||||
|
@ -38,3 +39,6 @@ lto = "off"
|
|||
opt-level = 3
|
||||
lto = true
|
||||
panic = "abort"
|
||||
|
||||
[patch.crates-io.possiblyrandom]
|
||||
path = "possiblyrandom"
|
||||
|
|
|
@ -15,6 +15,8 @@ def check_feature(feature):
|
|||
pass
|
||||
elif feature == "ahash":
|
||||
pass
|
||||
elif feature == "getrandom":
|
||||
pass
|
||||
elif feature == "hashbrown":
|
||||
pass
|
||||
elif feature == "backtrace":
|
||||
|
|
|
@ -15,3 +15,6 @@ lightning-background-processor = { path = "../lightning-background-processor", f
|
|||
# Obviously lightning-transaction-sync doesn't support no-std, but it should build
|
||||
# even if lightning is built with no-std.
|
||||
lightning-transaction-sync = { path = "../lightning-transaction-sync", optional = true }
|
||||
|
||||
[patch.crates-io]
|
||||
possiblyrandom = { path = "../possiblyrandom" }
|
||||
|
|
21
possiblyrandom/Cargo.toml
Normal file
21
possiblyrandom/Cargo.toml
Normal file
|
@ -0,0 +1,21 @@
|
|||
[package]
|
||||
name = "possiblyrandom"
|
||||
version = "0.1.0"
|
||||
authors = ["Matt Corallo"]
|
||||
license = "MIT OR Apache-2.0"
|
||||
repository = "https://github.com/lightningdevkit/rust-lightning/"
|
||||
description = """
|
||||
A crate that wraps getrandom and always compiles, returning 0s when no randomness is available.
|
||||
"""
|
||||
edition = "2021"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
||||
[dependencies]
|
||||
getrandom = { version = "0.2", optional = true, default-features = false }
|
||||
|
||||
# Enable getrandom if we are on a platform that (likely) supports it
|
||||
[target.'cfg(not(any(target_os = "unknown", target_os = "none")))'.dependencies]
|
||||
getrandom = { version = "0.2", default-features = false }
|
35
possiblyrandom/src/lib.rs
Normal file
35
possiblyrandom/src/lib.rs
Normal file
|
@ -0,0 +1,35 @@
|
|||
// This file is Copyright its original authors, visible in version control
|
||||
// history.
|
||||
//
|
||||
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
|
||||
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
|
||||
// You may not use this file except in accordance with one or both of these
|
||||
// licenses.
|
||||
|
||||
//! [`getrandom`] provides access to OS randomness, but will fail to compile on platforms that do
|
||||
//! not support fetching OS randomness. This is exactly what you want when you're doing
|
||||
//! cryptographic operations, but when you're just opportunistically randomizing, we're fine with
|
||||
//! compiling and simply disabling randomization.
|
||||
//!
|
||||
//! This crate does that, returning only possibly-random data.
|
||||
//!
|
||||
//! Note that this crate only enables getrandom on a subset of platforms it supports. As getrandom
|
||||
//! evolves this crate is unlikely to carefully track all getrandom-supported platforms, however
|
||||
//! will use random data on popular platforms.
|
||||
|
||||
#![no_std]
|
||||
|
||||
#[cfg(feature = "getrandom")]
|
||||
extern crate getrandom;
|
||||
|
||||
/// Possibly fills `dest` with random data. May fill it with zeros.
|
||||
#[inline]
|
||||
pub fn getpossiblyrandom(dest: &mut [u8]) {
|
||||
#[cfg(feature = "getrandom")]
|
||||
if getrandom::getrandom(dest).is_err() {
|
||||
dest.fill(0);
|
||||
}
|
||||
#[cfg(not(feature = "getrandom"))]
|
||||
dest.fill(0);
|
||||
}
|
Loading…
Add table
Reference in a new issue