Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@
"integrations/vercel/ai-sdk",
"integrations/vercel/marketplace"
]
}
},
"integrations/web-bot-auth"
]
},
{
Expand Down Expand Up @@ -183,7 +184,8 @@
"reference/cli",
"reference/cli/auth",
"reference/cli/browsers",
"reference/cli/apps"
"reference/cli/apps",
"reference/cli/extensions"
]
}
]
Expand Down
172 changes: 172 additions & 0 deletions integrations/web-bot-auth.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
---
title: "Web Bot Auth"
description: "Cryptographically sign browser requests with Cloudflare's Web Bot Auth"
---

[Web Bot Auth](https://github.com/cloudflare/web-bot-auth) is Cloudflare's implementation of cryptographic authentication for automated web agents. It uses [RFC 9421 HTTP Message Signatures](https://datatracker.ietf.org/doc/html/rfc9421) to sign outgoing HTTP requests, allowing websites to verify the identity and integrity of bot traffic.

By integrating Web Bot Auth with Kernel, your browser automations can cryptographically prove their identity to websites that support signature verification.

## How it works

Web Bot Auth works via a Chrome extension that intercepts all outgoing HTTP requests and adds cryptographic signature headers:

- **`Signature`**: The RFC 9421 signature of the request
- **`Signature-Input`**: Metadata about how the signature was created

Websites can verify these signatures against your public key to confirm the request came from your authenticated agent.

## Quick Start with Test Key

The fastest way to get started is using Cloudflare's RFC9421 test key, which works with their [test verification site](https://http-message-signatures-example.research.cloudflare.com/).

### 1. Build the extension

Use the Kernel CLI to build the Web Bot Auth extension:

```bash
kernel extensions build-web-bot-auth --to ./web-bot-auth-ext --upload
```

This command:
- Downloads Cloudflare's web-bot-auth browser extension source
- Builds it with the default RFC9421 test key
- Uploads it to Kernel as `web-bot-auth`

<Info>
The build command requires Node.js and npm to be installed on your system.
</Info>

### 2. Create a browser with the extension

<CodeGroup>
```bash CLI
# Create a browser with the web-bot-auth extension
kernel browsers create --extension web-bot-auth

# The command outputs the browser ID and live view URL
# Open the live view URL in your browser, then navigate to:
# https://http-message-signatures-example.research.cloudflare.com/
```

```typescript TypeScript
import { Kernel } from "@onkernel/sdk";
import { chromium } from "playwright";

const kernel = new Kernel();

// Create browser with web-bot-auth extension
const browser = await kernel.browsers.create({
extensions: [{ name: "web-bot-auth" }],
});

// Connect via Playwright
const pw = await chromium.connectOverCDP(browser.browser_url);
const context = pw.contexts()[0];
const page = context?.pages()[0] || await context.newPage();

// Navigate to a page - requests will be automatically signed
await page.goto("https://http-message-signatures-example.research.cloudflare.com/");
```

```python Python
from kernel import Kernel
from playwright.sync_api import sync_playwright

kernel = Kernel()

# Create browser with web-bot-auth extension
browser = kernel.browsers.create(extensions=[{"name": "web-bot-auth"}])

# Connect via Playwright
with sync_playwright() as p:
pw = p.chromium.connect_over_cdp(browser.browser_url)
context = pw.contexts[0]
page = context.pages[0] if context.pages else context.new_page()

# Navigate to a page - requests will be automatically signed
page.goto("https://http-message-signatures-example.research.cloudflare.com/")
```

</CodeGroup>

### 3. Verify it's working

Navigate to Cloudflare's test site to verify your signatures are being accepted:

```
https://http-message-signatures-example.research.cloudflare.com/
```

This site validates requests signed with the RFC9421 test key and shows whether the signature was verified successfully.

## Using Your Own Keys

For production use, you'll want to use your own signing keys instead of the test key.

### 1. Generate an Ed25519 key pair

Create a JWK file with your Ed25519 private key. The key must include both the public (`x`) and private (`d`) components:

```json my-key.jwk
{
"kty": "OKP",
"crv": "Ed25519",
"x": "YOUR_PUBLIC_KEY_BASE64URL",
"d": "YOUR_PRIVATE_KEY_BASE64URL"
}
```

<Info>
See [Cloudflare's web-bot-auth documentation](https://github.com/cloudflare/web-bot-auth) for tools to generate Ed25519 key pairs.
</Info>

### 2. Build with your key

```bash
kernel extensions build-web-bot-auth --to ./web-bot-auth-ext --key ./my-key.jwk --upload --name my-web-bot-auth
```

### 3. Host your public key

For websites to verify your signatures, you need to host your public key at a well-known URL. Create a key directory at:

```
https://yourdomain.com/.well-known/http-message-signatures-directory
```

The directory should contain your public keys in JWKS format:

```json
{
"keys": [
{
"kty": "OKP",
"crv": "Ed25519",
"x": "YOUR_PUBLIC_KEY_BASE64URL",
"kid": "YOUR_KEY_ID"
}
],
"purpose": "your-bot-purpose"
}
```

### 4. Register with Cloudflare (optional)

If you want Cloudflare-protected sites to recognize your bot, you can register your key directory with Cloudflare:

1. Log into the Cloudflare dashboard
2. Navigate to **Manage Account > Configurations**
3. Select the **Bot Submission Form** tab
4. Choose **Request Signature** as the verification method
5. Enter your key directory URL

See [Cloudflare's Web Bot Auth documentation](https://developers.cloudflare.com/bots/reference/bot-verification/web-bot-auth/) for complete details.

## References

- [Web Bot Auth GitHub Repository](https://github.com/cloudflare/web-bot-auth)
- [Cloudflare Web Bot Auth Documentation](https://developers.cloudflare.com/bots/reference/bot-verification/web-bot-auth/)
- [RFC 9421 - HTTP Message Signatures](https://datatracker.ietf.org/doc/html/rfc9421)
- [Cloudflare Test Verification Site](https://http-message-signatures-example.research.cloudflare.com/)
- [Web Bot Auth Architecture Draft](https://thibmeu.github.io/http-message-signatures-directory/draft-meunier-web-bot-auth-architecture.html)
3 changes: 3 additions & 0 deletions reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ kernel --version
<Card icon="rocket" title="Apps" href="/reference/cli/apps">
Deploy apps, invoke actions, and stream logs.
</Card>
<Card icon="puzzle-piece" title="Extensions" href="/reference/cli/extensions">
Upload, download, and build browser extensions.
</Card>
</Columns>

## Quick Start
Expand Down
64 changes: 64 additions & 0 deletions reference/cli/extensions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: "Extensions"
---

## Extension management

### `kernel extensions list`
List all uploaded extensions.

### `kernel extensions upload <directory>`
Upload an unpacked browser extension directory.

| Flag | Description |
|------|-------------|
| `--name <name>` | Optional unique extension name. |

### `kernel extensions download <id-or-name>`
Download an extension archive.

| Flag | Description |
|------|-------------|
| `--to <directory>` | Output directory (required). |

### `kernel extensions download-web-store <url>`
Download an extension from the Chrome Web Store.

| Flag | Description |
|------|-------------|
| `--to <directory>` | Output directory (required). |
| `--os <os>` | Target OS: `mac`, `win`, or `linux` (default: `linux`). |

### `kernel extensions delete <id-or-name>`
Delete an extension by ID or name.

| Flag | Description |
|------|-------------|
| `--yes`, `-y` | Skip confirmation prompt. |

### `kernel extensions build-web-bot-auth`
Build Cloudflare's [Web Bot Auth](/integrations/web-bot-auth) browser extension for signing HTTP requests with RFC 9421 signatures.

| Flag | Description |
|------|-------------|
| `--to <dir>` | Output directory for the built extension (required). |
| `--key <path>` | Path to JWK file with Ed25519 signing key (defaults to RFC9421 test key). |
| `--upload` | Upload the extension to Kernel after building. |
| `--name <name>` | Extension name when uploading (default: `web-bot-auth`). |

**Examples:**

```bash
# Build with default test key
kernel extensions build-web-bot-auth --to ./web-bot-auth-ext

# Build with custom key and upload
kernel extensions build-web-bot-auth --to ./web-bot-auth-ext --key ./my-key.jwk --upload

# Build with custom name
kernel extensions build-web-bot-auth --to ./web-bot-auth-ext --upload --name my-company-bot
```

<Info>
This command requires Node.js and npm to be installed on your system.
</Info>