Skip to content

Commit 90fd817

Browse files
Stable release (v1.0)
Version 1.0 marks the stable release of C5-DEC. See CHANGELOG for details.
1 parent 06a6adc commit 90fd817

File tree

315 files changed

+17872
-2429
lines changed

Some content is hidden

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

315 files changed

+17872
-2429
lines changed

.devcontainer/devcontainer.json

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
22
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
33
{
4-
"name": "Existing Dockerfile",
4+
"name": "C5-DEC CAD dev container",
5+
// Use 'dockerFile' if you want to build an image from a Dockerfile.
6+
// Use 'image' if you want to use an existing image from Docker Hub or a local image, e.g., the commented line for OpenSSL with oqs provider for PQC.
7+
// Use 'dockerComposeFile' and 'service' if you want to use a service from a docker-compose.yml file.
58
"build": {
69
// Sets the run context to one level up instead of the .devcontainer folder.
710
"context": "..",
@@ -22,8 +25,13 @@
2225
"customizations": {
2326
"vscode": {
2427
"extensions": [
25-
"ms-python.python"
26-
],
28+
"ms-python.python",
29+
"streetsidesoftware.code-spell-checker",
30+
"quarto.quarto",
31+
"ms-toolsai.jupyter",
32+
"ms-toolsai.datawrangler",
33+
"ms-azuretools.vscode-docker"
34+
],
2735
"settings": {
2836
"python.testing.pytestArgs": [
2937
"."
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
3+
{
4+
"name": "C5-DEC cryptography dev container",
5+
"image": "openquantumsafe/oqs-ossl3:latest",
6+
// Use 'dockerFile' if you want to build an image from a Dockerfile.
7+
// Use 'image' if you want to use an existing image from Docker Hub or a local image, e.g., the commented line for OpenSSL with oqs provider for PQC.
8+
// Use 'dockerComposeFile' and 'service' if you want to use a service from a docker-compose.yml file.
9+
10+
// Features to add to the dev container. More info: https://containers.dev/features.
11+
// "features": {},
12+
13+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
14+
// "forwardPorts": [],
15+
16+
// Uncomment the next line to run commands after the container is created.
17+
// "postCreateCommand": "cat /etc/os-release",
18+
19+
// Configure tool-specific properties.
20+
"customizations": {
21+
"vscode": {
22+
"extensions": [
23+
"ms-python.python",
24+
"streetsidesoftware.code-spell-checker",
25+
"quarto.quarto"
26+
],
27+
"settings": {
28+
"python.testing.pytestArgs": [
29+
"."
30+
],
31+
"python.testing.unittestEnabled": false,
32+
"python.testing.pytestEnabled": true,
33+
"python.formatting.provider": "black"
34+
}
35+
}
36+
},
37+
38+
"workspaceMount": "source=${localWorkspaceFolder},target=/home/alab/c5dec,type=bind",
39+
"workspaceFolder": "/home/alab/c5dec"
40+
41+
// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
42+
// "remoteUser": "devcontainer"
43+
}

CHANGELOG.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
1+
# 1.0 (2025-05-07)
2+
3+
Version 1.0 marks the stable release of C5-DEC.
4+
5+
## Added
6+
7+
- C5-DEC new project creation feature and command added to the CLI: `c5dec.sh new`
8+
- C5-DEC DocEngine enhancement: new templates, automation scripts, LaTeX enhancements
9+
- ETR evaluation spreadsheet formulas for automatic work unit verdict computation from atomic work item
10+
- LaTeX commands for dynamic and color-coded ETR verdict encoding: pass, fail, inconclusive
11+
- ETR evaluation overview templates, spreadsheets and compilation into Markdown for DocEngine
12+
- Doorstop source processing code for C5-DEC keyword handling in test reports
13+
- CPSSA, Cryptography, and Transformer commands to the CLI
14+
- Cryptographic software to the containerized `C5-DEC cryptography dev container`: Kryptor, Cryptomator CLI
15+
- Fully containerized DocEngine and dependencies within the `C5-DEC CAD dev container`
16+
- OQS-OpenSSL provider container to `.devcontainer` and allow selection between C5-DEC containers
17+
- Abstract to DocEngine report template cover pages
18+
- Interactive session mode with the C5-DEC container accessed via `c5dec.sh session`
19+
- Interactive session mode with the OQS-OpenSSL container for PQC accessed via `c5dec.sh pqc`
20+
- Publish function isolation in `docs/specs`
21+
- C5-DEC project template with placeholders used as input by the CLI `new` command
22+
- Validation test cases (`TSS`) and test report (`TRS`) for the stable release
23+
24+
## Fixed
25+
26+
- Header and footer logo placement offset bugs in DocEngine report compilation
27+
28+
## Modified
29+
30+
- DocEngine default report and ETR layouts for the cover page
31+
- DocEngine for ETR part generation to improve work unit and atomic work item compilation
32+
- `_quarto.yml` files for both DocEngine report and ETR templates
33+
- CLI command descriptions and help instructions
34+
- User manual pages for Cryptography, CPSSA, SSDLC and Transformer
35+
- Runner `c5dec.sh` implementation to provide new modes: `help`, `session`, `pqc`, `c5dec <command>`
36+
- Build script `build-c5dec.sh` to also build the dev container for access via `c5dec.sh session`
37+
- VS Code dev container configuration to include new extensions: Code Spell Checker, Quarto, Jupyter and Data Wrangler
38+
39+
## Removed
40+
41+
- All CLI commands for SSDLC (all have been integrated into the `new` CLI command)
42+
- TUI menus of features migrated to the CLI: SSDLC, CPSSA, Cryptography, Transformer
43+
144
# 0.3.1 (2024-09-16)
245

346
## Added

Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ ENV MY_ENV=${MY_ENV} \
1111
PIP_DEFAULT_TIMEOUT=100 \
1212
POETRY_VERSION=1.5.0
1313

14-
ENV user=root
14+
ENV user=alab
1515
ENV c5folder=c5dec
1616

17-
# Update and install depencencies
17+
# Update and install dependencies
1818
RUN apt update --fix-missing
1919
RUN apt-get install -y git python3-pip graphviz
2020

0 commit comments

Comments
 (0)