# kleo/evilportals architecture

> Architecture diagram of the GitHub repository kleo/evilportals, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kleo/evilportals
- Repository: https://github.com/kleo/evilportals

## Overview

##### Main Components

a) Core System Components:
- WiFi Pineapple Device (Tetra/Nano)
- Evil Portal Module
- Portal Collection System
- Credential Capture System
- Logging System

b) Portal Types (Multiple Implementations):
- Social Media Portals (Facebook, Twitter, Instagram)
- Email Portals (Google, Yahoo)
- Service Portals (Starbucks, O2, OptimumWiFi)
- Custom Payload Portal (CLIQQ)

**User Interface Layer**
- WiFi Pineapple Web Interface
- Evil Portal Module Interface

**Portal Management Layer**
- Portal Activation System
- Portal Selection System
- Credential Collection Handler

**Implementation Layer**
- Individual Portal Implementations
- Asset Management
- Helper Systems

##### Key Relationships

- Data flow from victim to portal
- Credential capture flow
- Management commands flow
- Storage and logging operations

##### Component Details

Each portal implementation should show:
- MyPortal.php (Controller)
- Assets (CSS/JS/Images)
- Helper.php (Utilities)
- Index.php (Entry Point)

##### Implementation Notes

- Modular portal design
- Common infrastructure sharing
- Asset management system
- Credential capture workflow

##### Technical Elements

Integration points with:
- Evil Portal Module (v3.2)
- WiFi Pineapple Hardware
- File System Structure
- Network Stack

- Lucidchart
- Microsoft Visio

- Component relationships
- Data flows
- Security boundaries
- Implementation structure

This system design should reflect the project's nature as a security testing tool while maintaining clarity about its modular architecture and implementation details.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        WPI[WiFi Pineapple Interface]:::interface
        EPM[Evil Portal Module Interface]:::interface
    end

    subgraph "Portal Management Layer"
        PAS[Portal Activation System]:::management
        PSS[Portal Selection System]:::management
        CCH[Credential Collection Handler]:::management
    end

    subgraph "Portal Collection System"
        PCS[Portal Collection System]:::collection
    end

    subgraph "Social Media Portals"
        FB[Facebook Portal]:::portal
        TW[Twitter Portal]:::portal
        IG[Instagram Portal]:::portal
    end

    subgraph "Email Portals"
        GP[Google Portal]:::portal
        YP[Yahoo Portal]:::portal
    end

    subgraph "Service Portals"
        SB[Starbucks Portal]:::portal
        O2[O2 Portal]:::portal
        OW[OptimumWiFi Portal]:::portal
    end

    subgraph "Custom Portals"
        CQ[CLIQQ Payload Portal]:::portal
    end

    subgraph "Common Components"
        PC[Portal Controller]:::component
        AM[Asset Management]:::component
        UF[Utility Functions]:::component
        EP[Entry Point]:::component
    end

    WPI --> EPM
    EPM --> PAS
    EPM --> PSS
    PSS --> PCS
    PCS --> FB
    PCS --> TW
    PCS --> IG
    PCS --> GP
    PCS --> YP
    PCS --> SB
    PCS --> O2
    PCS --> OW
    PCS --> CQ

    FB --> PC
    FB --> AM
    FB --> UF
    FB --> EP

    CCH --> PC

    classDef interface fill:#ff6b6b,stroke:#333,stroke-width:2px
    classDef management fill:#4ecdc4,stroke:#333,stroke-width:2px
    classDef collection fill:#45b7d1,stroke:#333,stroke-width:2px
    classDef portal fill:#96ceb4,stroke:#333,stroke-width:2px
    classDef component fill:#d4d4d4,stroke:#333,stroke-width:2px

    click PCS "https://github.com/kleo/evilportals/tree/master/portals/"
    click FB "https://github.com/kleo/evilportals/tree/master/portals/facebook-login/"
    click TW "https://github.com/kleo/evilportals/tree/master/portals/twitter-login/"
    click IG "https://github.com/kleo/evilportals/tree/master/portals/instagram-login/"
    click GP "https://github.com/kleo/evilportals/tree/master/portals/google-login/"
    click YP "https://github.com/kleo/evilportals/tree/master/portals/yahoo-login/"
    click SB "https://github.com/kleo/evilportals/tree/master/portals/starbucks-login/"
    click O2 "https://github.com/kleo/evilportals/tree/master/portals/o2-login/"
    click OW "https://github.com/kleo/evilportals/tree/master/archive/optimumwifi/"
    click CQ "https://github.com/kleo/evilportals/tree/master/portals/cliqq-payload/"
    click PC "https://github.com/kleo/evilportals/blob/master/MyPortal.php"
    click AM "https://github.com/kleo/evilportals/tree/master/assets/"
    click UF "https://github.com/kleo/evilportals/blob/master/helper.php"
    click EP "https://github.com/kleo/evilportals/blob/master/index.php"
```
