Skip to content

[drivers][ivshmem] Validate the shared memory window - #11993

Open
BernardXiong wants to merge 2 commits into
RT-Thread:masterfrom
BernardXiong:fix/ivshmem-shmem-window-validation
Open

BernardXiong wants to merge 2 commits into
RT-Thread:masterfrom
BernardXiong:fix/ivshmem-shmem-window-validation

Conversation

@BernardXiong

Copy link
Copy Markdown
Member

Summary

When BAR2 is absent, ivshmem_pci_probe() takes the JailHouse fallback and copies the shared memory address and size from the device-controlled PCI config words at 0x40..0x4f. The PCI core never validates these values, and rt_ioremap() maps whatever physical range it is given. A malicious or ill-formatted ivshmem device can therefore make the kernel map an arbitrary physical window (for example kernel RAM) and expose it to user space through /dev/ivshmemN, giving unprivileged processes arbitrary kernel memory read/write.

Changes

  • Only use the config space fallback when the new RT_IVSHMEM_JAILHOUSE option is enabled. It defaults to n, and its help text documents that the device must be trusted. Without it, a valid BAR2 is required.
  • Validate the window before rt_ioremap(): non-zero size, no address overflow, and the whole range must be representable with native pointer/size types.
  • Read the four config words into 64-bit locals instead of writing through 32-bit aliases of the shmem and shmem_size fields (which also corrupted adjacent fields on 32-bit builds).
  • Check the return value of the config space reads.

Fixes #11992

Testing

Changed files pass clang-format 22.1.8. The ivshmem driver compiles in both configurations (RT_IVSHMEM_JAILHOUSE=n and =y) for bsp/qemu-virt64-aarch64 with RT_USING_PCI, RT_PCI_MSI and RT_USING_IVSHMEM enabled. CI will confirm the full build.

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • Use workflow from 保持默认分支(通常为 master)
    Keep the default branch (usually master) in Use workflow from
  • 在 branch 输入框填写 PR 分支 fix/ivshmem-shmem-window-validation
    Enter PR branch fix/ivshmem-shmem-window-validation in the branch field
  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将作为独立提交推送至你的分支。
    The formatting changes will be pushed to your branch as a separate commit.

完成后,提交将自动更新至 fix/ivshmem-shmem-window-validation 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the fix/ivshmem-shmem-window-validation branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: components

Reviewers: @Maihuanyi

Changed Files (Click to expand)
  • components/drivers/ivshmem/Kconfig
  • components/drivers/ivshmem/ivshmem.c

📊 Current Review Status (Last Updated: 2026-11-14 00:05 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

The shared memory address and size in the ivshmem PCI config space
(0x40..0x4f) are controlled by the device. ivshmem_pci_probe() used them
verbatim as a JailHouse fallback when BAR2 was absent, so a malicious
device could make the kernel map an arbitrary physical window and expose
it to user space through /dev/ivshmemN.

Only use the config space fallback when RT_IVSHMEM_JAILHOUSE is enabled,
and validate the window (non-zero size, no overflow and representable by
native pointer and size types) before mapping. Read the four config words
into 64-bit locals instead of writing through 32-bit aliases of the
pointer and size fields, and check the config space read result.

Fixes RT-Thread#11992
@BernardXiong
BernardXiong force-pushed the fix/ivshmem-shmem-window-validation branch from 0bc5e16 to 6bee4a6 Compare November 6, 2026 16:06

@Rbb666 Rbb666 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

复核提交 6bee4a6:默认关闭设备配置空间回退、使用 64 位临时变量读取配置的方向正确,但新增窗口校验仍漏掉长度转换和资源类型两个边界,请处理下列行内意见。建议增加 32 位长度溢出与 I/O BAR 的负向测试。非阻塞:标题/提交前缀建议改为小写 [drivers][ivshmem]。

}

/* The whole window must be representable with native pointer and size types */
if (size - 1 > max_addr - addr)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

[P2] 单独检查 size 是否能由 rt_size_t 表示

此处只验证最后一个地址可表示,并不等价于长度可表示。32 位配置下,addr=0、size=0x100000000 会通过检查(size-1 恰好等于 max_addr),随后第 181 行转换成 rt_size_t 得到 0,仍被作为有效窗口交给 rt_ioremap()。这与函数“排除零长度并保证 native size 可表示”的契约相反。请在转换前显式拒绝 size > (rt_uint64_t)(rt_size_t)-1,并覆盖零长度、4 GiB 长度及接近地址上界的测试;映射前也应确保页对齐后的映射长度不会溢出。

Comment thread components/drivers/ivshmem/ivshmem.c Outdated
* The JailHouse config words are controlled by the device and are only
* used when the platform explicitly opts in.
*/
if (shmem_res->flags != PCI_BUS_REGION_F_NONE &&

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

[P2] 共享内存窗口必须拒绝 I/O 类型的 BAR

flags != PCI_BUS_REGION_F_NONE 同样接受 PCI_BUS_REGION_F_IO。PCI 核心会根据设备声明把这类 BAR 分配到 I/O region,但下面无条件把其 base 当作物理内存交给 rt_ioremap(),之后还会暴露给 /dev/ivshmemN;在端口 I/O 与物理内存分离的平台上,这不是对应的共享内存资源。请显式限定为 memory / prefetchable-memory BAR,并把 I/O BAR 作为无效共享内存窗口拒绝(或仅在明确启用的 JailHouse 回退策略下处理),补一个 size 非零但 flags=PCI_BUS_REGION_F_IO 的负向验证。

ivshmem_shmem_range_valid() only checked the last address of the window, so
a 4 GiB length on a 32-bit platform passed validation and was truncated to
zero when converted to rt_size_t. Reject lengths that rt_size_t cannot
represent and page-aligned mapping lengths that would overflow.

Only memory and prefetchable memory BARs may describe the shared memory
window; an I/O BAR was accepted before and then passed to rt_ioremap().
@BernardXiong
BernardXiong force-pushed the fix/ivshmem-shmem-window-validation branch from 35d9bd6 to 9226535 Compare November 13, 2026 16:05
@BernardXiong

Copy link
Copy Markdown
Member Author

已在新提交 92265354 处理两条行内意见:

  • 长度转换:ivshmem_shmem_range_valid() 在转换前显式拒绝 size > (rt_size_t)-1,并按 rt_ioremap() 的页块对齐方式校验 size + 页内偏移 与对齐后长度不会在 rt_size_t 中溢出。32 位下 4 GiB 长度、地址加长度越界、页对齐溢出都会返回 -RT_EINVAL。
  • BAR 类型:只接受 PCI_BUS_REGION_F_MEM / PCI_BUS_REGION_F_PREFETCH,PCI_BUS_REGION_F_IO 的 BAR 不会再传给 rt_ioremap()。
  • 验证:以 32 位 rt_size_t 为模型对校验函数做了宿主侧负向检查(零长度、4 GiB、地址空间顶端、页对齐溢出等 10 个用例)全部通过。仓库内暂无 ivshmem 的 utest 框架,本次未新增仓库内用例;如有需要,可以补一组基于模拟 rt_pci_bus_resource 的 utest。

非阻塞项:PR 标题已改为小写 [drivers][ivshmem];提交信息保留 fix(drivers): ... 以符合仓库提交规范。

English: both inline findings are addressed in 92265354. Lengths that rt_size_t cannot represent (including a 4 GiB window on 32-bit) and page-alignment overflows are rejected before the cast; only memory/prefetchable BARs are accepted, so an I/O BAR is never passed to rt_ioremap(). Negative cases were checked host-side against a 32-bit rt_size_t model (10 cases). No ivshmem utest harness exists in-tree, so no repository test was added.

@BernardXiong BernardXiong changed the title [DM/PCI] Validate ivshmem shared memory window [drivers][ivshmem] Validate the shared memory window Nov 13, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

2 participants