@cloudflare/sandbox 0.0.0-d1c7c99 → 0.0.0-d81d2a5

package/src/jupyter-client.ts

@@ -0,0 +1,266 @@
+import { HttpClient } from './client.js';
+import type { 
+  CodeContext, 
+  CreateContextOptions, 
+  ExecutionError, 
+  OutputMessage,
+  Result
+} from './interpreter-types.js';
+
+// API Response types
+interface ContextResponse {
+  id: string;
+  language: string;
+  cwd: string;
+  createdAt: string;  // ISO date string from JSON
+  lastUsed: string;   // ISO date string from JSON
+}
+
+interface ContextListResponse {
+  contexts: ContextResponse[];
+}
+
+interface ErrorResponse {
+  error: string;
+}
+
+// Streaming execution data from the server
+interface StreamingExecutionData {
+  type: 'result' | 'stdout' | 'stderr' | 'error' | 'execution_complete';
+  text?: string;
+  html?: string;
+  png?: string;    // base64
+  jpeg?: string;   // base64
+  svg?: string;
+  latex?: string;
+  markdown?: string;
+  javascript?: string;
+  json?: any;
+  chart?: any;
+  data?: any;
+  metadata?: any;
+  execution_count?: number;
+  ename?: string;
+  evalue?: string;
+  traceback?: string[];
+  lineNumber?: number;
+  timestamp?: number;
+}
+
+export interface ExecutionCallbacks {
+  onStdout?: (output: OutputMessage) => void | Promise<void>;
+  onStderr?: (output: OutputMessage) => void | Promise<void>;
+  onResult?: (result: Result) => void | Promise<void>;
+  onError?: (error: ExecutionError) => void | Promise<void>;
+}
+
+export class JupyterClient extends HttpClient {
+  async createCodeContext(options: CreateContextOptions = {}): Promise<CodeContext> {
+    const response = await this.doFetch('/api/contexts', {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        language: options.language || 'python',
+        cwd: options.cwd || '/workspace',
+        env_vars: options.envVars
+      }),
+    });
+    
+    if (!response.ok) {
+      const errorData = await response.json().catch(() => ({ error: 'Unknown error' })) as ErrorResponse;
+      throw new Error(errorData.error || `Failed to create context: ${response.status}`);
+    }
+    
+    const data = await response.json() as ContextResponse;
+    return {
+      id: data.id,
+      language: data.language,
+      cwd: data.cwd,
+      createdAt: new Date(data.createdAt),
+      lastUsed: new Date(data.lastUsed)
+    };
+  }
+  
+  async runCodeStream(
+    contextId: string | undefined, 
+    code: string, 
+    language: string | undefined,
+    callbacks: ExecutionCallbacks
+  ): Promise<void> {
+    const response = await this.doFetch('/api/execute/code', {
+      method: 'POST',
+      headers: { 
+        'Content-Type': 'application/json',
+        'Accept': 'text/event-stream'
+      },
+      body: JSON.stringify({ 
+        context_id: contextId, 
+        code,
+        language 
+      }),
+    });
+    
+    if (!response.ok) {
+      const errorData = await response.json().catch(() => ({ error: 'Unknown error' })) as ErrorResponse;
+      throw new Error(errorData.error || `Failed to execute code: ${response.status}`);
+    }
+    
+    if (!response.body) {
+      throw new Error('No response body for streaming execution');
+    }
+    
+    // Process streaming response
+    for await (const chunk of this.readLines(response.body)) {
+      await this.parseExecutionResult(chunk, callbacks);
+    }
+  }
+  
+  private async *readLines(stream: ReadableStream<Uint8Array>): AsyncGenerator<string> {
+    const reader = stream.getReader();
+    let buffer = '';
+    
+    try {
+      while (true) {
+        const { done, value } = await reader.read();
+        if (value) {
+          buffer += new TextDecoder().decode(value);
+        }
+        if (done) break;
+        
+        let newlineIdx = buffer.indexOf('\n');
+        while (newlineIdx !== -1) {
+          yield buffer.slice(0, newlineIdx);
+          buffer = buffer.slice(newlineIdx + 1);
+          newlineIdx = buffer.indexOf('\n');
+        }
+      }
+      
+      // Yield any remaining data
+      if (buffer.length > 0) {
+        yield buffer;
+      }
+    } finally {
+      reader.releaseLock();
+    }
+  }
+  
+  private async parseExecutionResult(line: string, callbacks: ExecutionCallbacks) {
+    if (!line.trim()) return;
+    
+    try {
+      const data = JSON.parse(line) as StreamingExecutionData;
+      
+      switch (data.type) {
+        case 'stdout':
+          if (callbacks.onStdout && data.text) {
+            await callbacks.onStdout({
+              text: data.text,
+              timestamp: data.timestamp || Date.now()
+            });
+          }
+          break;
+          
+        case 'stderr':
+          if (callbacks.onStderr && data.text) {
+            await callbacks.onStderr({
+              text: data.text,
+              timestamp: data.timestamp || Date.now()
+            });
+          }
+          break;
+          
+        case 'result':
+          if (callbacks.onResult) {
+            // Convert raw result to Result interface
+            const result: Result = {
+              text: data.text,
+              html: data.html,
+              png: data.png,
+              jpeg: data.jpeg,
+              svg: data.svg,
+              latex: data.latex,
+              markdown: data.markdown,
+              javascript: data.javascript,
+              json: data.json,
+              chart: data.chart,
+              data: data.data,
+              formats: () => {
+                const formats: string[] = [];
+                if (data.text) formats.push('text');
+                if (data.html) formats.push('html');
+                if (data.png) formats.push('png');
+                if (data.jpeg) formats.push('jpeg');
+                if (data.svg) formats.push('svg');
+                if (data.latex) formats.push('latex');
+                if (data.markdown) formats.push('markdown');
+                if (data.javascript) formats.push('javascript');
+                if (data.json) formats.push('json');
+                if (data.chart) formats.push('chart');
+                return formats;
+              }
+            };
+            await callbacks.onResult(result);
+          }
+          break;
+          
+        case 'error':
+          if (callbacks.onError) {
+            await callbacks.onError({
+              name: data.ename || 'Error',
+              value: data.evalue || data.text || 'Unknown error',
+              traceback: data.traceback || [],
+              lineNumber: data.lineNumber
+            });
+          }
+          break;
+          
+        case 'execution_complete':
+          // Execution completed successfully
+          break;
+      }
+    } catch (error) {
+      console.error('[JupyterClient] Error parsing execution result:', error);
+    }
+  }
+  
+  async listCodeContexts(): Promise<CodeContext[]> {
+    const response = await this.doFetch('/api/contexts', {
+      method: 'GET',
+      headers: { 'Content-Type': 'application/json' }
+    });
+    
+    if (!response.ok) {
+      const errorData = await response.json().catch(() => ({ error: 'Unknown error' })) as ErrorResponse;
+      throw new Error(errorData.error || `Failed to list contexts: ${response.status}`);
+    }
+    
+    const data = await response.json() as ContextListResponse;
+    return data.contexts.map((ctx) => ({
+      id: ctx.id,
+      language: ctx.language,
+      cwd: ctx.cwd,
+      createdAt: new Date(ctx.createdAt),
+      lastUsed: new Date(ctx.lastUsed)
+    }));
+  }
+  
+  async deleteCodeContext(contextId: string): Promise<void> {
+    const response = await this.doFetch(`/api/contexts/${contextId}`, {
+      method: 'DELETE',
+      headers: { 'Content-Type': 'application/json' }
+    });
+    
+    if (!response.ok) {
+      const errorData = await response.json().catch(() => ({ error: 'Unknown error' })) as ErrorResponse;
+      throw new Error(errorData.error || `Failed to delete context: ${response.status}`);
+    }
+  }
+  
+  // Override parent doFetch to be public for this class
+  public async doFetch(
+    path: string,
+    options?: RequestInit
+  ): Promise<Response> {
+    return super.doFetch(path, options);
+  }
+}

package/src/request-handler.ts

@@ -0,0 +1,144 @@
+import { getSandbox, type Sandbox } from "./sandbox";
+import {
+  logSecurityEvent,
+  sanitizeSandboxId,
+  validatePort
+} from "./security";
+
+export interface SandboxEnv {
+  Sandbox: DurableObjectNamespace<Sandbox>;
+}
+
+export interface RouteInfo {
+  port: number;
+  sandboxId: string;
+  path: string;
+}
+
+export async function proxyToSandbox<E extends SandboxEnv>(
+  request: Request,
+  env: E
+): Promise<Response | null> {
+  try {
+    const url = new URL(request.url);
+    const routeInfo = extractSandboxRoute(url);
+
+    if (!routeInfo) {
+      return null; // Not a request to an exposed container port
+    }
+
+    const { sandboxId, port, path } = routeInfo;
+    const sandbox = getSandbox(env.Sandbox, sandboxId);
+
+    // Build proxy request with proper headers
+    let proxyUrl: string;
+
+    // Route based on the target port
+    if (port !== 3000) {
+      // Route directly to user's service on the specified port
+      proxyUrl = `http://localhost:${port}${path}${url.search}`;
+    } else {
+      // Port 3000 is our control plane - route normally
+      proxyUrl = `http://localhost:3000${path}${url.search}`;
+    }
+
+    const proxyRequest = new Request(proxyUrl, {
+      method: request.method,
+      headers: {
+        ...Object.fromEntries(request.headers),
+        'X-Original-URL': request.url,
+        'X-Forwarded-Host': url.hostname,
+        'X-Forwarded-Proto': url.protocol.replace(':', ''),
+        'X-Sandbox-Name': sandboxId, // Pass the friendly name
+      },
+      body: request.body,
+    });
+
+    return sandbox.containerFetch(proxyRequest, port);
+  } catch (error) {
+    console.error('[Sandbox] Proxy routing error:', error);
+    return new Response('Proxy routing error', { status: 500 });
+  }
+}
+
+function extractSandboxRoute(url: URL): RouteInfo | null {
+  // Parse subdomain pattern: port-sandboxId.domain
+  const subdomainMatch = url.hostname.match(/^(\d{4,5})-([^.-][^.]*[^.-]|[^.-])\.(.+)$/);
+
+  if (!subdomainMatch) {
+    // Log malformed subdomain attempts
+    if (url.hostname.includes('-') && url.hostname.includes('.')) {
+      logSecurityEvent('MALFORMED_SUBDOMAIN_ATTEMPT', {
+        hostname: url.hostname,
+        url: url.toString()
+      }, 'medium');
+    }
+    return null;
+  }
+
+  const portStr = subdomainMatch[1];
+  const sandboxId = subdomainMatch[2];
+  const domain = subdomainMatch[3];
+
+  const port = parseInt(portStr, 10);
+  if (!validatePort(port)) {
+    logSecurityEvent('INVALID_PORT_IN_SUBDOMAIN', {
+      port,
+      portStr,
+      sandboxId,
+      hostname: url.hostname,
+      url: url.toString()
+    }, 'high');
+    return null;
+  }
+
+  let sanitizedSandboxId: string;
+  try {
+    sanitizedSandboxId = sanitizeSandboxId(sandboxId);
+  } catch (error) {
+    logSecurityEvent('INVALID_SANDBOX_ID_IN_SUBDOMAIN', {
+      sandboxId,
+      port,
+      hostname: url.hostname,
+      url: url.toString(),
+      error: error instanceof Error ? error.message : 'Unknown error'
+    }, 'high');
+    return null;
+  }
+
+  // DNS subdomain length limit is 63 characters
+  if (sandboxId.length > 63) {
+    logSecurityEvent('SANDBOX_ID_LENGTH_VIOLATION', {
+      sandboxId,
+      length: sandboxId.length,
+      port,
+      hostname: url.hostname
+    }, 'medium');
+    return null;
+  }
+
+  logSecurityEvent('SANDBOX_ROUTE_EXTRACTED', {
+    port,
+    sandboxId: sanitizedSandboxId,
+    domain,
+    path: url.pathname || "/",
+    hostname: url.hostname
+  }, 'low');
+
+  return {
+    port,
+    sandboxId: sanitizedSandboxId,
+    path: url.pathname || "/",
+  };
+}
+
+export function isLocalhostPattern(hostname: string): boolean {
+  const hostPart = hostname.split(":")[0];
+  return (
+    hostPart === "localhost" ||
+    hostPart === "127.0.0.1" ||
+    hostPart === "::1" ||
+    hostPart === "[::1]" ||
+    hostPart === "0.0.0.0"
+  );
+}