memory-journal-mcp 7.7.1 → 8.0.0

package/skills/cloudflare/references/turn/README.md

@@ -0,0 +1,86 @@
+# Cloudflare TURN Service
+
+Expert guidance for implementing Cloudflare TURN Service in WebRTC applications.
+
+## Overview
+
+Cloudflare TURN (Traversal Using Relays around NAT) Service is a managed relay service for WebRTC applications. TURN acts as a relay point for traffic between WebRTC clients and SFUs, particularly when direct peer-to-peer communication is obstructed by NATs or firewalls. The service runs on Cloudflare's global anycast network across 310+ cities.
+
+## Key Characteristics
+
+- **Anycast Architecture**: Automatically connects clients to the closest Cloudflare location
+- **Global Network**: Available across Cloudflare's entire network (excluding China Network)
+- **Zero Configuration**: No need to manually select regions or servers
+- **Protocol Support**: STUN/TURN over UDP, TCP, and TLS
+- **Free Tier**: Free when used with Cloudflare Calls SFU, otherwise $0.05/GB outbound
+
+## In This Reference
+
+| File                                   | Purpose                                                  |
+| -------------------------------------- | -------------------------------------------------------- |
+| [api.md](./api.md)                     | Credentials API, TURN key management, types, constraints |
+| [configuration.md](./configuration.md) | Worker setup, wrangler.jsonc, env vars, IP allowlisting  |
+| [patterns.md](./patterns.md)           | Implementation patterns, use cases, integration examples |
+| [gotchas.md](./gotchas.md)             | Troubleshooting, limits, security, common mistakes       |
+
+## Reading Order
+
+| Task                 | Files to Read                     | Est. Tokens |
+| -------------------- | --------------------------------- | ----------- |
+| Quick start          | README only                       | ~500        |
+| Generate credentials | README → api                      | ~1300       |
+| Worker integration   | README → configuration → patterns | ~2000       |
+| Debug connection     | gotchas                           | ~700        |
+| Security review      | api → gotchas                     | ~1500       |
+| Enterprise firewall  | configuration                     | ~600        |
+
+## Service Addresses and Ports
+
+### STUN over UDP
+
+- **Primary**: `stun.cloudflare.com:3478/udp`
+- **Alternate**: `stun.cloudflare.com:53/udp` (blocked by browsers, not recommended)
+
+### TURN over UDP
+
+- **Primary**: `turn.cloudflare.com:3478/udp`
+- **Alternate**: `turn.cloudflare.com:53/udp` (blocked by browsers)
+
+### TURN over TCP
+
+- **Primary**: `turn.cloudflare.com:3478/tcp`
+- **Alternate**: `turn.cloudflare.com:80/tcp`
+
+### TURN over TLS
+
+- **Primary**: `turn.cloudflare.com:5349/tcp`
+- **Alternate**: `turn.cloudflare.com:443/tcp`
+
+## Quick Start
+
+1. **Create TURN key via API**: see [api.md#create-turn-key](./api.md#create-turn-key)
+2. **Generate credentials**: see [api.md#generate-temporary-credentials](./api.md#generate-temporary-credentials)
+3. **Configure Worker**: see [configuration.md#cloudflare-worker-integration](./configuration.md#cloudflare-worker-integration)
+4. **Implement client**: see [patterns.md#basic-turn-configuration-browser](./patterns.md#basic-turn-configuration-browser)
+
+## When to Use TURN
+
+- **Restrictive NATs**: Symmetric NATs that block direct connections
+- **Corporate firewalls**: Environments blocking WebRTC ports
+- **Mobile networks**: Carrier-grade NAT scenarios
+- **Predictable connectivity**: When reliability > efficiency
+
+## Related Cloudflare Services
+
+- **Cloudflare Calls SFU**: Managed Selective Forwarding Unit (TURN free when used with SFU)
+- **Cloudflare Stream**: Video streaming with WHIP/WHEP support
+- **Cloudflare Workers**: Backend for credential generation
+- **Cloudflare KV**: Credential caching
+- **Cloudflare Durable Objects**: Session state management
+
+## Additional Resources
+
+- [Cloudflare Calls Documentation](https://developers.cloudflare.com/calls/)
+- [Cloudflare TURN Service Docs](https://developers.cloudflare.com/realtime/turn/)
+- [Cloudflare API Reference](https://developers.cloudflare.com/api/resources/calls/subresources/turn/)
+- [Orange Meets (Open Source Example)](https://github.com/cloudflare/orange)

package/skills/cloudflare/references/turn/api.md

@@ -0,0 +1,236 @@
+# TURN API Reference
+
+Complete API documentation for Cloudflare TURN service credentials and key management.
+
+## Authentication
+
+All endpoints require Cloudflare API token with "Calls Write" permission.
+
+Base URL: `https://api.cloudflare.com/client/v4`
+
+## TURN Key Management
+
+### List TURN Keys
+
+```
+GET /accounts/{account_id}/calls/turn_keys
+```
+
+### Get TURN Key Details
+
+```
+GET /accounts/{account_id}/calls/turn_keys/{key_id}
+```
+
+### Create TURN Key
+
+```
+POST /accounts/{account_id}/calls/turn_keys
+Content-Type: application/json
+
+{
+  "name": "my-turn-key"
+}
+```
+
+**Response includes**:
+
+- `uid`: Key identifier
+- `key`: The actual secret key (only returned on creation—save immediately)
+- `name`: Human-readable name
+- `created`: ISO 8601 timestamp
+- `modified`: ISO 8601 timestamp
+
+### Update TURN Key
+
+```
+PUT /accounts/{account_id}/calls/turn_keys/{key_id}
+Content-Type: application/json
+
+{
+  "name": "updated-name"
+}
+```
+
+### Delete TURN Key
+
+```
+DELETE /accounts/{account_id}/calls/turn_keys/{key_id}
+```
+
+## Generate Temporary Credentials
+
+```
+POST https://rtc.live.cloudflare.com/v1/turn/keys/{key_id}/credentials/generate
+Authorization: Bearer {key_secret}
+Content-Type: application/json
+
+{
+  "ttl": 86400
+}
+```
+
+### Credential Constraints
+
+| Parameter | Min | Max            | Default | Notes                      |
+| --------- | --- | -------------- | ------- | -------------------------- |
+| ttl       | 1   | 172800 (48hrs) | varies  | API rejects values >172800 |
+
+**CRITICAL**: Maximum TTL is 48 hours (172800 seconds). API will reject requests exceeding this limit.
+
+### Response Schema
+
+```json
+{
+  "iceServers": {
+    "urls": [
+      "stun:stun.cloudflare.com:3478",
+      "turn:turn.cloudflare.com:3478?transport=udp",
+      "turn:turn.cloudflare.com:3478?transport=tcp",
+      "turn:turn.cloudflare.com:53?transport=udp",
+      "turn:turn.cloudflare.com:80?transport=tcp",
+      "turns:turn.cloudflare.com:5349?transport=tcp",
+      "turns:turn.cloudflare.com:443?transport=tcp"
+    ],
+    "username": "1738035200:user123",
+    "credential": "base64encodedhmac=="
+  }
+}
+```
+
+**Port 53 Warning**: Filter port 53 URLs for browser clients—blocked by Chrome/Firefox. See [gotchas.md](./gotchas.md#using-port-53-in-browsers).
+
+## Revoke Credentials
+
+```
+POST https://rtc.live.cloudflare.com/v1/turn/keys/{key_id}/credentials/revoke
+Authorization: Bearer {key_secret}
+Content-Type: application/json
+
+{
+  "username": "1738035200:user123"
+}
+```
+
+**Response**: 204 No Content
+
+Billing stops immediately. Active connection drops after short delay (~seconds).
+
+## TypeScript Types
+
+```typescript
+interface CloudflareTURNConfig {
+  keyId: string
+  keySecret: string
+  ttl?: number // Max 172800 (48 hours)
+}
+
+interface TURNCredentialsRequest {
+  ttl?: number // Max 172800 seconds
+}
+
+interface TURNCredentialsResponse {
+  iceServers: {
+    urls: string[]
+    username: string
+    credential: string
+  }
+}
+
+interface RTCIceServer {
+  urls: string | string[]
+  username?: string
+  credential?: string
+  credentialType?: 'password'
+}
+
+interface TURNKeyResponse {
+  uid: string
+  key: string // Only present on creation
+  name: string
+  created: string
+  modified: string
+}
+```
+
+## Validation Function
+
+```typescript
+function validateRTCIceServer(obj: unknown): obj is RTCIceServer {
+  if (!obj || typeof obj !== 'object') {
+    return false
+  }
+
+  const server = obj as Record<string, unknown>
+
+  if (typeof server.urls !== 'string' && !Array.isArray(server.urls)) {
+    return false
+  }
+
+  if (server.username && typeof server.username !== 'string') {
+    return false
+  }
+
+  if (server.credential && typeof server.credential !== 'string') {
+    return false
+  }
+
+  return true
+}
+```
+
+## Type-Safe Credential Generation
+
+```typescript
+async function fetchTURNServers(config: CloudflareTURNConfig): Promise<RTCIceServer[]> {
+  // Validate TTL constraint
+  const ttl = config.ttl ?? 3600
+  if (ttl > 172800) {
+    throw new Error('TTL cannot exceed 172800 seconds (48 hours)')
+  }
+
+  const response = await fetch(
+    `https://rtc.live.cloudflare.com/v1/turn/keys/${config.keyId}/credentials/generate`,
+    {
+      method: 'POST',
+      headers: {
+        Authorization: `Bearer ${config.keySecret}`,
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify({ ttl }),
+    }
+  )
+
+  if (!response.ok) {
+    throw new Error(`TURN credential generation failed: ${response.status}`)
+  }
+
+  const data = await response.json()
+
+  // Filter port 53 for browser clients
+  const filteredUrls = data.iceServers.urls.filter((url: string) => !url.includes(':53'))
+
+  const iceServers = [
+    { urls: 'stun:stun.cloudflare.com:3478' },
+    {
+      urls: filteredUrls,
+      username: data.iceServers.username,
+      credential: data.iceServers.credential,
+      credentialType: 'password' as const,
+    },
+  ]
+
+  // Validate before returning
+  if (!iceServers.every(validateRTCIceServer)) {
+    throw new Error('Invalid ICE server configuration received')
+  }
+
+  return iceServers
+}
+```
+
+## See Also
+
+- [configuration.md](./configuration.md) - Worker setup, environment variables
+- [patterns.md](./patterns.md) - Implementation examples using these APIs
+- [gotchas.md](./gotchas.md) - Security best practices, common mistakes

package/skills/cloudflare/references/turn/configuration.md

@@ -0,0 +1,181 @@
+# TURN Configuration
+
+Setup and configuration for Cloudflare TURN service in Workers and applications.
+
+## Environment Variables
+
+```bash
+# .env
+CLOUDFLARE_ACCOUNT_ID=your_account_id
+CLOUDFLARE_API_TOKEN=your_api_token
+TURN_KEY_ID=your_turn_key_id
+TURN_KEY_SECRET=your_turn_key_secret
+```
+
+Validate with zod:
+
+```typescript
+import { z } from 'zod'
+
+const envSchema = z.object({
+  CLOUDFLARE_ACCOUNT_ID: z.string().min(1),
+  CLOUDFLARE_API_TOKEN: z.string().min(1),
+  TURN_KEY_ID: z.string().min(1),
+  TURN_KEY_SECRET: z.string().min(1),
+})
+
+export const config = envSchema.parse(process.env)
+```
+
+## wrangler.jsonc
+
+```jsonc
+{
+  "name": "turn-credentials-api",
+  "main": "src/index.ts",
+  "compatibility_date": "2025-01-01",
+  "vars": {
+    "TURN_KEY_ID": "your-turn-key-id", // Non-sensitive, can be in vars
+  },
+  "env": {
+    "production": {
+      "kv_namespaces": [
+        {
+          "binding": "CREDENTIALS_CACHE",
+          "id": "your-kv-namespace-id",
+        },
+      ],
+    },
+  },
+}
+```
+
+**Store secrets separately**:
+
+```bash
+wrangler secret put TURN_KEY_SECRET
+```
+
+## Cloudflare Worker Integration
+
+### Worker Binding Types
+
+```typescript
+interface Env {
+  TURN_KEY_ID: string
+  TURN_KEY_SECRET: string
+  CREDENTIALS_CACHE?: KVNamespace
+}
+
+export default {
+  async fetch(request: Request, env: Env): Promise<Response> {
+    // See patterns.md for implementation
+  },
+}
+```
+
+### Basic Worker Example
+
+```typescript
+export default {
+  async fetch(request: Request, env: Env): Promise<Response> {
+    if (request.url.endsWith('/turn-credentials')) {
+      // Validate client auth
+      const authHeader = request.headers.get('Authorization')
+      if (!authHeader) {
+        return new Response('Unauthorized', { status: 401 })
+      }
+
+      const response = await fetch(
+        `https://rtc.live.cloudflare.com/v1/turn/keys/${env.TURN_KEY_ID}/credentials/generate`,
+        {
+          method: 'POST',
+          headers: {
+            Authorization: `Bearer ${env.TURN_KEY_SECRET}`,
+            'Content-Type': 'application/json',
+          },
+          body: JSON.stringify({ ttl: 3600 }),
+        }
+      )
+
+      if (!response.ok) {
+        return new Response('Failed to generate credentials', { status: 500 })
+      }
+
+      const data = await response.json()
+
+      // Filter port 53 for browser clients
+      const filteredUrls = data.iceServers.urls.filter((url: string) => !url.includes(':53'))
+
+      return Response.json({
+        iceServers: [
+          { urls: 'stun:stun.cloudflare.com:3478' },
+          {
+            urls: filteredUrls,
+            username: data.iceServers.username,
+            credential: data.iceServers.credential,
+          },
+        ],
+      })
+    }
+
+    return new Response('Not found', { status: 404 })
+  },
+}
+```
+
+## IP Allowlisting (Enterprise/Firewall)
+
+For strict firewalls, allowlist these IPs for `turn.cloudflare.com`:
+
+| Type | Address               | Protocol |
+| ---- | --------------------- | -------- |
+| IPv4 | 141.101.90.1/32       | All      |
+| IPv4 | 162.159.207.1/32      | All      |
+| IPv6 | 2a06:98c1:3200::1/128 | All      |
+| IPv6 | 2606:4700:48::1/128   | All      |
+
+**IMPORTANT**: These IPs may change with 14-day notice. Monitor DNS:
+
+```bash
+# Check A and AAAA records
+dig turn.cloudflare.com A
+dig turn.cloudflare.com AAAA
+```
+
+Set up automated monitoring to detect IP changes and update allowlists within 14 days.
+
+## IPv6 Support
+
+- **Client-to-TURN**: Both IPv4 and IPv6 supported
+- **Relay addresses**: IPv4 only (no RFC 6156 support)
+- **TCP relaying**: Not supported (RFC 6062)
+
+Clients can connect via IPv6, but relayed traffic uses IPv4 addresses.
+
+## TLS Configuration
+
+### Supported TLS Versions
+
+- TLS 1.1
+- TLS 1.2
+- TLS 1.3
+
+### Recommended Ciphers (TLS 1.3)
+
+- AEAD-AES128-GCM-SHA256
+- AEAD-AES256-GCM-SHA384
+- AEAD-CHACHA20-POLY1305-SHA256
+
+### Recommended Ciphers (TLS 1.2)
+
+- ECDHE-ECDSA-AES128-GCM-SHA256
+- ECDHE-RSA-AES128-GCM-SHA256
+- ECDHE-RSA-AES128-SHA (also TLS 1.1)
+- AES128-GCM-SHA256
+
+## See Also
+
+- [api.md](./api.md) - TURN key creation, credential generation API
+- [patterns.md](./patterns.md) - Full Worker implementation patterns
+- [gotchas.md](./gotchas.md) - Security best practices, troubleshooting