Skip to content

Commit 014f1b7

Browse files
committed
chore(docs): add security policy
This commit introduces a detailed SECURITY.md file that outlines: - Supported version policy for security patches - Vulnerability reporting process - Disclosure and handling procedures - Security best practices for using the provider - Additional security resources and references The new security policy provides clear guidance for users and contributors on how security issues are managed and mitigated. Signed-off-by: Pavel Boldyrev <[email protected]>
1 parent 8c0c79b commit 014f1b7

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

.github/SECURITY.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
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 release | :white_check_mark: |
10+
| Previous minor release | :white_check_mark: |
11+
| < Previous minor release | :x: |
12+
13+
## Reporting a Vulnerability
14+
15+
We take the security of the Terraform Provider for Proxmox and its users seriously. If you believe you have found a security vulnerability, please report it to us privately.
16+
17+
**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
18+
19+
Instead, please send an email to <[email protected]> or report it through GitHub's Security Advisory feature:
20+
21+
1. Go to <https://github.com/bpg/terraform-provider-proxmox/security/advisories/new>
22+
2. Provide a descriptive title
23+
3. Fill in a detailed description of the issue
24+
4. Click "Submit report"
25+
26+
Please include the following information in your report:
27+
28+
- Description of the vulnerability
29+
- Steps to reproduce the issue
30+
- Potential impact of the vulnerability
31+
- Suggested fix if possible
32+
- Your name/handle for credit (optional)
33+
34+
## What to Expect
35+
36+
When you submit a vulnerability report, you can expect:
37+
38+
- Acknowledgment of your report within 48 hours
39+
- Regular updates about our progress
40+
- Credit for discovering the vulnerability (if desired)
41+
42+
## Disclosure Policy
43+
44+
When we receive a security bug report, we will:
45+
46+
1. Confirm the problem and determine the affected versions
47+
2. Audit code to find any potential similar problems
48+
3. Prepare fixes for all supported versions
49+
4. Release new versions and notify users
50+
51+
## Security-Related Configuration
52+
53+
When using this provider, please follow these security best practices:
54+
55+
1. **API Credentials**:
56+
- Use environment variables or encrypted credential files to store sensitive information
57+
- Never commit API tokens or credentials to version control
58+
- Use the most restrictive permissions possible for API users
59+
60+
2. **Network Security**:
61+
- Use HTTPS/TLS for all API connections
62+
- Configure appropriate firewall rules
63+
- Use private networks where possible
64+
65+
3. **State File Security**:
66+
- Encrypt your Terraform state files
67+
- Use remote state with appropriate access controls
68+
- Be cautious with state file contents as they may contain sensitive information
69+
70+
## Additional Information
71+
72+
For more information about security practices when using this provider, please refer to:
73+
74+
- [Terraform Security Best Practices](<https://www.terraform.io/docs/cloud/guides/recommended-practices/security.html>)
75+
- [Proxmox Security Documentation](<https://www.proxmox.com/en/proxmox-ve/security>)

0 commit comments

Comments
 (0)