# sonali2109/skycrate architecture

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

- Interactive diagram: https://gitdiagram.com/sonali2109/skycrate
- Repository: https://github.com/sonali2109/skycrate

## Overview

##### Project type and purpose
- SkyCrate is a full-stack web-based file management system built around a Spring Boot backend and a Hadoop (HDFS) storage layer.
- The system exposes REST endpoints for file operations, authentication, and HDFS interactions, while the frontend (not in this repo) consumes these APIs and provides i18n support.

##### File structure
- Top-level Dockerfile, Maven wrapper, pom.xml → containerized Spring Boot microservice.
- src/main/java/com/skycrate/backend/…
– config/ → Spring configuration beans (security, HDFS, caching, HTTPS redirect).
– controller/ → REST controllers (AuthController, FileController, HDFScontroller).
– dto/ → request & response payload models with validation.
– entity/ → JPA entities (User, FileMetadata, RefreshToken).
– repository/ → Spring Data JPA repos.
– security/ → JWT filter, token blacklist, encryption service.
– services/ → business logic (AuthenticationService, FileService, HDFSOperations, RateLimiterService, etc.).
– utils/ → key generation & encryption utilities.
- src/main/resources/ → application configs, prod profile, keystore.

##### README for additional insights
- Dockerized Hadoop cluster behind Tailscale → persistent HDFS service
- Hybrid RSA-AES file encryption per user
- JWT auth with refresh tokens + blacklist on logout
- Brute-force protection via in-code rate limiting
- Automatic HDFS directory provisioning on user signup
- Audit logging & DTO validation

##### Detail without over-fragmentation
- Major sub-systems (config, security, business, data).
- Unique features: hybrid encryption, automated HDFS provisioning, rate limiting, internationalization entry point.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client["Client (Web/Mobile)"]:::external

    %% Spring Boot Application Container
    subgraph "Spring Boot Application"
        direction TB

        %% Configurations
        subgraph "Configuration" 
            direction TB
            AppConfig["ApplicationConfiguration"]:::config
            HDFSConfig["HDFSConfig"]:::config
            CacheConfig["CacheConfig"]:::config
            HTTPSRedirect["HttpToHttpsRedirectConfig"]:::config
            SecurityConfig["SecurityConfig"]:::config
        end

        %% Security Layer
        subgraph "Security" 
            direction TB
            JWTFilter["JwtAuthenticationFilter"]:::security
            TokenBlacklist["TokenBlacklistService"]:::security
            EncryptionSec["EncryptionService"]:::security
        end

        %% Controllers
        subgraph "Controllers"
            direction TB
            AuthCtrl["AuthController"]:::controller
            FileCtrl["FileController"]:::controller
            HDFSCtrl["HDFSController"]:::controller
        end

        %% Services
        subgraph "Services"
            direction TB
            AuthService["AuthenticationService"]:::service
            FileService["FileService"]:::service
            HDFSOps["HDFSOperations"]:::service
            JwtService["JwtService"]:::service
            RefreshTokenSvc["RefreshTokenService"]:::service
            UserService["UserService"]:::service
            RateLimiter["RateLimiterService"]:::service
            KeyCache["KeyCacheService"]:::service
            EncUtilSvc["EncryptionUtil"]:::service
        end

        %% Repositories
        subgraph "Repositories"
            direction TB
            UserRepo["UserRepository"]:::repo
            FileMetaRepo["FileMetadataRepository"]:::repo
            TokenRepo["RefreshTokenRepository"]:::repo
        end
    end

    %% Infrastructure and External Systems
    subgraph "Persistence Layer"
        direction TB
        Database[(Relational DB)]:::storage
        HDFSCluster[(HDFS Cluster)]:::storage
    end

    HaveIBeenPwned["HaveIBeenPwned API"]:::external
    Tailscale["Tailscale VPN"]:::infra

    %% Data Flows
    Client -->|"HTTPS 443"| HTTPSRedirect
    HTTPSRedirect --> JWTFilter
    JWTFilter --> AuthCtrl
    JWTFilter --> FileCtrl
    JWTFilter --> HDFSCtrl

    AuthCtrl -->|"calls"| AuthService
    FileCtrl -->|"calls"| FileService
    HDFSCtrl -->|"calls"| HDFSOps

    AuthService -->|"(user, pass)"| HaveIBeenPwned
    AuthService -->|"(user data)"| UserService
    AuthService -->|"(tokens)"| JwtService
    AuthService -->|"(refresh)"| RefreshTokenSvc

    FileService -->|"(metadata operations)"| FileMetaRepo
    FileService -->|"(user lookup)"| UserRepo
    FileService -->|"(refresh lookup)"| TokenRepo
    FileService -->|"(HDFS read/write)"| HDFSOps

    HDFSOps -->|HDFS RPC| Tailscale
    Tailscale --> HDFSCluster

    AuthService -->|"(blacklist tokens)"| TokenBlacklist
    JWTFilter -->|"(validate tokens)"| JwtService
    JWTFilter -->|"(check blacklist)"| TokenBlacklist

    %% Repositories to Database
    UserRepo --> Database
    FileMetaRepo --> Database
    TokenRepo --> Database

    %% Utility & Support
    AuthService --> RateLimiter
    AuthService --> KeyCache
    AuthService --> EncUtilSvc
    FileService --> EncUtilSvc

    %% Click Events
    click AppConfig "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/config/ApplicationConfiguration.java"
    click HDFSConfig "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/config/HDFSConfig.java"
    click CacheConfig "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/config/CacheConfig.java"
    click HTTPSRedirect "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/config/HttpToHttpsRedirectConfig.java"
    click SecurityConfig "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/config/SecurityConfig.java"
    click AuthCtrl "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/controller/AuthController.java"
    click FileCtrl "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/controller/FileController.java"
    click HDFSCtrl "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/controller/HDFScontroller.java"
    click AuthService "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/services/AuthenticationService.java"
    click FileService "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/services/FileService.java"
    click HDFSOps "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/services/HDFSOperations.java"
    click JwtFilter "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/security/JwtAuthenticationFilter.java"
    click TokenBlacklist "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/security/TokenBlacklistService.java"
    click EncryptionSec "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/security/EncryptionService.java"
    click UserRepo "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/repository/UserRepository.java"
    click FileMetaRepo "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/repository/FileMetadataRepository.java"
    click TokenRepo "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/repository/RefreshTokenRepository.java"
    click KeyCache "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/services/KeyCacheService.java"
    click EncUtilSvc "https://github.com/sonali2109/skycrate/blob/main/src/main/java/com/skycrate/backend/skycrateBackend/services/EncryptionUtil.java"

    %% Styles
    classDef external fill:#b3e2cd,stroke:#333,stroke-width:1px
    classDef config fill:#d9f0d3,stroke:#333,stroke-width:1px
    classDef security fill:#fdae61,stroke:#333,stroke-width:1px
    classDef controller fill:#67a9cf,stroke:#333,stroke-width:1px
    classDef service fill:#2166ac,stroke:#fff,stroke-width:1px,color:#fff
    classDef repo fill:#92c5de,stroke:#333,stroke-width:1px
    classDef storage fill:#b2abd2,stroke:#333,stroke-width:1px
    classDef infra fill:#d1e5f0,stroke:#333,stroke-width:1px\n
```
