Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 1 | // Copyright (C) 2022 The Android Open Source Project |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
| 15 | //! FIPS compliant random number conditioner. Reads from /dev/hw_random |
| 16 | //! and applies the NIST SP 800-90A CTR DRBG strategy to provide |
| 17 | //! pseudorandom bytes to clients which connect to a socket provided |
| 18 | //! by init. |
| 19 | |
| 20 | mod conditioner; |
| 21 | mod cutils_socket; |
| 22 | mod drbg; |
| 23 | |
| 24 | use std::{ |
| 25 | convert::Infallible, |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 26 | fs::remove_file, |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 27 | io::ErrorKind, |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 28 | os::unix::net::UnixListener, |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 29 | path::{Path, PathBuf}, |
| 30 | }; |
| 31 | |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 32 | use anyhow::{ensure, Context, Result}; |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 33 | use clap::Parser; |
Jeff Vander Stoep | 940820c | 2024-01-31 10:55:29 +0100 | [diff] [blame] | 34 | use log::{error, info, LevelFilter}; |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 35 | use nix::sys::signal; |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 36 | use tokio::{io::AsyncWriteExt, net::UnixListener as TokioUnixListener}; |
| 37 | |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 38 | use crate::conditioner::ConditionerBuilder; |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 39 | |
Andrew Walbran | 13335de | 2022-12-01 15:05:39 +0000 | [diff] [blame] | 40 | #[derive(Debug, Parser)] |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 41 | struct Cli { |
| 42 | #[clap(long, default_value = "/dev/hw_random")] |
| 43 | source: PathBuf, |
| 44 | #[clap(long)] |
| 45 | socket: Option<PathBuf>, |
| 46 | } |
| 47 | |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 48 | fn configure_logging() -> Result<()> { |
| 49 | ensure!( |
| 50 | logger::init( |
Jeff Vander Stoep | 940820c | 2024-01-31 10:55:29 +0100 | [diff] [blame] | 51 | logger::Config::default() |
| 52 | .with_tag_on_device("prng_seeder") |
| 53 | .with_max_level(LevelFilter::Info) |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 54 | ), |
| 55 | "log configuration failed" |
| 56 | ); |
| 57 | Ok(()) |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 58 | } |
| 59 | |
| 60 | fn get_socket(path: &Path) -> Result<UnixListener> { |
| 61 | if let Err(e) = remove_file(path) { |
| 62 | if e.kind() != ErrorKind::NotFound { |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 63 | return Err(e).context(format!("Removing old socket: {}", path.display())); |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 64 | } |
| 65 | } else { |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 66 | info!("Deleted old {}", path.display()); |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 67 | } |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 68 | UnixListener::bind(path) |
| 69 | .with_context(|| format!("In get_socket: binding socket to {}", path.display())) |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 70 | } |
| 71 | |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 72 | fn setup() -> Result<(ConditionerBuilder, UnixListener)> { |
| 73 | configure_logging()?; |
| 74 | let cli = Cli::try_parse()?; |
Andrew Walbran | c768733 | 2023-07-21 17:26:09 +0100 | [diff] [blame] | 75 | // SAFETY: Nothing else sets the signal handler, so either it was set here or it is the default. |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 76 | unsafe { signal::signal(signal::Signal::SIGPIPE, signal::SigHandler::SigIgn) } |
| 77 | .context("In setup, setting SIGPIPE to SIG_IGN")?; |
| 78 | |
| 79 | let listener = match cli.socket { |
| 80 | Some(path) => get_socket(path.as_path())?, |
| 81 | None => cutils_socket::android_get_control_socket("prng_seeder") |
| 82 | .context("In setup, calling android_get_control_socket")?, |
| 83 | }; |
| 84 | let hwrng = std::fs::File::open(&cli.source) |
| 85 | .with_context(|| format!("Unable to open hwrng {}", cli.source.display()))?; |
| 86 | let cb = ConditionerBuilder::new(hwrng)?; |
| 87 | Ok((cb, listener)) |
| 88 | } |
| 89 | |
| 90 | async fn listen_loop(cb: ConditionerBuilder, listener: UnixListener) -> Result<Infallible> { |
| 91 | let mut conditioner = cb.build(); |
| 92 | listener.set_nonblocking(true).context("In listen_loop, on set_nonblocking")?; |
| 93 | let listener = TokioUnixListener::from_std(listener).context("In listen_loop, on from_std")?; |
| 94 | info!("Starting listen loop"); |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 95 | loop { |
| 96 | match listener.accept().await { |
| 97 | Ok((mut stream, _)) => { |
| 98 | let new_bytes = conditioner.request()?; |
| 99 | tokio::spawn(async move { |
| 100 | if let Err(e) = stream.write_all(&new_bytes).await { |
| 101 | error!("Request failed: {}", e); |
| 102 | } |
| 103 | }); |
| 104 | conditioner.reseed_if_necessary().await?; |
| 105 | } |
| 106 | Err(e) if e.kind() == ErrorKind::Interrupted => {} |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 107 | Err(e) => return Err(e).context("accept on socket failed"), |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 108 | } |
| 109 | } |
| 110 | } |
| 111 | |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 112 | fn run() -> Result<Infallible> { |
| 113 | let (cb, listener) = match setup() { |
| 114 | Ok(t) => t, |
| 115 | Err(e) => { |
| 116 | // If setup fails, just hang forever. That way init doesn't respawn us. |
| 117 | error!("Hanging forever because setup failed: {:?}", e); |
| 118 | // Logs are sometimes mysteriously not being logged, so print too |
| 119 | println!("prng_seeder: Hanging forever because setup failed: {:?}", e); |
| 120 | loop { |
| 121 | std::thread::park(); |
| 122 | error!("std::thread::park() finished unexpectedly, re-parking thread"); |
| 123 | } |
| 124 | } |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 125 | }; |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 126 | |
| 127 | tokio::runtime::Builder::new_current_thread() |
| 128 | .enable_all() |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 129 | .build() |
| 130 | .context("In run, building reactor")? |
| 131 | .block_on(async { listen_loop(cb, listener).await }) |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 132 | } |
| 133 | |
| 134 | fn main() { |
Paul Crowley | 021cf55 | 2022-09-28 18:37:43 +0000 | [diff] [blame] | 135 | let e = run(); |
| 136 | error!("Launch terminated: {:?}", e); |
| 137 | // Logs are sometimes mysteriously not being logged, so print too |
| 138 | println!("prng_seeder: launch terminated: {:?}", e); |
Paul Crowley | 9da969e | 2022-09-16 23:42:24 +0000 | [diff] [blame] | 139 | std::process::exit(-1); |
| 140 | } |
Andrew Walbran | 13335de | 2022-12-01 15:05:39 +0000 | [diff] [blame] | 141 | |
| 142 | #[cfg(test)] |
| 143 | mod tests { |
| 144 | use super::*; |
| 145 | use clap::CommandFactory; |
| 146 | |
| 147 | #[test] |
| 148 | fn verify_cli() { |
| 149 | Cli::command().debug_assert(); |
| 150 | } |
| 151 | } |