We release patches for security vulnerabilities. The following versions are currently being supported with security updates:
| Version | Supported |
|---|---|
| v0.1.x | ✅ |
| 0.1.x | ❌ |
We take the security of odinnordico.github.io 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 email to:
- 📧 Email: odin.nordico90@gmail.com
- Subject:
[SECURITY] Brief description of the issue
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
After submitting a vulnerability report, you should receive:
- Acknowledgment: Within 48 hours of submission
- Initial Assessment: Within 5 business days, we'll provide an initial assessment
- Updates: Regular updates on our progress as we investigate and address the issue
- Resolution: A timeline for when you can expect a fix to be released
- We ask that you give us reasonable time to investigate and fix the issue before public disclosure
- We will keep you informed of our progress
- Once the issue is resolved, we will publicly acknowledge your responsible disclosure (unless you prefer to remain anonymous)
When using this project, we recommend following these security best practices:
-
Keep Dependencies Updated: Regularly update Go and project dependencies
go get -u ./... go mod tidy
-
Validate Data Files: Ensure YAML data files come from trusted sources
- Be cautious when accepting YAML files from external sources
- Review YAML content before processing
-
Environment Security: When running the development server:
- Only bind to
localhostunless specifically needed - Use
--host 0.0.0.0only in trusted network environments - Don't expose the development server to the public internet
- Only bind to
-
Asset Security:
- Verify all assets (images, logos) are from trusted sources
- Scan uploaded or user-provided files for malware
-
Input Validation: Always validate and sanitize user inputs
-
Dependency Management:
- Review dependencies before adding them
- Keep dependencies up to date
- Use Go's vulnerability scanner:
go run golang.org/x/vuln/cmd/govulncheck@latest ./...
-
Code Review:
- All code changes should be reviewed by at least one other maintainer
- Security-sensitive changes require additional scrutiny
-
Testing:
- Write tests for security-critical functionality
- Include negative test cases for validation logic
- This project processes YAML files which could potentially contain malicious content
- Always review YAML files from untrusted sources before processing
- The
yaml.v3library is used with default safe parsing
- The application reads from and writes to the file system
- Ensure appropriate file permissions on data directories
- Be cautious with the
--data-dirand--output-dirflags
- The development server (
servecommand) is intended for local development only - Do not use the development server in production environments
- Production deployments should use proper web servers (nginx, Apache, etc.)
- Templates are executed with access to resume data
- Custom templates should be reviewed for potential injection vulnerabilities
- Only use templates from trusted sources
Security updates will be announced through:
- GitHub Security Advisories: Security Advisories
- Release Notes: Check our Releases page
- README Updates: Critical security information will also be added to the README
We use the following tools to scan for vulnerabilities:
- Go Vulnerability Database:
govulncheck - Dependency Scanning: GitHub Dependabot
- Code Analysis: GitHub CodeQL (if configured)
To check for vulnerabilities locally:
# Install govulncheck
go install golang.org/x/vuln/cmd/govulncheck@latest
# Run vulnerability check
govulncheck ./...For security-related questions or concerns that are not vulnerabilities, you can:
- Open a GitHub Discussion
- Email: odin.nordico90@gmail.com
Thank you for helping keep odinnordico.github.io and its users safe!