Spaces:
Paused
π Citizen Intelligence Agency - CI/CD Workflows
π― Pipeline Overview
The Citizen Intelligence Agency project implements a comprehensive DevSecOps CI/CD pipeline with multi-stage quality gates ensuring security, quality, and reliability at every step. This document details the continuous integration and deployment workflows that automate testing, security scanning, and release procedures to ensure code quality and security compliance.
π Related Architecture Documentation
| Document | Focus | Description | Documentation Link |
|---|---|---|---|
| Architecture | ποΈ Architecture | C4 model showing current system structure | View Source |
| Future Architecture | ποΈ Architecture | C4 model showing future system structure | View Source |
| Mindmaps | π§ Concept | Current system component relationships | View Source |
| Future Mindmaps | π§ Concept | Future capability evolution | View Source |
| SWOT Analysis | πΌ Business | Current strategic assessment | View Source |
| Future SWOT Analysis | πΌ Business | Future strategic opportunities | View Source |
| Data Model | π Data | Current data structures and relationships | View Source |
| Future Data Model | π Data | Enhanced political data architecture | View Source |
| Flowcharts | π Process | Current data processing workflows | View Source |
| Future Flowcharts | π Process | Enhanced AI-driven workflows | View Source |
| State Diagrams | π Behavior | Current system state transitions | View Source |
| Future State Diagrams | π Behavior | Enhanced adaptive state transitions | View Source |
| CI/CD Workflows | π§ DevOps | Current automation processes | View Source |
| Future Workflows | π§ DevOps | Enhanced CI/CD with ML | View Source |
| End-of-Life Strategy | π Lifecycle | Maintenance and EOL planning | View Source |
| Financial Security Plan | π° Security | Cost and security implementation | View Source |
| ISMS Compliance Mapping | π ISMS | Comprehensive ISMS-PUBLIC policy mapping | View Source |
| Security Architecture | π‘οΈ Security | Complete security overview | View Source |
| CIA Features | π Features | Platform features overview | View on hack23.com |
| Threat Model | π‘οΈ Security | Threat analysis informing pipeline gates | View Source |
ποΈ Pipeline Architecture
The CIA project implements a multi-stage CI/CD pipeline with comprehensive quality gates:
graph LR
A[Code Push] --> B[Build & Test]
B --> C[SCA Scan]
C --> D[CodeQL Scan]
D --> E[Quality Gate]
E --> F[Security Gate]
F --> G[SBOM Generation]
G --> H[Attestations]
H --> I[Release]
I --> J[DAST Scan]
style A fill:#bbdefb
style B fill:#c8e6c9
style C fill:#ffccbc
style D fill:#ffccbc
style E fill:#fff9c4
style F fill:#fff9c4
style G fill:#d1c4e9
style H fill:#d1c4e9
style I fill:#a5d6a7
style J fill:#ffccbc
Pipeline Stages Summary
| Stage | Tool/Service | Trigger | Quality Gate | Duration |
|---|---|---|---|---|
| Build & Test | Maven, JUnit | Manual workflow dispatch | Tests pass, Coverage β₯80% | ~15-20 min |
| SCA | Dependabot, Dependency Review | Daily / PR | No critical vulnerabilities | ~2 min |
| CodeQL | GitHub CodeQL | PR, Push to master, Weekly | No critical/high issues | ~20 min |
| Quality Gate | Multiple tools | Every commit | Overall quality β₯A | Auto |
| Security Gate | Multiple tools | Every commit | Zero critical vulnerabilities | Auto |
| SBOM | Maven CycloneDX | Release | Complete SBOM generated | ~5 min |
| Attestations | GitHub Attestations | Release | SLSA provenance created | ~2 min |
| DAST | OWASP ZAP | Manual/Scheduled | No high-risk vulnerabilities | ~30 min |
π Workflow Overview
The CIA project uses GitHub Actions for automation with the following workflows:
- π Verify & Release: Builds, tests, and releases new versions with comprehensive security checks and attestations
- π CodeQL Analysis: Performs advanced code security scanning to detect vulnerabilities
- π¦ Dependency Review: Analyzes dependency changes in PRs for security vulnerabilities
- β Scorecard Analysis: Evaluates the project against OSSF security best practices
- π ZAP Scan: Dynamic application security testing
- π·οΈ PR Labeler: Applies automated labels to pull requests
Workflow Relationships
flowchart TB
subgraph "Continuous Integration"
direction TB
PR[Pull Request] --> CodeQLScan[CodeQL Analysis]
PR --> DependencyReview[Dependency Review]
PR --> Labeler[PR Labeler]
CodeQLScan --> SecurityEvents[Security Events]
end
subgraph "Continuous Deployment"
direction TB
Release[Release Trigger] --> BuildTest[Prepare & Test]
BuildTest --> SetVersion[Set Version]
SetVersion --> BuildPackage[Build & Package]
BuildPackage --> GenerateSBOM[Generate SBOM]
GenerateSBOM --> Attestations[Create Attestations]
Attestations --> CreateRelease[Create GitHub Release]
end
PR -.-> |"approved & merged"| main[Main Branch]
main --> Scorecard[Scorecard Analysis]
main --> WeeklyScan[Weekly CodeQL Scan]
main -.-> |"tag created or manual trigger"| Release
%% Color styling for visual clarity
classDef integration fill:#a0c8e0,stroke:#333,stroke-width:1.5px,color:black
classDef deployment fill:#86b5d9,stroke:#333,stroke-width:1.5px,color:black
classDef process fill:#c8e6c9,stroke:#333,stroke-width:1.5px,color:black
classDef trigger fill:#bbdefb,stroke:#333,stroke-width:1.5px,color:black
classDef security fill:#ffccbc,stroke:#333,stroke-width:1.5px,color:black
classDef audit fill:#ffecb3,stroke:#333,stroke-width:1.5px,color:black
class PR,CodeQLScan,DependencyReview,Labeler integration
class Release,BuildTest,SetVersion,BuildPackage,GenerateSBOM,Attestations,CreateRelease deployment
class main process
class SecurityEvents,Scorecard,WeeklyScan security
π Detailed Pipeline Stages
Stage 1: Build & Test (release.yml)
Workflow: Verify and Release
Trigger: Manual workflow dispatch with version input
Duration: ~15-20 minutes
Runtime: Ubuntu 24.04, JDK 25 (Temurin), Maven 3.9.9
Quality Gates:
- β Maven build success (Java 25, source 21)
- β All modules compile successfully
- β Unit tests pass (207+ tests across modules)
- β Integration tests pass
- β No build warnings or errors
Key Steps:
- name: Build with Maven
run: mvn -B --file pom.xml clean install -Prelease-site,all-modules
- name: APT update and install build tools
run: sudo apt-get install -y graphviz build-essential fakeroot devscripts
Artifacts Generated:
- WAR file:
citizen-intelligence-agency-{version}.war - DEB package:
cia-dist-deb-{version}.all.deb - CloudFormation template:
cia-dist-cloudformation.json
Success Metrics:
- Build success rate: Target 95%+
- Average build time: 18 minutes
- Test pass rate: Target 99%+
Stage 2: SCA - Software Composition Analysis
Tools: Dependabot, GitHub Dependency Review, OWASP Dependency-Check
Trigger: Daily automated scans, PR-based scanning
Duration: ~2 minutes
Quality Gates:
- β No critical vulnerabilities in dependencies
- β All dependencies up-to-date (within 30 days for critical)
- β License compliance verified
- β Known vulnerabilities < 30 days old remediated
Workflows:
.github/workflows/dependency-review.yml- PR-based scanning.github/dependabot.yml- Automated dependency updates
Dependency Review Configuration:
- name: 'Dependency Review'
uses: actions/dependency-review-action@v4.8.2
with:
comment-summary-in-pr: always
Remediation SLA:
- Critical vulnerabilities: 7 days
- High vulnerabilities: 30 days
- Medium vulnerabilities: 90 days
- Low vulnerabilities: Best effort
Dependency Freshness Target: 95% within 30 days of latest release
Stage 3: CodeQL - Semantic Code Analysis
Tool: GitHub CodeQL
Trigger: Push to master, PR, weekly schedule (Wednesday 04:00)
Duration: ~20 minutes
Language: Java
Quality Gates:
- β No critical security issues detected
- β No high-severity vulnerabilities
- β Code patterns comply with security best practices
- β OWASP Top 10 checks pass
Workflow File: .github/workflows/codeql-analysis.yml
Configuration:
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: java
dependency-caching: true
queries: security-extended # Enhanced security analysis
Additional Security Checks:
- Infrastructure as Code (IaC) scanning with Checkov
- CloudFormation template validation
- Security best practices verification
Security Dashboard: Code Scanning Alerts
Checkov Integration:
- name: Run Checkov action
uses: bridgecrewio/checkov-action@master
with:
file: cia-dist-cloudformation/src/main/resources/cia-dist-cloudformation.json
framework: cloudformation
output_format: sarif
Stage 4: OpenSSF Scorecard
Tool: OpenSSF Scorecard
Trigger: Weekly (Tuesday 07:20), branch protection changes, master push
Duration: ~5 minutes
Target Score: β₯ 7.0/10
Quality Gates:
- β Overall score β₯ 7.0/10
- β Branch protection enabled
- β Code review required
- β SAST/SCA tools configured
- β Dependency update automation active
- β Security policy published
Workflow File: .github/workflows/scorecards.yml
Checks Performed:
- Binary-Artifacts
- Branch-Protection
- CI-Tests
- CII-Best-Practices
- Code-Review
- Contributors
- Dangerous-Workflow
- Dependency-Update-Tool
- Fuzzing
- License
- Maintained
- Packaging
- Pinned-Dependencies
- SAST
- Security-Policy
- Signed-Releases
- Token-Permissions
- Vulnerabilities
Current Score: View OpenSSF Scorecard
Results Publication:
- name: "Run analysis"
uses: ossf/scorecard-action@v2.4.3
with:
results_file: results.sarif
results_format: sarif
publish_results: true # Enables OpenSSF badge
Stage 5: SBOM Generation & Attestations
Tool: GitHub Attestations, Maven CycloneDX
Trigger: Release workflow
Duration: ~5 minutes
Format: SPDX JSON
Attestations Generated:
Build Provenance (SLSA)
- DEB package provenance
- WAR file provenance
- Build environment details
- Dependencies snapshot
SBOM Attestations
- Complete software bill of materials
- Dependency tree
- License information
- Version tracking
Implementation:
# DEB Package Attestation
- name: Generate artifact attestation for deb package
uses: actions/attest-build-provenance@v3.0.0
with:
subject-path: 'cia-dist-deb/target/cia-dist-deb-${{ github.event.inputs.release }}.all.deb'
# SBOM Attestation
- name: Generate SBOM attestation for deb package
uses: actions/attest-sbom@v3.0.0
with:
subject-path: 'cia-dist-deb/target/cia-dist-deb-${{ github.event.inputs.release }}.all.deb'
sbom-path: 'cia-dist-deb/target/site/*.spdx.json'
Artifacts with Attestations:
cia-dist-deb-{version}.all.deb+.intoto.jsonlcitizen-intelligence-agency-{version}.war+.intoto.jsonl*.spdx.json+.intoto.jsonl
Verification: Attestations can be verified using GitHub CLI:
gh attestation verify cia-dist-deb-{version}.all.deb --owner Hack23
Stage 6: DAST - Dynamic Application Security Testing
Tool: OWASP ZAP
Trigger: Manual workflow dispatch
Duration: ~30 minutes
Scan Type: Full scan
Quality Gates:
- β No high-risk vulnerabilities
- β No medium-risk vulnerabilities in critical paths
- β Security headers validated
- β Authentication/authorization tested
- β Common web vulnerabilities checked (XSS, SQLi, CSRF)
Workflow File: .github/workflows/zap-scan.yml
Configuration:
- name: ZAP Scan
uses: zaproxy/action-full-scan@v0.13.0
with:
token: ${{ github.token }}
docker_name: "ghcr.io/zaproxy/zaproxy:stable"
target: ${{ github.event.inputs.url }}
Default Target: https://hack23.github.io/cia-compliance-manager/
Scan Coverage:
- SQL Injection
- Cross-Site Scripting (XSS)
- Cross-Site Request Forgery (CSRF)
- Security Headers
- Cookie Security
- SSL/TLS Configuration
- Authentication Bypass
- Session Management
- Information Disclosure
Vulnerability Reporting:
- Results posted as GitHub issues
- SARIF report generated
- Automated triage and prioritization
π ISMS Policy Integration
The CI/CD workflows implement security controls aligned with Hack23 AB's ISMS-PUBLIC framework. See the ISMS Compliance Mapping for complete policy-to-control traceability.
Security Controls by ISMS Policy
| π‘οΈ ISMS Policy | π§ Workflow Implementation | π Evidence |
|---|---|---|
| Secure Development Policy | CodeQL SAST scanning, Dependency Review SCA, SBOM generation | CodeQL workflow |
| Vulnerability Management | Dependabot automated patching, Weekly security scans, OSSF Scorecard | Scorecard workflow |
| Change Management | PR workflow with automated checks, Version control, Automated testing | Release workflow |
| Third-Party Management | Dependency review on PRs, SBOM attestations, Supply chain security | Dependency Review workflow |
| Security Metrics | OpenSSF Scorecard monitoring, Test coverage reporting, Build metrics | Automated dashboards |
Related Documentation:
- π ISMS Compliance Mapping - Complete policy alignment
- π‘οΈ Security Architecture - Implementation details
- π― Threat Model - Risk-based security controls
π Verify & Release Workflow
This comprehensive workflow handles the verification and release process, including building, testing, attestation generation, and release publication.
flowchart TD
Start[Release Trigger] --> Setup[Setup Environment]
Setup --> InstallTools[Install Build Tools]
InstallTools --> RemoveLocaltime[Configure Timezone]
RemoveLocaltime --> InstallMaven[Setup Maven]
InstallMaven --> SetVersion[Set Version]
SetVersion --> AutoCommit[Commit Version Changes]
AutoCommit --> Build[Build Project]
Build --> Generate[Generate Attestations]
Generate --> SBOMAttestation[SBOM Attestation]
SBOMAttestation --> WarAttestation[WAR Attestation]
WarAttestation --> DebAttestation[DEB Attestation]
DebAttestation --> ReleaseNotes[Generate Release Notes]
ReleaseNotes --> GitHubRelease[Create GitHub Release]
GitHubRelease --> DependencyReport[Submit Dependency Report]
DependencyReport --> End[End]
%% Enhanced styling
classDef startEnd fill:#bbdefb,stroke:#333,stroke-width:2px,color:black
classDef setup fill:#a0c8e0,stroke:#333,stroke-width:1.5px,color:black
classDef build fill:#c8e6c9,stroke:#333,stroke-width:1.5px,color:black
classDef security fill:#ffccbc,stroke:#333,stroke-width:1.5px,color:black
classDef release fill:#ffecb3,stroke:#333,stroke-width:1.5px,color:black
class Start,End startEnd
class Setup,InstallTools,RemoveLocaltime,InstallMaven,SetVersion,AutoCommit setup
class Build build
class Generate,SBOMAttestation,WarAttestation,DebAttestation security
class ReleaseNotes,GitHubRelease,DependencyReport release
Key Features of the Release Workflow:
- Automated Version Management: Sets version numbers and commits changes
- Comprehensive Building: Compiles all project components with proper dependency management
- Security Attestations: Generates cryptographic attestations for artifacts (DEB, WAR)
- SBOM Generation: Creates Software Bill of Materials for transparency
- Dependency Reporting: Submits dependency information to GitHub
π Security Scanning Workflows
Multiple security workflows validate different aspects of the CIA project to ensure security and compliance.
flowchart TD
subgraph "CodeQL Analysis"
CQL1[CodeQL Initialization] --> CQL2[Setup JDK 21]
CQL2 --> CQL3[Install Dependencies]
CQL3 --> CQL4[Build Project]
CQL4 --> CQL5[Perform Analysis]
CQL5 --> CQL6[Submit Dependencies]
end
subgraph "Dependency Review"
DR1[Checkout Code] --> DR2[Review Dependencies]
DR2 --> DR3[Comment in PR]
end
subgraph "Scorecard Analysis"
SC1[Checkout Code] --> SC2[Run Analysis]
SC2 --> SC3[Upload Results]
SC3 --> SC4[Upload to Code-Scanning]
end
%% Enhanced styling
classDef codeql fill:#ffccbc,stroke:#333,stroke-width:1.5px,color:black
classDef depend fill:#c8e6c9,stroke:#333,stroke-width:1.5px,color:black
classDef score fill:#ffecb3,stroke:#333,stroke-width:1.5px,color:black
class CQL1,CQL2,CQL3,CQL4,CQL5,CQL6 codeql
class DR1,DR2,DR3 depend
class SC1,SC2,SC3,SC4 score
π CodeQL Analysis Workflow
The CodeQL workflow analyzes code for security vulnerabilities using GitHub's CodeQL engine. It runs on:
- Pull requests to the main branch
- Weekly scheduled scans
- Direct pushes to the main branch
This workflow ensures that vulnerabilities are detected early in the development process, with additional scheduled scans to catch issues that might emerge due to new vulnerability patterns.
π¦ Dependency Review
The dependency review workflow scans dependency manifest changes in pull requests to identify potentially vulnerable packages:
- Runs automatically on all pull requests
- Provides PR comments with findings
- Helps prevent introducing new vulnerabilities
β Scorecard Analysis
The Scorecard workflow evaluates the project against OSSF security best practices:
- Branch protection rules validation
- Dependency management practices assessment
- Code signing verification
- Supply chain security adherence
Results are uploaded to GitHub's code scanning dashboard for easy visibility and tracking.
π·οΈ PR Labeler Workflow
This workflow automatically applies labels to pull requests based on configured rules:
flowchart LR
A[Pull Request] --> B[Checkout Code]
B --> C[Run Labeler]
C --> D{File Pattern Match}
D -->|Documentation changes| E1[Label: documentation]
D -->|CI workflow changes| E2[Label: ci]
D -->|Core code changes| E3[Label: core]
D -->|UI changes| E4[Label: ui]
D -->|Testing changes| E5[Label: testing]
%% Enhanced styling
classDef pr fill:#bbdefb,stroke:#333,stroke-width:1.5px,color:black
classDef process fill:#a0c8e0,stroke:#333,stroke-width:1.5px,color:black
classDef decision fill:#d1c4e9,stroke:#333,stroke-width:1.5px,color:black
classDef label fill:#c8e6c9,stroke:#333,stroke-width:1.5px,color:black
class A pr
class B,C process
class D decision
class E1,E2,E3,E4,E5 label
π CI/CD Configuration Details
The GitHub Actions workflows use several key configuration patterns:
- Hardened Runner Security: Step Security's harden-runner is used to secure CI/CD pipelines
- Egress Policies: Control outbound network connections from workflows
- Explicit Permissions: Limited, specific permissions for each workflow
- Dependency Caching: Optimizes build times by caching dependencies
- Comprehensive Attestations: SLSA provenance and SBOM attestations for security
JDK Configuration
The project's workflows are configured to use JDK 21 for building and testing:
graph TD
A[JDK Configuration] --> B[Java 21]
B --> C[Temurin Distribution]
C --> D[Maven Build]
D --> E[Compatibility with Spring]
E --> F[End-of-Life Planning]
%% Enhanced styling
classDef jdk fill:#a0c8e0,stroke:#333,stroke-width:1.5px,color:black
classDef build fill:#c8e6c9,stroke:#333,stroke-width:1.5px,color:black
classDef planning fill:#ffecb3,stroke:#333,stroke-width:1.5px,color:black
class A,B,C jdk
class D,E build
class F planning
For details on JDK compatibility planning, see the End-of-Life Strategy.
π Security Hardening in Workflows
All workflows include security hardening features:
flowchart TD
A[Security Hardening] --> B[Harden Runner]
B --> C{Egress Policy}
C -->|Audit| D1[Log Outbound Calls]
C -->|Block| D2[Allow Only Listed Endpoints]
B --> E[Limited Permissions]
E --> F[Principle of Least Privilege]
A --> G[Dependency Scanning]
G --> H[CodeQL]
H --> I[Vulnerability Detection]
A --> J[Artifact Attestation]
J --> K[SLSA Provenance]
K --> L[Supply Chain Security]
%% Enhanced styling
classDef main fill:#a0c8e0,stroke:#333,stroke-width:1.5px,color:black
classDef runner fill:#c8e6c9,stroke:#333,stroke-width:1.5px,color:black
classDef policy fill:#d1c4e9,stroke:#333,stroke-width:1.5px,color:black
classDef security fill:#ffccbc,stroke:#333,stroke-width:1.5px,color:black
classDef attest fill:#ffecb3,stroke:#333,stroke-width:1.5px,color:black
class A main
class B,C,D1,D2 runner
class E,F policy
class G,H,I security
class J,K,L attest
π Deployment Process
Release Workflow Overview
The release process is triggered manually via workflow dispatch with version input:
flowchart TD
Start[Manual Release Trigger] --> Input[Version Input]
Input --> Branch[Create Release Branch]
Branch --> Version[Set Maven Version]
Version --> Commit[Auto-commit Changes]
Commit --> Tag[Create Git Tag]
Tag --> Build[Maven Build]
Build --> Package[Generate Artifacts]
Package --> Attest[Generate Attestations]
Attest --> SBOM[Generate SBOMs]
SBOM --> Notes[Draft Release Notes]
Notes --> Release[Create GitHub Release]
Release --> Publish[Publish Artifacts]
Publish --> End[Release Complete]
style Start fill:#bbdefb
style Build fill:#c8e6c9
style Attest fill:#d1c4e9
style SBOM fill:#d1c4e9
style Release fill:#a5d6a7
style End fill:#a5d6a7
Deployment Gates
Pre-Deployment Checks:
- β All quality gates passed
- β Security scans clean (CodeQL)
- β Dependencies reviewed and approved
- β Test coverage meets threshold (β₯80% line coverage)
- β Manual approval for version number
Post-Deployment Validation:
- β Release artifacts published to GitHub
- β Attestations generated and verified
- β SBOM available for transparency
- β Release notes generated
- β Git tag created
Version Management
Versioning Strategy:
- Manual version input via workflow dispatch
- Semantic versioning (MAJOR.MINOR.PATCH)
- Maven versions plugin for version updates
- Automated version commit to release branch
Version Update Process:
mvn versions:set -DnewVersion="${{ github.event.inputs.release }}" -Pall-modules
mvn versions:commit
Deployment Targets
GitHub Release:
- Primary deployment target
- Artifacts published with attestations
- Release notes auto-generated
- Tagged in Git for traceability
Artifacts Published:
DEB Package:
cia-dist-deb-{version}.all.deb- Debian/Ubuntu installation package
- With build provenance attestation
- With SBOM attestation
WAR Application:
citizen-intelligence-agency-{version}.war- Java web application archive
- With build provenance attestation
- With SBOM attestation
CloudFormation Template:
cia-dist-cloudformation.json- AWS infrastructure as code
- Validated by Checkov
- Ready for AWS deployment
SBOM Files:
*.spdx.json- Software Bill of Materials
- SPDX format
- Complete dependency transparency
Rollback Strategy
Rollback Capabilities:
- Git tag-based version history
- Previous releases available on GitHub
- Immutable release artifacts
- Clear version tracking
Rollback Procedure:
- Identify target rollback version
- Download artifacts from GitHub release
- Deploy previous version
- Verify system health
- Document rollback reason
Health Checks
Post-Deployment Validation:
- Application startup validation
- Version verification
- Basic functionality tests
- Log monitoring for errors
Monitoring:
- GitHub Actions workflow status
- Release artifacts availability
- Attestation verification
- SBOM completeness
π Pipeline Analytics & Success Metrics
Performance Metrics
Quality Metrics
| Metric | Target | Current |
|---|---|---|
| Security Rating | A | |
| Maintainability Rating | A | |
| Reliability Rating | A | |
| Vulnerabilities | 0 | |
| Technical Debt | <5% | Tracked in SonarCloud |
Security Metrics
| Metric | Target | Monitoring |
|---|---|---|
| Critical Vulnerabilities | 0 | Daily Dependabot scans |
| High Vulnerabilities | 0 | Daily Dependabot scans |
| Vulnerability Remediation SLA | 7d (Critical), 30d (High) | GitHub Security Advisories |
| Dependency Freshness | 95% within 30 days | Dependabot alerts |
| SBOM Coverage | 100% | Every release |
| Attestation Coverage | 100% | Every release |
Failure Analysis & Response
Automated Failure Notifications:
- GitHub Actions workflow status
- Email notifications for failed workflows
- GitHub Security Advisories for vulnerabilities
Log Retention:
- Failed job logs preserved for 90 days
- Build artifacts retained per GitHub settings
- Security scan results in GitHub Security tab
Continuous Improvement:
- Root cause analysis tracked in issues
- Workflow improvements documented
- Regular retrospectives on failures
- Metrics review and adjustment
Failure Response Process:
- Automated notification triggered
- Review workflow logs
- Identify root cause
- Implement fix
- Validate fix in next run
- Document lessons learned
π Security Automation Evidence
Continuous Security Validation
The CIA project implements comprehensive security automation across all pipeline stages:
Security Scanning Schedule:
- SCA (Dependabot): Daily automated scans
- CodeQL: Every PR, push to master, weekly schedule
- Dependency Review: Every PR
- OpenSSF Scorecard: Weekly, branch protection changes
- DAST (ZAP): Manual/on-demand
- Secret Scanning: Continuous monitoring (GitHub native)
- IaC Scanning (Checkov): Every CodeQL workflow run
Security Evidence Badges
GitHub Actions Workflows:
Security & Quality Ratings:
Supply Chain Security
SLSA Provenance:
- Build provenance for all release artifacts
- GitHub-hosted runner attestations
- Immutable build environment
- Complete build parameter capture
SBOM Generation:
- SPDX format
- Complete dependency tree
- License information
- Version tracking
- Attestation signing
Artifact Verification:
# Verify DEB package attestation
gh attestation verify cia-dist-deb-{version}.all.deb \
--owner Hack23 --repo cia
# Verify WAR attestation
gh attestation verify citizen-intelligence-agency-{version}.war \
--owner Hack23 --repo cia
# Verify SBOM attestation
gh attestation verify *.spdx.json \
--owner Hack23 --repo cia
Security Hardening
Workflow Security:
- Step Security Harden Runner on all workflows
- Egress policy enforcement (audit/block)
- Minimal permissions (principle of least privilege)
- Pinned action versions with SHA256
- Dependency caching security
Example Hardening:
- name: Harden Runner
uses: step-security/harden-runner@v2.13.2
with:
egress-policy: block
allowed-endpoints: >
api.github.com:443
github.com:443
maven.apache.org:443
sonarcloud.io:443
Permission Model:
permissions:
contents: write # For checkout and release creation
security-events: write # For security scanning results
id-token: write # For SLSA provenance
attestations: write # For artifact attestations
packages: write # For package publishing
π Compliance Alignment
ISO 27001 Controls
The CI/CD workflows implement the following ISO 27001:2022 controls:
| Control | Description | Implementation |
|---|---|---|
| A.8.31 | Separation of development, test and production environments | Branch-based workflow, release branches |
| A.8.32 | Change management | Pull request workflow, automated testing, code review |
| A.8.33 | Test information | JUnit tests, JaCoCo coverage, test reports |
| A.5.15 | Access control | GitHub permissions, branch protection, code review |
| A.5.23 | Information security for use of cloud services | Hardened runners, egress policies, secure secrets |
NIST Cybersecurity Framework
| Function | Category | Subcategory | Implementation |
|---|---|---|---|
| Protect | PR.IP-1 | Baseline configuration maintained | Infrastructure as Code, pinned dependencies |
| Protect | PR.DS-6 | Integrity checking mechanisms | SBOM attestations, SLSA provenance |
| Detect | DE.CM-4 | Malicious code detected | SAST (SonarCloud, CodeQL), SCA (Dependabot) |
| Detect | DE.CM-8 | Vulnerability scans performed | Daily dependency scans, weekly CodeQL |
| Respond | RS.AN-5 | Processes established for vulnerabilities | Automated Dependabot PRs, security advisories |
CIS Controls v8
| Control | Sub-Control | Implementation |
|---|---|---|
| 2.3 | Address Unauthorized Software | Dependency review, SCA scanning |
| 2.7 | Allowlist Authorized Software | Maven dependency management, SBOM |
| 7.1 | Establish Secure Configurations | Hardened runner, egress policies |
| 7.5 | Implement Automated Configuration Monitoring | CodeQL, SonarCloud, Checkov |
| 16.8 | Establish Process for Software Updates | Automated Dependabot, weekly scans |
| 16.11 | Leverage Vetted Modules/Services | Pinned GitHub Actions, trusted registries |
EU Cyber Resilience Act (CRA)
| Requirement | Implementation |
|---|---|
| SBOM Requirements | SPDX SBOM generated for all releases, attested |
| Vulnerability Disclosure | GitHub Security Advisories, SECURITY.md |
| Security Updates | Automated Dependabot, 7-day SLA for critical |
| Supply Chain Security | SLSA provenance, attestations, dependency review |
| Transparency | Public workflows, badges, documentation |
π Related Resources
ISMS Compliance Documentation
- ISMS Compliance Mapping - Complete policy-to-control traceability
- Secure Development Policy - CI/CD workflow requirements
- Vulnerability Management - Vulnerability handling procedures
- Change Management - Change control processes
- Third-Party Management - Dependency management policies
Security Documentation
- Security Architecture - Complete security overview
- Threat Model - Threat analysis informing pipeline gates
- SECURITY.md - Security policy and vulnerability reporting
- CRA Assessment - EU Cyber Resilience Act compliance
Technical Documentation
- Architecture - System architecture and design
- Data Model - Database schema and relationships
- Flowcharts - Data processing workflows
External Resources
- GitHub Actions Documentation
- SonarCloud Quality Gates
- OpenSSF Scorecard
- OWASP DevSecOps Guideline
- SLSA Framework
Future CI/CD Improvements
For information about planned enhancements to the CI/CD pipelines, including ML integration, automated adaptation, and advanced security features, see Future Workflows.
The following improvements are prioritized for future implementation:
- Automated Testing Expansion: Expanding automated test coverage for UI components
- Performance Benchmarking: Implementing performance testing in CI pipeline
- Security Scanning Enhancement: Adding additional security scanners
- Containerization: Adding Docker image building and scanning
- Deployment Automation: Enhancing AWS deployment automation
- Accessibility Testing: Adding automated accessibility compliance checks
Mermaid Diagram Support
GitHub natively supports Mermaid diagrams in Markdown files. The diagrams in this documentation leverage this support to visually represent workflows using the Mermaid syntax, enabling:
- Visual representation of workflow relationships
- Clear process documentation
- Easier onboarding for new contributors
For more information about Mermaid syntax and capabilities, see the Mermaid documentation.