zaproxy / zaproxy/zap-api-docs

Update Auth with Session Management Scripts Details

Open
#42 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
JavaScript
Stars
40
Forks
32
PR merge metrics
No merged PRs in 30d

Description

After 2.10.0 or whatever the next release is.

As discussed:
https://github.com/zaproxy/zap-api-docs/pull/36/files#r422719979

This request is initiated as a client side AJAX request using a spec called JWT. Currently ZAP doesn't have a notion of the Authorization header for sessions so this is where ZAPs scripting engine will come into play! With ZAP's scripting engine, we can easily add to or augment it's functionality.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion and changed files in linked pull request #36, then compare its session-management and Authorization-header context with the documentation for the post-2.10.0 release. Confirm the intended scripting-engine details with maintainers before updating the relevant API documentation; done means the session-management script behavior and release timing are clearly documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
authentication, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.