feat: reorder Tarp README #14558
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,104 +1,169 @@ | ||
|  | ||
|
|
||
| # Janssen Tarp | ||
|
|
||
| Janssen Tarp is a browser extension from the [Janssen Project](https://github.com/JanssenProject/jans/tree/main/demos/janssen-tarp) that lets you test OpenID Connect (OIDC) authentication flows and [Cedarling](https://docs.jans.io/head/cedarling/cedarling-overview/) authorization decisions directly from your browser — no application code required. | ||
|
|
||
|  | ||
|
|
||
| In this tutorial you will: | ||
|
|
||
| 1. Install Janssen Tarp in your browser | ||
| 2. Register an OIDC client with your identity provider (IdP) | ||
| 3. Run an OAuth 2.0 Authorization Code flow and inspect the tokens | ||
| 4. Configure Cedarling (bootstrap configuration and policy store) | ||
| 5. Run a Cedarling multi-issuer authorization request and read the decision result | ||
|
|
||
| --- | ||
|
|
||
| ## 1. Prerequisites | ||
|
|
||
| - **Browser:** Chrome, or Firefox (version ≥ 115.0.3) | ||
| - **An OpenID Provider** Janssen Auth Server that supports Dynamic Client Registration | ||
|
|
||
| > **Self-signed certificates:** If your auth server uses a self-signed TLS certificate, open the server's URL in a browser tab first and accept the security warning. Otherwise, client registration will fail with a TLS error. | ||
|
|
||
| ## 2. Install the extension | ||
|
|
||
| Download the latest release assets from the [Janssen releases page](https://github.com/JanssenProject/jans/releases/latest): | ||
|
|
||
| - Chrome: `demo-janssen-tarp-chrome-v{x.x.x}.zip` | ||
| - Firefox: `demo-janssen-tarp-firefox-v{x.x.x}.xpi` | ||
|
|
||
| **Chrome** | ||
|
|
||
| 1. Unzip the downloaded file. | ||
| 2. Go to `Settings > Extensions` and enable **Developer mode** (top right). | ||
| 3. Click **Load unpacked** and select the unzipped folder. | ||
|
|
||
| **Firefox** | ||
|
|
||
| 1. Open `about:addons` in the address bar. | ||
| 2. Click **Extensions** in the left menu. | ||
| 3. Click the gear icon next to *Manage Your Extensions*, then **Install Add-on From File...**. | ||
| 4. Select the downloaded `.xpi` file. | ||
|
|
||
| Open the extension. You'll land on the **Authentication** tab, with two more tabs available: **Cedarling** and **AI Agent**. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Consider adding a screenshot. |
||
| ## 3. Register an OIDC client | ||
|
|
||
| 1. On the **Authentication** tab, click **+ Add Client**. | ||
| 2. In the **Register OIDC Client** dialog, fill in: | ||
| - **Issuer** (required) — your OpenID Provider host, e.g. `your-op-host.gluu.org` | ||
| - **Scopes** — type a scope and press Enter (e.g. `openid`) | ||
| - **Client Expiry Date** — when the client should expire | ||
| - Tick **Add an existing client** only if you want to reuse an already-registered client instead of creating a new one. | ||
| 3. Click **Register**. | ||
|
|
||
|  | ||
|
|
||
| Tarp performs Dynamic Client Registration against the issuer. The new client appears in the **OIDC Clients** table with its Client ID, Client Secret, and an `Enabled` status. | ||
|
|
||
|  | ||
|
|
||
| ## 4. Run the authentication flow | ||
|
|
||
| 1. In the client's row, click the ⚡ (trigger) icon under **Action**. | ||
| 2. The **Authentication Flow Inputs** dialog opens. All inputs are optional: | ||
| - **Additional Params** — extra request parameters as JSON, e.g. `{"paramOne": "valueOne"}` | ||
| - **Acr Values** — pick the authentication method (ACR) to request | ||
| - **Scope** — additional scopes for the request | ||
| - **Display tokens after authentication** — tick this to see the tokens after login | ||
| 3. Click **Trigger Auth Flow**. | ||
|
|
||
|  | ||
|
|
||
| Your browser is redirected to the IdP's login page. Sign in with your user credentials (if you already have a session, you may be logged in silently). | ||
|
|
||
| After a successful login, Tarp shows the **User Details** page with expandable sections for the **Access Token**, **ID Token**, and **User Details** (userinfo). Use **Show Payload** to decode a token, **Copy** to copy the details, and **Logout** to end the session. | ||
|
|
||
|  | ||
|
|
||
| ## 5. Configure Cedarling | ||
|
|
||
| Cedarling is an embedded Policy Decision Point (PDP) that evaluates authorization requests against Cedar policies. Configure it once, then test authorization decisions. | ||
|
Contributor
There was a problem hiding this comment. Consider linking to the Cedarling docs landing page: https://docs.jans.io/stable/cedarling/ |
||
|
|
||
| ### 5.1 Add a bootstrap configuration | ||
|
|
||
| 1. Open the **Cedarling** tab. You'll see the **Bootstrap Configuration** page. | ||
| 2. Click **+ Add Configurations**. | ||
|
|
||
|  | ||
|
|
||
| 3. In the **Add Cedarling Configuration** dialog, choose **JSON** (or **URL**) input. A minimal configuration is pre-filled — edit it as needed. Key properties: | ||
| - `CEDARLING_APPLICATION_NAME` — any name, e.g. `My App` | ||
| - `CEDARLING_POLICY_STORE_URI` — URL of your Cedar policy store (`.cjar`) | ||
| - `CEDARLING_JWT_SIG_VALIDATION` / `CEDARLING_JWT_STATUS_VALIDATION` — `enabled`/`disabled` token validation | ||
| - `CEDARLING_LOG_TYPE`, `CEDARLING_LOG_LEVEL`, `CEDARLING_LOG_TTL` — logging options | ||
| 4. Click **Save**. | ||
|
duttarnab marked this conversation as resolved.
|
||
|
|
||
|  | ||
|
|
||
| The saved configuration appears in the table. Two more sub-tabs become available: **Cedarling Unsigned Authz Form** and **Cedarling Multi-Issuer Authz Form**. | ||
|
|
||
|  | ||
|
|
||
| ### 5.2 Browse the policy store (optional) | ||
|
|
||
| Click **Browse Policy Store** in the configuration's row to inspect the loaded policy store: Cedar policies, trusted issuers, manifest, metadata, and schema. Click any file to view its contents — for example, a policy that only permits users with the `auditor` role to `Read`. | ||
|
|
||
|  | ||
|
|
||
| ## 6. Test authorization (Cedarling Multi-Issuer Authz Form) | ||
|
|
||
| This form builds an authorization request from tokens, an action, a resource, and optional context — then asks Cedarling for a decision. | ||
|
|
||
| 1. On the **Cedarling** tab, open **Cedarling Multi-Issuer Authz Form**. The status badge shows **Ready** once the bootstrap configuration is initialized. | ||
|
|
||
|  | ||
|
|
||
| 2. Fill in the **Request builder** (at least one token mapping, an action, and a non-empty resource are required): | ||
| - **Issuer-to-Token Mapping** — the tokens to evaluate, entered as a JSON array. Each entry has a `mapping` (the Cedar token entity type) and a `payload` (the raw JWT string). If you completed the authentication flow in Section 4, copy the Access Token / ID Token values from the **User Details** page and use them here: | ||
| ```json | ||
| [ | ||
| { | ||
| "mapping": "Jans::Access_token", | ||
| "payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ.." | ||
| }, | ||
| { | ||
| "mapping": "Jans::id_token", | ||
| "payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ.." | ||
| }, | ||
| { | ||
| "mapping": "AGT::Access_token", | ||
| "payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ.." | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| Add one object per token you want Cedarling to consider — typically the access token and, if you enabled **Display tokens after authentication**, the ID token as well. The `mapping` value must match a token entity type defined in your policy store's schema (see Section 5.2). | ||
|
duttarnab marked this conversation as resolved.
Contributor
There was a problem hiding this comment. This renders in a scrollable area in my preview. Not sure why, but may be you can check the final rendering after we merge the PR. |
||
| - **Action** — the Cedar action, e.g. `Jans::Action::"Read"` | ||
| - **Resource** — the Cedar entity, e.g. `entity_type: "Jans::Application"`, `id: "dashboard"` | ||
| - **Context** — optional additional context attributes | ||
| - **Log tag** — choose which logs to display: `Decision`, `System`, or `Metric` | ||
| 3. Click **Run authorization**. | ||
|
|
||
|  | ||
|
|
||
| The **Result** panel shows the outcome: | ||
|
|
||
| - **Decision** — `True` (allow) or `False` (deny) | ||
| - **diagnostics → reason** — which policies matched (e.g. `AdminCanReadAndWrite`, `AuditorCanOnlyRead`) | ||
| - **errors** — any evaluation errors | ||
| - **request_id** — correlates with entries in the **Logs** panel below | ||
|
|
||
|  | ||
|
|
||
| Use **Clear result** to reset and try different tokens, actions, or resources. See the [Cedarling multi-issuer authorization reference](https://docs.jans.io/head/cedarling/reference/cedarling-multi-issuer/) for details. | ||
|
|
||
| ## 7. Troubleshooting | ||
|
|
||
| - **TLS error during client registration** — trust the server's self-signed certificate first (Section 1). | ||
| - **Registration fails against Keycloak on localhost** — in the KC admin console, set `localhost` under *Clients → Client registration → Trusted Hosts*, and create an **Optional** client scope named `openid`. | ||
| - **Authorization always denied** — verify the policy store URI in the bootstrap configuration, and that your token payloads match what the policies expect (use **Browse Policy Store** to check). | ||
|
|
||
| ## 8. More topics | ||
|
|
||
| - [Building Janssen Tarp from Source](./docs/build-from-source.md) | ||
| - [Using Janssen Tarp with Keycloak (localhost)](./docs/tarp-with-keycloak.md) | ||
| - [Using the AI Assistant in Janssen Tarp](./docs/ai-agents.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # Building Janssen Tarp from Source | ||
|
|
||
| This tutorial walks through cloning the Janssen Project repository and building the Janssen Tarp browser extension yourself, instead of installing a pre-built release. | ||
|
|
||
| ## 1. Prerequisites | ||
|
|
||
| - **Node.js** ≥ v18.15.0 (check with `node -v`) | ||
| - **npm** (bundled with Node.js) | ||
| - **git** | ||
|
|
||
| ## 2. Clone the repository | ||
|
|
||
| Janssen Tarp lives inside the main `jans` monorepo, under `demos/janssen-tarp`. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/JanssenProject/jans.git | ||
| cd jans | ||
| ``` | ||
|
|
||
| If you need a specific branch (for example, a feature branch that hasn't merged yet): | ||
|
|
||
| ```bash | ||
| git checkout jans-tarp-14557 | ||
| ``` | ||
|
|
||
| Otherwise, stay on `main` for the latest stable source. | ||
|
|
||
| ## 3. Install dependencies | ||
|
|
||
| The actual extension project is in the `browser-extension` subfolder: | ||
|
|
||
| ```bash | ||
| cd demos/janssen-tarp/browser-extension | ||
| npm install | ||
| ``` | ||
|
|
||
| This pulls in the build tooling (Webpack, TypeScript, Tailwind CSS) and runtime dependencies (React, the Cedarling WASM bindings, the Anthropic and OpenAI SDKs used by the AI Agent tab, etc.), as declared in `package.json`. | ||
|
|
||
| ## 4. Build the extension | ||
|
|
||
| ```bash | ||
| npm run build | ||
| ``` | ||
|
|
||
| This runs Webpack in production mode and outputs two ready-to-load builds: | ||
|
|
||
| - `dist/chrome` — Chrome/Chromium build | ||
| - `dist/firefox` — Firefox build | ||
|
|
||
| **Other useful scripts:** | ||
|
|
||
| | Command | Purpose | | ||
| |---|---| | ||
| | `npm run build-dev` | Development-mode build (unminified, easier to debug) | | ||
| | `npm run watch` | Watches source files and rebuilds automatically on change (development config) | | ||
| | `npm run pack` | Packages the `dist` builds into distributable zip/xpi files under `release/` | | ||
|
duttarnab marked this conversation as resolved.
|
||
|
|
||
| ## 5. Load the unpacked extension into your browser | ||
|
|
||
| ### Chrome | ||
|
|
||
| 1. Open `chrome://extensions`. | ||
| 2. Enable **Developer mode** (top right toggle). | ||
| 3. Click **Load unpacked**. | ||
| 4. Select the `demos/janssen-tarp/browser-extension/dist/chrome` folder. | ||
|
|
||
| ### Firefox | ||
|
|
||
| Firefox requires a packed `.xpi` for the standard install flow, or a temporary load for development: | ||
|
|
||
| 1. Open `about:debugging#/runtime/this-firefox`. | ||
| 2. Click **Load Temporary Add-on...**. | ||
| 3. Select any file inside `dist/firefox` (e.g. `manifest.json`). | ||
|
|
||
| > A temporary add-on is removed when Firefox restarts. For a persistent install, run `npm run pack` and install the generated `.xpi` from `release/` via `about:addons` (see the end-user tutorial for that flow). | ||
| ## 6. Verify the build | ||
|
|
||
| Open the extension from your browser toolbar. You should see the **Authentication**, **Cedarling**, and **AI Agent** tabs — the same interface covered in the [end-user tutorial](../README.md). If the popup fails to load or shows a blank screen, check the browser's extension error console (`chrome://extensions` → the extension's **Errors** button, or Firefox's `about:debugging` → **Inspect**) for build/runtime errors. | ||
|
|
||
| ## 7. Iterating on the source | ||
|
|
||
| If you're modifying the extension: | ||
|
|
||
| 1. Run `npm run watch` to rebuild automatically on file changes. | ||
| 2. In Chrome, click the reload icon on the extension card in `chrome://extensions` after each rebuild (Chrome doesn't auto-reload unpacked extensions). | ||
| 3. In Firefox, click **Reload** next to the temporary add-on in `about:debugging`. | ||
|
|
||
| ## 8. Troubleshooting | ||
|
|
||
| - **`npm install` fails on native/WASM deps** — ensure your Node.js version meets the ≥ 18.15.0 requirement; older versions can fail to install the Cedarling WASM package. | ||
| - **Build succeeds but extension icon is missing/broken** — re-run `npm run build` (not `build-dev`) for a clean production output, since `dist/` is cleaned on each build. | ||
| - **Changes not reflected in browser** — remember unpacked extensions must be manually reloaded after each rebuild (Chrome) or are removed on restart (Firefox temporary add-ons). | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An OpenID Provider->An OpenID Provider:Janssen Auth Server->Janssen Server or any other OIDC providerLink to the DCR RFC: https://datatracker.ietf.org/doc/html/rfc7591
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
supports Dynamic Client Registration->supports Dynamic Client Registration and is enabled