ocelli/README.md

50 lines
1.4 KiB
Markdown
Raw Normal View History

2024-12-27 23:30:48 +02:00
# ocelli: Camera-Based TRNG
2024-12-29 23:50:20 +02:00
**Ocelli** is a Rust application that generates high-quality entropy using a camera feed. The application supports two entropy generation methods (`chop_and_tack` and `pick_and_flip`) and optionally applies Van Neumann whitening for enhanced randomness. Generated entropy is saved as a binary file.
2024-12-27 23:30:48 +02:00
## Features
- **Entropy Methods**:
2024-12-29 23:50:20 +02:00
- `chop_and_tack`: Compares pixel values between frames.
- `pick_and_flip`: Processes pixel data and flips bits every second frame.
- **Van Neumann Whitening**: Optional, enabled via the `-w` flag.
- **Shannon Entropy Test**: Ensures the randomness quality of generated entropy.
2024-12-27 23:30:48 +02:00
## Usage
```bash
cargo run --release -- <entropy_length_in_bytes> <resolution_width> <resolution_height> [-w]
2024-12-27 23:30:48 +02:00
```
### Example
2024-12-27 23:30:48 +02:00
```bash
2024-12-29 23:50:20 +02:00
cargo run --release -- 1 1024 -w
2024-12-27 23:30:48 +02:00
```
2024-12-29 23:50:20 +02:00
This generates 1024 bytes of whitened entropy using camera 1.
## Requirements
- OpenCV 4.x
## Installation
1. Install Rust: https://www.rust-lang.org/tools/install
2. Install OpenCV: Follow the [official guide](https://docs.opencv.org/).
3. Clone the repository:
```bash
git clone <repository_url>
cd ocelli-entropy-generator
```
4. Run the application:
```bash
cargo run --release -- <arguments>
```
2024-12-27 23:30:48 +02:00
## Output
Generated entropy files are saved in the current directory with a name format:
```
<method>[_whitened]_YYYYMMDD_HHMMSS.bin
```