diff --git a/.github/SECURITY.md b/.github/SECURITY.md index c3b84ca..5656ca0 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -2,15 +2,52 @@ The Docling team and community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. +## Supported Versions + +The latest versions of all Docling repositories are supported. + +### Security + +- Participation in the [OpenSSF Best Practices Badge Program](https://bestpractices.coreinfrastructure.org/en/projects/10101) for Free/Libre and FLOSS projects to ensure that we follow current best practices for quality and security +- Use of [HTTPS](https://en.wikipedia.org/wiki/HTTPS) for network communication +- Use of secure protocols for network communication (through the use of HTTPS) +- Up-to-date support for TLS/SSL (through the use of [OpenSSL](https://www.openssl.org/)) +- Performance of TLS certificate verification by default before sending HTTP headers with private information (through the use of OpenSSL and HTTPS) +- Distribution of the software via cryptographically signed releases (on the [PyPI](https://pypi.org/), [Quay.io](https://quay.io/organization/docling-project/) and [GHCR.io](https://github.com/orgs/docling-project/packages) package repositories) +- Use of [GitHub](https://github.com/) Issues for vulnerability reporting and tracking + +### Analysis + +- Use of [Ruff](https://docs.astral.sh/ruff/), [Mypy](https://mypy.readthedocs.io/) and [Pytest](https://docs.pytest.org/en/7.2.x/) for Python code linting (static and dynamic analysers) on pull requests and builds +- Use of GitHub Issues for bug reporting and tracking + ## Reporting a Vulnerability -If you think you've identified a security issue in an Docling project repository, please DO NOT report the issue publicly via the GitHub issue tracker, etc. +If you think you've identified a security issue in any Docling project repository, please DO NOT report the issue publicly via the GitHub issue tracker, discussions, or any other public forum. -Instead, send an email with as many details as possible to [deepsearch-core@zurich.ibm.com](mailto:deepsearch-core@zurich.ibm.com). This is a private mailing list for the maintainers team. +### Preferred Method: GitHub Private Vulnerability Reporting -Please do not create a public issue. +**We strongly encourage you to use GitHub's Private Vulnerability Reporting feature**, which provides a secure and streamlined process for disclosing security issues: -## Security Vulnerability Response +1. Navigate to the **Security tab** of the specific Docling repository where the vulnerability exists (e.g., `https://github.com/docling-project//security`) + - For example: [docling](https://github.com/docling-project/docling/security), [docling-core](https://github.com/docling-project/docling-core/security), [docling-parse](https://github.com/docling-project/docling-parse/security), etc. +2. Click on "Report a vulnerability" +3. Fill out the vulnerability report form with as many details as possible +4. Submit the report + +This method allows for: +- **Secure communication** directly with the maintainers team +- **Coordinated disclosure** through GitHub's built-in workflow +- **Automatic tracking** of the vulnerability lifecycle +- **Credit attribution** when the vulnerability is published + +### Alternative Method: Email Disclosure + +Alternatively, you can send an email with as many details as possible to [deepsearch-core@zurich.ibm.com](mailto:deepsearch-core@zurich.ibm.com). This is a private mailing list for the maintainers team. + +**Important:** Please do not create a public issue or discuss the vulnerability in any public channel until it has been addressed. + +### Security Vulnerability Response Each report is acknowledged and analyzed by the core maintainers within 3 working days. @@ -20,4 +57,4 @@ After the initial reply to your report, the security team will keep you informed ## Security Alerts -We will send announcements of security vulnerabilities and steps to remediate on the [Docling announcements](https://github.com/docling-project/docling-jobkit/discussions/categories/announcements). +We will send announcements of security vulnerabilities and steps to remediate on the [Docling announcements](https://github.com/docling-project/docling/discussions/categories/announcements).