Skip to content

Security: fidpa/bash-markdown-link-validator

Security

SECURITY.md

Security Policy

πŸ”’ Supported Versions

We actively support the following versions with security updates:

Version Supported Status
1.1.x βœ… Yes Active
1.0.x ⚠️ Limited EOL soon
< 1.0 ❌ No Unsupported

Recommendation: Always use the latest stable release from the Releases page.


πŸ› Reporting a Vulnerability

We take security vulnerabilities seriously. If you discover a security issue, please follow responsible disclosure:

πŸ“§ Contact

DO NOT open a public GitHub issue for security vulnerabilities.

Instead, report via:

  1. GitHub Security Advisories (Preferred):

  2. Email (Alternative):

    • Contact: [your-email@example.com]
    • Subject: [SECURITY] bash-markdown-link-validator vulnerability
    • Use PGP key (if available): [link to PGP key]

πŸ“‹ Report Template

## Vulnerability Description
[Clear description of the security issue]

## Impact
[Potential impact: data exposure, code execution, etc.]

## Steps to Reproduce
1. Step 1
2. Step 2
3. ...

## Proof of Concept
[Code snippet, logs, or screenshots]

## Suggested Fix
[Optional: Your recommendation for fixing the issue]

## Environment
- Version: [e.g., v1.1.0]
- OS: [e.g., Ubuntu 22.04]
- Bash Version: [output of `bash --version`]

⏱️ Response Timeline

Stage Timeline Description
Acknowledgment 48 hours We confirm receipt of your report
Initial Assessment 7 days We evaluate severity and impact
Fix Development 14-30 days We develop and test the fix
Disclosure 30-90 days Coordinated public disclosure

Note: Timelines may vary based on complexity and severity.


πŸ›‘οΈ Security Best Practices

For Users

  1. Keep Updated: Use the latest stable release
  2. Review Code: Inspect scripts before running in sensitive environments
  3. Least Privilege: Run with minimal necessary permissions
  4. Input Validation: Be cautious with untrusted Markdown files

For Contributors

  1. No Secrets: Never commit credentials, tokens, or sensitive data
  2. ShellCheck: Run shellcheck to catch common vulnerabilities
  3. Input Sanitization: Always validate and sanitize user inputs
  4. Dependency Security: Minimize dependencies (we have zero!)

πŸ” Known Security Considerations

1. File System Access

  • Risk: Scripts read files from the file system
  • Mitigation: Run in controlled environments, use --exclude for sensitive dirs

2. External Links

  • Risk: Validates HTTP(S) links (no actual HTTP requests by default)
  • Mitigation: JSON mode for CI/CD, avoid executing external code

3. Bash Execution

  • Risk: Shell injection if inputs are not sanitized
  • Mitigation: All variables are quoted, no eval usage

πŸ“œ Security Audit History

Date Version Type Summary
2025-01 v1.1.0 Internal Review No vulnerabilities found
2024-12 v1.0.0 Initial Release Baseline security assessment

πŸ† Acknowledgments

We appreciate security researchers who help improve this project:

No security reports yet. Be the first!


πŸ“ž Questions?

For general security questions (not vulnerabilities):


Thank you for helping keep bash-markdown-link-validator secure! πŸ”

There aren’t any published security advisories