https://github.com/mkj/caprand

RP2040 entropy source
https://github.com/mkj/caprand

entropy random rp2040

Last synced: about 1 month ago
JSON representation

RP2040 entropy source

• Host: GitHub
• URL: https://github.com/mkj/caprand
• Owner: mkj
• License: 0bsd
• Created: 2022-10-26T12:21:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-18T05:19:58.000Z (10 months ago)
• Last Synced: 2024-11-11T11:31:58.512Z (about 1 month ago)
• Topics: entropy, random, rp2040
• Language: Rust
• Homepage:
• Size: 1.52 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RP2040 entropy source

[Docs](https://docs.rs/caprand) [`caprand` crate](https://crates.io/crates/caprand)

This is a random number generator for a RP2040. It requires one hardware component,

a capacitor between a GPIO pin and ground. It should be treated as a proof of concept,

it requires further analysis before use in applications with consequences.

This is based on Peter Allan’s [twocent](https://github.com/alwynallan/twocents), with

half the component and pin count.

An end program would use [getrandom](https://docs.rs/getrandom) with `custom` feature,

see [rand](examples/rand.rs) example.

```rust

    caprand::setup(&mut p.PIN_10).expect("RNG setup failed");

    getrandom::register_custom_getrandom!(caprand::random);

    // ...

    let mut key = [0u8; 32];

    getrandom::getrandom(&key).unwrap();

```

## Operation

There is a capacitor between a GPIO pin and ground.

The capacitor is discharged briefly via the GPIO pin pulling low (1 cycle)

then the RP2040 internal pullup on that pin brings the capacitor high again.

It spins in a tight loop waiting for the pin to read as “high” input.

The time taken is measured to an exact system clock cycle (125MHz default), in

bursts of 5 bits (limited by number of registers).  That low order part of the

pullup time is output as a noise sample. Samples are hashed together

to form a seed, which seeds a [ChaCha20](https://docs.rs/rand_chacha/latest/rand_chacha/struct.ChaCha20Rng.html)

cryptographic DRBG.

![Oscilloscope capture](docs/50MS-50mv.png)

## Security

The noise source has not been thoroughly quantified. Empirical testing seems

to show 1-2 bits per sample. As a workaround it takes 100 noise samples per bit of output,

hashing 25600 input noise samples to seed the DRBG.

![A 160x160 random square](docs/25600.png)  

(typical 25600 samples taken from usbnoise example)

Basic health tests (Adaptive Proportion and Repetition) are applied.

The hardware scheme has no protection against local interference (similar to the RP2040 itself).

## Hardware

Testing was performed with a 10nF Y5V SMD chip capacitor soldered between

GP10 pad and the adjacent GND pad, on a Pico W board.

Other capacitor values should also work OK - 100nF was tested, 1nF is likely to work.

![RP Pico with capacitor](docs/pico-cap.jpeg)

## Examples

Examples must be built with `--features defmt`.

[rand](examples/rand.rs) uses getrandom as a normal program would.

[usbnoise](examples/usbnoise.rs) outputs raw samples as hex values, as a USB serial device

[sernoise](examples/sernoise.rs) outputs raw samples as hex values, via the rp2040 uart