2.0 rewrite

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "gradle" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 12

.github/workflows/build.yml

@@ -33,11 +33,23 @@ jobs:
         run: chmod +x ./gradlew
       - name: build
         run: ./gradlew build
+      - name: Gradle Dependency Submission
+        if: ${{ runner.os != 'Windows' }}
+        uses: mikepenz/[email protected]
+        with:
+          gradle-build-module: |-
+            :api
+            :cli
+            :launchwrapper
+            :gui
+        continue-on-error: true
       - name: capture build artifacts
         if: ${{ runner.os == 'Linux' && matrix.java == '17' }} # Only upload artifacts built from latest java on one OS
         uses: actions/upload-artifact@v3
         with:
           name: Artifacts
           path: |
-            build/libs/
-            compose/build/libs/
+            api/build/libs/
+            cli/build/libs/
+            launchwrapper/build/libs/
+            gui/build/libs/

.gitignore

@@ -117,6 +117,8 @@ run/
 # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
 !gradle-wrapper.jar
 
-/database
+/api/database
 
-*.pass
+*.pass
+
+**/logs

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# How can I help?
+
+## Requesting feature or request adding malware signature to the database
+
+In this case, feel free to open an issue or contact me on [Minecraft Malware Prevention Alliance](https://mmpa.info/) Discord server.  
+**Never upload malware to GitHub or Discord!** If you have a malware sample that you want to share with se, please share it via [Wormhole](https://wormhole.app/).  
+<!-- or use malware store TODO -->
+
+## Contribution
+If you're familiar with [Kotlin](https://kotlinlang.org/) and you want to help with the project, feel free to open pull requests.  
+
+### Pull-requests  
+Please keep pull requests clean: only add one feature per pull request. Pull requests modifying the whole project and adding multiple unrelated features will be rejected.  
+If you start working on a feature, please open a draft PR as soon as you can, and track your progress there.  
+This way people will know that someone is already working on XXX.  
+
+
+GitHub support checkboxes, you may use those:  
+
+---
+```md
+- [x] ticked checkbox
+- [ ] todo checkbox
+```
+- [x] ticked checkbox
+- [ ] todo checkbox
+
+
+---
+
+## Coding
+Follow common sense!
+
+### No premature optimization
+First, make a feature work, then you might profile and optimize it. (you may choose efficient algorithms)  
+
+You may use Object Oriented or Functional style, but please avoid unnecessary abstraction.  
+A readable code is better than an optimized or obfuscated code.  
+
+### Readable code
+Please avoid global variables and functions. Only use global if it is widely used in the project.
+Group simple functions into Objects, or use extension functions.  
+
+Multiple classes may be declared in a single file as long as those are closely related.  
+
+If possible, avoid using reflection.  
+
+Avoid [platform types](https://kotlinlang.org/docs/java-interop.html#null-safety-and-platform-types): If java library has no nullability annotation choose the expected type.
+```kt
+val mayBeNull = JavaClass.function() //  Any! NOT OK
+val mayBeNull: Any = JavaClass.function() //  Any OK
+```

README.md

@@ -1,14 +1,60 @@
 # 🪡 jNeedle (or Needle)
+
 Yet another jar malware detection tool
 
 ---
+
+## Quickstart / How to use
+
+If you came from [MMPA](https://blog.mmpa.info) or already know what this program does, look here to see how to use jNeedle.
+
+### GUI (Graphical) mode
+
+The easiest way to use jNeedle is to use the GUI version.
+Just download the `jneedle-gui-xxx.jar` from the [release page](https://github.com/KosmX/jneedle/releases/latest) and double click on it.
+
+_Help, it won't start!_
+
+There currently is a bug with Java 1.8, which won't let the program start. This is known and will be fixed in the future.
+
+### CLI mode
+
+If you want to use the CLI version, you have to download the `jneedle-xxx-fat.jar` from the [release page](https://github.com/KosmX/jneedle/releases/latest) and run it with the following command:
+
+```text
+java -jar jneedle-xxx-fat.jar -f <path to jar or directory>
+```
+
+JNeedle will then check the given file or directory for malicious code. It gives a summary of the results at the end.
+
+_Help, where do I need to put that command?_  
+On Windows, open the file explorer, navigate to the folder where you downloaded the jar file. Hold `Shift` and right click on empty space. Select `Open PowerShell window here` and type the command above.
+
+_Help, it won't start!_  
+See the [GUI section](#gui-graphical-mode) for more information.
+
+For more CLI arguments, type the command without `-f`:
+
+```text
+> java -jar .\jneedle-1.0.0.jar
+Value for option --file should be always provided in command line.
+Usage: jNeedle options_list
+Options:
+    --file, -f -> file or directory (always required) { String }
+    --url, -u [https://maven.kosmx.dev/dev/kosmx/needles] { String }
+    --dblocation [C:\Users\kosmx\.jneedle] { String }
+    --threads [16] { Int }
+    --help, -h -> Usage info
+```
+
 ## How to find the needle in a haystack? - Use a strong enough magnet
 
 The detection tool is parsing jar `.class` files looking for signature instruction sequences.
 It is actually similar to string search:
 
 Is the following sequence: `"jump into the well"`
 in the program:
+
 ```text
 exit house and lock door,
 get the bus and to the shop to buy milk
@@ -17,78 +63,66 @@ come home
 ```
 
 ## See the **light** at the end of the tunnel
+
+**Attention! These are advanced options, which you probably won't need!**  
+For an easy setup, look at the [Quickstart](#quickstart--how-to-use) section.
+
 ### Add to PrismLauncher
 
 ### Extra jar // recommended but harder to set-up
+
 1. Check current launch classpath in the Version menu:  
-Select the Fabric/Forge/Quilt/Minecraft (most bottom of these) and on the right menu, click Customize then Edit
+   Select the Fabric/Forge/Quilt/Minecraft (most bottom of these) and on the right menu, click Customize then Edit
 2. This will open a text-editor, look for the `mainClass` entry in the class  
-Fabrc for example: `"mainClass": "net.fabricmc.loader.impl.launch.knot.KnotClient",`
+   Fabrc for example: `"mainClass": "net.fabricmc.loader.impl.launch.knot.KnotClient",`
 3. Save (copy) the entry value: `net.fabricmc.loader.impl.launch.knot.KnotClient`
 4. close the editor and optionally click Revert in Prismlauncher
 5. click `Add to Minecraft.jar` button and select jneedle.jar
 6. Click edit while jneedle.jar is selected
 7. Add the following to the json:  
-`"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass={launchClass}"],` where you replace `{launchClass}` with the earlier saved class.
+   `"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass={launchClass}"],` where you replace `{launchClass}` with the earlier saved class.
 8. Add the following to the json:  
-`"mainClass": "dev.kosmx.needle.launchWrapper.ParameterizedWrapper",`
+   `"mainClass": "dev.kosmx.needle.launchWrapper.ParameterizedWrapper",`
 9. Save the file and have fun!
 
---- 
+---
 
 **The lines for specific launchers:**  
 Quilt: `"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass=org.quiltmc.loader.impl.launch.knot.KnotClient"],`  
-Fabric: `"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass=net.fabricmc.loader.impl.launch.knot.KnotClient"],`   
+Fabric: `"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass=net.fabricmc.loader.impl.launch.knot.KnotClient"],`  
 Forge up to 1.12.2: `"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass=net.minecraft.launchwrapper.Launch"],`  
-Forge from 1.13.2: `"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass=io.github.zekerzhayard.forgewrapper.installer.Main"],`  
+Forge from 1.13.2: `"+jvmArgs": ["-Ddev.kosmx.jneedle.launchClass=io.github.zekerzhayard.forgewrapper.installer.Main"],`
 
 ### Easy path // slow but easy-to-setup
-1. In the game version menu, click `Add agents`:  
+
+1. In the game version menu, click `Add agents`:
 2. Select jneedle.jar
 3. Done. (It will be slow in large modpacks)
 
 ## JVM properties
+
 Some parameter can be set as a JVM property:  
 `-Ddev.kosmx.jneedle.remoteDatabase` to set online database location.  
-`-Ddev.kosmx.jneedle.remoteDatabase=https://maven.kosmx.dev/dev/kosmx/needles` is default.  
+`-Ddev.kosmx.jneedle.remoteDatabase=https://maven.kosmx.dev/dev/kosmx/needles` is default.
 
 `-Ddev.kosmx.jneedle.databasePath` to set local database cache.  
 `-Ddev.kosmx.jneedle.databasePath=${user.home}/.jneedle` by default.
 
-
 If using `-cp jneedle.jar dev.kosmx.needle.launchWrapper.ParameterizedWrapper`  
 `-Ddev.kosmx.jneedle.launchClass` to set the start class after checking is completed. The application has to be in classpath.  
 (This is for Minecraft wrapper use)
 
-## GUI mode
-There is a gui version, you can simply open it in a graphical environment
-
-## CLI mode
-```text
-> java -jar .\jneedle-1.0.0.jar
-Value for option --file should be always provided in command line.
-Usage: jNeedle options_list
-Options:
-    --file, -f -> file or directory (always required) { String }
-    --url, -u [https://maven.kosmx.dev/dev/kosmx/needles] { String }
-    --dblocation [C:\Users\kosmx\.jneedle] { String }
-    --threads [16] { Int }
-    --help, -h -> Usage info
-```
-
 ## API usage:
+
 <not yet in maven, I'll change that soon>  
 dev.kosmx.needle.CheckWrapper object (static class) has API functions:  
 These can be used from any JVM interop language (ideally Kotlin)  
 First call `CheckWrapper.init()` to initialize database. Optionally database location and file location can be specified
 
-Then the program state is effectively immutable, calling check function is safe from any thread anytime.  
+Then the program state is effectively immutable, calling check function is safe from any thread anytime.
 
 `CheckWrapper.checkJar()` to check a single jar file (extension doesn't have to be jar)  
-`CheckWrapper.checkPathBlocking()` to check jar file or walk directory. Function will return with results once completed.  
+`CheckWrapper.checkPathBlocking()` to check jar file or walk directory. Function will return with results once completed.
 
-
 `CheckWrapper.checkPath()` with parameters to check path as a coroutine function. It can have feedback while running.  
 This function is kotlin only.
-
-

api/build.gradle.kts

@@ -0,0 +1,58 @@
+plugins {
+
+    jneedle.compilation
+    alias(libs.plugins.kotlin.serialization)
+
+    //alias(libs.plugins.shadow)
+
+    jneedle.repositories
+    jneedle.tasks
+    jneedle.publishing
+    jneedle.dokka
+}
+
+
+sourceSets {
+    val main by getting
+    create("dbGen") {
+        compileClasspath += main.compileClasspath + main.output
+        runtimeClasspath += main.runtimeClasspath + main.output
+    }
+}
+
+dependencies {
+    implementation(libs.kotlin.stdlib)
+
+    implementation(libs.bundles.kotlinx.serialization)
+
+    implementation(libs.bundles.kotlinx.coroutines)
+    testImplementation(libs.bundles.kotlinx.coroutines.debugging)
+
+    implementation(libs.kotlinx.cli)
+
+    implementation(libs.bundles.asm)
+
+    implementation(libs.cafedude)
+
+    implementation(libs.lljzip)
+
+    implementation(libs.slf4j)
+    implementation(libs.slf4k)
+    "dbGenImplementation"(libs.logback) // API doesn't need a logger backend
+
+    testImplementation(kotlin("test"))
+}
+
+
+tasks {
+    withType<Jar>().configureEach {
+        manifest {
+        }
+    }
+
+    // TODO: 2023-06-12 buildDb should be a subproject, or possibly a build script thingy
+    create<JavaExec>("buildDb") {
+        this.mainClass.set("dev.kosmx.needle.dbGen.GeneratorKt")
+        this.classpath = sourceSets["dbGen"].runtimeClasspath
+    }
+}

src/dbGen/kotlin/dev/kosmx/needle/dbGen/Generator.kt → api/src/dbGen/kotlin/dev/kosmx/needle/dbGen/Generator.kt

@@ -15,7 +15,7 @@ import kotlin.io.path.writeText
 import kotlin.streams.asSequence
 
 
-const val databaseId = 5
+const val databaseId = 6
 
 
 

src/dbGen/kotlin/dev/kosmx/needle/dbGen/db/Fractureiser.kt → api/src/dbGen/kotlin/dev/kosmx/needle/dbGen/db/Fractureiser.kt

@@ -1,7 +1,7 @@
 package dev.kosmx.needle.dbGen.db
 
-import dev.kosmx.needle.core.MatchType
 import dev.kosmx.needle.dbGen.dsl.KDSL
+import dev.kosmx.needle.matcher.result.Severity
 import org.objectweb.asm.Opcodes.*
 import org.objectweb.asm.tree.InsnNode
 import org.objectweb.asm.tree.IntInsnNode
@@ -10,7 +10,7 @@ import org.objectweb.asm.tree.TypeInsnNode
 
 fun KDSL.fractureiser() {
     malwareId = "fractureiser"
-    type = MatchType.MALWARE
+    type = Severity.SEVERE
 
     "SIG1" byteCodeEntry {
         autoFilerInstructions = true

src/dbGen/kotlin/dev/kosmx/needle/dbGen/db/SessionLogger.kt → api/src/dbGen/kotlin/dev/kosmx/needle/dbGen/db/SessionLogger.kt

@@ -1,14 +1,14 @@
 package dev.kosmx.needle.dbGen.db
 
-import dev.kosmx.needle.core.MatchType
 import dev.kosmx.needle.dbGen.dsl.KDSL
+import dev.kosmx.needle.matcher.result.Severity
 import org.objectweb.asm.Opcodes.*
 import org.objectweb.asm.tree.LdcInsnNode
 import org.objectweb.asm.tree.TypeInsnNode
 
 fun KDSL.sessionLogger() {
     malwareId = "SessionLogger"
-    type = MatchType.MALWARE
+    type = Severity.SEVERE
 
     "webhook" byteCodeEntry {
         insn(

src/dbGen/kotlin/dev/kosmx/needle/dbGen/db/Skyrage.kt → api/src/dbGen/kotlin/dev/kosmx/needle/dbGen/db/Skyrage.kt

@@ -1,15 +1,15 @@
 package dev.kosmx.needle.dbGen.db
 
-import dev.kosmx.needle.core.MatchType
 import dev.kosmx.needle.dbGen.dsl.KDSL
+import dev.kosmx.needle.matcher.result.Severity
 import org.objectweb.asm.Opcodes
 import org.objectweb.asm.tree.LdcInsnNode
 import org.objectweb.asm.tree.MethodInsnNode
 import org.objectweb.asm.tree.TypeInsnNode
 
 fun KDSL.skyrage() {
     malwareId = "Skyrage"
-    type = MatchType.MALWARE
+    type = Severity.SEVERE
 
     "Upd1" byteCodeEntry {
         autoFilerInstructions = true