# adityapatadiya/file-integrity-monitor-fim architecture

> Architecture diagram of the GitHub repository adityapatadiya/file-integrity-monitor-fim, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/adityapatadiya/file-integrity-monitor-fim
- Repository: https://github.com/adityapatadiya/file-integrity-monitor-fim

## Overview

##### Main Components
- CLI Frontend: Represented by CLI.py that handles user input and dispatches CLI commands.
- Monitoring Engine (FIM Module): Found in src/FIM/FIM.py and src/FIM/fim_utils.py; this is the core where file integrity checks occur.
- Authentication Module: Located in src/Authentication/Authentication.py, responsible for user sign-in and sign-up functionality.
- Utilities: A collection of helper scripts in src/utils:
- database.py – handles baseline data storage (likely interfacing with the JSON file in data/baselines/baseline.json).
- backup.py – handles directory backup operations.
- log_parser.py – processes log files from the logs folder.
- anomaly_detection.py – performs anomaly detection using machine learning (using data/models/anomaly_model.pkl and vectorizer.pkl).
- Data Storage Components:
- Baseline Data: Maintained in data/baselines.
- Model Files: Stored in data/models.
- Logs: A dedicated logs folder holds detailed logs.
- Configuration: The config directory contains logging_config.py which configures how logs are generated.

##### Relationships and Interactions
- The CLI frontend triggers various operations (monitoring, viewing/resetting baselines, log analysis, etc.) via command-line arguments. Each argument maps to specific modules.
- The FIM module works in close association with the utilities. For example, when monitoring is triggered, it will:
- Authenticate the user (via the Authentication module).
- Take backups (using backup.py) before starting the monitoring process.
- Use database.py to read/write baseline data.
- Log the file changes; those logs are then later parsed/analyzed by log_parser.py and anomaly_detection.py.
- The configuration file in config/logging_config.py sets up how the logging is handled across the application.
- External dependencies are illustrated with the use of machine learning models (anomaly_model.pkl and vectorizer.pkl) that are loaded during log analysis.

##### Architectural Patterns and Principles
- Modular Design: The project cleanly separates authentication, monitoring (FIM engine), logging, and utility functions into distinct modules.
- CLI-Driven Workflow: The control flow is command-driven; the CLI acts as the orchestrator between user commands and backend processes.
- Data-Driven Operation: The baseline data and logs reside in isolated directories to maintain persistence, while models support anomaly detection.
- Separation of Concerns: Different functionalities (authentication, backup, analysis) are placed in separate folders/files, ensuring maintainability.

##### Relevant Technologies and Frameworks
- Python is the underlying programming language.
- JSON is utilized for maintaining baseline data.
- Machine learning model files indicate a use of libraries (likely scikit-learn or similar) for anomaly detection.
- Logging is configured via a dedicated logging configuration, suggesting either the native Python logging module or a configured external service.

- That labels are clear and descriptive, including major actions like “Backup Initiation” and “Log Analysis.”

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Interface Layer
    subgraph "User Interface Layer"
        cli["CLI Interface (CLI.py)"]:::cli
        auth["Authentication Module (src/Authentication/Authentication.py)"]:::auth
        cli -->|"triggers"| auth
    end

    %% Core Operations
    subgraph "Core Operations"
        fim_main["FIM Engine (src/FIM/FIM.py)"]:::core
        fim_utils["FIM Utils (src/FIM/fim_utils.py)"]:::core
        auth -->|"authorizes"| fim_main
        auth -->|"authorizes"| fim_utils
    end

    %% Utilities
    subgraph "Utilities"
        backup["Backup Utility (src/utils/backup.py)"]:::util
        database["Database Utility (src/utils/database.py)"]:::util
        log_parser["Log Parsing Utility (src/utils/log_parser.py)"]:::util
        anomaly["Anomaly Detection Utility (src/utils/anomaly_detection.py)"]:::util
        fim_main -->|"initiates_backup"| backup
        fim_main -->|"reads/writes|baseline"| database
        fim_main -->|"logs_events"| log_parser
        log_parser -->|"triggers_analysis"| anomaly
    end

    %% Data & Configuration
    subgraph "Data & Configuration"
        baseline["Baseline Data (data/baselines/baseline.json)"]:::storage
        log_files["Log Files (logs folder)"]:::storage
        ml_models["Machine Learning Models (data/models)"]:::storage
        logging_conf["Logging Config (config/logging_config.py)"]:::storage
        database -->|"stores_data"| baseline
        log_parser -->|"parses_logs_from"| log_files
        anomaly -->|"loads_models_from"| ml_models
        fim_main -->|"configures_logging"| logging_conf
        log_parser -->|"uses_logging"| logging_conf
    end

    %% Click Events
    click cli "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/CLI.py"
    click auth "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/src/Authentication/Authentication.py"
    click fim_main "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/src/FIM/FIM.py"
    click fim_utils "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/src/FIM/fim_utils.py"
    click backup "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/src/utils/backup.py"
    click database "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/src/utils/database.py"
    click log_parser "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/src/utils/log_parser.py"
    click anomaly "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/src/utils/anomaly_detection.py"
    click baseline "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/data/baselines/baseline.json"
    click log_files "https://github.com/adityapatadiya/file-integrity-monitor-fim/tree/main/logs"
    click ml_models "https://github.com/adityapatadiya/file-integrity-monitor-fim/tree/main/data/models"
    click logging_conf "https://github.com/adityapatadiya/file-integrity-monitor-fim/blob/main/config/logging_config.py"

    %% Styles
    classDef cli fill:#ffcc00,stroke:#333,stroke-width:2px;
    classDef auth fill:#66ccff,stroke:#333,stroke-width:2px;
    classDef core fill:#ccffcc,stroke:#333,stroke-width:2px;
    classDef util fill:#ffcccc,stroke:#333,stroke-width:2px;
    classDef storage fill:#ccccff,stroke:#333,stroke-width:2px;
```
