We release patches for security vulnerabilities for the following versions:
| Version | Supported |
|---|---|
| 3.0.x | ✅ |
| 2.0.x | ❌ |
| < 2.0 | ❌ |
We take the security of this project 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 security vulnerabilities by:
- Email: Send details to the repository maintainer
- GitHub Security Advisories: Use the Security tab in this repository
Please include the following information in your report:
- Type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- 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
- Initial Response: Within 48 hours of report
- Status Update: Within 7 days with initial assessment
- Fix Timeline: Security fixes are prioritized and typically released within 30 days
- Public Disclosure: After fix is released and users have had time to update (minimum 7 days)
- Security issue is reported privately
- Issue is confirmed and severity assessed
- Fix is developed in a private branch
- Fix is tested and reviewed
- Security advisory is prepared
- Fix is released with security advisory
- Public disclosure after users have time to update
When using this setup, follow these security practices:
# Run update script regularly
./update.sh
# Check for outdated packages
brew outdated
mise outdatedBefore running the setup, review:
Brewfile- All packages that will be installedBrewfile.sre- SRE-specific packagessetup.yml- Ansible tasks that will run
- Never commit sensitive data (passwords, API keys, tokens)
- Use
.env.localfor local secrets (already in .gitignore) - Review all dotfiles before applying with chezmoi
- Use vault or password managers for credentials
The setup downloads software from:
- Homebrew official repositories
- GitHub official repositories (Oh My Zsh, Powerlevel10k, etc.)
- npm/pip official registries (via mise)
All downloads use HTTPS and official sources.
- Never run bootstrap as root
- Scripts will prompt for sudo when needed
- Review sudoers configuration (disabled by default)
# Run security verification
./verify-setup.sh
# Check for known vulnerabilities
brew audit --strict
npm audit (for Node.js projects)If running in a corporate environment:
- Configure proxy settings in shell RC files
- Verify firewall allows Homebrew/GitHub access
- Use VPN if required by organization
This setup installs 100+ packages from Homebrew. Each package is:
- Downloaded from official Homebrew formulae
- Verified with checksums by Homebrew
- From trusted sources (official maintainers)
Review the Brewfile to understand what will be installed.
The setup modifies shell configuration (~/.zshrc). Review:
dotfiles/.zshrcbefore applying- Ensure no untrusted plugins are added
- Verify PATH modifications
The configure_sudoers option is disabled by default for security. Only
enable if you understand the implications and trust your environment.
Pre-commit hooks run code on every commit. Review:
.pre-commit-config.yamlfor all hooks- Ensure hooks are from trusted sources
- Update hooks regularly:
pre-commit autoupdate
This repository includes automated security scanning:
- Shellcheck: Catches shell script vulnerabilities
- Ansible-lint: Catches Ansible security issues
- Secret detection: Pre-commit hook detects private keys
- Dependency scanning: CI checks for outdated packages
Scripts request minimal permissions:
- No root access by default
- Sudo only when absolutely necessary
- User consent required for sensitive operations
- Telemetry disabled in VS Code
- Passwordless sudo disabled by default
- Secrets excluded via .gitignore
- Private key detection in pre-commit
All changes are logged:
- Git history tracks all modifications
- CI logs available for review
- Pre-commit hooks enforce quality gates
We follow a coordinated disclosure process:
- Reporter notifies us privately
- We confirm and develop fix
- Fix is released
- Public disclosure after 7+ days
- Credit given to reporter (if desired)
For security concerns, please refer to the repository maintainer information in the README.
Last Updated: 2025-10-27 Security Policy Version: 1.0