swagger-api / swagger-api/swagger-codegen

[CDN]: Support Subresource integrity

Open
#12,590 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Feature Description

Support optional Subresource Integrity (SRI) metadata for swagger-ui-dist CDN bundles

Provide published integrity= and crossorigin= attributes for official CDN‑hosted Swagger UI assets (e.g. swagger-ui-bundle.js, swagger-ui.css) to enable runtime integrity validation in browsers.

Problem it solves:

  • Scanners currently flag missing integrity attributes as a security weakness.
  • Without SRI, there’s no protection against CDN supply‑chain tampering.
  • Security teams require measurable mitigation—even for client‑side docs.
  • Resolves Security Weakness CWE-693, OWASP A1 Broken Access Control

Use Case

  • Security tooling flags missing SRI on Swagger UI assets delivered via jsDelivr
  • This causes false‑positive vulnerability findings across nearly all Swagger UI deployments using CDN.
  • Teams want to satisfy compliance requirements with minimal overhead.
  • Public or internal docs could benefit from SRI for trust and auditability.

Suggested Solution

  • Automatically generate SRI hashes (e.g. sha384‑...) for each release and surface them in package metadata or CDN meta pages.
  • Provide example HTML snippets with <script>/<link> including integrity and crossorigin="anonymous".
  • Offer versioned integrity manifest files (e.g., .integrity.json) to support pinning across releases.
  • Add crossorigin="anonymous" hints to prevent integrity validation issues in browsers

Alternatives Considered

  • Self‑hosting Swagger UI assets and generating hashes manually — works, but is brittle and maintenance-heavy, risks not getting updtes via FastAPI
  • Restricting or disabling docs in production (e.g., with auth or IP filtering) — defeats the purpose of users reading documentation

Additional Context

  • There is an existing GitHub discussion: “Add integrity attributes to check security of CDN resources” (#11163), but it remains unanswered.

✅ Checklist
  • Searched existing issues — #11163 covers this request.
  • Use case is broadly applicable across many Swagger UI consumers.
  • Enough technical context provided (asset formats, distribution channels, workaround options).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how release assets such as swagger-ui-bundle.js and swagger-ui.css are published through the CDN, then review the proposed .integrity.json manifest and example HTML snippets. Done means each release exposes usable SRI hashes and crossorigin="anonymous" guidance for the official assets, with the scope aligned to discussion #11163.

Written by the indexing model from the issue text.

Assessment

Domain
security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.