We release patches for security vulnerabilities for the following versions:
| Version | Supported |
|---|---|
| 0.1.x | ✅ |
We take the security of wiremd seriously. If you discover a security vulnerability, please follow these steps:
- Open a public GitHub issue for security vulnerabilities
- Disclose the vulnerability publicly before it has been addressed
- Email the maintainer at the email address listed in the package.json or GitHub profile
- Include the following information:
- Description of the vulnerability
- Steps to reproduce the issue
- Potential impact
- Suggested fix (if you have one)
- Initial Response: Within 48 hours
- Status Update: Within 7 days
- Fix Timeline: Varies based on severity and complexity
- Critical: Within 7 days
- High: Within 30 days
- Medium/Low: Next scheduled release
- Security report received and acknowledged
- Issue confirmed and severity assessed
- Fix developed and tested
- Patch released as quickly as possible
- Public disclosure after users have time to update (typically 7-14 days)
- Credit given to reporter (unless anonymity requested)
wiremd parses markdown input. While markdown is generally safe, be aware:
- HTML in markdown: By default, markdown parsers may allow raw HTML
- XSS risks: When rendering HTML output, ensure proper sanitization in your application
- File operations: The CLI tool reads files - ensure proper file path validation
- Sanitize output: If displaying wiremd HTML output in a web context, use a sanitization library
- Validate input: If accepting user input, validate and sanitize before parsing
- Keep updated: Use the latest version to get security patches
- Review dependencies: Regularly audit dependencies with
npm audit
We regularly monitor our dependencies for vulnerabilities:
# Check for vulnerabilities
npm audit
# Fix vulnerabilities
npm audit fixCurrently no known security issues. Check the Security Advisories page for updates.
Security updates will be announced:
- In the CHANGELOG.md
- As GitHub Security Advisories
- In release notes
- Via npm security advisories
For security-related questions or concerns, please contact the project maintainer through GitHub.
Thank you for helping keep wiremd and its users safe!