Skip to content

Commit 5c4b659

Browse files
karlllewistcpninja
andauthored
docs: added screenshots and updated README and trust-page.md with image links (#27)
Co-authored-by: tcpninja <cnciso@proton.me>
1 parent ad0d412 commit 5c4b659

6 files changed

Lines changed: 22 additions & 11 deletions

File tree

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,13 @@ git commit -m "test: add fake token (should fail)"
118118

119119
- **Vulnerabilities & IaC Findings:**
120120
Found under [Security → Code scanning alerts](../../security/code-scanning) in the GitHub UI.
121+
All pushes are scanned in CI/CD:
122+
![GitHub Actions workflow passing with SBOM artifact](docs/screenshots/gh-actions-passing.jpg)
121123

122124
- **SBOM (Software Bill of Materials):**
123125
Downloadable artifact (`sbom-spdx`) from the workflow run.
126+
Each build publishes an SPDX SBOM Artifact:
127+
![SBOM artifact download in GitHub Actions](docs/screenshots/sbom-artifacts.jpg)
124128

125129
- **Executive Summary:**
126130
`security-summary.md` artifact includes counts of HIGH/CRITICAL issues and SBOM status.
@@ -136,6 +140,8 @@ make scan # Vulnerability + IaC scan
136140
make sbom # SBOM generation (SPDX JSON)
137141
```
138142

143+
![Make Scan from local terminal](docs/screenshots/local-make-scan.jpg)
144+
139145
---
140146

141147
## Secure Examples
@@ -179,19 +185,20 @@ For executive stakeholders and security reviewers, we maintain a concise
179185
- Policy exception workflow
180186
- Security contact information
181187

182-
- **Compliance mapping:** see [docs/compliance-mapping.md](./docs/compliance-mapping.md)
183-
- **Architecture overview:** see [docs/architecture.md](./docs/architecture.md)
188+
**Compliance mapping:** see [docs/compliance-mapping.md](./docs/compliance-mapping.md)
189+
**Architecture overview:** see [docs/architecture.md](./docs/architecture.md)
184190

185191
---
186192

187193
## Roadmap
188194

189-
- [x] Repo scaffolded
190-
- [x] Pre-commit (Gitleaks)
191-
- [x] CI: Trivy vuln + SBOM
192-
- [x] Makefile for local parity
193-
- [x] Secure examples in repo; failing demo via permanent tag
194-
- [x] OpenSSF Scorecard (workflow)
195-
- [x] Compliance mapping & trust artifacts in README
196-
- [ ] “How to download SBOM” screenshots (docs/screenshots)
197-
- [ ] Policy-as-code (Kyverno) in v2
195+
**Completed (v1 baseline):**
196+
Scaffold, Gitleaks pre-commit, Trivy CI + SBOM, Makefile, Basic secure/insecure examples, OpenSSF Scorecard, compliance mapping & trust artifacts, initial screenshots.
197+
198+
**Planned Enhancements:**
199+
- [ ] Automate Trust Badge updates (CI → shields.io)
200+
- [ ] Add IAM/Multicloud examples (secure vs insecure)
201+
- [ ] Expand pre-commit hooks (IaC lint, markdownlint)
202+
- [ ] Exec-friendly “Trust” page polish (auto-fill scan date)
203+
- [ ] More real-world IaC examples (Kubernetes, Terraform modules)
204+
- [ ] Demo video / GIF for Quickstart
108 KB
Loading
79 KB
Loading
100 KB
Loading
41.6 KB
Loading

docs/trust-page.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22

33
**Last CI security scan:** ![Security Workflow](https://github.com/cloudnativeciso/secure-by-default-starter/actions/workflows/security.yml/badge.svg)
44
**Latest SBOM artifact:** Available via **GitHub Actions → latest run → Artifacts → `sbom-spdx`**
5+
![Screenshot of SBOM artifact in GitHub Actions](../docs/screenshots/sbom-artifacts.jpg)
6+
57
**Guardrails in place:**
68
- Secrets scanning (pre-commit Gitleaks)
79
- CI vulnerability & IaC scanning (Trivy, fails on HIGH/CRITICAL)
810
- SPDX SBOM generated for every run
911
- OpenSSF Scorecard for secure SDLC hygiene
12+
![Screenshot of GitHub Actions security checks](../docs/screenshots/gh-actions-passing.jpg)
1013

1114
**Policy exception process:**
1215
Tracked via GitHub Issues → **Security Exception Request** form
1316
(see `.github/ISSUE_TEMPLATE/security-exception.yml`)
17+
![Screenshot of Policy Exception Process](../docs/screenshots/policy-exception.jpg)
1418

1519
**Contact:** [security@cloudnativeciso.com](mailto:security@cloudnativeciso.com)
1620

0 commit comments

Comments
 (0)