Skip to content

Commit e198d85

Browse files
Merge pull request #35 from Danielpeter-99/patch-3
Create SECURITY.md
2 parents 0b722c9 + c2df6a0 commit e198d85

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

SECURITY.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We aim to support the latest stable release of Evo AI and apply security updates as soon as possible. Please use the most recent version for the best security.
6+
7+
---
8+
9+
## Reporting a Vulnerability
10+
11+
If you discover a security vulnerability in Evo AI, **please report it privately** and responsibly. Do **not** open a public issue.
12+
13+
**To report a vulnerability:**
14+
15+
- Email: [contato@evolution-api.com](mailto:contato@evolution-api.com)
16+
- Include as much detail as possible, including:
17+
- Steps to reproduce the issue
18+
- Potential impact
19+
- Your suggestions (if any) for remediation
20+
21+
You will receive a response as soon as possible. We may request additional information to fully understand and address the issue.
22+
23+
---
24+
25+
## Security Best Practices
26+
27+
- **Keep your installation up to date.**
28+
Always use the latest stable version and regularly check for updates.
29+
30+
- **Environment Variables:**
31+
Store all secrets, credentials, and keys in environment variables or secrets managers.
32+
Never commit sensitive information to the repository.
33+
34+
- **Authentication:**
35+
Evo AI uses JWT authentication with expiration, email verification, and account lockout for brute-force protection.
36+
37+
- **Passwords:**
38+
All passwords are securely hashed with bcrypt and random salt.
39+
40+
- **Access Control:**
41+
Access to sensitive endpoints is protected via role-based checks and resource ownership verification.
42+
43+
- **Audit Logs:**
44+
Important administrative actions are logged for traceability.
45+
46+
- **Input Validation:**
47+
All inputs are validated using Pydantic schemas to prevent injection attacks.
48+
49+
---
50+
51+
## Responsible Disclosure
52+
53+
Please give us a reasonable time to investigate and address any reported security issues before any public disclosure.
54+
55+
---
56+
57+
## Project Security Features
58+
59+
- JWT tokens with limited lifetime
60+
- Secure password hashing (bcrypt)
61+
- Email verification with one-time tokens
62+
- Account lockout after multiple failed login attempts
63+
- Resource-based access control
64+
- Strict input validation for all APIs
65+
- Separation between regular and administrative users
66+
67+
---
68+
69+
## License
70+
71+
All security contributions are made under the [Apache License 2.0](./LICENSE).
72+
73+
---
74+
75+
Thank you for helping keep Evo AI and its users safe!

0 commit comments

Comments
 (0)