Skip to content

Security: HadrienG2/hwlocality

SECURITY.md

Security Policy

Supported Versions

This project aims for strict SemVer compliance. This means that upgrading to a new minor or patch version should be trivial, but upgrading to a new major version may incur some significant costs on your side.

With that in mind, if we denote major.minor.patch the project's version number, the policy for security updates support is that...

  • The latest major.minor.patch version published on crates.io is supported (obviously).
  • Each previously published major release remains supported, for users of the latest minor.patch version, during 6 months after the release of the next major release.

Reporting a Vulnerability

Basics

Please do not report security vulnerabilities (any bug that has security implications if e.g. a setuid binary happens to use hwlocality) using public channels such as...

  • A project's issue tracker
  • Social media
  • A CVE Report

Doing so is the computer security equivalent of reporting a fire safety risk by starting a fire: you are informing attackers that software has a problem before a fix is available, and they will be able to exploit this information for the entire duration it will take us to come up with a fix, which is Very Bad.

Instead, you should privately report the vulnerability to the project, give it some time to come up with a fix, and only report the vulnerability publicly once a patch release is available for all supported major versions (except in worst-case scenarios discussed below).

Reporting to the right project

Please start by assessing whether the vulnerability only affects users of the hwlocality Rust bindings, or would also affect direct users of the underlying hwloc C library.

If the problem lies in hwloc itself, the preferred course of action is to directly report the vulnerability to the hwloc project, so that it can be fixed with the broadest user impact. To avoid effort duplication between the two projects, mitigation of such issues at the hwlocality level will only be considered if you have correctly followed the above procedure and can convincingly argue that the hwloc developers are not responding to your vulnerability report in an appropriate and timely manner.

If the problem only affects hwlocality users, or if hwloc declined to address the problem on their side, then please privately submit us a security advisory that describes the vulnerability, assesses its impact, and provides instructions on how to replicate the issue locally. If you have a patch that adresses the issue, please also submit it there.

Worst-case scenarios

While private reporting and embargo until a bugfix is available is the preferred course of action on our side, we are well aware that if we spend too much time without fixing the vulnerability, or if you become aware that another attacker has found out about the vulnerability and started exploiting it, you may want to publicly report the vulnerability anyway.

Here's what you can expect from us in terms of response time :

  • At the time of writing, the project only has one permanent maintainer, @HadrienG2. I will aim for fast replies (less than a week, ideally next-day), but I may be momentarily unavailable for various reasons: holidays, sickness... So please ping me a few times (e.g. after a week and a month) before concluding that I am unresponsive and must have abandoned the project.
  • Unless the vulnerability is extremely complex and requires a major library rewrite to fix, 90 days should be more than enough time for me to fix it.

There aren’t any published security advisories