barrierModel arity mismatch: "Expected 4, but was 3" on documented-correct 3-column rows (python-all, javascript-all)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- security
Research direction
Start by reproducing the failure from .github/codeql/extensions/.../models/log-injection.yml using the CLI 2.26.4 and 2.27.0 bundles. Read ApiGraphModelsExtensions.qll and compare its barrierModel signature with the documented three-column form and the python-all/javascript-all packs. Done means confirming the valid user-facing arity and identifying whether the fix belongs in the packs, CLI validation, or documentation.
Written by the indexing model from the issue text.
Description
Summary
CodeQL fatally errors when resolving barrierModel data extensions for codeql/python-all and codeql/javascript-all, on rows that exactly match the documented, correct format (and the format used identically by sourceModel/sinkModel, per github/codeql#21004).
Repro
.github/codeql/extensions/.../models/log-injection.yml:
extensions:
- addsTo:
pack: codeql/python-all
extensible: barrierModel
data:
- ["sciemo_one_client_base.safe_log", "Member[safe_log_value].ReturnValue", "log-injection"]
This is the exact format shown in the official docs (https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-python/, "Example: Taint barrier using the 'escape' function") and matches barrierModel(type, path, kind) as formally declared in the Ruby docs' reference section.
Error
A fatal error occurred: A tuple in a data extension for the extensible predicate 'barrierModel' has an incorrect number of columns. Expected 4, but was 3.
What we tried
Assuming a genuine 4-column requirement (the trailing column being QlBuiltins::ExtensionId, per ApiGraphModelsExtensions.qll), we tried supplying a literal 4th value ourselves. None satisfy validation — all fail with:
ERROR: In extension for codeql/python-all:barrierModel, row 1 is invalid. Found '"...", "...", "log-injection", <value>', which does not match the signature 'barrierModel(string type, string path, string kind, [int origin])'.
Tried for <value>:
"manual"(string, matching theprovenanceconvention used elsewhere in MaD, e.g. sourceModel/sinkModel)0(int, repeated across rows)- unique sequential ints per row (
1000,1001,1002)
All fail identically. Per github/codeql#21004, barrierModel's trailing param is QlBuiltins::ExtensionId madId, described as "the data extension row number" — auto-populated internally, never meant to be user-supplied (same as sinkModel/sourceModel, which only ever take 3 user columns). So there appears to be no valid literal a user can write to satisfy the 4-column requirement the arity check enforces.
Versions tried (same failure on both)
- CLI 2.27.0 (codeql-bundle-v2.27.0,
python-all7.2.5 /javascript-all2.10.1, via floatingcodeql-action@v4) - CLI 2.26.4 (codeql-bundle-v2.26.4,
javascript-all/javascript-queries2.4.4, viatools:pinned explicitly to the 2.26.4 bundle asset)
Both hit the identical Expected 4, but was 3 fatal error, and identical rejection of every literal 4th-column value tried.
Why this looks like a real bug, not user error
This is the same failure class as github/codeql-action#2706 (sourceModel arity mismatch, C#, "Expected 10, but was 9"), which was triaged as a genuine bug and fixed upstream, not a documentation/config issue on the reporter's side.
Impact
We currently work around this with continue-on-error: true on the analyze job, which means our repo has had no functioning CodeQL security scanning at all (all languages, not just the one with the custom model) since the analyze step fatally errors before any queries run.
Ask
- Confirm whether
barrierModelgenuinely requires a 4th user-supplied column at these CLI versions, and if so, document the correct literal value for it. - If it should only take 3 columns (matching the documented examples and
sourceModel/sinkModel's pattern), this looks like a packaging/version-skew bug between the compiled query pack and thepython-all/javascript-alllibrary pack.
- Dominant language
- CodeQL
- Stars
- 10.1k
- Forks
- 2.1k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 134
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/codeql
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
C#: cs/simplifiable-boolean-expression false positive on Nullable<bool> compared with a literal Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
false-positive
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
false-positive
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Similar issues
-
Product: Azure Policy :shield: Topic: Diagnostic Settings :test_tube: Topic: Policy :pencil:
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
Azure/Azure-Landing-Zones#4283 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
MystenLabs/MemWal#979 · 1 comment ·
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 82/100
EclipseFdn/open-vsx.org#13384 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
documentation
Difficulty 2/5 Half a day Newbie friendliness 62/100
inmanta/inmanta-core#10835 ·