[swiftsrc2cpg] Added support for binary .plist files (#5691)

Author: max-leuthaeuser

joern-cli/frontends/swiftsrc2cpg/build.sbt

@@ -26,7 +26,9 @@ libraryDependencies ++= Seq(
   "io.shiftleft" %% "codepropertygraph" % Versions.cpg,
   "com.lihaoyi"  %% "upickle"           % Versions.upickle,
   // we want to use also Google Gson for its streaming abilities for very large Json files:
-  "com.google.code.gson" % "gson"      % Versions.gson,
+  "com.google.code.gson" % "gson" % Versions.gson,
+  // to handle property list files of various formats (i.e., binary and plain XML)
+  "com.googlecode.plist" % "dd-plist"  % "1.28",
   "org.scalatest"       %% "scalatest" % Versions.scalatest % Test
 )
 

joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/passes/ConfigFileCreationPass.scala

@@ -1,18 +1,54 @@
 package io.joern.swiftsrc2cpg.passes
 
+import com.dd.plist.PropertyListParser
 import io.joern.swiftsrc2cpg.Config
 import io.joern.swiftsrc2cpg.utils.AstGenRunner
 import io.joern.x2cpg.passes.frontend.XConfigFileCreationPass
 import io.shiftleft.codepropertygraph.generated.Cpg
+import io.shiftleft.codepropertygraph.generated.nodes.NewConfigFile
+import io.shiftleft.semanticcpg.utils.FileUtil.*
+import io.shiftleft.utils.IOUtils
+import org.slf4j.LoggerFactory
 
 import java.nio.file.Path
+import scala.util.{Failure, Success, Try}
 
 class ConfigFileCreationPass(cpg: Cpg, config: Config)
     extends XConfigFileCreationPass(
       cpg,
       config = config.withDefaultIgnoredFilesRegex(AstGenRunner.AstGenDefaultIgnoreRegex)
     ) {
 
-  override val configFileFilters: List[Path => Boolean] = List(extensionFilter(".plist"), extensionFilter(".xib"))
+  private val logger = LoggerFactory.getLogger(this.getClass)
 
+  private val PlistExt: String = ".plist"
+
+  override val configFileFilters: List[Path => Boolean] = List(extensionFilter(PlistExt), extensionFilter(".xib"))
+
+  private def isBinaryPlist(file: Path): Boolean = {
+    if (!file.extension().contains(PlistExt)) return false
+    Try(IOUtils.readLinesInFile(file)) match {
+      case Success(dataBeginning :: _) => dataBeginning.trim.startsWith("bplist")
+      case _                           => false
+    }
+  }
+
+  override def runOnPart(diffGraph: DiffGraphBuilder, file: Path): Unit = {
+    val parseResult = if (isBinaryPlist(file)) {
+      val sourceComment = s"\n<!--This file was generated from ${file.toAbsolutePath}-->"
+      Try((PropertyListParser.parse(file.toFile).toXMLPropertyList, sourceComment))
+    } else {
+      Try((IOUtils.readEntireFile(file), ""))
+    }
+    parseResult match {
+      case Success((content, sourceComment)) =>
+        val configFileContent = s"$content$sourceComment"
+        val name              = configFileName(file)
+        val configNode        = NewConfigFile().name(name).content(configFileContent)
+        logger.debug(s"Adding config file $name")
+        diffGraph.addNode(configNode)
+      case Failure(error) =>
+        logger.warn(s"Unable to create config file node for ${file.toAbsolutePath}: $error")
+    }
+  }
 }

joern-cli/frontends/swiftsrc2cpg/src/test/scala/io/joern/swiftsrc2cpg/passes/config/ConfigFileCreationPassTests.scala

@@ -0,0 +1,77 @@
+package io.joern.swiftsrc2cpg.passes.config
+
+import com.dd.plist.PropertyListConverter
+import flatgraph.DNode
+import io.joern.swiftsrc2cpg.Config
+import io.joern.swiftsrc2cpg.passes.ConfigFileCreationPass
+import io.shiftleft.codepropertygraph.generated.GraphSchema
+import io.shiftleft.codepropertygraph.generated.nodes.NewConfigFile
+import io.shiftleft.semanticcpg.utils.FileUtil
+import org.scalatest.funspec.AnyFunSpec
+import org.scalatest.matchers.should.Matchers
+
+import java.nio.file.Files
+
+class ConfigFileCreationPassTests extends AnyFunSpec with Matchers {
+
+  private class TestDiffGraphBuilder extends io.shiftleft.codepropertygraph.generated.DiffGraphBuilder(GraphSchema) {
+    val nodes = scala.collection.mutable.Buffer[DNode]()
+    override def addNode(newNode: DNode): this.type = {
+      this.nodes.append(newNode)
+      this
+    }
+  }
+
+  private val Xml: String =
+    """<?xml version="1.0" encoding="UTF-8"?>
+      |<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+      |<plist version="1.0">
+      |<dict>
+      |  <key>Example</key>
+      |  <string>value</string>
+      |</dict>
+      |</plist>""".stripMargin
+      // com.dd.plist.NSObject#toXMLPropertyList uses line separator when converting
+      .replace("\n", System.lineSeparator())
+      // com.dd.plist.NSObject#toXMLPropertyList uses tabs when converting
+      .replace("  ", "\t")
+
+  describe("ConfigFileCreationPass") {
+    it("creates config node for an XML plist") {
+      FileUtil.usingTemporaryFile("test", ".plist") { xmlFile =>
+        Files.write(xmlFile, Xml.getBytes("UTF-8"))
+
+        val pass = new ConfigFileCreationPass(null /* cpg not used in here */, Config())
+        val diff = new TestDiffGraphBuilder
+
+        pass.runOnPart(diff, xmlFile)
+        diff.nodes.nonEmpty shouldBe true
+        val node = diff.nodes.collectFirst { case n: NewConfigFile => n }.get
+        node.name should (startWith("test") and endWith(".plist"))
+        node.content shouldBe Xml
+      }
+    }
+
+    it("creates config node for a binary plist") {
+      FileUtil.usingTemporaryFile("testbin-src", ".plist") { xmlFile =>
+        FileUtil.usingTemporaryFile("testbin", ".plist") { binFile =>
+          Files.write(xmlFile, Xml.getBytes("UTF-8"))
+          PropertyListConverter.convertToBinary(xmlFile, binFile)
+
+          val pass = new ConfigFileCreationPass(null /* cpg not used in here */, Config())
+          val diff = new TestDiffGraphBuilder
+
+          pass.runOnPart(diff, binFile)
+
+          diff.nodes.nonEmpty shouldBe true
+          val node = diff.nodes.collectFirst { case n: NewConfigFile => n }.get
+          node.name should (startWith("testbin") and endWith(".plist"))
+          // binary should have been converted to XML content:
+          node.content should startWith(Xml)
+          // and the content should have a comment referencing the original file at the very end
+          node.content.linesIterator.toList.last should startWith("<!--This file was generated from")
+        }
+      }
+    }
+  }
+}

joern-cli/frontends/x2cpg/src/main/scala/io/joern/x2cpg/passes/frontend/XConfigFileCreationPass.scala

@@ -54,7 +54,7 @@ abstract class XConfigFileCreationPass(cpg: Cpg, private val rootDir: Option[Str
     }
   }
 
-  private def configFileName(configFile: Path): String = {
+  protected def configFileName(configFile: Path): String = {
     Try(Paths.get(rootDir.getOrElse(cpg.metaData.root.head)).toAbsolutePath)
       .map(_.relativize(configFile.toAbsolutePath).toString)
       .getOrElse(configFile.fileName)