Skip to content

Commit

Permalink
Merge pull request #7 from 1Password/DCKcode/mention-releases-page
Browse files Browse the repository at this point in the history
Mention the releases in the README
  • Loading branch information
DCKcode authored Dec 5, 2023
2 parents 442514a + c9d61fa commit 255b9c9
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The HMAC algorithm currently used for v1 is HMAC-SHA256.

## Using this plugin

The Burp plugin works with Burp's message editor and contains its own custom implementation of 1Password.com's session management protocol. You activate it by loading the JAR file in Burp's extender tab, like any other Burp plugin.
The Burp plugin works with Burp's message editor and contains its own custom implementation of 1Password.com's session management protocol. You activate it by loading the JAR file in Burp's extender tab, like any other Burp plugin. Grab the JAR file from the [releases page](https://github.com/1Password/burp-1password-session-analyzer/releases).

When activated, it provides a number of inputs, such as an input for the original HTTP message, and an input for the decrypted payload (if present). It also provides a way to edit the request identifier, the key identifier and the session key itself. Inputting the correct session key will automatically decrypt the message and allow you to inspect and modify payloads and requests.

Expand All @@ -67,6 +67,8 @@ brew install temurin17

`./gradlew fatJar` builds this plugin and puts the resulting JAR file in `build/libs`.

If you don't want to build the plugin yourself, you can grab a built version of the JAR from the [releases page](https://github.com/1Password/burp-1password-session-analyzer/releases)

## How to debug
To be able to connect a Java debugger to your Burp plugin, you must manually start Burp from your command line. On a Mac, run:

Expand All @@ -77,4 +79,4 @@ java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address='*:5005' -jar
You can now connect your debugger on local port 5005. For example, in IntelliJ IDEA you can add a _Remote JVM debugger_ configuration with the following command line configured: `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005`

## How to test
Run the tests using `./gradlew test`. The test output results are in `build/test-results`.
Run the tests using `./gradlew test`. The test output results are in `build/test-results`.

0 comments on commit 255b9c9

Please sign in to comment.