Skip to content
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

Fixes JSONPath boundary finding for booleans #561

Merged
merged 5 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions AppInspector.Benchmarks/AppInspector.Benchmarks.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="BenchmarkDotNet" Version="0.13.6" />
<PackageReference Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.13.6" />
<PackageReference Include="BenchmarkDotNet" Version="0.13.8" />
<PackageReference Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.13.8" />

</ItemGroup>
<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion AppInspector.CLI/AppInspector.CLI.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@

<ItemGroup>
<PackageReference Include="DotLiquid" Version="2.2.692" />
<PackageReference Include="Sarif.Sdk" Version="4.2.2" />
<PackageReference Include="Sarif.Sdk" Version="4.3.1" />
<PackageReference Include="Serilog" Version="3.0.1" />
<PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
<PackageReference Include="Serilog.Sinks.Console" Version="4.1.0" />
Expand Down
6 changes: 3 additions & 3 deletions AppInspector.RulesEngine/AppInspector.RulesEngine.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
<ItemGroup>
<PackageReference Include="gstocco.YamlDotNet.YamlPath" Version="1.0.16" />
<PackageReference Include="JsonCons.JsonPath" Version="1.1.0" />
<PackageReference Include="Microsoft.CST.OAT" Version="1.2.49" />
<PackageReference Include="Microsoft.CST.RecursiveExtractor" Version="1.2.16" />
<PackageReference Include="Microsoft.CST.OAT" Version="1.2.54" />
<PackageReference Include="Microsoft.CST.RecursiveExtractor" Version="1.2.17" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
<PackageReference Include="YamlDotNet" Version="13.1.1" />
<PackageReference Include="YamlDotNet" Version="13.3.1" />
</ItemGroup>

<ItemGroup>
Expand Down
3 changes: 2 additions & 1 deletion AppInspector.RulesEngine/TextContainer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@ public TextContainer(string content, string language, Languages languages, ILogg
// The idx field is the start of the JSON element, including markup that isn't directly part of the element itself
if (field.GetValue(ele) is int idx)
{
var eleString = ele.ToString();
// ele.ToString doesn't return the raw string from the json for booleans, it returns a capitalized False/True but JSON requires lower case false/true to parse
var eleString = ele.ValueKind is JsonValueKind.False ? "false" : ele.ValueKind is JsonValueKind.True ? "true" : ele.ToString();
if (eleString is { } denulledString)
{
var location = new Boundary
Expand Down
2 changes: 1 addition & 1 deletion AppInspector.Tests/AppInspector.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Logging" Version="7.0.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
<PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
<PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
<PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
Expand Down
51 changes: 51 additions & 0 deletions AppInspector.Tests/RuleProcessor/XmlAndJsonTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,57 @@ public void XmlStringRule(string rule)
}
}

[TestMethod]
public void JsonBooleanRule()
{
var testContent = @"{
""list"":
[
{
""field1"": ""Foo"",
""field2"": ""Bar"",
""field3"": false
},
{
""field1"": ""Contoso"",
""field2"": ""Elephant"",
""field3"": true
}
]
}";
var testRule = @"[
{
""id"": ""Field3true"",
""name"": ""Testing.Rules.JSON"",
""tags"": [
""Testing.Rules.JSON""
],
""severity"": ""Critical"",
""confidence"": ""High"",
""description"": ""This rule finds field3 is true"",
""patterns"": [
{
""pattern"": ""true"",
""type"": ""regex"",
""confidence"": ""High"",
""jsonpaths"" : [""$.list[*].field3""]
}
]
}
]";
RuleSet rules = new();
var originalSource = "TestRules";
rules.AddString(testRule, originalSource);
var analyzer = new Microsoft.ApplicationInspector.RulesEngine.RuleProcessor(rules,
new RuleProcessorOptions { Parallel = false, AllowAllTagsInBuildFiles = true });
if (_languages.FromFileNameOut("test.json", out var info))
{
var matches = analyzer.AnalyzeFile(testContent, new FileEntry("test.json", new MemoryStream()), info);
Assert.AreEqual(1, matches.Count);
Assert.AreEqual(237, matches[0].Boundary.Index);
}
}

[TestMethod]
public void TestYml()
{
Expand Down
4 changes: 2 additions & 2 deletions AppInspector/AppInspector.Commands.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
<PackageReference Include="DotLiquid" Version="2.2.692" />
<PackageReference Include="Glob" Version="1.1.9" />
<PackageReference Include="LibGit2Sharp" Version="0.27.2" />
<PackageReference Include="Microsoft.CST.OAT" Version="1.2.49" />
<PackageReference Include="Microsoft.CST.RecursiveExtractor" Version="1.2.16" />
<PackageReference Include="Microsoft.CST.OAT" Version="1.2.54" />
<PackageReference Include="Microsoft.CST.RecursiveExtractor" Version="1.2.17" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
<PackageReference Include="ShellProgressBar" Version="5.2.0" />
<PackageReference Include="System.Reflection.Metadata" Version="7.0.2" />
Expand Down