We release patches for security vulnerabilities for the following versions:
| Version | Supported |
|---|---|
| 1.0.x | ✅ |
| < 1.0 | ❌ |
We take the security of Hello Club Event Attendance Auto-Print seriously. If you discover a security vulnerability, please follow these steps:
- DO NOT open a public GitHub issue for security vulnerabilities
- Email security concerns to the maintainer through GitHub
- Use GitHub Security Advisories to privately report vulnerabilities
Please provide as much information as possible:
- Type of vulnerability (e.g., SQL injection, XSS, credential exposure)
- Full paths of affected source files
- Location of the affected code (tag/branch/commit)
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact assessment and potential attack scenarios
- Initial Response: Within 48 hours
- Status Update: Within 5 business days
- Fix Timeline: Depends on severity
- Critical: Within 7 days
- High: Within 14 days
- Medium: Within 30 days
- Low: Next scheduled release
- Acknowledgment: We'll confirm receipt of your report
- Assessment: We'll evaluate the vulnerability and severity
- Updates: We'll keep you informed of our progress
- Fix: We'll develop and test a fix
- Disclosure: We'll coordinate public disclosure with you
- Credit: We'll credit you in the security advisory (if desired)
When using this application:
- NEVER commit your
.envfile to version control - Store API keys in environment variables only
- Rotate API keys regularly
- Use different API keys for development and production
- Use app-specific passwords for SMTP (not your main password)
- Enable 2FA on email accounts used for SMTP
- Restrict printer email addresses to trusted recipients only
- Run the service with minimum required permissions
- Regularly update dependencies using
npm auditand Dependabot - Review logs regularly for suspicious activity
- The SQLite database (
events.db) contains event and attendee data - Ensure proper file permissions on the database file
- Backup the database regularly
- Delete old event data periodically
- Only run the tray app from trusted sources
- Verify checksums when downloading releases
- Keep Electron updated to the latest secure version
Status: MODERATE severity - No fix available CVE: GHSA-22r3-9w55-cj54 (Local Privilege Escalation) Impact: Development tool only, not used in production
The pkg package (used experimentally for creating standalone executables) has a known local privilege escalation vulnerability with no fix available. This is a development-only dependency and poses no risk to production deployments because:
- pkg is not used in the main build process
- The production application uses electron-builder for packaging
- pkg is never executed in production environments
- The vulnerability requires local access (not remotely exploitable)
Mitigation:
- pkg is isolated to development use only
- Consider removing if standalone executable builds are not needed
- Use electron-builder (secure, actively maintained) for production builds
- Environment variable isolation for secrets
- Input validation using Joi schema
- Winston logging for audit trails
- Automated dependency updates via Dependabot
- npm audit checks in CI/CD pipeline
- Production dependencies fully patched and secure
- Enhanced Electron security (context isolation)
- Database encryption at rest
- Rate limiting for API requests
- Automated security scanning with CodeQL
# Production environment
NODE_ENV=production
# Use strong, unique API keys
API_KEY=your_secure_api_key_here
# Use app-specific passwords
SMTP_PASS=your_app_specific_passwordEnsure restrictive permissions on sensitive files:
# Windows (PowerShell)
icacls .env /inheritance:r /grant:r "$($env:USERNAME):(R,W)"
icacls events.db /inheritance:r /grant:r "$($env:USERNAME):(R,W)"We use multiple layers to ensure dependency security:
- Dependabot: Automated weekly dependency updates
- npm audit: Runs in CI/CD pipeline
- package-lock.json: Locked dependency versions
- Manual Review: Critical dependencies reviewed before updates
We follow coordinated disclosure:
- Security researchers have 90 days to report vulnerabilities before public disclosure
- We aim to patch critical vulnerabilities within 7 days
- Public disclosure occurs after a fix is available
- Security advisories are published on GitHub
- Security Issues: Use GitHub Security Advisories
- General Issues: GitHub Issues
- Maintainer: ispyisail (via GitHub)
We appreciate the security research community's efforts to improve this project. Security researchers who responsibly disclose vulnerabilities will be acknowledged in:
- This SECURITY.md file
- GitHub Security Advisories
- Release notes
Thank you for helping keep Hello Club Event Attendance Auto-Print secure!