# vbarahona/edurogue architecture

> Architecture diagram of the GitHub repository vbarahona/edurogue, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vbarahona/edurogue
- Repository: https://github.com/vbarahona/edurogue

## Overview

Edurogue is an administrator’s tool for assessing whether nearby Eduroam clients accept an untrusted RADIUS certificate. The runtime starts a rogue access point, interprets hostapd-wpe authentication logs, records assessment outcomes, and enforces a retest interval. Administrators can query results through a separate interactive manager; optional Telegram integration sends device and operational logs. The sampled Python shows runtime startup, database access, log handling, and Telegram calls; other assessment details are represented from the README rather than unsampled implementation.

Main entry points: [`edurogue/edurogue.py`](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py) (Assessment runtime), [`edurogue/edurogue-mgr.py`](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue-mgr.py) (Management CLI), [`hostapd-wpe`](https://github.com/vbarahona/edurogue/tree/main/hostapd-wpe) (Rogue AP / RADIUS), [`edurogue/edurogue_db.sql`](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue_db.sql) (MariaDB records)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_assessment["Wireless assessment"]
  node_runtime["Assessment runtime<br/>[edurogue.py]"]
  node_rogueap["Rogue AP / RADIUS"]
  node_authlogs["Authentication logs<br/>[edurogue.py]"]
  node_classification["Outcome handling<br/>[edurogue.py]"]
  node_retest["Retest eligibility<br/>[edurogue.py]"]
end

subgraph group_operations["Results and operations"]
  node_database[("MariaDB records<br/>[edurogue_db.sql]")]
  node_dbaccess["Runtime database access<br/>[edurogue.py]"]
  node_manager["Management CLI<br/>[edurogue-mgr.py]"]
  node_notifications["Logging and notifications<br/>[edurogue.py]"]
end

node_admin(("Administrator"))
node_clients(("Nearby clients"))
node_telegram(("Telegram"))

node_runtime -->|"starts service"| node_rogueap
node_clients -->|"connect and authenticate"| node_rogueap
node_rogueap -->|"writes logs"| node_authlogs
node_runtime -->|"reads logs"| node_authlogs
node_runtime -->|"handles outcomes"| node_classification
node_classification -->|"stores assessment"| node_dbaccess
node_dbaccess -->|"reads and writes"| node_database
node_runtime -->|"expires records"| node_retest
node_retest -->|"deletes expired"| node_dbaccess
node_admin -->|"queries results"| node_manager
node_manager -->|"queries records"| node_database
node_runtime -->|"emits logs"| node_notifications
node_notifications -->|"sends messages"| node_telegram
node_manager -->|"checks token"| node_telegram

click node_runtime "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py"
click node_rogueap "https://github.com/vbarahona/edurogue/tree/main/hostapd-wpe"
click node_authlogs "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py"
click node_classification "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py"
click node_retest "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py"
click node_database "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue_db.sql"
click node_dbaccess "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py"
click node_manager "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue-mgr.py"
click node_notifications "https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_runtime,node_rogueap,node_authlogs,node_classification,node_retest,node_clients toneBlue
class node_database,node_dbaccess,node_manager,node_notifications toneAmber
class node_admin,node_telegram toneIndigo
```

## Components

### Wireless assessment

- [Assessment runtime](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py): `edurogue/edurogue.py`
- [Rogue AP / RADIUS](https://github.com/vbarahona/edurogue/tree/main/hostapd-wpe): `hostapd-wpe`
- [Authentication logs](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py): `edurogue/edurogue.py`
- [Outcome handling](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py): `edurogue/edurogue.py`
- [Retest eligibility](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py): `edurogue/edurogue.py`

### Results and operations

- [MariaDB records](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue_db.sql): `edurogue/edurogue_db.sql`
- [Runtime database access](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py): `edurogue/edurogue.py`
- [Management CLI](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue-mgr.py): `edurogue/edurogue-mgr.py`
- [Logging and notifications](https://github.com/vbarahona/edurogue/blob/main/edurogue/edurogue.py): `edurogue/edurogue.py`

### Other components

- **Administrator**
- **Nearby clients**
- **Telegram**

## Connections

- Assessment runtime → Rogue AP / RADIUS: starts service (evidence: `edurogue/edurogue.py`)
- Nearby clients → Rogue AP / RADIUS: connect and authenticate (evidence: `README.md`)
- Rogue AP / RADIUS → Authentication logs: writes logs (evidence: `edurogue/edurogue.py`)
- Assessment runtime → Authentication logs: reads logs (evidence: `edurogue/edurogue.py`)
- Assessment runtime → Outcome handling: handles outcomes (evidence: `edurogue/edurogue.py`)
- Outcome handling → Runtime database access: stores assessment (evidence: `edurogue/edurogue.py`)
- Runtime database access → MariaDB records: reads and writes (evidence: `edurogue/edurogue.py`)
- Assessment runtime → Retest eligibility: expires records (evidence: `edurogue/edurogue.py`)
- Retest eligibility → Runtime database access: deletes expired (evidence: `edurogue/edurogue.py`)
- Administrator → Management CLI: queries results (evidence: `README.md`)
- Management CLI → MariaDB records: queries records (evidence: `edurogue/edurogue-mgr.py`)
- Assessment runtime → Logging and notifications: emits logs (evidence: `edurogue/edurogue.py`)
- Logging and notifications → Telegram: sends messages (evidence: `edurogue/edurogue.py`)
- Management CLI → Telegram: checks token (evidence: `edurogue/edurogue-mgr.py`)
