We actively support the following versions of this project with security updates:
| Version | Supported |
|---|---|
| Latest | ✅ |
| < 1.0 | ❌ |
Note: As a template repository, security primarily concerns the automation scripts (PowerShell) and any dependencies they may have. Once you use this template for your own project, please update this section with your project's specific version support policy.
We take the security of this template and its users seriously. If you believe you have found a security vulnerability, please report it to us as described below.
Please do NOT report security vulnerabilities through public GitHub issues.
Instead, please report them via one of the following methods:
-
GitHub Security Advisories (Preferred)
- Navigate to the repository's Security tab
- Click "Report a vulnerability"
- Fill out the security advisory form with details
-
Direct Email
- Send an email to: security@christaylor.codes
- Use the subject line:
[SECURITY] Project Name - Brief Description
-
Private Message on Slack
- Contact @CTaylor on MSPGeek Slack
- Clearly mark the message as security-related
Please include the following information in your report to help us better understand and resolve the issue:
- Type of issue (e.g., code injection, privilege escalation, information disclosure)
- Full paths of source file(s) related to the manifestation of the issue
- Location of the affected source code (tag/branch/commit or direct URL)
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit it
- Any special configuration required to reproduce the issue
- Your assessment of severity (Critical, High, Medium, Low)
After you submit a vulnerability report:
- Acknowledgment - We will acknowledge receipt of your vulnerability report within 48 hours
- Initial Assessment - We will provide an initial assessment of the vulnerability within 5 business days
- Updates - We will keep you informed of the progress toward a fix and full announcement
- Verification - We may ask you to verify that our fix resolves the vulnerability
- Public Disclosure - We will coordinate with you on the timing of public disclosure
- Credit - We will credit you in the security advisory (unless you prefer to remain anonymous)
| Phase | Timeline |
|---|---|
| Acknowledgment | 48 hours |
| Initial Assessment | 5 business days |
| Fix Development | Varies by severity |
| Release | Coordinated with reporter |
We use the CVSS v3.1 scoring system to assess vulnerability severity:
- Critical (9.0-10.0) - Fix within 24-48 hours
- High (7.0-8.9) - Fix within 1 week
- Medium (4.0-6.9) - Fix within 2-4 weeks
- Low (0.1-3.9) - Fix in next regular release
When using this template for your own project, please:
-
Keep Dependencies Updated
- Regularly update PowerShell modules and any other dependencies
- Enable Dependabot alerts in your repository settings
-
Secure Your Secrets
- Never commit sensitive information (API keys, passwords, tokens)
- Use environment variables or secure secret storage
- Review the
.gitignoreto ensure sensitive files are excluded
-
Code Review
- Review all scripts before execution, especially
Scripts\Initialize-Repository.ps1 - Understand what automation scripts do before running them
- Use
-WhatIfparameter when available
- Review all scripts before execution, especially
-
PowerShell Execution Policy
- Be cautious when using
-ExecutionPolicy Bypass - Prefer signed scripts in production environments
- Review script signatures when available
- Be cautious when using
-
Regular Security Audits
- Run
Scripts\Test-Template.ps1regularly to check for issues - Review and update this SECURITY.md for your project's needs
- Monitor GitHub security advisories for dependencies
- Run
The template includes PowerShell scripts that modify files on your system:
Scripts\Initialize-Repository.ps1- Modifies template filesScripts\Test-Template.ps1- Reads files and makes web requests (when link checking enabled)Scripts\New-TemplateBadges.ps1- Can modify README.md
Recommendations:
- Review scripts before execution
- Run with least privilege necessary
- Test in a safe environment first
- Keep backups before running automation
This template may reference or suggest external services:
- shields.io for badges
- GitHub Actions for CI/CD
- Package managers (PowerShell Gallery, npm, etc.)
Recommendations:
- Verify the integrity of external resources
- Use trusted, official package sources
- Review CI/CD workflows before enabling
- Understand third-party service terms and privacy policies
Security updates for this template will be released as follows:
- Critical vulnerabilities - Immediate patch release
- High severity vulnerabilities - Patch within 1 week
- Medium/Low severity - Included in next regular release
When you use this template for your own project, update this section with:
- Your project's update schedule
- Supported version policy
- How users should update
- Communication channels for security announcements
We appreciate security researchers who responsibly disclose vulnerabilities. Contributors will be listed here (with permission):
No vulnerabilities reported yet.
- GitHub Security Best Practices
- OWASP Top 10
- PowerShell Security Best Practices
- National Vulnerability Database
If you have questions about this security policy or the security posture of this template, please:
- Check the Discussions section
- Open a general (non-security) issue
- Contact the maintainers through community Slack channels
Last Updated: 2025-01-22