GHSA-cm77-ch27-6w6v: Path Traversal
Impact
When using the local TechDocs publisher (techdocs.publisher.type: 'local'), it was possible for the documentation serving endpoint to follow filesystem references outside the intended documentation tree, potentially exposing host files to authenticated users.
This is mitigated by the fact that exploration requires preconditions that do not arise through normal MkDocs operation. Cloud-based publishers (S3, GCS, Azure Blob Storage) are not affected.
Patches
Patched in @backstage/plugin-techdocs-node version 1.15.4
Workarounds
If you cannot upgrade immediately, consider switching to an external store for published TechDocs content (e.g. awsS3, googleGcs, or azureBlobStorage publishers)
Affected Software
Remediation
Recommended actions to resolve this vulnerability, in priority order.
- Upgrade
Upgrade
npm/@backstage/plugin-techdocs-nodeto a version that resolves this vulnerability.Fixed in 1.15.4 - Upgrade
Upgrade
@backstage/plugin-techdocs-nodeto a version that resolves this vulnerability.Fixed in 1.15.4 - Configuration
If unable to upgrade immediately, switch from the local TechDocs publisher (techdocs.publisher.type: 'local') to an external store such as awsS3, googleGcs, or azureBlobStorage.
Backstage TechDocs techdocs.publisher.type = awsS3, googleGcs, or azureBlobStorage
Event History
Frequently Asked Questions
Which deployments are affected?
Only deployments using the local TechDocs publisher (`techdocs.publisher.type: 'local'`) are affected. Cloud-based publishers using S3, GCS, or Azure Blob Storage are not affected.
What does an attacker need to exploit this issue?
The attacker would need to be an authenticated user and the documentation-serving endpoint must encounter filesystem references outside the intended documentation tree. The required conditions do not arise through normal MkDocs operation.
What should be done if upgrading is not immediately possible?
Switch published TechDocs content to an external store, such as the `awsS3`, `googleGcs`, or `azureBlobStorage` publisher.
What version contains the fix?
The issue is patched in `@backstage/plugin-techdocs-node` version 1.15.4.