@@ -17,74 +17,79 @@ We take the security of Eliza seriously. If you believe you have found a securit
17
17
18
18
1 . ** DO NOT** create a public GitHub issue for the vulnerability
19
19
2 . Send an email to security@eliza.builders with:
20
- - A detailed description of the vulnerability
21
- - Steps to reproduce the issue
22
- - Potential impact of the vulnerability
23
- - Any possible mitigations you've identified
20
+ - A detailed description of the vulnerability
21
+ - Steps to reproduce the issue
22
+ - Potential impact of the vulnerability
23
+ - Any possible mitigations you've identified
24
24
25
25
### What to Expect
26
26
27
- - ** Initial Response** : Within 48 hours, you will receive an acknowledgment of your report
28
- - ** Updates** : We will provide updates every 5 business days about the progress
29
- - ** Resolution Timeline** : We aim to resolve critical issues within 15 days
30
- - ** Disclosure** : We will coordinate with you on the public disclosure timing
27
+ - ** Initial Response** : Within 48 hours, you will receive an acknowledgment of your report
28
+ - ** Updates** : We will provide updates every 5 business days about the progress
29
+ - ** Resolution Timeline** : We aim to resolve critical issues within 15 days
30
+ - ** Disclosure** : We will coordinate with you on the public disclosure timing
31
31
32
32
## Security Best Practices
33
33
34
34
### For Contributors
35
35
36
36
1 . ** API Keys and Secrets**
37
- - Never commit API keys, passwords, or other secrets to the repository
38
- - Use environment variables as described in our secrets management guide
39
- - Rotate any accidentally exposed credentials immediately
37
+
38
+ - Never commit API keys, passwords, or other secrets to the repository
39
+ - Use environment variables as described in our secrets management guide
40
+ - Rotate any accidentally exposed credentials immediately
40
41
41
42
2 . ** Dependencies**
42
- - Keep all dependencies up to date
43
- - Review security advisories for dependencies regularly
44
- - Use ` pnpm audit ` to check for known vulnerabilities
43
+
44
+ - Keep all dependencies up to date
45
+ - Review security advisories for dependencies regularly
46
+ - Use ` pnpm audit ` to check for known vulnerabilities
45
47
46
48
3 . ** Code Review**
47
- - All code changes must go through pull request review
48
- - Security-sensitive changes require additional review
49
- - Enable branch protection on main branches
49
+ - All code changes must go through pull request review
50
+ - Security-sensitive changes require additional review
51
+ - Enable branch protection on main branches
50
52
51
53
### For Users
52
54
53
55
1 . ** Environment Setup**
54
- - Follow our [ secrets management guide] ( docs/guides/secrets-management.md ) for secure configuration
55
- - Use separate API keys for development and production
56
- - Regularly rotate credentials
56
+
57
+ - Follow our [ secrets management guide] ( docs/guides/secrets-management.md ) for secure configuration
58
+ - Use separate API keys for development and production
59
+ - Regularly rotate credentials
57
60
58
61
2 . ** Model Provider Security**
59
- - Use appropriate rate limiting for API calls
60
- - Monitor usage patterns for unusual activity
61
- - Implement proper authentication for exposed endpoints
62
+
63
+ - Use appropriate rate limiting for API calls
64
+ - Monitor usage patterns for unusual activity
65
+ - Implement proper authentication for exposed endpoints
62
66
63
67
3 . ** Platform Integration**
64
- - Use separate bot tokens for different environments
65
- - Implement proper permission scoping for platform APIs
66
- - Regular audit of platform access and permissions
68
+ - Use separate bot tokens for different environments
69
+ - Implement proper permission scoping for platform APIs
70
+ - Regular audit of platform access and permissions
67
71
68
72
## Security Features
69
73
70
74
### Current Implementation
71
75
72
- - Environment variable based secrets management
73
- - Type-safe API implementations
74
- - Automated dependency updates via Renovate
75
- - Continuous Integration security checks
76
+ - Environment variable based secrets management
77
+ - Type-safe API implementations
78
+ - Automated dependency updates via Renovate
79
+ - Continuous Integration security checks
76
80
77
81
### Planned Improvements
78
82
79
83
1 . ** Q4 2024**
80
- - Automated security scanning in CI pipeline
81
- - Enhanced rate limiting implementation
82
- - Improved audit logging
84
+
85
+ - Automated security scanning in CI pipeline
86
+ - Enhanced rate limiting implementation
87
+ - Improved audit logging
83
88
84
89
2 . ** Q1 2025**
85
- - Security-focused documentation improvements
86
- - Enhanced platform permission management
87
- - Automated vulnerability scanning
90
+ - Security-focused documentation improvements
91
+ - Enhanced platform permission management
92
+ - Automated vulnerability scanning
88
93
89
94
## Vulnerability Disclosure Policy
90
95
@@ -100,21 +105,21 @@ We follow a coordinated disclosure process:
100
105
101
106
We believe in recognizing security researchers who help improve our security. Contributors who report valid security issues will be:
102
107
103
- - Credited in our security acknowledgments (unless they wish to remain anonymous)
104
- - Added to our security hall of fame
105
- - Considered for our bug bounty program (coming soon)
108
+ - Credited in our security acknowledgments (unless they wish to remain anonymous)
109
+ - Added to our security hall of fame
110
+ - Considered for our bug bounty program (coming soon)
106
111
107
112
## License Considerations
108
113
109
114
As an MIT licensed project, users should understand:
110
115
111
- - The software is provided "as is"
112
- - No warranty is provided
113
- - Users are responsible for their own security implementations
114
- - Contributors grant perpetual license to their contributions
116
+ - The software is provided "as is"
117
+ - No warranty is provided
118
+ - Users are responsible for their own security implementations
119
+ - Contributors grant perpetual license to their contributions
115
120
116
121
## Contact
117
122
118
- - Security Issues: security@eliza.builders
119
- - General Questions: Join our [ Discord] ( https://discord.gg/ai16z )
120
- - Updates: Follow our [ security advisory page] ( https://github.com/ai16z/eliza/security/advisories )
123
+ - Security Issues: security@eliza.builders
124
+ - General Questions: Join our [ Discord] ( https://discord.gg/ai16z )
125
+ - Updates: Follow our [ security advisory page] ( https://github.com/ai16z/eliza/security/advisories )
0 commit comments