Skip to content

Commit

Permalink
Updated Readme development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ddwightx committed Mar 31, 2024
1 parent 07effe5 commit 63ecc63
Showing 1 changed file with 10 additions and 18 deletions.
28 changes: 10 additions & 18 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,39 +103,31 @@ Share values across different Rules while processing the same event or all event
### Build JAR with IntelliJ

1. Open IntelliJ.
2. Create a new project (Gradle) from existing source using Java 17.
2. Create a new project (Gradle) from existing source using Java 21.
3. Once the project is created/open, wait for IntelliJ to process Gradle dependencies.
4. Run the `jar` Gradle build task from the Gradle tool window/sidebar. The JAR will be placed in the `build\libs` directory.
4. Run the `jar` Gradle build task under the `extension` module from the Gradle tool window/sidebar. The JAR will be placed in the `extension/build/libs` directory.

### Build JAR with CLI

1. Install Java 17.
2. Install Gradle v7.4.
3. Run the `gradle --refresh-dependencies build` command.
4. Run the `gradle build jar` command. The JAR will be placed in the `build\libs` directory.
1. Install Java 18.
2. Install Gradle v8.5.
3. Open a terminal into the `extension` directory of the project.
4. Run the `gradle --refresh-dependencies build jar` command.
5. The JAR will be placed in the `extension/build/libs` directory.

### Debugging

#### IntelliJ

1. Apply this [git patch](https://gist.github.com/ddwightx/6965732339bdf4cd022d550f40a9e99f) to the project to allow Reshaper to be debugged as a legacy extension in Burp Suite.
1. Set the environment variable `BURP_JAR_PATH` to the `burpsuite_community.jar` file location. (e.g. `C:\Users\<user>\AppData\Local\Programs\BurpSuiteCommunity\burpsuite_community.jar` on Windows)
2. In Reshaper, using the Settings tab, export all Rules and global variables to a JSON file to prevent data loss.
3. In Extender, unload the Reshaper extension from Burp Suite if you already have the extension installed from the BApp Store or from a JAR.
4. Close Burp Suite.
5. Open the Reshaper project in IntelliJ.
6. Navigate to `java/synfron/reshaper/burp/ui/Window.java`.
7. Right-click the file in the Project view and click `Run Window.main()` or `Run Window.main()`.
6. Navigate to `debug/src/main/java/synfron/reshaper/burp/debug/Burp.java`.
7. Right-click the file in the Project view and click `Run Burp.main()` or `Debug Burp.main()`.
8. Burp Suite will open with Reshaper loaded as an legacy extension.

#### CLI

1. Apply this [git patch](https://gist.github.com/ddwightx/6965732339bdf4cd022d550f40a9e99f) to the project to allow Reshaper to be debugged as a legacy extension in Burp Suite.
2. In Reshaper, using the Settings tab, export all Rules and global variables to a JSON file to prevent data loss.
3. In Extender, unload the Reshaper extension from Burp Suite if you already have the extension installed from the BApp Store or from a JAR.
4. Close Burp Suite.
5. In a CLI, execute `java -cp path/to/the/reshaper-for-burp/JAR/file.jar synfron.reshaper.burp.ui.Window`.
6. Burp Suite will open with Reshaper loaded as a legacy extension.

## Contributions

Contributions are encouraged. Issues and Pull Requests welcome. Also help us spread the word.
Expand Down

0 comments on commit 63ecc63

Please sign in to comment.