You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## 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)
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.
10
10
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).
12
12
13
13
## Table of contents
14
14
@@ -26,7 +26,7 @@ This repository contains the source code and full documentation (requirements, t
26
26
27
27
## Overview
28
28
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.
30
30
31
31
### Knowledge base
32
32
@@ -150,7 +150,7 @@ Install [Docker Desktop](https://www.docker.com/products/docker-desktop/), [VS C
150
150
| Container | Contents | Best for |
151
151
|-----------|----------|----------|
152
152
|`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 |
Copy file name to clipboardExpand all lines: docs/specs/README.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
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.
4
4
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
+
5
7
## What lives here
6
8
7
9
| Path | Document type | Role in hierarchy |
@@ -10,8 +12,8 @@ This folder holds the authoritative, traceable specifications for IDPS-ESCAPE ma
10
12
|`srs/`| Software/System Requirements Specifications | Child of MRS |
11
13
|`arc/`| Architecture | Child of MRS |
12
14
|`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 |
15
17
|`docs/publish/`| Generated HTML output | Produced by `publish.sh`|
0 commit comments