Skip to content

docs: clarify host-level firewall requirements#5860

Merged
JamesC1305 merged 3 commits into
firecracker-microvm:mainfrom
JamesC1305:clarify-mmds-toctou
May 6, 2026
Merged

docs: clarify host-level firewall requirements#5860
JamesC1305 merged 3 commits into
firecracker-microvm:mainfrom
JamesC1305:clarify-mmds-toctou

Conversation

@JamesC1305
Copy link
Copy Markdown
Contributor

Clarify threat model to emphasise that outbound traffic from the guest should be treated as untrusted, and that host-level filtering should be implemented.

Add a section to the MMDS design docs to emphasise that the MMDS network stack should not be relied on to filter guest egress.

Add an entry to prod host setup suggesting firewall rules should be setup for guest VM outbound traffic.

Also add a comment to write_to_mmds_or_tap to clarify that Firecracker is not responsible for packet filtering, and therefore we will not fix a TOCTOU allowing guests to race and avoid MMDS packet detouring.

Changes

...

Reason

...

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkbuild --all to verify that the PR passes
    build checks on all supported architectures.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

Clarify threat model to emphasise that outbound traffic from the guest
should be treated as untrusted, and that host-level filtering should be
implemented.

Add a section to the MMDS design docs to emphasise that the MMDS network
stack should not be relied on to filter guest egress.

Add an entry to prod host setup suggesting firewall rules should be
setup for guest VM outbound traffic.

Also add a comment to write_to_mmds_or_tap to clarify that Firecracker
is not responsible for packet filtering, and therefore we will not fix a
TOCTOU allowing guests to race and avoid MMDS packet detouring.

Signed-off-by: James Curtis <jxcurtis@amazon.co.uk>
@JamesC1305 JamesC1305 added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Apr 27, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.80%. Comparing base (e7e0efe) to head (7ee1098).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5860      +/-   ##
==========================================
+ Coverage   82.62%   82.80%   +0.18%     
==========================================
  Files         275      277       +2     
  Lines       29750    29895     +145     
==========================================
+ Hits        24581    24756     +175     
+ Misses       5169     5139      -30     
Flag Coverage Δ
5.10-m5n.metal 83.10% <ø> (?)
5.10-m6a.metal 82.43% <ø> (?)
5.10-m6g.metal 79.73% <ø> (ø)
5.10-m6i.metal 83.10% <ø> (?)
5.10-m7a.metal-48xl 82.42% <ø> (?)
5.10-m7g.metal 79.73% <ø> (ø)
5.10-m7i.metal-24xl 83.07% <ø> (?)
5.10-m7i.metal-48xl 83.08% <ø> (?)
5.10-m8g.metal-24xl 79.73% <ø> (ø)
5.10-m8g.metal-48xl 79.73% <ø> (ø)
5.10-m8i.metal-48xl 83.07% <ø> (?)
5.10-m8i.metal-96xl 83.07% <ø> (?)
6.1-m5n.metal 83.12% <ø> (?)
6.1-m6a.metal 82.45% <ø> (?)
6.1-m6g.metal 79.73% <ø> (-0.01%) ⬇️
6.1-m6i.metal 83.12% <ø> (+<0.01%) ⬆️
6.1-m7a.metal-48xl 82.45% <ø> (?)
6.1-m7g.metal 79.73% <ø> (ø)
6.1-m7i.metal-24xl 83.14% <ø> (?)
6.1-m7i.metal-48xl 83.14% <ø> (?)
6.1-m8g.metal-24xl 79.73% <ø> (-0.01%) ⬇️
6.1-m8g.metal-48xl 79.73% <ø> (+<0.01%) ⬆️
6.1-m8i.metal-48xl 83.14% <ø> (?)
6.1-m8i.metal-96xl 83.14% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JamesC1305 JamesC1305 enabled auto-merge (rebase) May 5, 2026 16:08
@JamesC1305 JamesC1305 merged commit fe9f12a into firecracker-microvm:main May 6, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Awaiting review Indicates that a pull request is ready to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants