-
Notifications
You must be signed in to change notification settings - Fork 2.1k
cpp: Add 'cpp/mmio-unsanitized-memcpy' query #22438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Tito0015
wants to merge
4
commits into
github:main
Choose a base branch
from
Tito0015:feature/cpp-mmio-unsanitized-memcpy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
31ca346
cpp: Add 'cpp/mmio-unsanitized-memcpy' query
Tito0015 b200dd7
Merge upstream/main into feature/cpp-mmio-unsanitized-memcpy
Tito0015 ac50b21
cpp: Add change note for mmio-unsanitized-memcpy query
Tito0015 597608a
Merge branch 'main' into feature/cpp-mmio-unsanitized-memcpy
Tito0015 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
35 changes: 35 additions & 0 deletions
35
cpp/ql/src/Security/CWE/CWE-120/MmioUnsanitizedMemcpy.qhelp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <!DOCTYPE qhelp PUBLIC | ||
| "-//Semmle//qhelp//EN" | ||
| "qhelp.dtd"> | ||
| <qhelp> | ||
| <overview> | ||
| <p> | ||
| Firmware and embedded drivers often copy data into buffers using lengths read from | ||
| memory-mapped I/O (MMIO) registers or DMA descriptor fields. When those lengths are not | ||
| validated against the destination buffer size, an attacker who can influence hardware | ||
| registers or DMA metadata can trigger buffer overflows and potentially achieve remote | ||
| code execution on microcontrollers, WiFi stacks, and cellular basebands. | ||
| </p> | ||
| </overview> | ||
| <recommendation> | ||
| <p> | ||
| Always validate MMIO/DMA-derived lengths before passing them to <code>memcpy</code>, | ||
| <code>memmove</code>, or <code>strncpy</code>. Compare against a compile-time maximum | ||
| and reject or clamp out-of-range values before copying. | ||
| </p> | ||
| </recommendation> | ||
| <example> | ||
| <p>Bad: length from an MMIO register used directly as the copy size.</p> | ||
| <sample src="MmioUnsanitizedMemcpyBad.c" /> | ||
| <p>Good: defensive bounds check before the copy.</p> | ||
| <sample src="MmioUnsanitizedMemcpyGood.c" /> | ||
| </example> | ||
| <references> | ||
| <li> | ||
| CWE-120: Buffer Copy without Checking Size of Input | ||
| </li> | ||
| <li> | ||
| CWE-787: Out-of-bounds Write | ||
| </li> | ||
| </references> | ||
| </qhelp> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /** | ||
| * @name MMIO/DMA unsanitized memory copy | ||
| * @description Memory copy sizes derived from memory-mapped I/O or DMA | ||
| * descriptor fields without bounds validation may overflow | ||
| * destination buffers. | ||
| * @kind path-problem | ||
| * @problem.severity error | ||
| * @security-severity 8.6 | ||
| * @precision medium | ||
| * @id cpp/mmio-unsanitized-memcpy | ||
| * @tags security | ||
| * external/cwe/cwe-120 | ||
| * external/cwe/cwe-787 | ||
| */ | ||
|
|
||
| import cpp | ||
| import semmle.code.cpp.dataflow.new.TaintTracking | ||
| import semmle.code.cpp.controlflow.IRGuards | ||
| import MmioFlow::PathGraph | ||
|
|
||
| /** Holds if `e` is an expression that reads MMIO/DMA hardware state. */ | ||
| predicate isMmioExpr(Expr e) { | ||
| exists(VariableAccess va | va = e and va.getTarget().isVolatile()) | ||
| or | ||
| exists(FieldAccess fa | fa = e and fa.getTarget().getType().isVolatile()) | ||
| or | ||
| exists(FunctionCall call | | ||
| call = e and | ||
| call.getTarget().hasName(["READ_REG", "GET_MMIO", "REG_READ", "DMA_READ"]) | ||
| ) | ||
| or | ||
| exists(PointerDereferenceExpr deref | | ||
| deref = e and | ||
| deref.getOperand().getUnspecifiedType() instanceof PointerType and | ||
| deref.getOperand().getUnspecifiedType().(PointerType).getBaseType().isVolatile() | ||
| ) | ||
| } | ||
|
|
||
| predicate isMmioSource(DataFlow::Node source) { | ||
| isMmioExpr(source.asExpr()) | ||
| or | ||
| exists(MacroInvocation mi | | ||
| mi.getMacro().hasName(["READ_REG", "GET_MMIO", "REG_READ", "DMA_READ"]) and | ||
| source.asExpr() = mi.getExpr() | ||
| ) | ||
| } | ||
|
|
||
| predicate isMemcpySizeSink(DataFlow::Node sink, FunctionCall fc) { | ||
| fc.getTarget().hasName(["memcpy", "memmove", "strncpy", "wmemcpy", "wmemmove"]) and | ||
| sink.asExpr() = fc.getArgument(2) | ||
| } | ||
|
|
||
| /** Recognizes relational comparison bounds checks using public IRGuards API. */ | ||
| predicate lessThanOrEqual(IRGuardCondition g, Expr e, boolean branch) { | ||
| exists(Operand left | | ||
| g.comparesLt(left, _, _, true, branch) or | ||
| g.comparesEq(left, _, _, true, branch) | ||
| | | ||
| left.getDef().getConvertedResultExpression() = e | ||
| ) | ||
| } | ||
|
|
||
| module MmioConfig implements DataFlow::ConfigSig { | ||
| predicate isSource(DataFlow::Node source) { isMmioSource(source) } | ||
|
|
||
| predicate isSink(DataFlow::Node sink) { isMemcpySizeSink(sink, _) } | ||
|
|
||
| predicate isBarrier(DataFlow::Node node) { | ||
| node = DataFlow::BarrierGuard<lessThanOrEqual/3>::getABarrierNode() or | ||
| node = DataFlow::BarrierGuard<lessThanOrEqual/3>::getAnIndirectBarrierNode() | ||
| } | ||
|
|
||
| predicate observeDiffInformedIncrementalMode() { any() } | ||
| } | ||
|
|
||
| module MmioFlow = TaintTracking::Global<MmioConfig>; | ||
|
|
||
| from FunctionCall memcpyCall, MmioFlow::PathNode source, MmioFlow::PathNode sink | ||
| where | ||
| MmioFlow::flowPath(source, sink) and | ||
| isMemcpySizeSink(sink.getNode(), memcpyCall) | ||
| select memcpyCall, source, sink, | ||
| "Memory copy size argument is derived from $@ without sufficient bounds validation.", | ||
| source.getNode(), "an MMIO/DMA hardware register read" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| #define READ_REG(addr) (*(volatile unsigned int *)(addr)) | ||
| #define MAX_DMA_LEN 64 | ||
|
|
||
| void *memcpy(void *dest, const void *src, unsigned long n); | ||
|
|
||
| void bad_mmio_memcpy(char *dst, char *src) { | ||
| unsigned int len = READ_REG(0x40001000); | ||
| memcpy(dst, src, len); | ||
| } |
10 changes: 10 additions & 0 deletions
10
cpp/ql/src/Security/CWE/CWE-120/MmioUnsanitizedMemcpyGood.c
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| #define READ_REG(addr) (*(volatile unsigned int *)(addr)) | ||
| #define MAX_DMA_LEN 64 | ||
|
|
||
| void *memcpy(void *dest, const void *src, unsigned long n); | ||
|
|
||
| void good_mmio_memcpy(char *dst, char *src) { | ||
| unsigned int len = READ_REG(0x40001000); | ||
| if (len <= MAX_DMA_LEN) | ||
| memcpy(dst, src, len); | ||
| } |
4 changes: 4 additions & 0 deletions
4
cpp/ql/src/change-notes/2026-08-31-mmio-unsanitized-memcpy.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| category: minorAnalysis | ||
| --- | ||
| * Added a new query, `cpp/mmio-unsanitized-memcpy`, to detect memory copy operations whose size argument is derived from memory-mapped I/O or DMA hardware state without sufficient bounds validation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,3 +3,6 @@ | |
| - apply: security-extended-selectors.yml | ||
| from: codeql/suite-helpers | ||
| - apply: codeql-suites/exclude-slow-queries.yml | ||
| # CWE-120: MMIO/DMA unsanitized memcpy (also selected by metadata; explicit for review) | ||
| - include: | ||
| id: cpp/mmio-unsanitized-memcpy | ||
|
Comment on lines
+6
to
+8
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This will need to go. |
||
22 changes: 22 additions & 0 deletions
22
...est/query-tests/Security/CWE/CWE-120/MmioUnsanitizedMemcpy/MmioUnsanitizedMemcpy.expected
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| #select | ||
| | test.c:21:3:21:8 | call to memcpy | test.c:20:18:20:37 | * ... | test.c:21:20:21:22 | len | Memory copy size argument is derived from $@ without sufficient bounds validation. | test.c:20:18:20:37 | * ... | an MMIO/DMA hardware register read | | ||
| | test.c:26:3:26:9 | call to memmove | test.c:25:18:25:25 | call to GET_MMIO | test.c:26:21:26:23 | len | Memory copy size argument is derived from $@ without sufficient bounds validation. | test.c:25:18:25:25 | call to GET_MMIO | an MMIO/DMA hardware register read | | ||
| | test.c:31:3:31:9 | call to strncpy | test.c:30:18:30:29 | mmio_len_reg | test.c:31:21:31:23 | len | Memory copy size argument is derived from $@ without sufficient bounds validation. | test.c:30:18:30:29 | mmio_len_reg | an MMIO/DMA hardware register read | | ||
| edges | ||
| | test.c:20:18:20:37 | * ... | test.c:20:18:20:37 | * ... | provenance | | | ||
| | test.c:20:18:20:37 | * ... | test.c:21:20:21:22 | len | provenance | | | ||
| | test.c:25:18:25:25 | call to GET_MMIO | test.c:25:18:25:25 | call to GET_MMIO | provenance | | | ||
| | test.c:25:18:25:25 | call to GET_MMIO | test.c:26:21:26:23 | len | provenance | | | ||
| | test.c:30:18:30:29 | mmio_len_reg | test.c:30:18:30:29 | mmio_len_reg | provenance | | | ||
| | test.c:30:18:30:29 | mmio_len_reg | test.c:31:21:31:23 | len | provenance | | | ||
| nodes | ||
| | test.c:20:18:20:37 | * ... | semmle.label | * ... | | ||
| | test.c:20:18:20:37 | * ... | semmle.label | * ... | | ||
| | test.c:21:20:21:22 | len | semmle.label | len | | ||
| | test.c:25:18:25:25 | call to GET_MMIO | semmle.label | call to GET_MMIO | | ||
| | test.c:25:18:25:25 | call to GET_MMIO | semmle.label | call to GET_MMIO | | ||
| | test.c:26:21:26:23 | len | semmle.label | len | | ||
| | test.c:30:18:30:29 | mmio_len_reg | semmle.label | mmio_len_reg | | ||
| | test.c:30:18:30:29 | mmio_len_reg | semmle.label | mmio_len_reg | | ||
| | test.c:31:21:31:23 | len | semmle.label | len | | ||
| subpaths |
2 changes: 2 additions & 0 deletions
2
...l/test/query-tests/Security/CWE/CWE-120/MmioUnsanitizedMemcpy/MmioUnsanitizedMemcpy.qlref
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| query: Security/CWE/CWE-120/MmioUnsanitizedMemcpy.ql | ||
| postprocess: utils/test/InlineExpectationsTestQuery.ql |
50 changes: 50 additions & 0 deletions
50
cpp/ql/test/query-tests/Security/CWE/CWE-120/MmioUnsanitizedMemcpy/test.c
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* Semmle test case for MmioUnsanitizedMemcpy.ql | ||
| * MMIO/DMA register reads flowing into memcpy/memmove/strncpy size parameters. | ||
| */ | ||
|
|
||
| typedef unsigned int uint32_t; | ||
|
|
||
| void *memcpy(void *dest, const void *src, unsigned long n); | ||
| void *memmove(void *dest, const void *src, unsigned long n); | ||
| char *strncpy(char *dest, const char *src, unsigned long n); | ||
|
|
||
| #define READ_REG(addr) (*(volatile uint32_t *)(addr)) | ||
| #define MAX_DMA_LEN 64 | ||
|
|
||
| uint32_t GET_MMIO(unsigned long addr); | ||
| uint32_t DMA_READ(unsigned long addr); | ||
|
|
||
| volatile uint32_t mmio_len_reg; | ||
|
|
||
| static void bad_read_reg(char *dst, char *src) { | ||
| uint32_t len = READ_REG(0x40001000); // $ Source | ||
| memcpy(dst, src, len); // $ Alert | ||
| } | ||
|
|
||
| static void bad_get_mmio(char *dst, char *src) { | ||
| uint32_t len = GET_MMIO(0x50000000); // $ Source | ||
| memmove(dst, src, len); // $ Alert | ||
| } | ||
|
|
||
| static void bad_volatile_global(char *dst, char *src) { | ||
| uint32_t len = mmio_len_reg; // $ Source | ||
| strncpy(dst, src, len); // $ Alert | ||
| } | ||
|
|
||
| static void good_bounded(char *dst, char *src) { | ||
| uint32_t len = READ_REG(0x40001000); | ||
| if (len <= MAX_DMA_LEN) | ||
| memcpy(dst, src, len); // GOOD | ||
| } | ||
|
|
||
| static void good_early_return(char *dst, char *src) { | ||
| uint32_t len = DMA_READ(0x60000000); | ||
| if (len > MAX_DMA_LEN) | ||
| return; | ||
| memcpy(dst, src, len); // GOOD | ||
| } | ||
|
|
||
| static void good_constant_size(char *dst, char *src) { | ||
| uint32_t len = READ_REG(0x40001000); | ||
| memcpy(dst, src, 32); // GOOD — constant size, not tainted sink | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going by your test some or all of these are macros, which means this will not work, as macros are not picked up as functions. You correct for this below, but if some of these are always macros or always functions, it would be better to avoid this duplication.