# owasp/abap-code-scanner architecture

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

- Interactive diagram: https://gitdiagram.com/owasp/abap-code-scanner
- Repository: https://github.com/owasp/abap-code-scanner

## Overview

##### Main Components

a) Input Layer:
- ABAP Source Code Input Handler
- Configuration Manager (handling config.yml)
- CLI Interface Component

b) Core Analysis Engine:
- Scanner Core
- Check Registry
- Security Check Modules
- Dataflow Analysis Engine (upcoming feature)

c) Output Layer:
- Report Generator
- XLSX Export Module

##### Input Flow
- ABAP source files entering the system
- Configuration file feeding into the Scanner Core

##### Processing Flow
- Scanner Core distributing work to various check modules
- Dataflow Analysis Engine interacting with check modules

##### Output Flow
- Results aggregation
- Report generation in XLSX format

##### Specific Design Elements

Use these visual elements:
- Blue rectangles for input components
- Green rectangles for processing components
- Yellow rectangles for output components
- Red rectangles for security check modules

##### Detailed Component Breakdown

Scanner Core:
**┌─────────────────────┐**
- Scanner Core     │
- ┤
- File Parser      │
- Check Orchestrator│
- Config Manager   │
- ┘

Security Checks Module:
**┌─────────────────────┐**
- Security Checks    │
- ┤
- XSS              │
- SQL Injection    │
- Dir Traversal    │
- Crypto Checks    │
- ┘

##### Integration Points

Clear interfaces between:
- CLI and Scanner Core
- Scanner Core and Check Modules
- Check Modules and Report Generator
- Dataflow Analysis Engine and Security Checks

##### Technical Details

- Python version requirement (3.9+)
- File extension handlers (.abap, .txt)
- Configuration file format (YAML)
- Report output format (XLSX)

##### Extensibility Points

Highlight:
- Custom check module integration points
- Configuration extension possibilities
- Report format plugins

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        ABAP[ABAP Source Files]
        Config["Configuration"]:::config
        CLI[CLI Interface]
    end

    subgraph "Core Analysis"
        Scanner[Scanner Core]
        Registry[Check Registry]
        DFA[Dataflow Analysis Engine]
    end

    subgraph "Security Checks"
        XSS[XSS Check]:::security
        SQL[SQL Injection Check]:::security
        DT[Directory Traversal Check]:::security
        Crypto[Crypto Security Check]:::security
    end

    subgraph Output
        Report[Report Generator]
        XLSX[XLSX Export Module]
    end

    %% Input Flow
    ABAP --> Scanner
    Config --> Scanner
    CLI --> Scanner

    %% Core Processing
    Scanner --> Registry
    Registry --> XSS
    Registry --> SQL
    Registry --> DT
    Registry --> Crypto
    DFA -.-> XSS
    DFA -.-> SQL
    DFA -.-> DT
    DFA -.-> Crypto

    %% Output Flow
    XSS --> Report
    SQL --> Report
    DT --> Report
    Crypto --> Report
    Report --> XLSX

    %% Styling
    classDef input fill:#a8d1ff
    classDef core fill:#90EE90
    classDef security fill:#ff6b6b
    classDef output fill:#ffeb99
    classDef config fill:#d7bce8

    class ABAP,CLI input
    class Scanner,Registry,DFA core
    class XSS,SQL,DT,Crypto security
    class Report,XLSX output
    class Config config

    %% Click Events
    click Config "https://github.com/OWASP/abap-code-scanner/blob/main/_config.yml"

    %% Legend
    subgraph Legend
        L1[Input Components]:::input
        L2[Core Components]:::core
        L3[Security Checks]:::security
        L4[Output Components]:::output
        L5[Configuration]:::config
    end
```
