Skip to content

docs: added docs around potential decompressions bomb#10763

Merged
jasonsaayman merged 5 commits intov1.xfrom
fix/axi-198-decompression-bomb-unlimited-response-buffering
Apr 19, 2026
Merged

docs: added docs around potential decompressions bomb#10763
jasonsaayman merged 5 commits intov1.xfrom
fix/axi-198-decompression-bomb-unlimited-response-buffering

Conversation

@jasonsaayman
Copy link
Copy Markdown
Member

@jasonsaayman jasonsaayman commented Apr 19, 2026

Summary by cubic

Adds a security notice to axios docs and README about decompression-bomb risk and how to mitigate it with maxContentLength/maxBodyLength caps. Aligns with AXI-198 and keeps defaults unchanged.

Description

  • Summary of changes: README callout with example and security link; warning notes in Request Config pages; expanded Security pages with examples and rationale; follow-up copy tweaks in fr/zh.
  • Reasoning: Defaults of -1 allow DoS via gzip/deflate/brotli; set explicit caps when calling untrusted servers.
  • Additional context: Limits are enforced per chunk during streaming; defaults stay to avoid breaking legitimate large downloads.

Docs

  • /docs/ updated (en, es, fr, zh) and README links to security guide; publish site and add a release note highlighting the recommendation.

Testing

  • Docs-only change; no tests added or needed.

Semantic version impact

  • Patch (documentation only); no runtime or API changes.

Written for commit b5f2a09. Summary will update on new commits.

@jasonsaayman jasonsaayman self-assigned this Apr 19, 2026
@jasonsaayman jasonsaayman added priority::medium A medium priority commit::docs The PR is related to docs type::security The PR is a secuirty related changed normally from a CVE labels Apr 19, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 issues found across 9 files

Confidence score: 4/5

  • This PR looks safe to merge with minimal risk because the reported issues are low-severity documentation problems (1–3/10) and do not indicate runtime or code-path regressions.
  • The most important issue is in docs/fr/pages/misc/security.md: it links maxBodyLength to response decompression-bomb mitigation, which could mislead readers about request-vs-response limits in security guidance.
  • Pay close attention to docs/fr/pages/misc/security.md and docs/zh/pages/misc/security.md - fix the incorrect maxBodyLength explanation and clean up Chinese spacing/typography inconsistencies.
Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/zh/pages/misc/security.md">

<violation number="1" location="docs/zh/pages/misc/security.md:7">
P3: Remove the stray space in the Chinese sentence (`分块 强制执行` → `分块强制执行`).</violation>

<violation number="2" location="docs/zh/pages/misc/security.md:20">
P3: Remove the extra space in `为不可信来源 选择合理的上限` for consistent Chinese typography.</violation>
</file>

<file name="docs/fr/pages/misc/security.md">

<violation number="1" location="docs/fr/pages/misc/security.md:7">
P3: Cette recommandation lie `maxBodyLength` à la mitigation des bombes de décompression de réponse, alors que cette limite concerne la taille du corps de requête (upload), pas la réponse.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Comment thread docs/zh/pages/misc/security.md Outdated
Comment thread docs/zh/pages/misc/security.md Outdated
Comment thread docs/fr/pages/misc/security.md Outdated
jasonsaayman and others added 3 commits April 19, 2026 16:49
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
@jasonsaayman jasonsaayman merged commit f93f815 into v1.x Apr 19, 2026
25 checks passed
@jasonsaayman jasonsaayman deleted the fix/axi-198-decompression-bomb-unlimited-response-buffering branch April 19, 2026 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit::docs The PR is related to docs priority::medium A medium priority type::security The PR is a secuirty related changed normally from a CVE

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant