jupyterlab-passkey-extension 1.0.32

Jupyterlab extension to allow passkeys to be captured by Jupyterlab with supporting API, CLI etc - to allow internal functionality such as vaults or secrets to be using the passkey functionality of the user's browser or operating system

jupyterlab_passkey_extension

A generic passkey bridge for JupyterLab. It exposes the passkey (WebAuthn) capability of the user's browser or operating system to local clients that have no browser of their own - the JupyterLab terminal, a script, a CLI, or an AI agent working on the Jupyter server. The extension runs the browser-side ceremony and hands the result back to the requesting local process.

It is purpose-agnostic and performs no cryptography of its own. Every caller supplies its own parameters, and the extension holds no secret. A vault that unlocks with a passkey, or any tool that wants a WebAuthn PRF value, is just a consumer - all key handling stays there.

The way in is the CLI (jupyterlab-passkey, shipped with the package). Behind it sits an authenticated HTTP API - not a second way in, but the return path the browser posts its result to, and the relay's contract.

Features

• Passkeys from a terminal - Windows Hello, Touch ID, or a security key, reachable from a process that has no browser. The user approves in their open tab; the result returns to the caller as a blocking call
• Enroll and unlock - register a passkey (create) and assert it later (get)
• Key material without a stored key - get --prf-salt yields a deterministic 32-byte WebAuthn PRF. The same credential and salt always return the same bytes, so a vault can derive its key from it and store none
• Take a secret from the user, without it entering the transcript - passphrase prompts in the browser and prints only the path of a 0600 file. The value never crosses the terminal, the shell history, or a process argument
• Hand a secret to the user, without leaving one behind - copy puts a value on the user's clipboard via a notification button. It rides a one-shot relay the server deletes as it reads, and never enters the notification itself
• Purpose-agnostic - no cryptography, no stored secret, no opinion about what the passkey unlocks

Working with an AI agent

The last two features are what make this usable when an AI agent is at the keyboard. An agent can run jupyterlab-passkey passphrase --once --prompt "GitHub token"; the user types the token into a browser dialog, and the agent receives a filesystem path it hands to a consumer - so the token never appears in the agent's output, its context, or the session transcript. In the other direction, pass-cli get github/api ... | jupyterlab-passkey copy moves a secret from a vault to the user's clipboard through a pipe between two processes, so the bytes never pass through the agent either.

Both CLI and subcommand --help are written to be read by an agent: every flag states its default and its failure mode, and each subcommand carries worked examples.

[!IMPORTANT] This is not a sandbox, and it is not a defence against a hostile caller. Any process that can run the CLI can also read the relay file it points at. What it buys is that a secret is never incidentally captured - not echoed to a terminal, not printed into a transcript, not left in ~/.bash_history or a process argument, and not broadcast in a notification payload.

How it works

A browser page can only talk back to the Jupyter server over HTTP, and a local process on that server cannot receive anything from the page directly. So the ceremony runs in the page, and its result returns through an authenticated endpoint that writes an atomic 0600 relay file the local client reads.

Inbound - a ceremony, browser to local client. passkey:passphrase takes the same shape, POSTing to /passphrase instead:

flowchart LR
    subgraph BROWSER["Browser - JupyterLab page"]
        direction TB
        TRIG["consumer triggers<br/>passkey:run"]
        CER["navigator.credentials<br/>get / create"]
        OS(["OS / authenticator<br/>Windows Hello, security key"])
        TRIG --> CER
        CER <--> OS
    end
    subgraph SERVER["Jupyter server"]
        direction TB
        EP["POST /result<br/>authenticated"]
        RELAY[("atomic 0600 relay<br/>/dev/shm/jlab-passkey-uid")]
        EP --> RELAY
    end
    LOCAL["local client<br/>terminal / CLI / API"]
    CER -->|"POST JSON result"| EP
    RELAY -->|"reads, then shreds"| LOCAL

    style BROWSER stroke:#6b7280,stroke-width:3px
    style SERVER stroke:#6b7280,stroke-width:3px
    style TRIG stroke:#f59e0b,stroke-width:2px
    style CER stroke:#10b981,stroke-width:2px
    style OS stroke:#0284c7,stroke-width:2px
    style EP stroke:#10b981,stroke-width:2px
    style RELAY stroke:#3b82f6,stroke-width:2px
    style LOCAL stroke:#10b981,stroke-width:2px

Outbound - copy runs the same plumbing backwards: the local client writes and the server reads. The notification carries only a nonce (see Security), raised through the notifications extension - which is how every button in either direction gets on screen:

flowchart LR
    LOCAL2["local client<br/>CLI / agent"]
    subgraph SERVER2["Jupyter server"]
        direction TB
        ING["notifications ingest<br/>separate extension"]
        RELAY2[("0600 relay<br/>nonce.secret")]
        EP2["POST /secret<br/>authenticated"]
        RELAY2 -->|"reads, then unlinks"| EP2
    end
    subgraph BROWSER2["Browser - JupyterLab page"]
        direction TB
        BTN["notification button<br/>passkey:copy"]
        CLIP(["user's clipboard"])
        BTN --> CLIP
    end
    LOCAL2 -->|"stages the secret"| RELAY2
    LOCAL2 -->|"posts the nonce only"| ING
    ING -.->|"pushes to the page"| BTN
    BTN -->|"collects, once"| EP2
    EP2 -->|"the value"| BTN

    style BROWSER2 stroke:#6b7280,stroke-width:3px
    style SERVER2 stroke:#6b7280,stroke-width:3px
    style LOCAL2 stroke:#10b981,stroke-width:2px
    style ING stroke:#f59e0b,stroke-width:2px
    style RELAY2 stroke:#3b82f6,stroke-width:2px
    style EP2 stroke:#10b981,stroke-width:2px
    style BTN stroke:#f59e0b,stroke-width:2px
    style CLIP stroke:#0284c7,stroke-width:2px

Install

pip install jupyterlab_passkey_extension

Command line

jupyterlab-passkey ships with the package and is the intended way in. It turns a browser ceremony into a blocking local call: it posts the notification carrying the request, waits for your click, and prints the result. A caller needs to know none of the relay contract below, beyond the path passphrase hands it.

Command	Does	Prints
create	registers a new passkey	its cred_id
get	asserts a passkey	the PRF (with --prf-salt) or the cred_id
passphrase	prompts you for a secret in the browser	the path of a 0600 file, never the value
copy	puts a secret on your clipboard	nothing - it posts a button and returns

Exit status is the contract: 0 succeeded, 1 refused, timed out, or could not reach the server. Only the result goes to stdout, so $(...) captures it clean.

Enroll a passkey, then derive key material from it:

cred_id=$(jupyterlab-passkey create --rp-id lab.example.com)

salt=$(head -c32 /dev/urandom | base64 | tr '+/' '-_' | tr -d '=')
prf=$(jupyterlab-passkey get --rp-id lab.example.com --cred-id "$cred_id" --prf-salt "$salt")

Take a secret from the user and give it straight to a consumer, without it passing through the terminal:

pass_file=$(jupyterlab-passkey passphrase --prompt "Recovery passphrase") || exit 1
PASS_RECOVERY_FILE="$pass_file" pass-cli-open --ensure
shred -u "$pass_file"

# a token you paste rather than type - one field, no confirmation
tok_file=$(jupyterlab-passkey passphrase --once --prompt "GitHub token") || exit 1

The || exit 1 matters: a prefix assignment does not propagate a command substitution's exit status, so PASS_RECOVERY_FILE=$(jupyterlab-passkey passphrase) pass-cli-open would run the consumer with an empty passphrase file after a timeout or a cancel.

Send a secret the other way, to the user's clipboard:

pass-cli get github/api --field password --quiet --no-clipboard \
  | jupyterlab-passkey copy --label "GitHub token"

copy reads from a file or stdin and returns immediately - the click is what collects it, one time only - so its exit code means posted, not copied. Add --block to wait until the browser collects the secret and delete it if that never happens; even then it means collected, not pasted, since the page writes the clipboard after the relay is already gone. It refuses a stdin that is a terminal, which would echo the secret into your scrollback.

Full flags in docs/cli-reference.md, or jupyterlab-passkey <command> --help.

Server API

All endpoints live under the server base URL and require Jupyter authentication (@tornado.web.authenticated - a caller needs the Jupyter token or session).

Method	Path	Purpose
POST	<base_url>/jupyterlab-passkey-extension/result	ceremony result → atomic 0600 <nonce>.json; 204
POST	<base_url>/jupyterlab-passkey-extension/passphrase	{nonce, passphrase} → raw <nonce>.pass; 204
POST	<base_url>/jupyterlab-passkey-extension/secret	{nonce} ← raw <nonce>.secret; {"value": "..."}, or 404 once collected
GET	<base_url>/jupyterlab-passkey-extension/health	{ "ok": true }

Every POST answers 400 on a bad nonce and touches no file when it does. The nonce is the relay filename, so it must match [A-Za-z0-9_-]{16,128}. Bodies and values are never logged.

secret is the one endpoint that reads rather than writes, and the one the CLI stages for rather than the frontend. It is a POST despite only reading: the read is destructive, and a GET would carry the nonce in the query string straight into the server's access log.

The relay contract

• Directory - /dev/shm/jlab-passkey-$(id -u), mode 0700, ownership verified before every read and write; override with JLAB_PASSKEY_RELAY_DIR
• Files - <nonce>.json (ceremony result), raw <nonce>.pass (captured secret), raw <nonce>.secret (secret going out to the clipboard)
• Mode - 0600, written mkstemp-then-os.replace, so a reader never sees a partial write
• Lifecycle - the consumer shreds .json and .pass; .secret is server-enforced one-shot, unlinked as it is read

// create success
{ "nonce": "...", "ok": true, "cred_id": "<b64url>", "prf_enabled": false }

// get success (prf present only when prf_salt was supplied and evaluated)
{ "nonce": "...", "ok": true, "cred_id": "<b64url>", "prf": "<b64url>" }

// failure
{ "nonce": "...", "ok": false, "error": "no-prf" | "not-allowed" | "error" }

create never rejects on the create-time PRF flag - it always returns cred_id and a plain prf_enabled. Some authenticators (Windows Hello) report prf_enabled: false at registration yet yield a real PRF at assertion, so PRF availability is confirmed by a follow-up get with a prf_salt. not-allowed is WebAuthn's deliberate conflation of user-cancel, no-matching-credential, and wrong-RP into one privacy-preserving code.

For extension authors: the frontend commands

Three JupyterLab commands POST to the API above. Reach for them only when writing an extension that triggers a ceremony itself; everything else is better served by the CLI.

Command	Args	Does
passkey:run	op, nonce, rp_id, cred_id?, prf_salt?, user?	runs the ceremony and POSTs the result to /result
passkey:passphrase	nonce, prompt?, once?	opens the dialog and POSTs the value to /passphrase
passkey:copy	nonce, label?	collects a staged secret from /secret and writes it to the clipboard

passkey:run reaches navigator.credentials.* before any await, so the trigger's user gesture survives into the ceremony. The challenge is a random 32-byte value the frontend generates itself - anti-replay plumbing nothing here verifies, so callers never supply it.

WebAuthn requires a user gesture, and this extension builds no request-submission UI of its own - that is the consumer's job. The reference trigger is a jupyterlab-notify notification whose action button is bound to the command; the click supplies the gesture and reaches the command with the app already in hand. This is what the CLI does for you.

jupyterlab-notify --now --no-auto-close -t info \
  -m "Approve passkey" \
  --action "Approve" \
  --cmd "passkey:run" \
  --command-args '{"op":"get","nonce":"<16-128 url-safe chars>","rp_id":"lab.example.com","cred_id":"<b64url>","prf_salt":"<b64url>"}'

[!NOTE] Do not start JupyterLab with --expose-app-in-browser just to trigger the command by hand. A notify button (or any extension that holds the app reference) reaches passkey:run directly with a genuine gesture and no global.

Full argument, relay, and endpoint reference in docs/commands-reference.md; a worked consumer walkthrough that seals and opens a secret with a passkey in docs/example-secret-unlock.md.

Security

• All four endpoints are gated by @tornado.web.authenticated - a caller needs the Jupyter token or session
• The relay is created with mkstemp + os.replace: a fresh 0600 file with no world-readable window, renamed onto its <nonce> name atomically. A reader never sees a partial write, and the file is never appended to
• Single-read is the consumer's responsibility for <nonce>.json and <nonce>.pass - the server does not delete those, so a consumer must shred -u what it reads. <nonce>.secret is the exception: the server reads it and unlinks it together, so collection is a server-enforced one shot
• A secret never enters a notification. The notifications extension pushes every payload to each connected socket and holds it in an in-memory queue until a client drains it, so what travels there is a nonce - useless without the Jupyter token that collects it
• The relay directory's path is uid-scoped but predictable, and /dev/shm is world-writable (1777), so squatting it is checked rather than assumed away: before any read or write, the directory must be a real directory (not a symlink) owned by the current uid - anything foreign raises instead of falling back, so a co-tenant who gets there first is refused, not followed. A loose mode on a directory that is ours is tightened to 0700, not refused
• The result body, the passphrase, and any PRF value are never written to logs
• The extension performs no cryptography and stores no secret; every parameter and all key handling belong to the caller
• Once a secret reaches the clipboard it is an OS-wide value, readable by any application until overwritten - inherent to copy's purpose, and the reason nothing else here touches the clipboard

Requirements

• JupyterLab >= 4.0.0, served over HTTPS or on localhost - WebAuthn needs a secure context
• An open JupyterLab tab on the same server. The click in it is the user gesture WebAuthn requires, and a terminal has none
• jupyterlab_notifications_extension - a hard dependency, installed for you. The CLI posts to its ingest endpoint to raise the button
• A passkey authenticator for create and get: Windows Hello, Touch ID, a security key, or a browser password manager. passphrase and copy need none

Development install

# from a clone of this repository
pip install -e "."
jupyter labextension develop . --overwrite
jlpm build

Rebuild after changes with jlpm build, or run jlpm watch in one terminal alongside JupyterLab. See CONTRIBUTING.md for the full development, testing, and release workflow.

Uninstall

pip uninstall jupyterlab_passkey_extension

License

BSD-3-Clause. See LICENSE.