# spring-projects/spring-security-samples architecture

> Architecture diagram of the GitHub repository spring-projects/spring-security-samples, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/spring-projects/spring-security-samples
- Repository: https://github.com/spring-projects/spring-security-samples

## Overview

##### Project type and purpose
- This is a multi‐module “monorepo” of Spring Security sample applications. It groups dozens of small web apps and services illustrating different security scenarios (Servlet MVC, Spring Boot, WebFlux, RSocket, OAuth2, SAML2, JWT, LDAP, X.509, CAS, etc.). The README is purely a catalog of those samples.

##### File‐structure overview
- Top‐level “infrastructure”:
- .github/workflows – CI/CD definitions (GitHub Actions).
- config/checkstyle – quality rules applied across modules.
- docker/cas – Docker Compose to spin up a CAS server for CAS samples.
- build.gradle, settings.gradle, gradle.properties, gradle/… – root Gradle build orchestrating all subprojects, plus version catalogs and wrapper.
- scripts (sync‐*, find‐latest‐minor‐version.sh) – utility scripts for dependency/version management.
- Subproject groups:
- reactive/… – WebFlux, RSocket, WebFlux.fn, Kotlin WebFlux samples.
- servlet/… – Spring Boot (Java/Kotlin), pure Servlet Java‐Config, XML‐Config, AOT, OAuth2, SAML2, authentication variants, data integration, session management, observability.
- Each leaf directory under reactive/ or servlet/ is a standalone Gradle project with its own build files, source tree, and integration tests.

##### README insights
- The README maps each submodule to a use case (e.g. “OAuth2 login”, “Resource Server”, “JWT login”, “X.509”).
- No single system runs all modules at once—they’re independent samples. Some integration tests rely on external containers (CAS, LDAP, database scripts).

##### Diagramming this architecture
a. Main components:
- GitHub Monorepo (root)
- CI/CD (GitHub Actions workflows)
- Build System (Gradle root + multiproject)
- Quality Config (Checkstyle rules)
- Docker CAS environment
- Subproject groups (“reactive”, “servlet”)
- Individual sample apps (OAuth2 Authorization Server, WebFlux hello‐security, LDAP sample, etc.)
- External services (CAS server, LDAP directory, relational DB for JDBC samples)
b. Relationships & interactions:
- Commits → CI pipeline (trigger .github/workflows)
- CI → invokes `./gradlew build` (loads settings.gradle → configures all subprojects)
- CI → spins up Docker CAS for CAS‐samples’ tests
- LDAP samples → LDAP directory (embedded or external)
- JDBC samples → relational DB (import.sql)
c. Architectural patterns & principles:
- Multi‐module Gradle build (composite/cross‐project)
- Containerization for external dependencies (Docker Compose)
- CI/CD enforcing consistency and code quality
- Each sample follows MVC / Reactive‐Streams / WebFlux.fn or pure Servlet configuration patterns
d. Key technologies:
- Spring Security, Spring Boot, Spring WebFlux, Spring MVC
- OAuth2 (Spring Security’s client, resource‐server, authorization‐server)
- SAML2 login/logout, JWT auth, X.509 client cert, multi‐factor, CAS
- RSocket (hello‐security sample)
- Gradle (settings.gradle, libs.versions.toml, wrapper)
- Docker Compose for CAS
- Checkstyle for styling

## Diagram (Mermaid)

```mermaid
graph TD
  subgraph "Platform Layer"
    Repo["GitHub Monorepo"]:::infra
    CI["CI/CD (GitHub Actions)"]:::ci
    Build["Gradle Root Build"]:::infra
    Config["Quality Config (Checkstyle)"]:::infra
    DockerCAS["Docker CAS Environment"]:::external
  end

  subgraph "Samples Layer"
    subgraph "Reactive Samples"
      RS1["RSocket Hello-Security"]:::reactive
      RS2["WebFlux.fn Hello-Security"]:::reactive
      RS3["Reactive WebFlux Hello-Security"]:::reactive
      RS4["Reactive OAuth2 Login"]:::reactive
    end
    subgraph "Servlet Samples"
      SS1["Spring Boot OAuth2 Login"]:::servlet
      SS2["Spring Boot LDAP Sample"]:::servlet
      SS3["Spring Boot JWT Login"]:::servlet
      SS4["Servlet Java-Config X.509"]:::servlet
      SS5["Servlet XML-Config Contacts"]:::servlet
    end
  end

  CASServer["CAS Server"]:::external
  LDAP["LDAP Directory"]:::external
  DB["Relational DB"]:::external

  Repo -->|push| CI
  CI -->|"run build"| Build
  CI -->|"spin up CAS"| DockerCAS
  DockerCAS -->|"hosts"| CASServer

  Build -->|"apply config"| Config
  Build -->|"configure"| RS1
  Build -->|"configure"| RS2
  Build -->|"configure"| RS3
  Build -->|"configure"| RS4
  Build -->|"configure"| SS1
  Build -->|"configure"| SS2
  Build -->|"configure"| SS3
  Build -->|"configure"| SS4
  Build -->|"configure"| SS5

  Config --> RS1
  Config --> RS2
  Config --> RS3
  Config --> RS4
  Config --> SS1
  Config --> SS2
  Config --> SS3
  Config --> SS4
  Config --> SS5

  SS2 -->|"uses for tests"| LDAP
  SS3 -->|"uses for tests"| DB

  classDef infra fill:#D0E7FF,stroke:#0366d6,color:#0366d6,stroke-width:2px;
  classDef ci fill:#BEE3F8,stroke:#3182CE,color:#3182CE,stroke-width:2px,stroke-dasharray: 5 5;
  classDef reactive fill:#E6FFFA,stroke:#2C7A7B,color:#2C7A7B,stroke-width:2px;
  classDef servlet fill:#FFF5E6,stroke:#DD6B20,color:#DD6B20,stroke-width:2px;
  classDef external fill:#FFE6E6,stroke:#E53E3E,color:#E53E3E,stroke-width:2px,stroke-dasharray: 5 5;

  click CI "https://github.com/spring-projects/spring-security-samples/tree/main/.github/workflows/"
  click Config "https://github.com/spring-projects/spring-security-samples/tree/main/config/checkstyle/"
  click DockerCAS "https://github.com/spring-projects/spring-security-samples/blob/main/docker/cas/docker-compose.yml"
  click Build "https://github.com/spring-projects/spring-security-samples/blob/main/build.gradle"
  click Build "https://github.com/spring-projects/spring-security-samples/blob/main/settings.gradle"
  click Build "https://github.com/spring-projects/spring-security-samples/blob/main/gradle/libs.versions.toml"
  click RS1 "https://github.com/spring-projects/spring-security-samples/blob/main/reactive/rsocket/hello-security/build.gradle"
  click RS2 "https://github.com/spring-projects/spring-security-samples/blob/main/reactive/webflux-fn/hello-security/build.gradle"
  click RS3 "https://github.com/spring-projects/spring-security-samples/blob/main/reactive/webflux/java/hello-security/build.gradle"
  click RS4 "https://github.com/spring-projects/spring-security-samples/blob/main/reactive/webflux/java/oauth2/login/build.gradle"
  click SS1 "https://github.com/spring-projects/spring-security-samples/blob/main/servlet/spring-boot/java/oauth2/login/build.gradle"
  click SS2 "https://github.com/spring-projects/spring-security-samples/blob/main/servlet/spring-boot/java/ldap/build.gradle"
  click SS3 "https://github.com/spring-projects/spring-security-samples/blob/main/servlet/spring-boot/java/jwt/login/build.gradle"
  click SS4 "https://github.com/spring-projects/spring-security-samples/blob/main/servlet/java-configuration/authentication/x509/build.gradle"
  click SS5 "https://github.com/spring-projects/spring-security-samples/blob/main/servlet/xml/java/contacts/build.gradle"
```
