We release patches for security vulnerabilities in the following versions:
| Version | Supported |
|---|---|
| 1.0.x | ✅ |
| < 1.0 | ❌ |
If you discover a security vulnerability in this framework, please report it responsibly by emailing:
Primary Contact: murilo.chianfa@uel.br
Please provide the following information:
- Description of the vulnerability: Clear explanation of the security issue
- Steps to reproduce: Detailed steps to reproduce the vulnerability
- Potential impact: How the vulnerability could be exploited
- Affected components: Which parts of the framework are affected
- Suggested fix (optional): If you have ideas on how to fix it
- Initial Response: Within 48 hours of receiving your report
- Status Update: Within 7 days with assessment and expected timeline
- Resolution: Depending on severity, typically within 30 days
- Please allow us reasonable time to investigate and fix the vulnerability before public disclosure
- We will credit you for the discovery (unless you prefer to remain anonymous)
- Once fixed, we will publish a security advisory with details
This framework processes NetFlow data that may contain sensitive information about network traffic:
-
Data Anonymization: While the included datasets have been processed to remove direct identifiers, users should:
- Review datasets for any potentially traceable information
- Apply additional anonymization if needed for their use case
- Comply with local data protection regulations (GDPR, LGPD, etc.)
-
Found Traceable Information: If you discover any identifiable or traceable information in the provided datasets:
- Do not publish or share the information publicly
- Contact us immediately at murilo.chianfa@uel.br
- Provide details about what you found and where
- We will investigate and take appropriate action
-
Environment Isolation:
- Use the provided conda environment (
nf-ae) to isolate dependencies - Keep dependencies updated for security patches
- Review
environment.ymlbefore installation
- Use the provided conda environment (
-
Model Files:
- Trained models are saved in
results/andcache/directories - These files should be treated as sensitive if trained on proprietary data
- Use appropriate file permissions in production environments
- Trained models are saved in
-
Network Access:
- The framework does not transmit data over the network
- The framework does not collect telemetry or usage data
- All processing is local to your machine
-
Resource Consumption:
- Be aware of computational resource usage (CPU, GPU, RAM)
- Monitor execution in shared or production environments
- See README.md for details
This project uses third-party dependencies managed through Conda and pip:
- Dependencies are pinned to specific versions in
environment.yml - Dependabot monitors for security updates in pip packages
- Review security advisories for TensorFlow, PyTorch, and scikit-learn regularly
- No Authentication: The framework has no built-in authentication or authorization
- Local Execution: Designed for local execution, not for web deployment without additional security layers
- File System Access: The framework reads/writes local files without sandboxing
- Security vulnerabilities in the framework code
- Dependency vulnerabilities that affect functionality
- Data leakage or privacy issues
- Code injection vulnerabilities
- Path traversal issues
- Arbitrary code execution
- Issues in third-party dependencies (report to respective maintainers)
- Vulnerabilities requiring physical access to the machine
- Social engineering attacks
- Denial of service through resource exhaustion (expected behavior during training)
Security updates will be:
- Released as patch versions (e.g., 1.0.1)
- Announced in GitHub Security Advisories
- Documented in release notes with [SECURITY] prefix
For security-related questions or concerns:
- Email: murilo.chianfa@uel.br
- Subject Line: [SECURITY] Brief description
For non-security issues, please use the GitHub issue tracker.
We appreciate the security research community and will acknowledge responsible disclosure in our security advisories.
Note: This is an academic research project. While we take security seriously, it is provided "as is" without warranties. See LICENSE for details.