# ernw/dizzfiles architecture

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

- Interactive diagram: https://gitdiagram.com/ernw/dizzfiles
- Repository: https://github.com/ernw/dizzfiles

## Overview

##### Main Components

a. Protocol Modules Layer
- Protocols into related categories:
- Network Protocols (ARP, CDP, LLDP, VXLAN)
- Internet Protocols (IPv6, ICMP, DHCP)
- Application Protocols (HTTP, SIP)
- Storage Protocols (NFSv3, NFSv4)
- Mobile/Telecom Protocols (GTP_v1, GTP_v2, GSM_MAP)
- Device Protocols (USB)
- Security Protocols (SSL)

b. Fuzzing Engine Interface Layer
- How these scripts interface with the Dizzy fuzzing toolkit
- .dizz file format as the connection point

c. Test Execution Layer
- Action files (.act)
- Test case generation flow

**┌─────────────────────────────────────────┐**
- Dizzy Fuzzing Engine         │
- ┘
- ↑

**┌─────────────────────────────────────────┐**
- Protocol Fuzzing Scripts         │
- ┬─────────┬─────────┬──────────┤
- Network │Internet │  App    │ Storage  │
- Protocol │Protocol │Protocol │Protocol  │
- Scripts  │Scripts  │Scripts  │Scripts   │
- ┴─────────┴─────────┴──────────┘

##### Important Elements to Highlight

a. Protocol Implementation Structure
- How complex protocols (like NFSv4) have multiple components:
- Core operation files
- Action scripts
- Supporting modules

b. Test Flow Representation
- How test cases are generated
- Relationship between .dizz and .act files

##### Specific Details

a. File Type Relationships:
- .dizz files → Test Definitions
- .act files → Test Actions
- .py files → Supporting Logic

b. Protocol-Specific Components:
- Related protocol operations
- Dependencies between operations

##### The interface with the Dizzy fuzzing engine

Remember to maintain a balance between showing the overall architecture while providing enough detail to understand the relationship between different components and their role in the fuzzing process.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph DizzyEngine["Dizzy Fuzzing Engine"]
        Engine["Core Engine"]
    end

    subgraph ProtocolLayer["Protocol Fuzzing Scripts"]
        subgraph NetworkProtocols["Network Protocols"]
            ARP["ARP"]:::network
            CDP["CDP"]:::network
            LLDP["LLDP"]:::network
            VXLAN["VXLAN"]:::network
        end

        subgraph InternetProtocols["Internet Protocols"]
            IPv6["IPv6"]:::internet
            ICMP["ICMP"]:::internet
            DHCP["DHCP"]:::internet
        end

        subgraph AppProtocols["Application Protocols"]
            HTTP["HTTP"]:::app
            SIP["SIP"]:::app
        end

        subgraph StorageProtocols["Storage Protocols"]
            NFSv3["NFSv3"]:::storage
            NFSv4["NFSv4"]:::storage
        end

        subgraph MobileProtocols["Mobile/Telecom Protocols"]
            GTPv1["GTP v1"]:::mobile
            GTPv2["GTP v2"]:::mobile
            GSM_MAP["GSM MAP"]:::mobile
        end

        subgraph DeviceProtocols["Device Protocols"]
            USB["USB"]:::device
        end

        subgraph SecurityProtocols["Security Protocols"]
            SSL["SSL"]:::security
        end

        subgraph NFSv4Components["NFSv4 Components"]
            CoreOps["Core Operations"]:::nfs
            ClientOps["Client Operations"]:::nfs
            FileOps["File Operations"]:::nfs
            ActionScripts["Action Scripts"]:::nfs
            SupportModules["Supporting Modules"]:::nfs
        end
    end

    Engine --> ProtocolLayer

    NFSv4 --> NFSv4Components

    %% Click events for components
    click ARP "https://github.com/ernw/dizzfiles/blob/master/arp.dizz"
    click CDP "https://github.com/ernw/dizzfiles/blob/master/cdp.dizz"
    click LLDP "https://github.com/ernw/dizzfiles/blob/master/lldp.dizz"
    click VXLAN "https://github.com/ernw/dizzfiles/blob/master/vxlan.dizz"
    click IPv6 "https://github.com/ernw/dizzfiles/tree/master/ipv6/"
    click ICMP "https://github.com/ernw/dizzfiles/tree/master/icmp/"
    click DHCP "https://github.com/ernw/dizzfiles/tree/master/dhcp/"
    click HTTP "https://github.com/ernw/dizzfiles/tree/master/http/"
    click SIP "https://github.com/ernw/dizzfiles/tree/master/sip/"
    click NFSv3 "https://github.com/ernw/dizzfiles/tree/master/nfsv3/"
    click NFSv4 "https://github.com/ernw/dizzfiles/tree/master/nfsv4/"
    click GTPv1 "https://github.com/ernw/dizzfiles/tree/master/gtp_v1/"
    click GTPv2 "https://github.com/ernw/dizzfiles/tree/master/gtp_v2/"
    click GSM_MAP "https://github.com/ernw/dizzfiles/tree/master/gsm_map/"
    click USB "https://github.com/ernw/dizzfiles/tree/master/usb/"
    click SSL "https://github.com/ernw/dizzfiles/tree/master/ssl/"
    click CoreOps "https://github.com/ernw/dizzfiles/blob/master/nfsv4/operations.dizz"
    click ClientOps "https://github.com/ernw/dizzfiles/tree/master/nfsv4/setclientid/"
    click FileOps "https://github.com/ernw/dizzfiles/tree/master/nfsv4/read/"
    click ActionScripts "https://github.com/ernw/dizzfiles/tree/master/nfsv4/"
    click SupportModules "https://github.com/ernw/dizzfiles/blob/master/nfsv4/__init__.py"

    %% Styling
    classDef network fill:#a8e6cf
    classDef internet fill:#dcedc1
    classDef app fill:#ffd3b6
    classDef storage fill:#ffaaa5
    classDef mobile fill:#ff8b94
    classDef device fill:#98ddca
    classDef security fill:#d4a5a5
    classDef nfs fill:#ffcb91
```
