Initial commit

Author: fmagin

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Main
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.11
+      - uses: er28-0652/setup-ghidra@master
+        with:
+          version: "10.1"
+
+      - name: Build with Gradle
+        run: gradle buildExtension
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: ./dist/*zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test_extension.yml

@@ -0,0 +1,40 @@
+# This workflow will build a Java project with Gradle
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.11
+      - uses: er28-0652/setup-ghidra@master
+        with:
+                version: "10.1"
+
+      - name: Build Extension
+        run: gradle buildExtension
+
+      - name: Upload built extension as artifact for debugging
+        uses: actions/upload-artifact@v2
+        with:
+                path: ./dist/*zip
+                retention-days: 1
+
+      - name: Install Extension
+        run: unzip ./dist/*zip -d $GHIDRA_INSTALL_DIR/Ghidra/Extensions
+
+      - name: Run Tests
+        run: echo "Execute your tests here!"

.gitignore

@@ -0,0 +1,5 @@
+build/
+.gradle/
+gradlew
+gradlew.bat
+lib/*jar

.idea/fileTemplates/GhidraKotlinScript.kt

@@ -0,0 +1,55 @@
+# Ghidra Extension in Kotlin using IntelliJ IDEA
+
+> Write a Ghidra Extension without using Java or Eclipse!
+
+## Setup
+
+* Hit `Use this template` at the top of the repo on GitHub
+* Clone the new repo to your development machine
+* Add the line `GHIDRA_INSTALL_DIR=/path/to/your/ghidra_10.1_PUBLIC/` to `$HOME/.gradle/gradle.properties`
+* Open IntelliJ, create a new `Project from Existing Sources...` and select the `build.gradle`
+  * If you are using the [Kotlin Jupyter Plugin](https://github.com/GhidraJupyter/ghidra-jupyter-kotlin) uncomment the line in the `dependencies` block in the `build.gradle`
+* Wait for IntelliJ to finish indexing and fetching dependencies, hit the build button, and then run Ghidra
+
+
+## Features
+
+* Gradle Config that works out of the box with IntelliJ
+* IntelliJ IDEA Run Configuration for debugging of the extension
+  * If you have are using the [Kotlin Jupyter Plugin](https://github.com/GhidraJupyter/ghidra-jupyter-kotlin) you can also set breakpoints in the script file!
+* GitHub CI files that
+  * make sure the extension at least builds for each PR
+  * will automatically build a release and publish it on GitHub if a commit is tagged with a version matching `vX.X.X`, e.g. `v1.2.3`/`v1.2.0` (`v1.2` doesn't work!)
+  
+
+## Additional Development Tips
+
+These aspects can not be included in the repo files itself, but make development smoother.
+
+### Thread Breakpoints
+
+Make sure that you use breakpoints that only suspend the thread, and not everything.
+This means that the breakpoint will only suspend the thread that is currently running the analysis or the script,
+and the GUI will keep working.
+  * Set a breakpoint, right-click the icon, and in the `Suspend` line select `Thread` instead of `All`
+  * IntelliJ IDEA will suggest making this the default, click this too
+
+
+### Use Scripts and the Jupyter Kernel to prototype ideas
+
+With the [Kotlin Jupyter Plugin](https://github.com/GhidraJupyter/ghidra-jupyter-kotlin) you can test your new ideas first.
+IntelliJ IDEA can do hot reloading of classes, but this has limits and then requires an IDE restart,
+which take an annoying amount of time. The QT Console only is fairly basic, but the Jupyter Notebook uses nearly the same
+code analysis engine as IntelliJ itself.
+
+### Automatic conversion to Kotlin
+
+* pasting Java code into a Kotlin file you will get the suggestion for this to be converted and then pasted
+* right-click `.java` file in the Project Tree there is an action at the very bottom to convert the entire file
+
+
+## Issues
+
+If any step in this process doesn't work as described in the README, please open an issue on GitHub.
+I have only tested this on Linux so there might be some aspects that work differently on macOS or Windows, though these
+should be minor.

.idea/runConfigurations/Run_Ghidra.xml

@@ -0,0 +1,67 @@
+// Builds a Ghidra Extension for a given Ghidra installation.
+//
+// An absolute path to the Ghidra installation directory must be supplied
+// To make this work well with IntelliJ this should be automatically resolve able and NOT an environmental variable
+// You can either:
+// * use the `gradle.properties` file in the extension folder to set it for this project
+// * add the line `GHIDRA_INSTALL_DIR=/path/to/ghidras/ghidra_10.1_PUBLIC/` to your global config (`.gradle/gradle.properties` in your home folder)
+
+
+plugins {
+	id 'org.jetbrains.kotlin.jvm' version "1.6.0"
+	id 'idea'
+}
+
+repositories {
+	mavenCentral()
+}
+
+//----------------------START "DO NOT MODIFY" SECTION------------------------------
+def ghidraInstallDir
+
+if (System.env.GHIDRA_INSTALL_DIR) {
+	ghidraInstallDir = System.env.GHIDRA_INSTALL_DIR
+}
+else if (project.hasProperty("GHIDRA_INSTALL_DIR")) {
+	ghidraInstallDir = project.getProperty("GHIDRA_INSTALL_DIR")
+}
+
+if (ghidraInstallDir) {
+	apply from: new File(ghidraInstallDir).getCanonicalPath() + "/support/buildExtension.gradle"
+}
+else {
+	throw new GradleException("GHIDRA_INSTALL_DIR is not defined!")
+}
+//----------------------END "DO NOT MODIFY" SECTION-------------------------------
+
+// Set the JVM target to 11, as described in https://stackoverflow.com/a/44297713/13220684
+// Ghidra requires 11 and the buildExtension.gradle sets this for Java
+// IntelliJ will complain about the discrepancy between the Java and the Kotlin target otherwise
+tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
+	kotlinOptions {
+		jvmTarget = "11"
+	}
+}
+
+dependencies {
+	// If you are using the Ghidra Jupyter Plugin for Kotlin, add the following line to declare it as a dependency
+	// This allows using the extension methods and makes sure that the required Kotlin libraries are present and not
+	// conflicting
+	//	api fileTree(dir: ghidraInstallDir + 'Ghidra/Extensions/GhidraJupyterKotlin/', include: "**/*.jar")
+}
+
+// Make it explicit that the compilation depends on some libraries in the `lib` folder,
+// otherwise gradle will issue warnings
+compileKotlin.dependsOn(copyDependencies)
+
+// Add the ghidra_scripts directory as an additional source set, so IntelliJ IDEA treats the scripts there as part of
+// the module
+// this means that your plugin code is available for code completion and analysis and that all dependencies of the module
+// are inherited
+sourceSets {
+	main {
+		kotlin {
+			srcDirs 'ghidra_scripts'
+		}
+	}
+}

README.md

@@ -0,0 +1,5 @@
+name=@extname@
+description=Kotlin Example Extension.
+author=Florian Magin
+createdOn=2021-12-15
+version=@extversion@

build.gradle

@@ -0,0 +1,13 @@
+// SCRIPT DESCRIPTION
+//@category    Examples
+//@toolbar    world.png
+
+import ghidra.app.script.GhidraScript
+
+@Suppress("unused")
+class KotlinExtensionExampleScript : GhidraScript() {
+    @Throws(Exception::class)
+    override fun run() {
+        TODO("Script code goes here")
+    }
+}

extension.properties

@@ -0,0 +1 @@
+#GHIDRA_INSTALL_DIR=/path/to/ghidras/ghidra_10.1_PUBLIC/