True Random Number Generator

An awesome TRNG based on a modified galton board.
Includes a REST API and a simple frontend.
Explore the docs »

---

Table of Contents

1. About The Project
   • REST API
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Startup of the api
3. Screenshots
   • Starting the system
   • Generation
   • Export
   • Dark theme
4. Building the galton board
5. License

---

🔍 About The Project

The Galton Board is a Physical True Random Number Generator.
The goal is to generate random numbers that can be used for cryptographic processes.
It is based on a physical noise source and generates random numbers that fulfill the required PTG.2 standard of the Federal Office for Information Security (BSI).

We offer a REST API interface or a web application with a user interface for operation.

(back to top)

---

⚙️ REST API endpoints

• '/': Redirects to the TRNG page.
• '/trng': Renders the TRNG page.
• '/trng/randomNum/init': Initializes the TRNG system.
• '/trng/randomNum/shutdown': Shuts down the TRNG system.
• '/trng/randomNum/getRandom': Retrieves random bits from the database and converts them to HEX encoding.
• '/trng/getCount': Retrieves the count of stored random bits from the database.

REST API Documentation »

---

👷‍♂️ Built With

• 
• 
• 
• 
• 
• 

(back to top)

---

🏃 Getting Started

To get a local copy of the project up and running follow these simple steps.

---

📌 Prerequisites

The project must run on a raspberry pi because it uses hardware components (gpio pins).
For installing the dependencies you should use the latest version of pip.

• pip

  pip install --upgrade pip

---

⚡ Installation

1. Clone the repo

   git clone https://github.com/2120865/TRNG.git

2. Switch into the directory

   cd TRNG

3. Install PIP packages

   pip install -r requirements.txt

---

✅ Startup of the REST API

• python3 rest_api.py

(back to top)

---

📸 Screenshots

Starting the system

Generating random numbers

Exporting the generated random numbers

Switching to dark theme

---

🌲 Project tree

TRNG
├── LICENSE
├── README.md
├── docs
│   ├── API
│   │   └── ...
│   └── models
│       ├── README.md
│       ├── 3D
│       │   ├── GaltonBoard
│       │   │   ├── ...
│       │   │   └── ...
│       │   └── MarblePump
│       │       ├── ...
│       │       └── ...
│       └── lasercutter
│           ├── ...
│           └── ...
├── hardware
│   ├── gyroscope.py
│   ├── laser_sensor.py
│   └── stepper_engine.py
├── instance
│   └── TRNG.db
├── models
│   └── models.py
├── requirements.txt
├── rest_api.py
├── static
│   ├── css
│   │   └── main.css
│   ├── img
│   │   ├── ...
│   │   └── ...
│   └── js
│       ├── background.js
│       └── main.js
├── templates
│   └── index.html
└── tests
    └── test_suite.py

16 directories, 43 files

---

👷‍♂️ Building the galton board

• Building instructions

---

📜 License

Distributed under the MIT License. See LICENSE for more information.

(back to top)