Skip to content

Commit 847e063

Browse files
committed
docs: add SECURITY.md and CODE_OF_CONDUCT.md
Add standard security policy and code of conduct for project governance. Essential for official Redis project transfer readiness.
1 parent be4e063 commit 847e063

File tree

2 files changed

+130
-0
lines changed

2 files changed

+130
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers responsible for enforcement via GitHub. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

SECURITY.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We release patches for security vulnerabilities for the following versions:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| Latest | :white_check_mark: |
10+
| < Latest| :x: |
11+
12+
We recommend always using the latest version to ensure you have the most recent security updates.
13+
14+
## Reporting a Vulnerability
15+
16+
If you discover a security vulnerability in redisctl, please report it privately to help us address it before public disclosure.
17+
18+
**Please do NOT report security vulnerabilities through public GitHub issues.**
19+
20+
### How to Report
21+
22+
1. **Email**: Send details to the project maintainers via GitHub
23+
2. **Include**:
24+
- Description of the vulnerability
25+
- Steps to reproduce the issue
26+
- Potential impact
27+
- Any suggested fixes (if available)
28+
29+
### What to Expect
30+
31+
- **Acknowledgment**: We will acknowledge receipt of your report within 48 hours
32+
- **Updates**: We will provide regular updates on our progress
33+
- **Timeline**: We aim to release a fix within 90 days of the initial report
34+
- **Credit**: We will credit you in the security advisory (unless you prefer to remain anonymous)
35+
36+
### Security Best Practices
37+
38+
When using redisctl:
39+
40+
1. **Credentials**: Use the `--use-keyring` flag with `secure-storage` feature to store credentials securely
41+
2. **Permissions**: Store configuration files with restrictive permissions (e.g., `chmod 600 ~/.config/redisctl/config.toml`)
42+
3. **TLS**: Always use HTTPS endpoints; only use `REDIS_ENTERPRISE_INSECURE=true` for testing
43+
4. **Environment Variables**: Be cautious when using environment variables for credentials in shared environments
44+
5. **Updates**: Keep redisctl updated to the latest version
45+
46+
## Known Security Considerations
47+
48+
- Credentials stored in plain text configuration files are readable by any process with access to the file
49+
- The `--insecure` flag disables TLS certificate verification and should only be used in development
50+
- API keys and secrets in command-line arguments may be visible in process listings
51+
52+
For enhanced security, we recommend:
53+
- Using the `secure-storage` feature for credential management
54+
- Configuring proper file system permissions
55+
- Using environment variables or profiles instead of command-line flags for sensitive data

0 commit comments

Comments
 (0)