pr: Let parser detector detect other categories of operations.

trailofbits · Nov 27, 2024 · a5c3474 · a5c3474
1 parent fd73384
commit a5c3474
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 35 deletions.
diff --git a/tools/vast-detect-parsers/ParserCategoryDetector.cpp b/tools/vast-detect-parsers/ParserCategoryDetector.cpp
@@ -0,0 +1,69 @@
+// Copyright (c) 2024, Trail of Bits, Inc.
+
+#ifdef VAST_ENABLE_SARIF
+    #include "SarifPasses.hpp"
+
+    #include "vast/Dialect/Parser/Ops.hpp"
+    #include "vast/Frontend/Sarif.hpp"
+
+namespace vast {
+    void ParserCategoryDetector::runOnOperation() {
+        getOperation().walk([&](pr::Source op) {
+            gap::sarif::result result{
+                .ruleId{ "pr-source" },
+                .ruleIndex = 0,
+                .kind      = gap::sarif::kind::kInformational,
+                .level     = gap::sarif::level::kNote,
+                .message{
+                    .text{ { "Parser source detected" } },
+                },
+                .locations{},
+            };
+            if (auto loc = cc::sarif::mk_location(op.getLoc());
+                loc.physicalLocation.has_value())
+            {
+                result.locations.push_back(std::move(loc));
+            }
+            results.push_back(result);
+        });
+
+        getOperation().walk([&](pr::Sink op) {
+            gap::sarif::result result{
+                .ruleId{ "pr-sink" },
+                .ruleIndex = 0,
+                .kind      = gap::sarif::kind::kInformational,
+                .level     = gap::sarif::level::kNote,
+                .message{
+                    .text{ { "Parser sink detected" } },
+                },
+                .locations{},
+            };
+            if (auto loc = cc::sarif::mk_location(op.getLoc());
+                loc.physicalLocation.has_value())
+            {
+                result.locations.push_back(std::move(loc));
+            }
+            results.push_back(result);
+        });
+
+        getOperation().walk([&](pr::Parse op) {
+            gap::sarif::result result{
+                .ruleId{ "pr-parse" },
+                .ruleIndex = 0,
+                .kind      = gap::sarif::kind::kInformational,
+                .level     = gap::sarif::level::kNote,
+                .message{
+                    .text{ { "Parsing operation detected" } },
+                },
+                .locations{},
+            };
+            if (auto loc = cc::sarif::mk_location(op.getLoc());
+                loc.physicalLocation.has_value())
+            {
+                result.locations.push_back(std::move(loc));
+            }
+            results.push_back(result);
+        });
+    }
+} // namespace vast
+#endif
diff --git a/tools/vast-detect-parsers/ParserSourceDetector.cpp b/tools/vast-detect-parsers/ParserSourceDetector.cpp
diff --git a/tools/vast-detect-parsers/SarifPasses.hpp b/tools/vast-detect-parsers/SarifPasses.hpp
@@ -14,12 +14,12 @@ VAST_UNRELAX_WARNINGS
     #include <gap/sarif/sarif.hpp>
 
 namespace vast {
-    struct ParserSourceDetector
-        : mlir::PassWrapper< ParserSourceDetector, mlir::OperationPass< mlir::ModuleOp > >
+    struct ParserCategoryDetector
+        : mlir::PassWrapper< ParserCategoryDetector, mlir::OperationPass< mlir::ModuleOp > >
     {
         std::vector< gap::sarif::result > &results;
 
-        ParserSourceDetector(std::vector< gap::sarif::result > &results) : results(results) {}
+        ParserCategoryDetector(std::vector< gap::sarif::result > &results) : results(results) {}
 
         void runOnOperation() override;
     };

diff --git a/tools/vast-detect-parsers/main.cpp b/tools/vast-detect-parsers/main.cpp
@@ -73,7 +73,7 @@ namespace vast {
             "parser-source-to-sarif", "Dumps all pr.source locations to a SARIF file.",
             [](mlir::OpPassManager &pm, const SarifOptions &opts) {
                 auto writer = std::make_unique< SarifWriter >(opts.out_path);
-                pm.addPass(std::make_unique< vast::ParserSourceDetector >(writer->results));
+                pm.addPass(std::make_unique< vast::ParserCategoryDetector >(writer->results));
                 pm.addPass(std::move(writer));
             }
         );