|
1 | | -# Security Policy |
2 | 1 |
|
3 | | -Thank you for taking the time to help make **StrengthX** more secure. |
4 | | -We take security and privacy very seriously, especially since our project deals with password analysis and user data protection. |
| 2 | +# Supported Versions |
| 3 | + |
| 4 | +This repository currently supports security updates for the **latest main branch only**. |
| 5 | + |
| 6 | + |
| 7 | + |
5 | 8 |
|
6 | | ---- |
7 | 9 |
|
8 | | -## Supported Versions |
9 | 10 |
|
10 | | -We currently provide security updates for the latest **main** branch. |
| 11 | +## Security Scope |
11 | 12 |
|
12 | | -| Version | Supported | |
13 | | -|----------|------------| |
14 | | -| `main` (latest) | ✅ Supported | |
15 | | -| Older versions | ⚠️ Not actively maintained | |
| 13 | +This project includes: |
| 14 | +- Password strength evaluation |
| 15 | +- Breached password checking using k-anonymity |
| 16 | +- Client-side password input handling |
| 17 | + |
| 18 | +This project **does NOT** include: |
| 19 | +- Authentication or login systems |
| 20 | +- Password storage |
| 21 | +- Session management |
| 22 | +- Authorization logic |
| 23 | +- Payment processing |
| 24 | + |
| 25 | +Security assessments are scoped accordingly. |
16 | 26 |
|
17 | 27 | --- |
18 | 28 |
|
19 | | -## Reporting a Vulnerability |
| 29 | +## Security Standards & Compliance |
20 | 30 |
|
21 | | -If you discover a **vulnerability**, **security issue**, or **data privacy risk** in StrengthX: |
| 31 | +This project aligns with the following standards and guidelines: |
22 | 32 |
|
23 | | -1. **Do not open a public issue.** |
24 | | - Instead, please report it **privately** to the maintainers. |
| 33 | +- OWASP Application Security Verification Standard (ASVS) v4.0.3 |
| 34 | + - Certified **ASVS Level 1–Ready** (password evaluation scope) |
| 35 | +- OWASP Password Guidelines |
| 36 | +- OWASP Top 10 (Input handling & data exposure) |
25 | 37 |
|
26 | | -2. Contact via: |
27 | | - - 📧 **Email:** [hexra2025@gmail.com](mailto:hexra2025@gmail.com) |
28 | | - - Or open a **confidential GitHub Security Advisory** (if available). |
| 38 | +--- |
29 | 39 |
|
30 | | -3. Include in your report: |
31 | | - - A clear and concise description of the vulnerability. |
32 | | - - Steps to reproduce the issue (if applicable). |
33 | | - - The potential impact or affected areas. |
34 | | - - Any suggestions for mitigation. |
| 40 | +## Cryptographic Practices |
35 | 41 |
|
36 | | -We’ll acknowledge your report within **48 hours** and aim to provide a fix or response within **7 working days**, depending on severity. |
| 42 | +- Passwords are **never stored** |
| 43 | +- Passwords are **never logged** |
| 44 | +- Passwords are **never rendered back to the UI** |
| 45 | +- SHA-1 is used **only** for compatibility with the Have I Been Pwned API |
| 46 | +- SHA-1 is **not** used for authentication or storage |
| 47 | +- Entropy-based strength estimation is performed using industry-standard methods |
37 | 48 |
|
38 | 49 | --- |
39 | 50 |
|
40 | | -## Security Principles Followed |
| 51 | +## Reporting a Vulnerability |
| 52 | + |
| 53 | +If you discover a security vulnerability, please report it **responsibly**. |
| 54 | + |
| 55 | +### Preferred Reporting Method |
| 56 | +Email: haroonuint144@gmail.com |
| 57 | + |
41 | 58 |
|
42 | | -StrengthX follows key security and privacy principles: |
| 59 | +(Replace this with your actual contact email.) |
43 | 60 |
|
44 | | -- **secure attacks:** prevent from DDOS attacks and man in the middle attacks, |
45 | | -- **No Data Storage:** User passwords or hashes are never logged, stored, or transmitted to external servers. |
46 | | -- **Hashed API Queries:** All password breach checks use **SHA-1 hashing** before transmission to maintain user privacy. |
47 | | -- **Zero Retention:** No personally identifiable information (PII) is stored on the server. |
48 | | -- **Secure Dependencies:** All Python dependencies are regularly scanned for vulnerabilities using `pip-audit` and GitHub Dependabot. |
49 | | -- **HTTPS Communication:** StrengthX is designed for deployment under HTTPS to ensure encrypted traffic. |
| 61 | +### What to Include |
| 62 | +Please include: |
| 63 | +- A clear description of the vulnerability |
| 64 | +- Steps to reproduce |
| 65 | +- Potential impact |
| 66 | +- Screenshots or proof-of-concept (if applicable) |
50 | 67 |
|
51 | 68 | --- |
52 | 69 |
|
53 | | -## Responsible Disclosure Guidelines |
| 70 | +## Responsible Disclosure Policy |
54 | 71 |
|
55 | | -- Act in **good faith** and avoid publicly disclosing vulnerabilities before they are fixed. |
56 | | -- Do not exploit, damage, or access user data during your testing. |
57 | | -- Respect user privacy and comply with all applicable laws. |
58 | | -- We credit responsible researchers in our release notes, if they wish. |
| 72 | +- Please **do not** publicly disclose vulnerabilities before coordination |
| 73 | +- We aim to acknowledge reports within **72 hours** |
| 74 | +- We aim to provide a fix or mitigation plan within **14 days** |
| 75 | + |
| 76 | +We appreciate responsible security research and will credit valid disclosures where appropriate. |
59 | 77 |
|
60 | 78 | --- |
61 | 79 |
|
62 | | -## Recommended Security Tools |
| 80 | +## Out of Scope Vulnerabilities |
| 81 | + |
| 82 | +The following are considered **out of scope**: |
| 83 | +- Denial of Service (DoS) attacks |
| 84 | +- Social engineering attacks |
| 85 | +- Issues requiring physical access |
| 86 | +- Vulnerabilities in third-party services or dependencies |
| 87 | +- User-generated weak passwords (expected behavior) |
63 | 88 |
|
64 | | -Developers contributing to StrengthX are encouraged to use: |
65 | | -- `bandit` — for static security analysis in Python. |
66 | | -- `pip-audit` — to check for vulnerable dependencies. |
67 | | -- `pre-commit` hooks — to ensure no secrets or keys are committed. |
68 | | -- `nmap` - it ensure for network scan in network security. |
69 | | -- `kali-linux`- it accessed for security management/ tools. |
70 | | - |
71 | 89 | --- |
72 | 90 |
|
73 | | -## Legal |
| 91 | +## Future Security Roadmap |
74 | 92 |
|
75 | | -By submitting a security report, you agree to allow the StrengthX maintainers to use your report for improving project security without restriction. |
76 | | -This project is covered under the **Apache License 2.0**. |
| 93 | +Planned security enhancements for future versions: |
| 94 | +- Secure authentication (Argon2id / bcrypt) |
| 95 | +- Rate limiting and brute-force protection |
| 96 | +- Multi-factor authentication (MFA) |
| 97 | +- ASVS Level 2 certification |
| 98 | +- Automated dependency vulnerability scanning |
77 | 99 |
|
78 | 100 | --- |
79 | 101 |
|
80 | | -> 🛡️ Security is everyone’s responsibility — thank you for helping make StrengthX safer for all users. |
| 102 | +## Acknowledgements |
| 103 | + |
| 104 | +This project follows security-by-design principles and welcomes constructive security feedback from the community. |
| 105 | + |
| 106 | +Thank you for helping keep this project secure. |
0 commit comments