Skip to content

Security: marttinm/Network-Security-Monitor

Security

SECURITY.md

Security Policy

Supported Versions

Network Security Monitor is currently in active development. Security updates are provided for the following versions:

Version Supported
2.0.x
1.x.x
< 1.0

Reporting a Vulnerability

The security of Network Security Monitor is important to us. If you discover a security vulnerability, please follow these guidelines:

How to Report

Please DO NOT create a public GitHub issue for security vulnerabilities.

Instead, please report security vulnerabilities by:

  1. Email: Send details to the repository owner via GitHub private message or email
  2. Include in your report:
    • Description of the vulnerability
    • Steps to reproduce the issue
    • Potential impact of the vulnerability
    • Any suggested fixes (if you have them)
    • Your contact information for follow-up

What to Expect

  • Acknowledgment: You'll receive an acknowledgment within 48 hours
  • Initial Assessment: Within 5 business days, we'll provide an initial assessment
  • Updates: We'll keep you informed about the progress of fixing the vulnerability
  • Resolution: We aim to resolve critical vulnerabilities within 30 days
  • Credit: With your permission, we'll credit you in the security advisory

Security Best Practices for Users

When using Network Security Monitor:

Authorization and Legal Compliance

  • Only scan networks you own or have explicit permission to scan
  • Comply with local laws and regulations regarding network scanning
  • Understand that unauthorized network scanning may be illegal in your jurisdiction

Running Securely

  1. Use Administrator Privileges Carefully

    • Only run with admin/root privileges when necessary for scanning
    • Don't run the web interface with elevated privileges unless required
  2. Protect Your Configuration

    • Keep config.json secure with appropriate file permissions
    • Don't share configuration files that contain sensitive network information
    • Use strong credentials for alert integrations (Email, Slack, Discord)
  3. Network Security

    • Run the web interface on localhost only (default: 127.0.0.1:5000)
    • Use a firewall to restrict access if running on a network-accessible address
    • Consider using HTTPS if exposing the web interface beyond localhost
  4. Data Privacy

    • Network scan data is stored locally in the data/ directory
    • Regularly clean old scan data if privacy is a concern
    • Be aware that exported reports contain network device information
  5. Keep Updated

    • Regularly update to the latest version for security patches
    • Review the changelog for security-related updates
    • Update Python and dependencies regularly

Known Security Considerations

  1. Local Data Storage

    • All network data is stored locally in SQLite database
    • Database files are not encrypted by default
    • Protect the data/ directory with appropriate file system permissions
  2. Network Scanning

    • Network scanning can be detected by intrusion detection systems
    • Some networks may consider scanning as hostile activity
    • Use responsibly and with authorization
  3. Threat Intelligence

    • External threat intelligence feeds are optional
    • When enabled, the application makes outbound HTTP requests
    • Review threat feed sources in config/threat_intel.json
  4. Web Interface

    • Default configuration binds to localhost only (secure)
    • Changing to 0.0.0.0 exposes the interface to network (use with caution)
    • No authentication is implemented by default

Scope

This security policy covers:

  • The Network Security Monitor application code
  • Configuration and deployment recommendations
  • Vulnerability disclosure process

This policy does NOT cover:

  • Security issues in third-party dependencies (report to respective projects)
  • Issues arising from unauthorized or illegal use
  • Security of networks being scanned

Security Updates

Security updates will be:

  • Released as patch versions (e.g., 2.0.1)
  • Documented in the CHANGELOG
  • Announced in release notes
  • Tagged with "security" label in GitHub releases

Responsible Disclosure

We follow responsible disclosure practices:

  1. Security researchers who report vulnerabilities will be credited (if desired)
  2. We'll work with reporters to understand and fix issues
  3. Public disclosure will only happen after a fix is available
  4. We'll coordinate disclosure timing with the reporter

Additional Security Resources

Security Acknowledgments

We would like to thank the following individuals for responsibly disclosing security issues:

No vulnerabilities have been reported yet.


Contact

For security concerns, please contact:

  • GitHub: @marttinm
  • Create a private security advisory via GitHub's security tab

Thank you for helping keep Network Security Monitor and its users safe!

There aren't any published security advisories