|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Supported Versions |
| 4 | + |
| 5 | +We take security seriously and provide security updates for the latest version of nmrs and nmrs-gui alike. |
| 6 | +We strongly recommend keeping your nmrs dependencies up to date. |
| 7 | + |
| 8 | +## Reporting a Vulnerability |
| 9 | + |
| 10 | +**Please do not report security vulnerabilities through public GitHub issues.** |
| 11 | + |
| 12 | +If you discover a security vulnerability in nmrs or any of the related crates, please report it privately by emailing |
| 13 | +**alhakimiakrmjATgmailDOTcom**. |
| 14 | + |
| 15 | +Please include the following information in your report: |
| 16 | + |
| 17 | +- A clear description of the vulnerability |
| 18 | +- Steps to reproduce the issue |
| 19 | +- Potential impact and attack scenarios |
| 20 | +- Any suggested fixes or mitigations |
| 21 | +- Your contact information for follow-up questions |
| 22 | + |
| 23 | +### What constitutes a security vulnerability? |
| 24 | + |
| 25 | +For nmrs, security vulnerabilities may include but are not limited to: |
| 26 | + |
| 27 | +- **Authentication bypass**: Ability to connect to protected networks without proper credentials |
| 28 | +- **Privilege escalation**: Unauthorized access to NetworkManager operations that should require elevated permissions |
| 29 | +- **Credential exposure**: Leaking WiFi passwords, VPN keys, or other sensitive connection data through logs, errors, or memory |
| 30 | +- **D-Bus injection**: Malicious D-Bus messages that could manipulate network connections or device state |
| 31 | +- **Denial of service**: Crashes, hangs, or resource exhaustion that prevent legitimate network management |
| 32 | +- **Information disclosure**: Exposing network SSIDs, MAC addresses, or connection details to unauthorized processes |
| 33 | +- **Input validation failures**: Improper handling of malformed SSIDs, credentials, or configuration data leading to undefined behavior |
| 34 | +- **Race conditions**: Timing vulnerabilities in connection state management that could lead to security issues |
| 35 | +- **Dependency vulnerabilities**: Security issues in upstream crates (zbus, tokio, etc.) that affect nmrs |
| 36 | + |
| 37 | +For nmrs-gui specifically: |
| 38 | +- **UI injection**: Malicious network names or data that could execute unintended actions in the GUI |
| 39 | +- **File system access**: Unauthorized reading or writing of configuration files outside the intended scope |
| 40 | + |
| 41 | + |
| 42 | +## Response Timeline |
| 43 | + |
| 44 | +We are committed to responding to security reports promptly: |
| 45 | + |
| 46 | +- **Acknowledgment**: We will acknowledge receipt of your vulnerability report within |
| 47 | + **24 hours** |
| 48 | +- **Initial assessment**: We will provide an initial assessment of the report within |
| 49 | + **5 business days** |
| 50 | +- **Regular updates**: We will provide progress updates at least every **7 days** until |
| 51 | + resolution |
| 52 | +- **Resolution**: We aim to provide a fix or mitigation within **30 days** for critical |
| 53 | + vulnerabilities |
| 54 | + |
| 55 | +Response times may vary based on the complexity of the issue and availability of maintainers. |
| 56 | + |
| 57 | +## Disclosure Policy |
| 58 | + |
| 59 | +We follow a coordinated disclosure process: |
| 60 | + |
| 61 | +1. **Private disclosure**: We will work with you to understand and validate the vulnerability |
| 62 | +2. **Fix development**: We will develop and test a fix in a private repository if necessary |
| 63 | +3. **Coordinated release**: We will coordinate the public disclosure with the release of a fix |
| 64 | +4. **Public disclosure**: After a fix is available, we will publish a security advisory |
| 65 | + |
| 66 | +We request that you: |
| 67 | +- Give us reasonable time to address the vulnerability before making it public |
| 68 | +- Avoid accessing or modifying data beyond what is necessary to demonstrate the vulnerability |
| 69 | +- Act in good faith and avoid privacy violations or destructive behavior |
| 70 | + |
| 71 | +## Security Advisories |
| 72 | + |
| 73 | +Published security advisories will be available through: |
| 74 | + |
| 75 | +- GitHub Security Advisories on the |
| 76 | + [nmrs repository](https://github.com/cachebag/nmrs/security/advisories) |
| 77 | +- [RustSec Advisory Database](https://rustsec.org/) |
| 78 | +- Release notes and changelog entries |
| 79 | + |
| 80 | +## Recognition |
| 81 | + |
| 82 | +We appreciate the security research community's efforts to improve the security of nmrs. With |
| 83 | +your permission, we will acknowledge your contribution in: |
| 84 | + |
| 85 | +- Security advisories |
| 86 | +- Release notes |
| 87 | +- Project documentation |
| 88 | + |
| 89 | +If you prefer to remain anonymous, please let us know in your report. |
| 90 | + |
| 91 | +## Scope |
| 92 | + |
| 93 | +This security policy covers both nmrs and nmrs-gui alike. |
| 94 | + |
| 95 | +## Additional Resources |
| 96 | + |
| 97 | +- [Contributing Guidelines](CONTRIBUTING.md) |
| 98 | +- [Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct) |
| 99 | +- [Rust Security Policy](https://www.rust-lang.org/policies/security) |
| 100 | + |
| 101 | +Thank you for helping to keep nmrs and the Rust ecosystem secure! |
0 commit comments