How l3montree-dev/devguard works
Project type and purpose
• This is the backend of a full-stack application (“DevGuard Backend”) written in Go. It provides:
• A RESTful API (cmd/devguard) for a web frontend and third-party tools
• A CLI (cmd/devguard-cli) for administrative tasks
• A standalone scanner CLI (cmd/devguard-scanner) for vulnerability scanning (SCA, container, IaC, etc.)
• Background daemons for periodic tasks (internal/core/daemon)
• Integration with Ory Kratos for identity, with PostgreSQL for persistence, and external vulnerability data providers (NVD, OSS tools, GitHub/GitLab APIs)
File structure
• Top-level directories:
• cmd/devguard → main API server
• cmd/devguard-cli → admin CLI entry points (migrate, daemon control, vulndb ops)
• cmd/devguard-scanner → security scanner CLI
• internal/core → business logic organized by domain (asset, component, vuln, compliance, integrations, etc.)
– controllers → HTTP handlers
– services → core business rules
– repositories → data access via internal/database
– daemon → scheduled/background jobs
• internal/database → GORM models & repositories
• internal/auth → session & middleware
• internal/echohttp → HTTP server & middleware
• internal/monitoring → Prometheus exporters
• charts/devguard → Helm deployment manifests
• config, Dockerfiles, docker-compose → environment & container setup
• External dependencies:
• Ory Kratos (identity server)
• PostgreSQL
• GitHub/GitLab APIs
• Vulnerability data services (NVD, DebSec, Mitre, etc.)
README for additional insights
• Confirms separation between Backend and Web-Frontend
• Backend serves Go REST API and scanner CLI
• Uses Ory Kratos for identity, PostgreSQL for storage, Helm for deployment
• Monitoring & metrics exposed for Prometheus
a. Main components:
1. DevGuard API Server
• HTTP server (Echo)
• Auth middleware (Ory Kratos integration)
• Controllers → Services → Repositories → Database
• Daemon workers (internal/core/daemon)
• Monitoring endpoints (Prometheus exporters)
2. PostgreSQL Database
3. Ory Kratos Identity Service
4. DevGuard-CLI (devguard-cli)
5. DevGuard-Scanner (devguard-scanner)
6. External Vulnerability Providers (NVD, DebSec, Mitre, GitHub Advisory API, etc.)
7. DevGuard Web Frontend (separate project, communicates via REST)
8. Kubernetes & Helm (deployment platform)
b. Relationships & interactions:
• Web Frontend & CLI tools → HTTP(S) → DevGuard API
• API → gRPC/HTTP → Ory Kratos for auth/session
• API → SQL → PostgreSQL
• Daemon workers inside API → pull data from External Providers → update database
• DevGuard-Scanner → HTTP → API (ingest SBOM, scan results)
• Monitoring scrapes API’s Prometheus endpoints
• Helm chart deploys API, Kratos, PostgreSQL on K8s
c. Architectural patterns:
• Layered architecture (Controller → Service → Repository)
• Hexagonal/Onion influences (core logic isolated from transports and persistence)
• CLI adapters on the same codebase, reusing core services
• Background worker pattern for periodic ingestion & tasks
• Integration and adapter modules for external services
d. Key technologies:
• Go with Echo framework
• GORM for DB ORM
• Ory Kratos for identity
• Docker & Helm for containerization & orchestration
• Prometheus metrics exporters
• Casbin or similar for RBAC (internal/accesscontrol)