Skip to content

Commit 6152aee

Browse files
Joel Proctorclaude
authored and
Joel Proctor
committed
feat: initialize AWS misconfiguration database with 251 entries
This commit establishes a comprehensive, community-driven database of AWS misconfigurations designed to be LLM-friendly and easily integrated into security tools, cost optimization platforms, and infrastructure analysis systems. Database Features: - 251 AWS misconfiguration entries - 21 AWS services covered (EC2, S3, RDS, Lambda, IAM, etc.) - 5 risk categories: Cost, Security, Performance, Operations, Reliability - Structured JSON format with comprehensive schema Repository Structure: - data/by-service/: Service-specific JSON files - data/by-category/: Risk-type organized files - data/all-misconfigs.json: Complete unified dataset - schema/misconfig-schema.json: JSON Schema validation Automation Tools: - scripts/import-csv.py: CSV to JSON converter - scripts/validate.py: Schema validation tool - scripts/generate.py: Aggregation generator Integration Examples: - Python: Basic usage and AWS scanner with boto3 - JavaScript: Node.js and browser examples - LLM: 10 prompt templates for various use cases Community Infrastructure: - Comprehensive contribution guidelines - GitHub issue and PR templates - Automated CI/CD validation workflows - Code of conduct and MIT license Statistics: - Operations: 196 entries - Cost: 29 entries - Performance: 21 entries - Security: 9 entries - Status: 209 open, 23 done, 10 ice, 9 pending 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3be97e8 commit 6152aee

Some content is hidden

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

54 files changed

+25695
-15
lines changed

‎.github/FUNDING.yml‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Bug Report
3+
about: Report an issue with an existing entry or the repository
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
**What's wrong?**
12+
<!-- A clear and concise description of the bug -->
13+
14+
**Type of issue:**
15+
<!-- Check one or more -->
16+
- [ ] Incorrect information in a misconfiguration entry
17+
- [ ] Validation error
18+
- [ ] Script/tool not working
19+
- [ ] Documentation error
20+
- [ ] Schema issue
21+
- [ ] Other
22+
23+
## Entry Information (if applicable)
24+
25+
**Entry ID:**
26+
<!-- UUID of the misconfiguration entry with the issue -->
27+
28+
**Service:**
29+
<!-- AWS service (e.g., ec2, s3, rds) -->
30+
31+
**File:**
32+
<!-- e.g., data/by-service/ec2.json -->
33+
34+
## Current Behavior
35+
36+
<!-- Describe what currently happens -->
37+
38+
## Expected Behavior
39+
40+
<!-- Describe what should happen -->
41+
42+
## Steps to Reproduce
43+
44+
1.
45+
2.
46+
3.
47+
48+
## Suggested Fix
49+
50+
<!-- If you have a suggestion for how to fix this, please describe it -->
51+
52+
## Additional Context
53+
54+
<!-- Add any other context, screenshots, or information -->
55+
56+
## Environment (if applicable)
57+
58+
- Python version:
59+
- Node.js version:
60+
- OS:

‎.github/ISSUE_TEMPLATE/new_misconfiguration.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
name: New Misconfiguration Entry
3+
about: Submit a new AWS misconfiguration to the database
4+
title: '[NEW] '
5+
labels: 'new-entry'
6+
assignees: ''
7+
---
8+
9+
## Misconfiguration Details
10+
11+
**AWS Service:**
12+
<!-- e.g., ec2, s3, rds, lambda -->
13+
14+
**Scenario:**
15+
<!-- Brief description of the misconfiguration (1-2 sentences) -->
16+
17+
**Risk Type:**
18+
<!-- Choose one or more: cost, security, operations, performance, reliability -->
19+
20+
**Priority:**
21+
<!-- 0 (Critical), 1 (High), 2 (Medium), 3 (Low) -->
22+
23+
## Detection
24+
25+
**Alert Criteria:**
26+
<!-- How to detect this misconfiguration? Include specific metrics or conditions -->
27+
28+
**Detection Method:**
29+
<!-- e.g., AWS Config Rule, CloudWatch Metric, CLI Command -->
30+
31+
```bash
32+
# If applicable, provide detection command/script
33+
```
34+
35+
## Remediation
36+
37+
**Recommended Action:**
38+
<!-- Clear, actionable recommendation -->
39+
40+
**Detailed Description:**
41+
<!-- Comprehensive explanation of why this matters and the impact -->
42+
43+
**Effort Level:**
44+
<!-- 0 (Minimal), 1 (Low), 2 (Medium), 3 (High) -->
45+
46+
**Expected Value/Impact:**
47+
<!-- 1 (Low), 2 (Medium), 3 (High) -->
48+
49+
## References
50+
51+
<!-- Provide links to AWS documentation or other authoritative sources -->
52+
- [ ] AWS Documentation:
53+
- [ ] Blog Post/Article:
54+
- [ ] Other:
55+
56+
## Remediation Examples
57+
58+
<!-- If you have code examples for fixing this issue, please provide them -->
59+
60+
**AWS CLI:**
61+
```bash
62+
# Command to remediate
63+
```
64+
65+
**Terraform:**
66+
```hcl
67+
# Terraform configuration
68+
```
69+
70+
**Python (boto3):**
71+
```python
72+
# Python script
73+
```
74+
75+
## Compliance Mapping
76+
77+
<!-- If applicable, which compliance frameworks does this relate to? -->
78+
- [ ] PCI-DSS
79+
- [ ] HIPAA
80+
- [ ] SOC2
81+
- [ ] CIS Benchmark
82+
- [ ] NIST
83+
- [ ] Other:
84+
85+
## Additional Context
86+
87+
<!-- Any other information that would be helpful -->
88+
89+
## Checklist
90+
91+
- [ ] I have searched the existing database to ensure this is not a duplicate
92+
- [ ] I have provided clear detection criteria
93+
- [ ] I have included at least one reference link
94+
- [ ] I have tested the remediation steps (if applicable)
95+
- [ ] I understand this will be reviewed before being merged

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
<!-- Provide a clear description of your changes -->
6+
7+
## Type of Change
8+
9+
<!-- Check all that apply -->
10+
11+
- [ ] New misconfiguration entry
12+
- [ ] Update to existing entry
13+
- [ ] Bug fix
14+
- [ ] Documentation improvement
15+
- [ ] Script/tool enhancement
16+
- [ ] Other (please describe):
17+
18+
## Related Issue
19+
20+
<!-- If this PR addresses an issue, link it here -->
21+
Closes #
22+
23+
## Changes Made
24+
25+
<!-- Describe the changes you've made -->
26+
27+
### New Entries (if applicable)
28+
29+
| Service | Scenario | Risk Type | Priority |
30+
|---------|----------|-----------|----------|
31+
| | | | |
32+
33+
### Modified Entries (if applicable)
34+
35+
| Entry ID | What Changed | Reason |
36+
|----------|--------------|--------|
37+
| | | |
38+
39+
## Validation
40+
41+
- [ ] I have run `python3 scripts/validate.py data/by-service/ --strict` successfully
42+
- [ ] I have run `python3 scripts/generate.py` to update aggregated files
43+
- [ ] All validation checks pass
44+
- [ ] I have tested my changes
45+
46+
## Documentation
47+
48+
- [ ] I have updated relevant documentation
49+
- [ ] I have added/updated references
50+
- [ ] I have added/updated remediation examples (if applicable)
51+
52+
## Checklist
53+
54+
- [ ] My code follows the repository's style guidelines
55+
- [ ] I have added my username to the `contributors` array in modified entries
56+
- [ ] I have updated the `updated_at` timestamp in modified entries
57+
- [ ] I have searched for duplicate entries
58+
- [ ] I have provided clear, actionable recommendations
59+
- [ ] I have included at least one reference for new entries
60+
- [ ] All JSON files are valid and properly formatted
61+
- [ ] The PR title clearly describes the change
62+
63+
## Testing
64+
65+
<!-- Describe how you tested your changes -->
66+
67+
## Screenshots (if applicable)
68+
69+
<!-- Add screenshots if relevant -->
70+
71+
## Additional Notes
72+
73+
<!-- Any other information reviewers should know -->

‎.github/workflows/generate.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Generate Aggregated Files
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
paths:
7+
- 'data/by-service/**'
8+
9+
jobs:
10+
generate:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v3
16+
with:
17+
token: ${{ secrets.GITHUB_TOKEN }}
18+
19+
- name: Set up Python
20+
uses: actions/setup-python@v4
21+
with:
22+
python-version: '3.10'
23+
24+
- name: Generate aggregated files
25+
run: |
26+
echo "Generating aggregated files..."
27+
python3 scripts/generate.py
28+
29+
- name: Check for changes
30+
id: check_changes
31+
run: |
32+
if git diff --quiet; then
33+
echo "changes=false" >> $GITHUB_OUTPUT
34+
echo "No changes generated"
35+
else
36+
echo "changes=true" >> $GITHUB_OUTPUT
37+
echo "Changes detected"
38+
fi
39+
40+
- name: Commit and push if changed
41+
if: steps.check_changes.outputs.changes == 'true'
42+
run: |
43+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
44+
git config --local user.name "github-actions[bot]"
45+
git add data/all-misconfigs.json
46+
git add data/by-category/
47+
git add data/summary-stats.json
48+
git add docs/SUMMARY.md
49+
git commit -m "chore: regenerate aggregated files [skip ci]"
50+
git push
51+
52+
- name: Summary
53+
run: |
54+
echo "✅ Aggregated files generated successfully"
55+
if [ "${{ steps.check_changes.outputs.changes }}" = "true" ]; then
56+
echo "📝 Changes committed and pushed"
57+
else
58+
echo "ℹ️ No changes to commit"
59+
fi

0 commit comments

Comments
 (0)