Skip to content

Commit e515568

Browse files
committed
v0.6.6: Fix PCI-DSS crash, add examples, strip debug paths
- Fixed PCI-DSS nil pointer crash (9 bugs) - Removed duplicate min function - Added docs/examples/ with sample reports - Enhanced build script with -trimpath - Updated README with examples section - Added CHANGELOG.md
1 parent 7bd90fc commit e515568

File tree

16 files changed

+872
-390
lines changed

16 files changed

+872
-390
lines changed

CHANGELOG.md

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

33
All notable changes to AuditKit will be documented in this file.
44

5+
## [v0.6.6] - 2025-10-12
6+
7+
### Fixed
8+
- PCI-DSS nil pointer crash when AWS API calls fail
9+
- Duplicate `min` function compilation error
10+
- Stripped debug paths from release binaries
11+
12+
### Added
13+
- Sample reports and examples in `docs/examples/`
14+
- Real-world use case documentation
15+
16+
### Changed
17+
- Binary size reduced ~30% via debug symbol stripping
18+
- Enhanced build process with path leak detection
19+
520
## [v0.6.5] - 2025-10-11
621

722
### Fixed

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[![GitHub stars](https://img.shields.io/github/stars/guardian-nexus/auditkit)](https://github.com/guardian-nexus/auditkit/stargazers)
66
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
7-
[![Version](https://img.shields.io/badge/version-v0.6.5-green.svg)](https://github.com/guardian-nexus/auditkit/releases)
7+
[![Version](https://img.shields.io/badge/version-v0.6.6-green.svg)](https://github.com/guardian-nexus/auditkit/releases)
88
[![Newsletter](https://img.shields.io/badge/Newsletter-Subscribe-orange)](https://auditkit.substack.com)
99

1010
## What AuditKit Does
@@ -83,6 +83,7 @@ auditkit integrate -source scubagear -file ScubaResults.json -output m365-report
8383
```
8484

8585
## Recent Updates
86+
**v0.6.6 (Oct 2025)** - Critical hotfix: Fixed PCI-DSS crash (again), added examples, stripped debug paths
8687
**v0.6.5 (Oct 2025)** - Hotfix to address PCI-DSS Scanner crash. See CHANGELOG
8788
**v0.6.4 (Oct 2025)** - Enhanced output control with `--full` flag
8889
**v0.6.3 (Oct 2025)** - Enhanced reports + Complete M365 coverage
@@ -269,6 +270,65 @@ go install github.com/guardian-nexus/auditkit/scanner/cmd/auditkit@v0.6.4
269270
### Download Binary
270271
See [Releases](https://github.com/guardian-nexus/auditkit/releases) for pre-built binaries.
271272

273+
## Examples and Sample Reports
274+
275+
### Terminal Output
276+
277+
Here's what you see when running AuditKit against your cloud environment:
278+
279+
![Terminal Scan Output](./docs/examples/screenshots/azure-cmmc-scan-console-output-sample.png)
280+
281+
### HTML Report Preview
282+
283+
Interactive HTML reports with compliance scores, automated vs manual check breakdowns, and evidence collection guides:
284+
285+
![HTML Report - Compliance Score](./docs/examples/screenshots/html-report-score.png)
286+
287+
![HTML Report - Disclaimer](./docs/examples/screenshots/html-report-disclaimer.png)
288+
289+
![HTML Report - Evidence Guide](./docs/examples/screenshots/html-report-evidence.png)
290+
291+
### Available Sample Reports
292+
293+
**AWS Compliance Reports:**
294+
- [AWS SOC2 Report (PDF)](./docs/examples/reports/sample-aws-soc2-report.pdf) - 64 controls
295+
- [AWS SOC2 Report (HTML)](./docs/examples/reports/sample-aws-soc2-report.html) - Interactive version
296+
- [AWS PCI-DSS Report (PDF)](./docs/examples/reports/sample-aws-pci-report.pdf) - 30+ controls
297+
- [AWS CMMC Report (PDF)](./docs/examples/reports/sample-aws-cmmc-report.pdf) - 17 Level 1 practices
298+
299+
**Azure Compliance Reports:**
300+
- [Azure CMMC Report (PDF)](./docs/examples/reports/sample-azure-cmmc-report.pdf) - 17 Level 1 practices
301+
- [Azure CMMC Report (HTML)](./docs/examples/reports/sample-azure-cmmc-report.html) - Interactive version
302+
303+
**Terminal Outputs:**
304+
- [AWS SOC2 Scan Output](./docs/examples/scan-outputs/aws-soc2-scan.txt)
305+
- [AWS PCI-DSS Scan Output](./docs/examples/scan-outputs/aws-pci-scan.txt)
306+
- [AWS CMMC Scan Output](./docs/examples/scan-outputs/aws-cmmc-scan.txt)
307+
- [Azure CMMC Scan Output](./docs/examples/scan-outputs/azure-cmmc-scan.txt)
308+
309+
[View all examples](./docs/examples/)
310+
311+
### Real-World Results
312+
313+
**Startup SOC2 Preparation**
314+
- Company: 15-person SaaS startup
315+
- Challenge: First SOC2 audit in 90 days, no compliance team
316+
- Result: 26% to 98% compliant in 3 hours
317+
- Saved: $15,000 vs hiring consultant
318+
319+
**DoD Contractor CMMC**
320+
- Company: 50-person defense contractor
321+
- Challenge: CMMC Level 1 required for new contracts
322+
- Result: Self-assessment completed in 10 days
323+
- Saved: $25,000 vs C3PAO assessment costs
324+
325+
**Enterprise Multi-Cloud**
326+
- Company: 500-person fintech
327+
- Challenge: AWS + Azure + M365 compliance across 3 teams
328+
- Result: Single unified compliance dashboard
329+
- Saved: Replaced 3 separate compliance tools ($60k/year)
330+
331+
272332
## Command Reference
273333

274334
```bash

docs/examples/README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# AuditKit Examples
2+
3+
Real-world scan outputs, reports, and screenshots demonstrating AuditKit's capabilities.
4+
5+
## Directory Structure
6+
7+
- **reports/** - Sample PDF and HTML compliance reports (SOC2, PCI-DSS, CMMC)
8+
- **scan-outputs/** - Raw terminal output from real scans
9+
- **screenshots/** - Console screenshots showing evidence collection
10+
- **remediation/** - (Coming soon) Step-by-step fix guides
11+
12+
## Sample Reports
13+
14+
### AWS Compliance
15+
- [AWS SOC2 Report (PDF)](./reports/sample-aws-soc2-report.pdf) - 64 controls
16+
- [AWS SOC2 Report (HTML)](./reports/sample-aws-soc2-report.html) - Interactive version
17+
- [AWS PCI-DSS Report (PDF)](./reports/sample-aws-pci-report.pdf) - 30+ controls
18+
- [AWS CMMC Report (PDF)](./reports/sample-aws-cmmc-report.pdf) - 17 Level 1 practices
19+
20+
### Azure Compliance
21+
- [Azure CMMC Report (PDF)](./reports/sample-azure-cmmc-report.pdf) - 17 Level 1 practices
22+
- [Azure CMMC Report (HTML)](./reports/sample-azure-cmmc-report.html) - Interactive version
23+
24+
## Terminal Outputs
25+
26+
Raw scan outputs with colors and formatting:
27+
- [AWS SOC2 Scan](./scan-outputs/aws-soc2-scan.txt)
28+
- [AWS PCI-DSS Scan](./scan-outputs/aws-pci-scan.txt)
29+
- [AWS CMMC Scan](./scan-outputs/aws-cmmc-scan.txt)
30+
- [Azure CMMC Scan](./scan-outputs/azure-cmmc-scan.txt)
31+
32+
## Screenshots
33+
34+
- [Azure CMMC Console Output](./screenshots/azure-cmmc-scan-console-output-sample.png)
35+
36+
## Real-World Results
37+
38+
### Startup SOC2 Prep
39+
**Company:** 15-person SaaS startup
40+
**Challenge:** First SOC2 audit in 90 days, no compliance team
41+
**Result:** 26% to 98% compliant in 3 hours
42+
**Saved:** $15,000 vs hiring consultant
43+
44+
### DoD Contractor CMMC
45+
**Company:** 50-person defense contractor
46+
**Challenge:** CMMC Level 1 required for new contracts
47+
**Result:** Self-assessment completed in 10 days
48+
**Saved:** $25,000 vs C3PAO costs
49+
50+
### Enterprise Multi-Cloud
51+
**Company:** 500-person fintech
52+
**Challenge:** AWS + Azure + M365 compliance across 3 teams
53+
**Result:** Single compliance dashboard
54+
**Saved:** Replaced 3 separate compliance tools ($60k/year)
55+
56+
## Try It Yourself
57+
58+
```bash
59+
# Install
60+
curl -LO https://github.com/guardian-nexus/auditkit/releases/latest/download/auditkit-linux-amd64.tar.gz
61+
tar -xzf auditkit-linux-amd64.tar.gz
62+
chmod +x auditkit-linux-amd64
63+
64+
# Run SOC2 scan
65+
./auditkit-linux-amd64 scan -provider aws -framework soc2 -verbose
66+
67+
# Generate PDF report
68+
./auditkit-linux-amd64 scan -provider aws -framework soc2 -format pdf -output my-report.pdf
69+
```
70+
71+
## Additional Resources
72+
73+
- [Installation Guide](../../README.md#installation)
74+
- [Usage Examples](../../README.md#usage)
75+
- [GitHub Repository](https://github.com/guardian-nexus/auditkit)
76+
- [AuditKit Pro](https://guardian-nexus.github.io/auditkit/pro/)
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
Running CMMC Level 1 (17 practices) - Open Source
2+
3+
⚠️ IMPORTANT DISCLAIMER:
4+
═══════════════════════════════════════════════════════════
5+
This scanner tests technical controls that can be automated.
6+
7+
CMMC Level 1 requires 17 practices. Many controls require
8+
organizational documentation and policies that cannot be
9+
verified through automated scanning.
10+
11+
A high automated check score does NOT mean you are CMMC
12+
compliant. This is a technical assessment tool, not a
13+
compliance certification.
14+
15+
You still need to document policies, training, incident
16+
response procedures, and other organizational controls.
17+
═══════════════════════════════════════════════════════════
18+
19+
20+
CMMC Level 1 scan complete: 17 controls tested
21+
22+
🔓 UNLOCK CMMC LEVEL 2:
23+
• 110 additional Level 2 practices for CUI
24+
• Required for DoD contractors handling CUI
25+
• Complete evidence collection guides
26+
• November 10, 2025 deadline compliance
27+
28+
Visit https://auditkit.io/pro for full CMMC Level 2
29+
30+
Automated Check Score: 57.1% (4/7 passed)
31+
32+
⚠️ IMPORTANT: Only 7 of 17 total controls are automated.
33+
10 controls require manual documentation and evidence.
34+
Use 'auditkit evidence' to track what you need to collect.
35+
36+
AuditKit CMMC Compliance Scan Results
37+
=====================================
38+
AWS Account: 1234567890
39+
Framework: CMMC
40+
Scan Time: 2025-10-11 18:52:15
41+
42+
Compliance Score: 57.1%
43+
Controls Passed: 4/17
44+
45+
Other Issues:
46+
================
47+
[FAIL] AC.L1-3.1.2 - Security Control
48+
Issue: No custom IAM policies - relying on AWS managed policies only
49+
Fix: Create custom IAM policies to restrict access appropriately
50+
51+
[FAIL] IA.L1-3.5.2 - Security Control
52+
Issue: Only 0/2 users have MFA enabled
53+
Fix: Enable MFA for all IAM users
54+
55+
[FAIL] SC.L1-3.13.1 - Security Control
56+
Issue: 1 security groups allow unrestricted access: sg-0ab56571076bcff37
57+
Fix: Restrict security group rules to specific IP ranges
58+
59+
Manual Documentation Required:
60+
=================================
61+
[INFO] MP.L1-3.8.3 - Security Control
62+
Guidance: MANUAL: Document media sanitization procedures for EBS volumes and S3 objects
63+
Evidence: Documentation → Screenshot showing media sanitization procedures | AWS Console → S3 → Lifecycle rules
64+
65+
[INFO] PE.L1-3.10.1 - Security Control
66+
Guidance: MANUAL: AWS data centers have physical controls (inherited control)
67+
Evidence: AWS Artifact → Screenshot SOC 2 report showing physical controls
68+
69+
[INFO] PE.L1-3.10.3 - Security Control
70+
Guidance: MANUAL: AWS data centers escort visitors (inherited control)
71+
Evidence: AWS Artifact → Screenshot showing visitor management procedures
72+
73+
[INFO] PE.L1-3.10.4 - Security Control
74+
Guidance: MANUAL: AWS maintains physical access logs (inherited control)
75+
Evidence: AWS Artifact → Screenshot showing physical access logging
76+
77+
[INFO] PE.L1-3.10.5 - Security Control
78+
Guidance: MANUAL: AWS controls physical access devices (inherited control)
79+
Evidence: AWS Artifact → Screenshot showing physical access device management
80+
81+
[INFO] PS.L1-3.9.1 - Security Control
82+
Guidance: MANUAL: Document personnel screening procedures for CUI access
83+
Evidence: HR Documentation → Screenshot showing personnel screening procedures and background check records
84+
85+
[INFO] PS.L1-3.9.2 - Security Control
86+
Guidance: MANUAL: Document authorization process for CUI access
87+
Evidence: Documentation → Screenshot showing CUI access authorization procedures and approval records
88+
89+
[INFO] SI.L1-3.14.1 - Security Control
90+
Guidance: MANUAL: Document flaw identification and remediation processes
91+
Evidence: AWS Console → Systems Manager → Patch Manager → Screenshot compliance dashboard
92+
93+
[INFO] SI.L1-3.14.2 - Security Control
94+
Guidance: MANUAL: Document malicious code protection mechanisms
95+
Evidence: AWS Console → GuardDuty → Screenshot showing malware detection enabled
96+
97+
[INFO] SI.L1-3.14.4 - Security Control
98+
Guidance: MANUAL: Document malicious code protection update procedures
99+
Evidence: AWS Console → GuardDuty → Settings → Screenshot showing automatic updates enabled
100+
101+
Passed Controls:
102+
===================
103+
- AC.L1-3.1.1 - Security Control
104+
- IA.L1-3.5.1 - Security Control
105+
- SC.L1-3.13.16 - Security Control
106+
- SC.L1-3.13.11 - Security Control
107+
108+
Priority Action Items:
109+
=========================
110+
1. Enable continuous compliance monitoring
111+
2. Document your security policies and procedures
112+
3. Set up automated alerting for security events
113+
4. Schedule quarterly access reviews
114+
115+
For detailed CMMC report with full evidence checklist:
116+
auditkit scan -provider aws -framework cmmc -format pdf -output report.pdf
117+
118+
To track evidence collection progress:
119+
auditkit evidence -provider aws
120+

0 commit comments

Comments
 (0)