If you discover a security vulnerability within the Split-Flap Display Controller, please send an email to your-email@example.com. All security vulnerabilities will be promptly addressed.
Please include the following information in your report:
- Type of vulnerability
- Steps to reproduce the issue
- Affected versions
- Potential impact
This application connects to MQTT brokers which may control physical hardware. Please consider the following security measures:
- Use TLS/SSL: Configure your MQTT broker to use encrypted connections (mqtts://)
- Strong Authentication: Always use username/password authentication for your MQTT broker
- Access Control Lists (ACLs): Restrict topic access on your MQTT broker
- Network Segmentation: Keep your MQTT broker on a separate network from the internet
The application uses the National Rail Enquiries API which requires an API token. Protect this token:
- Never commit API tokens to your repository
- Use environment variables to store sensitive credentials
- Rotate API tokens periodically
When deploying with Docker:
- Keep your Docker host and containers updated with security patches
- Use non-root users inside containers where possible
- Consider using Docker secrets for sensitive information
- Restrict network access to only required ports
The web interface should be secured if exposed beyond your local network:
- Use HTTPS with a valid certificate
- Consider implementing authentication if the interface is publicly accessible
- Keep all dependencies updated to patch security vulnerabilities
This project relies on various npm packages. To ensure security:
- Regularly run
npm auditto check for vulnerabilities - Keep dependencies updated
- Consider using tools like Dependabot to automate security updates
- Always change default credentials
- Limit network exposure of the application to trusted networks
- Review the
.envfile regularly to ensure no sensitive data is exposed