The following versions of okph are currently supported with security updates:
| Version | Supported |
|---|---|
| 0.9.x | ✅ |
| < 0.9 | ❌ |
We take the security of okph seriously. If you believe you have found a security vulnerability, please follow the guidelines below.
Please do not report security vulnerabilities through public GitHub issues.
Instead, please send vulnerability reports by email to: au54vz9rk@mozmail.com
Please include the following information in your report:
- Type of issue (e.g., information disclosure, ReDoS, prototype pollution, injection via error messages, etc.)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit it
You should receive a response within 5 business days. If for some reason you do not, please follow up via email to ensure we received your original message.
When we receive a security bug report, we will:
- Confirm the problem and determine the affected versions.
- Audit code to find any potential similar problems.
- Prepare fixes for all supported versions.
- Release new versions and notify users as quickly as possible.
We will coordinate a release date with the reporter to ensure the fix is available before the vulnerability is made public.
When using okph in your application:
- Keep the library updated to the latest version
- Validate and sanitize all markdown content before graphing if it comes from untrusted sources
- Run
okphoffline — it does not make network calls - Keep the lockfile committed and review dependency changes in CI
-
--git(onaffectedandvalidate) runs your localgitagainst the scanned repository. Git reads that repository's config, and some settings can execute commands.okphdisablescore.fsmonitorand external diff drivers, but it cannot enumerate every such setting (for example, clean filters named in the repo's own.git/config). Do not use--giton a checkout you do not trust.okphpasses arguments as an argv array (no shell) and rejects a<base>starting with-. -
validate --githides warnings outside the changed set. Errors are never scoped, but keep a fullvalidaterun on your main branch as the authoritative check. -
Very deeply nested markdown (e.g. thousands of nested blockquotes or list levels, well under the per-file size limit) overflows the stack in the
markedlexer.okphreports the error and exits non-zero; it does not hang or corrupt data. Files deep enough to be a realistic DoS vector are not valid OKF documents.
We thank the security researchers and community members who help keep okph and its users safe by reporting vulnerabilities responsibly.