Skip to content

Commit 6615b45

Browse files
Patch v1.2.1
## Modified - Main README to improve overview - Technical specifications (`docs/specs`) and traceability web site to tidy up TCS and TRP ## Fixed - SRS items (removed dates)
1 parent c910812 commit 6615b45

File tree

163 files changed

+6564
-4770
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+6564
-4770
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
# 1.2.1 (2026-03-11)
2+
3+
## Modified
4+
5+
- Main README to improve overview
6+
- Technical specifications (`docs/specs`) and traceability web site to tidy up TCS and TRP
7+
8+
## Fixed
9+
10+
- SRS items (removed dates)
11+
112
# 1.2 (2026-03-10)
213

314
## Added

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ C5-DEC, short for "Common Criteria for Cybersecurity, Cryptography, Clouds – D
66

77
[![Version](https://img.shields.io/badge/version-1.2-blue)](CHANGELOG.md) [![License: AGPL v3](https://img.shields.io/badge/license-AGPL--v3-brightgreen)](LICENSE) [![Python](https://img.shields.io/badge/python-3.8--3.11-blue)](pyproject.toml)
88

9-
C5-DEC CAD is the software component of C5-DEC — an [AI-enabled](./docs/manual/ssdlc.md#ai-enabled-design-specification-development-and-testing) toolkit for computer-aided secure system design, development and evaluation, accessible through a CLI, a Flask-powered GUI, and an asciimatics-powered TUI, with VS Code devcontainer support and preloaded extensions. Its modules cover: a [Common Criteria Toolbox (CCT)](./docs/manual/cct.md) (SFR/SAR database, CEM checklists, ETR generation); an [SSDLC](./docs/manual/ssdlc.md) pipeline (project scaffolding, [DocEngine](./docs/manual/ssdlc.md#c5-dec-docengine-for-report-generation), [SpecEngine](./docs/specs/SpecEngine/README.md), [certification-oriented](./docs/README.md) documentation tooling); [CRA compliance](./docs/manual/cra.md) (Annex I checklist, Annex VII tech doc, Annex V declaration); [SBOM management](./docs/manual/sbom.md) via [Syft](https://github.com/anchore/syft); a [CPSSA module](./docs/manual/cpssa.md) for STRIDE threat modelling and FAIR risk analysis; a [cryptography module](./docs/manual/cryptography.md) (classical and post-quantum crypto); and [project management](./docs/manual/pm.md) utilities. All artifacts are stored in open formats (Markdown, YAML), complemented by a [CC concept wiki](./c5dec/assets/database/KnowledgeBase/0_MapofContent.md) and an SSDLC/SVV/CPSSA knowledge base, making the full specification tree directly accessible to LLMs.
9+
C5-DEC CAD is the software component of C5-DEC — an [AI-enabled](./docs/manual/ssdlc.md#ai-enabled-design-specification-development-and-testing) toolkit for computer-aided secure system design, development and evaluation, accessible through native command-line and graphical [interfaces](#usage) (CLI, TUI, GUI), as well as a VS Code workbench with dedicated devcontainer support and preloaded extensions. Its modules cover: a [Common Criteria Toolbox (CCT)](./docs/manual/cct.md) (SFR/SAR database, CEM checklists, ETR generation); an [SSDLC](./docs/manual/ssdlc.md) pipeline (project scaffolding, [SpecEngine](./docs/specs/SpecEngine/README.md) for structured, fully traceable specification management aligned with [certification workflows](./docs/README.md), [DocEngine](./docs/manual/ssdlc.md#c5-dec-docengine-for-report-generation) for smart document authoring and technical/scientific publishing); [CRA compliance](./docs/manual/cra.md) (Annex I checklist, Annex VII tech doc, Annex V declaration); [SBOM management](./docs/manual/sbom.md) via [Syft](https://github.com/anchore/syft); a [CPSSA module](./docs/manual/cpssa.md) for STRIDE threat modelling and FAIR risk analysis; a [cryptography module](./docs/manual/cryptography.md) (classical and post-quantum crypto); and [project management](./docs/manual/pm.md) utilities. All artifacts are stored in open formats (Markdown, YAML), complemented by a [CC concept wiki](./c5dec/assets/database/KnowledgeBase/0_MapofContent.md) and an SSDLC/SVV/CPSSA knowledge base, making the full specification tree directly accessible to LLMs.
1010

11-
This repository contains the source code and full documentation (requirements, technical specifications, schematics, [user manual](./docs/manual/README.md), test case specifications and test reports) of C5-DEC CAD; see our [traceability web page](https://abstractionslab.github.io/c5dec/docs/traceability/index.html) for a live view of the full specification tree and traceability coverage.
11+
This repository contains the source code and full documentation (requirements, design artifacts, [user manual](./docs/manual/README.md), test case specifications and test reports) of C5-DEC CAD; see our [technical specification traceability web site](https://abstractionslab.github.io/c5dec/docs/traceability/index.html) for a live view of the full specification tree and traceability coverage, produced by the C5-DEC [SpecEngine](./docs/specs/SpecEngine/README.md).
1212

1313
## Table of contents
1414

@@ -26,7 +26,7 @@ This repository contains the source code and full documentation (requirements, t
2626

2727
## Overview
2828

29-
C5-DEC CAD assists system/software designers, developers, and security analysts with building and evaluating secure software systems. It integrates SSDLC, SVV, and CPSSA within the Common Criteria framework, providing full artifact traceability across the entire development life cycle, along with cryptographic checks, threat modelling, Cyber Resilience Act (CRA) compliance support, and SBOM lifecycle management.
29+
C5-DEC CAD assists system/software designers, developers, testers and security analysts with building and evaluating secure software systems. It integrates SSDLC, SVV, and CPSSA within the Common Criteria framework, providing full artifact traceability across the entire development life cycle, along with cryptographic checks, threat modelling, quantitative risk analysis, Cyber Resilience Act (CRA) compliance support, and SBOM lifecycle management. Its DocEngine, built on Quarto with custom LaTeX enhancements and pre/post-render scripting, enables smart document authoring, scientific and technical publishing across report, presentation, and CRA technical documentation templates.
3030

3131
### Knowledge base
3232

@@ -150,7 +150,7 @@ Install [Docker Desktop](https://www.docker.com/products/docker-desktop/), [VS C
150150
| Container | Contents | Best for |
151151
|-----------|----------|----------|
152152
| `C5-DEC CAD dev container` | CLI, TUI, GUI, CCT, CRA, SBOM, CPSSA, cryptography | General use and development |
153-
| `C5-DEC DocEngine dev container` | Quarto, TeX Live, Kryptor, Cryptomator CLI | Report and document publishing |
153+
| `C5-DEC DocEngine dev container` | `CAD dev container` plus Quarto, TeX Live, Kryptor, Cryptomator CLI | Report and document publishing |
154154
| `C5-DEC CAD cryptography dev container` | OpenSSL, OQS-OpenSSL provider | Post-quantum cryptography |
155155

156156
Once inside the container, activate the poetry environment with `poetry shell` and run `c5dec -h`.

docs/README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,6 @@ This directory contains all documentation for the C5-DEC CAD (Common Criteria fo
44

55
## Documentation structure
66

7-
### `dev/` - Developer context guides
8-
9-
**Audience**: AI assistants and developers working on the codebase
10-
11-
**Purpose**: Domain-specific context files that provide focused technical knowledge for specific subsystems or workflows.
12-
13-
**Contents**:
14-
- `copilot-context-architecture.md` - System architecture and design patterns
15-
- `copilot-context-cct.md` - Common Criteria Toolbox (CCT)
16-
- `copilot-context-docengine.md` - DocEngine and publishing system
17-
- `copilot-context-docker.md` - Docker containers and devcontainer
18-
- `copilot-context-frontend.md` - CLI, GUI, and TUI interfaces
19-
- `copilot-context-pm.md` - Project/resource management
20-
- `copilot-context-ssdlc.md` - SSDLC methodology and Transformer
21-
- `copilot-context-testing.md` - Test suite and conventions
22-
- `copilot-doorstop-context.md` - Requirements management with Doorstop
23-
- `cra.md` - Cyber Resilience Act guidance
24-
25-
**Usage**: AI assistants automatically load relevant context files based on the task.
26-
277
### `manual/` - User and developer manuals
288

299
**Audience**: End users, system administrators, and developers

docs/specs/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This folder holds the authoritative, traceable specifications for IDPS-ESCAPE managed with Doorstop following the [C5-DEC](https://github.com/AbstractionsLab/c5dec) methodology and its enhancements to Doorstop via extra custom code and templates. Use it for defining what the system must do and why, not how to operate it.
44

5+
> **Note:** `c5traceability_config.yaml` is project-specific. Before running the publish pipeline or traceability analysis on a new project, update this file to reflect your document hierarchy, coverage checks, and defect sources. If the file is missing or outdated, regenerate it automatically with `poetry run python SpecEngine/c5traceability.py --discover --discover-write` from the `docs/specs/` directory.
6+
57
## What lives here
68

79
| Path | Document type | Role in hierarchy |
@@ -10,8 +12,8 @@ This folder holds the authoritative, traceable specifications for IDPS-ESCAPE ma
1012
| `srs/` | Software/System Requirements Specifications | Child of MRS |
1113
| `arc/` | Architecture | Child of MRS |
1214
| `swd/` | Software design | Child of ARC |
13-
| `tcs/` | Test case specifications (merged) | Child of SRS |
14-
| `trp/` | Test reports (merged) | Child of TCS |
15+
| `tcs/` | Test case specifications | Child of SRS |
16+
| `trp/` | Test reports | Child of TCS |
1517
| `docs/publish/` | Generated HTML output | Produced by `publish.sh` |
1618

1719
### Custom tooling scripts

docs/specs/srs/SRS-053.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
acceptance: ''
33
active: true
44
author: ''
5-
date: DD.MM.YYYY
65
dependence: []
76
derived: false
87
difficulty: '2'

docs/specs/srs/SRS-054.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
acceptance: ''
33
active: true
44
author: ''
5-
date: DD.MM.YYYY
65
dependence: []
76
derived: false
87
difficulty: '2'

docs/specs/srs/SRS-055.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
acceptance: ''
33
active: true
44
author: ''
5-
date: DD.MM.YYYY
65
dependence: []
76
derived: false
87
difficulty: '2'

docs/specs/srs/SRS-056.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
acceptance: ''
33
active: true
44
author: ''
5-
date: DD.MM.YYYY
65
dependence: []
76
derived: false
87
difficulty: '2'

docs/specs/srs/SRS-057.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
acceptance: ''
33
active: true
44
author: ''
5-
date: DD.MM.YYYY
65
dependence: []
76
derived: false
87
difficulty: '2'

docs/specs/srs/SRS-058.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
acceptance: ''
33
active: true
44
author: ''
5-
date: DD.MM.YYYY
65
dependence: []
76
derived: false
87
difficulty: '1'

0 commit comments

Comments
 (0)