Skip to content

Commit c5585f0

Browse files
committed
rewrite based on fastcrud's security policy
1 parent 8be23be commit c5585f0

File tree

1 file changed

+116
-8
lines changed

1 file changed

+116
-8
lines changed

SECURITY.md

Lines changed: 116 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,127 @@
11
# Security Policy
22

3+
## Supported Versions
4+
5+
CRUDAdmin is currently in pre-1.0.0 development. During this phase, only the latest version receives security updates and patches.
6+
7+
| Version | Supported |
8+
| -------------- | ------------------ |
9+
| Latest Release | :white_check_mark: |
10+
| Older Versions | :x: |
11+
12+
We strongly recommend always using the latest version of CRUDAdmin to ensure you have all security fixes and improvements.
13+
314
## Reporting a Vulnerability
415

5-
If you think you found a vulnerability, and even if you are not sure about it, please report it right away by sending an email to: `igor.magalhaes.r at gmail dot com`. Please try to be as explicit as possible, describing all the steps and example code to reproduce the security issue.
16+
We take the security of CRUDAdmin seriously. If you believe you have found a security vulnerability, please report it to us as described below.
17+
18+
### Reporting Process
19+
20+
1. **Do Not** disclose the vulnerability publicly until it has been addressed by our team
21+
2. Submit the vulnerability report through one of these channels:
22+
23+
24+
- GitHub Security Advisory: https://github.com/igorbenav/crudadmin/security/advisories/new
25+
26+
### What to Include
27+
28+
Please provide detailed information about the vulnerability, including:
29+
30+
- A clear description of the vulnerability
31+
- Steps to reproduce the issue
32+
- Potential impact
33+
- Suggested fix (if available)
34+
- Your contact information for follow-up questions
35+
36+
### Response Timeline
37+
38+
- Initial Response: Within 48 hours
39+
- Status Update: Within 1 week
40+
- Fix Timeline: Based on severity
41+
- Critical: Within 7 days
42+
- High: Within 14 days
43+
- Medium: Within 30 days
44+
- Low: Within 60 days
45+
46+
### What to Expect
47+
48+
1. **Acknowledgment**: You will receive an acknowledgment of your report within 48 hours
49+
2. **Investigation**: Our team will investigate the issue and determine its impact
50+
3. **Updates**: You will receive updates on the status of your report
51+
4. **Resolution**: Once resolved, you will be notified of the fix
52+
5. **Public Disclosure**: Coordinated disclosure after the fix is released
53+
54+
## Security Considerations
55+
56+
### Database Security
57+
58+
CRUDAdmin provides robust authentication and session management. When using CRUDAdmin, ensure:
59+
60+
1. Use strong session backends (Redis recommended for production)
61+
2. Configure appropriate session timeouts and limits
62+
3. Enable secure cookies and HTTPS enforcement
63+
4. Implement proper password policies
64+
5. Monitor and audit admin user activities
65+
66+
### Access Control and IP Restrictions
67+
68+
CRUDAdmin includes built-in access control features. When configuring access:
69+
70+
1. Define allowed IP addresses and networks
71+
2. Implement proper authorization checks
72+
3. Use HTTPS for all admin communications
73+
4. Configure rate limiting for login attempts
74+
5. Monitor and log access attempts
75+
76+
### Data Protection and Privacy
77+
78+
1. Never expose sensitive data in error messages
79+
2. Implement proper logging practices
80+
3. Use HTTPS for all admin communications
81+
4. Follow data protection regulations (GDPR, CCPA, etc.)
82+
5. Implement proper data encryption at rest
83+
84+
## Best Practices
85+
86+
1. **Always use the latest supported version**
87+
2. Use Redis or Memcached for session management in production
88+
3. Enable HTTPS enforcement and secure cookies
89+
4. Regularly update dependencies
90+
5. Follow the principle of least privilege
91+
6. Implement proper error handling
92+
7. Use secure configuration management
93+
8. Regular security audits and testing
94+
95+
## Security Features
96+
97+
CRUDAdmin includes several security features:
98+
99+
1. **Multi-Backend Session Management**: Memory, Redis, Memcached, Database, and Hybrid backends
100+
2. **Built-in Security**: CSRF protection, rate limiting, IP restrictions, HTTPS enforcement
101+
3. **Session Security**: Automatic expiration, concurrent session limits, device tracking
102+
4. **Access Control**: IP-based restrictions, network-based access control
103+
5. **Event Tracking**: Comprehensive audit trails for all admin actions
104+
105+
## Disclaimer
6106

7-
## Vulnerability Disclosures
107+
While CRUDAdmin implements security best practices, it's crucial to properly secure your application as a whole. This includes:
8108

9-
Critical vulnerabilities will be disclosed via GitHub's [security advisory](https://github.com/benavlabs/crudadmin/security) system.
109+
1. Proper session backend configuration
110+
2. Secure environment variable management
111+
3. Monitoring and logging
112+
4. Proper database security
113+
5. Network security measures
114+
6. Regular security updates and audits
10115

11-
## Public Discussions
116+
## Updates and Notifications
12117

13-
Please restrain from publicly discussing a potential security vulnerability.
118+
Stay informed about security updates:
14119

15-
It's better to discuss privately and try to find a solution first, to limit the potential impact as much as possible.
120+
1. Watch the GitHub repository
121+
2. Follow our security announcements
122+
3. Subscribe to our security mailing list
123+
4. Monitor our release notes
16124

17-
---
125+
## License
18126

19-
Thanks for your help!
127+
This security policy is part of the CRUDAdmin project and is subject to the same license terms.

0 commit comments

Comments
 (0)