|
| 1 | +# Security and Disclosure Information Policy for the Docling Project |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## Supported Versions |
| 6 | + |
| 7 | +The latest versions of all Docling repositories are supported. |
| 8 | + |
| 9 | +### Security |
| 10 | + |
| 11 | +- 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 |
| 12 | +- Use of [HTTPS](https://en.wikipedia.org/wiki/HTTPS) for network communication |
| 13 | +- Use of secure protocols for network communication (through the use of HTTPS) |
| 14 | +- Up-to-date support for TLS/SSL (through the use of [OpenSSL](https://www.openssl.org/)) |
| 15 | +- Performance of TLS certificate verification by default before sending HTTP headers with private information (through the use of OpenSSL and HTTPS) |
| 16 | +- 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) |
| 17 | +- Use of [GitHub](https://github.com/) Issues for vulnerability reporting and tracking |
| 18 | + |
| 19 | +### Analysis |
| 20 | + |
| 21 | +- 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 |
| 22 | +- Use of GitHub Issues for bug reporting and tracking |
| 23 | + |
| 24 | +## Reporting a Vulnerability |
| 25 | + |
| 26 | +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. |
| 27 | + |
| 28 | +### Preferred Method: GitHub Private Vulnerability Reporting |
| 29 | + |
| 30 | +**We strongly encourage you to use GitHub's Private Vulnerability Reporting feature**, which provides a secure and streamlined process for disclosing security issues: |
| 31 | + |
| 32 | +1. Navigate to the **Security tab** of the specific Docling repository where the vulnerability exists (e.g., `https://github.com/docling-project/<repository-name>/security`) |
| 33 | + - 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. |
| 34 | +2. Click on "Report a vulnerability" |
| 35 | +3. Fill out the vulnerability report form with as many details as possible |
| 36 | +4. Submit the report |
| 37 | + |
| 38 | +This method allows for: |
| 39 | +- **Secure communication** directly with the maintainers team |
| 40 | +- **Coordinated disclosure** through GitHub's built-in workflow |
| 41 | +- **Automatic tracking** of the vulnerability lifecycle |
| 42 | +- **Credit attribution** when the vulnerability is published |
| 43 | + |
| 44 | +### Alternative Method: Email Disclosure |
| 45 | + |
| 46 | +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. |
| 47 | + |
| 48 | +**Important:** Please do not create a public issue or discuss the vulnerability in any public channel until it has been addressed. |
| 49 | + |
| 50 | +### Security Vulnerability Response |
| 51 | + |
| 52 | +Each report is acknowledged and analyzed by the core maintainers within 3 working days. |
| 53 | + |
| 54 | +Any vulnerability information shared with core maintainers stays within the Docling project and will not be disseminated to other projects unless it is necessary to get the issue fixed. |
| 55 | + |
| 56 | +After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. |
| 57 | + |
| 58 | +## Security Alerts |
| 59 | + |
| 60 | +We will send announcements of security vulnerabilities and steps to remediate on the [Docling announcements](https://github.com/docling-project/docling/discussions/categories/announcements). |
0 commit comments