Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getHelpIndex to Options panel for JWT #25

Open
preetkaran20 opened this issue Aug 8, 2021 · 0 comments
Open

Add getHelpIndex to Options panel for JWT #25

preetkaran20 opened this issue Aug 8, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers HacktoberFest help wanted Extra attention is needed tech debt

Comments

@preetkaran20
Copy link
Member

preetkaran20 commented Aug 8, 2021

Describe the bug
As the options panel for the JWT addon is complex, we should add the help index for the addon so that users can see the help index there only and they don't need to go to the readme.md in the repository to understand the options panel.

example of Help index:
image

Sample code changes
Help Index: https://github.com/SasanLabs/owasp-zap-fileupload-addon/tree/main/src/main/javahelp/org/sasanlabs/fileupload/resources/help

In https://github.com/SasanLabs/owasp-zap-jwt-addon/blob/master/src/main/java/org/zaproxy/zap/extension/jwt/ui/JWTOptionsPanel.java implement a method:

    @Override
    public String getHelpIndex() {
        return <name>;
    }

Sample PR: https://github.com/SasanLabs/owasp-zap-fileupload-addon/pull/6/files

Glimpse of UI where the help will be shown
image

Testing the changes
build the addon by running

  1. ./gradlew spotlessApply
  2. ./gradlew build
    Then go to the ZAP -> File -> Local addon file -> Navigate to project -> build -> bin -> jwt*.zap and done.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers HacktoberFest help wanted Extra attention is needed tech debt
Projects
None yet
Development

No branches or pull requests

1 participant