Skip to content

Commit d543f27

Browse files
committed
docs: update README with full architecture blueprint
1 parent 466580d commit d543f27

1 file changed

Lines changed: 88 additions & 10 deletions

File tree

README.md

Lines changed: 88 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,98 @@ This project secures the communication channels between distributed nodes in the
77

88
---
99

10-
## 🏛️ Strategic Alignment & Planning
11-
This repository contains the **Identity-Aware Perimeter Configurations** and encrypted mesh network settings.
10+
## 🏗️ System Architecture (Identity-Aware Perimeter)
1211

13-
### 📜 Detailed Architecture & Blueprint
14-
For the full security architecture, identity-flow diagrams, and zero-trust principles mapping, see the master planning document:
15-
👉 [**Full Architecture Blueprint: Zero-Trust Networking**](https://github.com/vspatabuga/vspatabuga/blob/main/Prototypes/zero-trust-networking.md)
12+
```mermaid
13+
flowchart TD
14+
%% Global Styling
15+
classDef default fill:#f9f9f9,stroke:#333,stroke-width:1px,color:#333,font-family:Inter,sans-serif;
16+
classDef user fill:#e1f5fe,stroke:#01579b,stroke-width:2px;
17+
classDef secure fill:#ede7f6,stroke:#4527a0,stroke-width:2px;
18+
classDef network fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px;
19+
classDef secret fill:#fffde7,stroke:#fbc02d,stroke-width:2px;
20+
classDef infra fill:#eceff1,stroke:#455a64,stroke-width:1px;
21+
22+
%% Nodes & Structure
23+
User((👤 User / Device))
24+
25+
subgraph IAM [Identity & Access Management]
26+
direction TB
27+
IDP[Tailscale / Cloudflare IDP]
28+
SECRETS{{Vaultwarden / Hashi Vault}}
29+
end
30+
31+
subgraph TRANSPORT [Secure Tunneling]
32+
direction LR
33+
WG[WireGuard Protocol] --- TUN[Cloudflare Tunnel]
34+
end
35+
36+
subgraph TARGET [Sovereign Resources]
37+
direction TB
38+
NODE[Distributed Nodes]
39+
AI[AI Governance Stack]
40+
end
41+
42+
%% Connections
43+
User ==>|Identity Challenge| IDP
44+
IDP ==>|Generate Token| SECRETS
45+
SECRETS ==>|Authorize| WG
46+
47+
WG ==>|Encrypted Pipe| TUN
48+
TUN ==>|Expose Services| TARGET
49+
50+
%% Assign Classes
51+
class User user;
52+
class IDP,SECRETS secure;
53+
class WG,TUN network;
54+
class NODE,AI infra;
55+
```
56+
57+
### 📋 Diagram Legend (Security Principles)
58+
| Symbol/Style | Description | Classification |
59+
| :--- | :--- | :--- |
60+
| **Double Circle (( ))** | Authenticated User or Device | **Person** |
61+
| **Hexagon {{ }}** | Secrets Management & Credential Store | **Security Controller** |
62+
| **Rectangle [ ]** | Networking Protocols and IDPs | **Network Component** |
63+
| **Bold Line (==>)** | Encrypted & Authenticated Traffic | **Secure Flow** |
64+
| **Thin Line (---)** | Protocol Peering | **Association** |
65+
| **Purple Box** | Identity & Secret Verification Layer | **Trust Control** |
66+
| **Blue Box (Nodes)** | Encryption & Tunneling Layer | **Network Fabric** |
67+
| **Green Box** | Final Protected Resource Layer | **Service Layer** |
68+
69+
---
70+
71+
## 🚀 Key Components & Logic
72+
73+
### 1. Identity over Location
74+
Instead of IP-based security, the system uses **Tailscale** (WireGuard-based) to create an encrypted mesh network where every node has a unique, verifiable identity. This ensures that a compromised node cannot easily move laterally through the network.
75+
76+
### 2. Secret Sovereignty: Vaultwarden
77+
Secrets, API keys, and certificates are managed centrally through **Vaultwarden**. This ensures that sensitive data is never hard-coded into the infrastructure and can be rotated automatically within the Zero-Trust perimeter.
78+
79+
### 3. Edge Security: Cloudflare Tunnel
80+
Public-facing services are exposed securely through **Cloudflare Tunnels**. This eliminates the need for open inbound ports on the server, effectively hiding the infrastructure from the public internet while allowing authenticated access.
81+
82+
---
83+
84+
## 🛡️ Zero-Trust Workflow
85+
86+
1. **Identity:** The User/Device authenticates with the Identity Provider (IDP).
87+
2. **Encryption:** Tailscale/WireGuard establishes an end-to-end encrypted tunnel.
88+
3. **Authorization:** The system checks the Access Control Policy (ACL) in Vaultwarden/Tailscale.
89+
4. **Least Privilege:** Access is granted *only* to the specific service requested (e.g., the AI Governance Dashboard).
90+
5. **Monitoring:** All access events are logged for audit and security analysis.
1691

1792
---
1893

19-
## 🚀 Key Technical Features
20-
- **Identity-Based Access:** Verification via Tailscale and Cloudflare Access.
21-
- **Mesh Encryption:** Secure tunneling using the WireGuard protocol.
22-
- **Hidden Ingress:** Eliminating open inbound ports with Cloudflare Tunnels.
23-
- **Secret Management:** Centralized credential control via Vaultwarden.
94+
## 🛠️ Tech Stack Employed
95+
96+
| Layer | Technologies |
97+
| :--- | :--- |
98+
| **Connectivity** | ![](https://img.shields.io/badge/Tailscale-4433FF?style=flat&logo=tailscale&logoColor=white) ![](https://img.shields.io/badge/WireGuard-881717?style=flat&logo=wireguard&logoColor=white) |
99+
| **Public Ingress** | ![](https://img.shields.io/badge/Cloudflare-F38020?style=flat&logo=cloudflare&logoColor=white) ![](https://img.shields.io/badge/GitHub%20Actions-2088FF?style=flat&logo=githubactions&logoColor=white) |
100+
| **Secrets Management**| ![](https://img.shields.io/badge/Vaultwarden-175DDC?style=flat&logo=vaultwarden&logoColor=white) ![](https://img.shields.io/badge/Hashi-FF3E00?style=flat&logo=hashicorp&logoColor=white) |
101+
| **Infrastructure** | ![](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=white) ![](https://img.shields.io/badge/Terraform-7B42BC?style=flat&logo=terraform&logoColor=white) |
24102

25103
---
26104

0 commit comments

Comments
 (0)