Overview
KafkaCode assigns a privacy grade from A+ to F based on the severity and number of issues found in your codebase. This grade provides an at-a-glance assessment of your codeβs privacy posture.Grading Scale
A+ / A / A-
ExcellentMinimal to no privacy issues. Production-ready code.
B+ / B / B-
GoodMinor issues present. Generally safe with small improvements needed.
C+ / C / C-
ModerateNotable privacy concerns. Should be addressed before production.
D
PoorMultiple high-severity issues. Not recommended for production.
F
FailingCritical vulnerabilities. Must fix before deployment.
How Grades Are Calculated
Step 1: Severity Points
Each issue type has a point value:| Severity | Points | Examples |
|---|---|---|
| Critical | 100 | AWS keys, private keys, database credentials |
| High | 50 | OAuth tokens, API keys, JWT secrets |
| Medium | 10 | Email addresses, phone numbers, SSNs |
| Low | 1 | IP addresses, URLs |
Step 2: Total Score
Calculate the total score by summing all severity points:Step 3: Grade Assignment
The grade is determined by the total score:Grade Breakdown
π’ A+ Grade (Perfect Score)
Score: 0 points Meaning: No privacy issues detected Example:π’ A Grade (Excellent)
Score: 1-5 points Typical Issues:- 1-2 Low severity items (IP addresses, URLs)
- 0-1 Medium severity items
π’ A- Grade (Very Good)
Score: 6-10 points Typical Issues:- 3-5 Low severity items
- 0-1 Medium severity items
π΅ B+ Grade (Good)
Score: 11-20 points Typical Issues:- 1-2 Medium severity items
- Several Low severity items
π΅ B Grade (Acceptable)
Score: 21-30 points Typical Issues:- 2-3 Medium severity items
- Multiple Low severity items
π΅ B- Grade (Fair)
Score: 31-50 points Typical Issues:- 3-5 Medium severity items, OR
- 1 High severity item
π‘ C+ Grade (Needs Improvement)
Score: 51-75 points Typical Issues:- 1-2 High severity items
- Multiple Medium severity items
π‘ C Grade (Poor)
Score: 76-100 points Typical Issues:- 1 Critical + some High/Medium items, OR
- 2 High severity items + multiple Medium items
π‘ C- Grade (Concerning)
Score: 101-150 points Typical Issues:- 1-2 Critical items, OR
- 2-3 High severity items
π D Grade (Dangerous)
Score: 151-200 points Typical Issues:- Multiple Critical items
- Many High severity items
π΄ F Grade (Critical)
Score: > 200 points Typical Issues:- Many Critical items
- Extensive High severity issues
- Widespread privacy violations
Grade Impact Examples
Example 1: Clean Project
Example 2: Minor Issues
Example 3: Some Concerns
Example 4: Critical Problems
Improving Your Grade
1
Fix Critical Issues First
Address all Critical severity items immediately:
- Remove hardcoded secrets
- Move credentials to environment variables
- Use secure vaults (AWS Secrets Manager, etc.)
2
Address High Severity Items
Fix High severity issues before next release:
- Externalize API keys
- Use configuration management
- Implement secret rotation
3
Clean Up Medium/Low Items
Improve grade by addressing remaining issues:
- Move PII to configuration
- Remove unnecessary hardcoded data
- Use DNS names instead of IP addresses
4
Rescan and Verify
Run KafkaCode again to verify improvements:
Grade Thresholds Quick Reference
| Grade | Score Range | Action Required |
|---|---|---|
| π’ A+ | 0 | None - Perfect! |
| π’ A | 1-5 | Optional cleanup |
| π’ A- | 6-10 | Minor improvements |
| π΅ B+ | 11-20 | Review recommended |
| π΅ B | 21-30 | Plan fixes |
| π΅ B- | 31-50 | Fix before release |
| π‘ C+ | 51-75 | Not production-ready |
| π‘ C | 76-100 | Must fix critical items |
| π‘ C- | 101-150 | Block deployment |
| π D | 151-200 | Emergency fixes |
| π΄ F | > 200 | Complete refactoring |
CI/CD Integration
Use grades to gate deployments:Best Practices
Set Grade Goals
Set Grade Goals
- Development: Accept B- or better
- Staging: Require B+ or better
- Production: Mandate A- or better
Track Over Time
Track Over Time
- Run scans regularly (daily/weekly)
- Monitor grade trends
- Set improvement targets
- Celebrate progress!
Use in PR Reviews
Use in PR Reviews
- Scan before merging
- Require grade maintenance
- Block PRs that lower grade
- Document fixes in commits
Security Policy
Security Policy
- Define acceptable grades per environment
- Escalate Critical/High findings
- Regular security audits
- Team training on privacy

