The MeshKit maintainers take security seriously. This document describes how to report a vulnerability and what to expect once a report has been received.
Security fixes target the latest 0.x release and the main branch. Until 1.0, only the most recent minor release line receives fixes.
| Version line | Supported |
|---|---|
| 0.2.x (current) | :white_check_mark: |
| Earlier releases | :x: |
MeshKit code that is still built inside the OpenSWMM GUI repository (libraries/meshkit) is covered by that repository's policy until the GUI consumes this repository's releases.
Please do not file public GitHub issues for security problems.
Use one of the private channels below so a fix can be prepared before public disclosure:
Please include, where possible:
src/native/, the Python bindings, the CLI)..mkb, .2dm, .inp) or the request that triggers the problem — and the observed vs. expected behaviour.If a report does not receive a response within the acknowledgement window, please re-send and CC a maintainer listed in AUTHORS.md.
In scope:
include/meshkit/, src/native/): meshing jobs, the MKB and SMS 2DM readers and writers, and atomic file publication. Readers parse files that may come from untrusted sources, so memory-safety defects there are the main concern.include/core/, include/mesh/, src/core/, src/mesh/), including the INP mesh-section and SMS 2DM readers.src/native/python.cpp, python/meshkit/) and the meshkit command-line tool (tools/)..github/, CMakeLists.txt, cmake/, setup.py, pyproject.toml.Out of scope (will be triaged but not necessarily fixed in this repo):
meshkit::Limits a caller has explicitly raised. Requests and files that exceed the limits (vertices, cells, workspace, metadata and record sizes) are refused with a reason; a crash or memory corruption instead of that refusal is in scope.main (see .github/workflows/codeql.yml)..github/workflows/scorecard.yml).