@aamp/protocol 1.1.0 → 1.1.2

package/src/nextjs.ts

@@ -1,109 +1,109 @@
-/**
- * Layer 3: Framework Adapters
- * Serverless integration for Next.js (App Router & API Routes).
- */
-import { AAMPPublisher } from './publisher';
-import { AccessPolicy, ContentOrigin, SignedAccessRequest } from './types';
-import { generateKeyPair } from './crypto';
-import { HEADERS } from './constants';
-
-type NextRequest = any; 
-type NextResponse = any; 
-
-const createJsonResponse = (body: any, status = 200) => {
-  return new Response(JSON.stringify(body), {
-    status,
-    headers: { 'Content-Type': 'application/json' }
-  });
-};
-
-export interface AAMPConfig {
-  policy: Omit<AccessPolicy, 'version'>;
-  meta: {
-    origin: keyof typeof ContentOrigin;
-    paymentPointer?: string;
-  };
-}
-
-export class AAMPNext {
-  private publisher: AAMPPublisher;
-  private origin: ContentOrigin;
-  private ready: Promise<void>;
-
-  private constructor(config: AAMPConfig) {
-    this.publisher = new AAMPPublisher({
-      version: '1.1',
-      ...config.policy
-    } as AccessPolicy);
-    this.origin = ContentOrigin[config.meta.origin];
-    
-    this.ready = generateKeyPair().then(keys => this.publisher.initialize(keys));
-  }
-
-  static init(config: AAMPConfig): AAMPNext {
-    return new AAMPNext(config);
-  }
-
-  /**
-   * Serverless Route Wrapper
-   */
-  withProtection(handler: (req: NextRequest) => Promise<NextResponse>) {
-    return async (req: NextRequest) => {
-      await this.ready;
-
-      // 1. Active Verification
-      const payloadHeader = req.headers.get(HEADERS.PAYLOAD);
-      const sigHeader = req.headers.get(HEADERS.SIGNATURE);
-      const keyHeader = req.headers.get(HEADERS.PUBLIC_KEY);
-
-      if (payloadHeader && sigHeader && keyHeader) {
-        try {
-          const headerJson = atob(payloadHeader); // RAW STRING
-          const requestHeader = JSON.parse(headerJson);
-          
-          const signedRequest: SignedAccessRequest = {
-            header: requestHeader,
-            signature: sigHeader,
-            publicKey: keyHeader
-          };
-
-          const agentKey = await crypto.subtle.importKey(
-            "spki",
-            new Uint8Array(atob(keyHeader).split('').map(c => c.charCodeAt(0))),
-            { name: "ECDSA", namedCurve: "P-256" },
-            true,
-            ["verify"]
-          );
-
-          // Pass raw headerJson to ensure signature matches exactly what was signed
-          const result = await this.publisher.verifyRequest(signedRequest, agentKey, headerJson);
-
-          if (!result.allowed) {
-            return createJsonResponse({ error: result.reason }, 403);
-          }
-        } catch (e) {
-          return createJsonResponse({ error: "Invalid AAMP Signature" }, 400);
-        }
-      }
-
-      // 2. Execute Handler
-      const response = await handler(req);
-
-      // 3. Inject Provenance Headers (Passive)
-      const aampHeaders = await this.publisher.generateResponseHeaders(this.origin);
-      if (response && response.headers) {
-         Object.entries(aampHeaders).forEach(([k, v]) => {
-           response.headers.set(k, v);
-         });
-      }
-
-      return response;
-    };
-  }
-
-  discoveryHandler() {
-    return async () => {
-      return createJsonResponse(this.publisher.getPolicy());
-    };
-  }
+/**
+ * Layer 3: Framework Adapters
+ * Serverless integration for Next.js (App Router & API Routes).
+ */
+import { AAMPPublisher } from './publisher';
+import { AccessPolicy, ContentOrigin, SignedAccessRequest } from './types';
+import { generateKeyPair } from './crypto';
+import { HEADERS } from './constants';
+
+type NextRequest = any; 
+type NextResponse = any; 
+
+const createJsonResponse = (body: any, status = 200) => {
+  return new Response(JSON.stringify(body), {
+    status,
+    headers: { 'Content-Type': 'application/json' }
+  });
+};
+
+export interface AAMPConfig {
+  policy: Omit<AccessPolicy, 'version'>;
+  meta: {
+    origin: keyof typeof ContentOrigin;
+    paymentPointer?: string;
+  };
+}
+
+export class AAMPNext {
+  private publisher: AAMPPublisher;
+  private origin: ContentOrigin;
+  private ready: Promise<void>;
+
+  private constructor(config: AAMPConfig) {
+    this.publisher = new AAMPPublisher({
+      version: '1.1',
+      ...config.policy
+    } as AccessPolicy);
+    this.origin = ContentOrigin[config.meta.origin];
+    
+    this.ready = generateKeyPair().then(keys => this.publisher.initialize(keys));
+  }
+
+  static init(config: AAMPConfig): AAMPNext {
+    return new AAMPNext(config);
+  }
+
+  /**
+   * Serverless Route Wrapper
+   */
+  withProtection(handler: (req: NextRequest) => Promise<NextResponse>) {
+    return async (req: NextRequest) => {
+      await this.ready;
+
+      // 1. Active Verification
+      const payloadHeader = req.headers.get(HEADERS.PAYLOAD);
+      const sigHeader = req.headers.get(HEADERS.SIGNATURE);
+      const keyHeader = req.headers.get(HEADERS.PUBLIC_KEY);
+
+      if (payloadHeader && sigHeader && keyHeader) {
+        try {
+          const headerJson = atob(payloadHeader); // RAW STRING
+          const requestHeader = JSON.parse(headerJson);
+          
+          const signedRequest: SignedAccessRequest = {
+            header: requestHeader,
+            signature: sigHeader,
+            publicKey: keyHeader
+          };
+
+          const agentKey = await crypto.subtle.importKey(
+            "spki",
+            new Uint8Array(atob(keyHeader).split('').map(c => c.charCodeAt(0))),
+            { name: "ECDSA", namedCurve: "P-256" },
+            true,
+            ["verify"]
+          );
+
+          // Pass raw headerJson to ensure signature matches exactly what was signed
+          const result = await this.publisher.verifyRequest(signedRequest, agentKey, headerJson);
+
+          if (!result.allowed) {
+            return createJsonResponse({ error: result.reason }, 403);
+          }
+        } catch (e) {
+          return createJsonResponse({ error: "Invalid AAMP Signature" }, 400);
+        }
+      }
+
+      // 2. Execute Handler
+      const response = await handler(req);
+
+      // 3. Inject Provenance Headers (Passive)
+      const aampHeaders = await this.publisher.generateResponseHeaders(this.origin);
+      if (response && response.headers) {
+         Object.entries(aampHeaders).forEach(([k, v]) => {
+           response.headers.set(k, v);
+         });
+      }
+
+      return response;
+    };
+  }
+
+  discoveryHandler() {
+    return async () => {
+      return createJsonResponse(this.publisher.getPolicy());
+    };
+  }
 }

package/src/publisher.ts

@@ -1,107 +1,107 @@
-/**
- * Layer 2: Publisher Middleware
- * Used by content owners to enforce policy and log access.
- */
-import { AccessPolicy, AccessPurpose, SignedAccessRequest, ContentOrigin, FeedbackSignal } from './types';
-import { verifySignature, signData } from './crypto';
-import { MAX_CLOCK_SKEW_MS, HEADERS } from './constants';
-
-export interface VerificationResult {
-  allowed: boolean;
-  reason: string;
-  responseHeaders?: Record<string, string>;
-}
-
-export class AAMPPublisher {
-  private policy: AccessPolicy;
-  private keyPair: CryptoKeyPair | null = null;
-  
-  constructor(policy: AccessPolicy) {
-    this.policy = policy;
-  }
-
-  // Publishers now need keys too, to sign their Content Origin declarations
-  async initialize(keyPair: CryptoKeyPair) {
-    this.keyPair = keyPair;
-  }
-
-  getPolicy(): AccessPolicy {
-    return this.policy;
-  }
-
-  /**
-   * Verifies an incoming AI access request.
-   * 
-   * @param request The parsed request object
-   * @param requestPublicKey The agent's public key
-   * @param rawPayload (Optional) The raw string received over the wire. REQUIRED for robust verification.
-   */
-  async verifyRequest(
-    request: SignedAccessRequest, 
-    requestPublicKey: CryptoKey,
-    rawPayload?: string
-  ): Promise<VerificationResult> {
-    
-    // 1. Replay Attack Prevention (Timestamp Check)
-    const requestTime = new Date(request.header.ts).getTime();
-    const now = Date.now();
-    if (Math.abs(now - requestTime) > MAX_CLOCK_SKEW_MS) {
-      return { allowed: false, reason: 'TIMESTAMP_INVALID: Clock skew exceeded.' };
-    }
-
-    // 2. Policy Enforcement (Usage Type)
-    // STRICT CHECK: Training
-    if (request.header.purpose === AccessPurpose.CRAWL_TRAINING && !this.policy.allowTraining) {
-      return { allowed: false, reason: 'POLICY_DENIED: Training not allowed by site owner.' };
-    }
-    // STRICT CHECK: RAG / Retrieval
-    if (request.header.purpose === AccessPurpose.RAG_RETRIEVAL && !this.policy.allowRAG) {
-      return { allowed: false, reason: 'POLICY_DENIED: RAG Retrieval not allowed.' };
-    }
-
-    // 3. Economic Policy Enforcement
-    if (this.policy.requiresPayment) {
-      const isExemptViaAds = this.policy.allowAdSupportedAccess && request.header.context.ads_displayed;
-      
-      if (!isExemptViaAds) {
-        return { 
-          allowed: false, 
-          reason: 'PAYMENT_REQUIRED: Site requires payment or ad-supported access.' 
-        };
-      }
-    }
-
-    // 4. Cryptographic Verification (The "Proof")
-    // CRITICAL: We prefer the rawPayload if available to avoid JSON parsing/stringify mismatches.
-    const signableString = rawPayload || JSON.stringify(request.header);
-    
-    const isValid = await verifySignature(requestPublicKey, signableString, request.signature);
-
-    if (!isValid) {
-      return { allowed: false, reason: 'CRYPTO_FAIL: Signature verification failed.' };
-    }
-
-    return { allowed: true, reason: 'OK' };
-  }
-
-  /**
-   * Verifies a Feedback Signal (Spam Report) from an Agent.
-   * Part of the AAMP Immune System.
-   */
-  async verifyFeedback(signal: FeedbackSignal, signature: string, agentPublicKey: CryptoKey): Promise<boolean> {
-    const signableString = JSON.stringify(signal);
-    return await verifySignature(agentPublicKey, signableString, signature);
-  }
-
-  async generateResponseHeaders(origin: ContentOrigin): Promise<Record<string, string>> {
-    if (!this.keyPair) throw new Error("Publisher keys not initialized");
-
-    const payload = JSON.stringify({ origin, ts: Date.now() });
-    const signature = await signData(this.keyPair.privateKey, payload);
-
-    return {
-      [HEADERS.CONTENT_ORIGIN]: origin,
-      [HEADERS.PROVENANCE_SIG]: signature
-    };
-  }
+/**
+ * Layer 2: Publisher Middleware
+ * Used by content owners to enforce policy and log access.
+ */
+import { AccessPolicy, AccessPurpose, SignedAccessRequest, ContentOrigin, FeedbackSignal } from './types';
+import { verifySignature, signData } from './crypto';
+import { MAX_CLOCK_SKEW_MS, HEADERS } from './constants';
+
+export interface VerificationResult {
+  allowed: boolean;
+  reason: string;
+  responseHeaders?: Record<string, string>;
+}
+
+export class AAMPPublisher {
+  private policy: AccessPolicy;
+  private keyPair: CryptoKeyPair | null = null;
+  
+  constructor(policy: AccessPolicy) {
+    this.policy = policy;
+  }
+
+  // Publishers now need keys too, to sign their Content Origin declarations
+  async initialize(keyPair: CryptoKeyPair) {
+    this.keyPair = keyPair;
+  }
+
+  getPolicy(): AccessPolicy {
+    return this.policy;
+  }
+
+  /**
+   * Verifies an incoming AI access request.
+   * 
+   * @param request The parsed request object
+   * @param requestPublicKey The agent's public key
+   * @param rawPayload (Optional) The raw string received over the wire. REQUIRED for robust verification.
+   */
+  async verifyRequest(
+    request: SignedAccessRequest, 
+    requestPublicKey: CryptoKey,
+    rawPayload?: string
+  ): Promise<VerificationResult> {
+    
+    // 1. Replay Attack Prevention (Timestamp Check)
+    const requestTime = new Date(request.header.ts).getTime();
+    const now = Date.now();
+    if (Math.abs(now - requestTime) > MAX_CLOCK_SKEW_MS) {
+      return { allowed: false, reason: 'TIMESTAMP_INVALID: Clock skew exceeded.' };
+    }
+
+    // 2. Policy Enforcement (Usage Type)
+    // STRICT CHECK: Training
+    if (request.header.purpose === AccessPurpose.CRAWL_TRAINING && !this.policy.allowTraining) {
+      return { allowed: false, reason: 'POLICY_DENIED: Training not allowed by site owner.' };
+    }
+    // STRICT CHECK: RAG / Retrieval
+    if (request.header.purpose === AccessPurpose.RAG_RETRIEVAL && !this.policy.allowRAG) {
+      return { allowed: false, reason: 'POLICY_DENIED: RAG Retrieval not allowed.' };
+    }
+
+    // 3. Economic Policy Enforcement
+    if (this.policy.requiresPayment) {
+      const isExemptViaAds = this.policy.allowAdSupportedAccess && request.header.context.ads_displayed;
+      
+      if (!isExemptViaAds) {
+        return { 
+          allowed: false, 
+          reason: 'PAYMENT_REQUIRED: Site requires payment or ad-supported access.' 
+        };
+      }
+    }
+
+    // 4. Cryptographic Verification (The "Proof")
+    // CRITICAL: We prefer the rawPayload if available to avoid JSON parsing/stringify mismatches.
+    const signableString = rawPayload || JSON.stringify(request.header);
+    
+    const isValid = await verifySignature(requestPublicKey, signableString, request.signature);
+
+    if (!isValid) {
+      return { allowed: false, reason: 'CRYPTO_FAIL: Signature verification failed.' };
+    }
+
+    return { allowed: true, reason: 'OK' };
+  }
+
+  /**
+   * Verifies a Feedback Signal (Spam Report) from an Agent.
+   * Part of the AAMP Immune System.
+   */
+  async verifyFeedback(signal: FeedbackSignal, signature: string, agentPublicKey: CryptoKey): Promise<boolean> {
+    const signableString = JSON.stringify(signal);
+    return await verifySignature(agentPublicKey, signableString, signature);
+  }
+
+  async generateResponseHeaders(origin: ContentOrigin): Promise<Record<string, string>> {
+    if (!this.keyPair) throw new Error("Publisher keys not initialized");
+
+    const payload = JSON.stringify({ origin, ts: Date.now() });
+    const signature = await signData(this.keyPair.privateKey, payload);
+
+    return {
+      [HEADERS.CONTENT_ORIGIN]: origin,
+      [HEADERS.PROVENANCE_SIG]: signature
+    };
+  }
 }

package/src/types.ts

@@ -1,98 +1,98 @@
-/**
- * Layer 1: Protocol Definitions
- * Shared types used by both Agent and Publisher.
- */
-
-export enum AccessPurpose {
-  CRAWL_TRAINING = 'CRAWL_TRAINING',
-  RAG_RETRIEVAL = 'RAG_RETRIEVAL',
-  SUMMARY = 'SUMMARY',
-  QUOTATION = 'QUOTATION',
-  EMBEDDING = 'EMBEDDING'
-}
-
-export enum ContentOrigin {
-  HUMAN = 'HUMAN',         // Created by humans. High training value.
-  SYNTHETIC = 'SYNTHETIC', // Created by AI. Risk of model collapse.
-  HYBRID = 'HYBRID'        // Edited by humans, drafted by AI.
-}
-
-export enum QualityFlag {
-  SEO_SPAM = 'SEO_SPAM',
-  INACCURATE = 'INACCURATE',
-  HATE_SPEECH = 'HATE_SPEECH',
-  HIGH_QUALITY = 'HIGH_QUALITY'
-}
-
-/**
- * Optional Rate Limiting (The Speed Limit)
- * Defines technical boundaries for the handshake.
- */
-export interface RateLimitConfig {
-  requestsPerMinute: number;
-  tokensPerMinute?: number;
-}
-
-/**
- * Optional Monetization (The Settlement Layer)
- * 
- * AAMP is neutral. Settlement can happen via:
- * 1. BROKER: A 3rd party clearing house (e.g., "AI-AdSense").
- * 2. CRYPTO: Direct on-chain settlement.
- * 3. TREATY: A private legal contract signed offline (Enterprise).
- */
-export interface MonetizationConfig {
-  method: 'BROKER' | 'CRYPTO' | 'PRIVATE_TREATY';
-  /**
-   * The destination for settlement. 
-   * - If BROKER: The API URL of the clearing house.
-   * - If CRYPTO: The wallet address.
-   * - If TREATY: The Contract ID or "Contact Sales".
-   */
-  location: string; 
-}
-
-export interface AccessPolicy {
-  version: '1.1';
-  allowTraining: boolean;
-  allowRAG: boolean;
-  attributionRequired: boolean;
-  
-  // Economic Signals
-  allowAdSupportedAccess: boolean; // If true, Agents showing ads are exempt from payment
-  requiresPayment: boolean;        // If true, Access is denied unless Ad-Supported condition is met
-  paymentPointer?: string;         // @deprecated (Legacy support)
-
-  // V1.1: Optional Traffic Control
-  rateLimit?: RateLimitConfig;
-  
-  // V1.1: Optional Settlement Info
-  // If undefined, parties are assumed to have no economic relationship or settled offline.
-  monetization?: MonetizationConfig;
-}
-
-export interface ProtocolHeader {
-  v: '1.1';
-  ts: string;
-  agent_id: string;
-  resource: string;
-  purpose: AccessPurpose;
-  // Access Context
-  context: {
-    ads_displayed: boolean; // Is the AI Agent displaying ads alongside this content?
-  };
-}
-
-export interface SignedAccessRequest {
-  header: ProtocolHeader;
-  signature: string;
-  publicKey?: string;
-}
-
-export interface FeedbackSignal {
-  target_resource: string;
-  agent_id: string;
-  quality_score: number; // 0.0 to 1.0
-  flags: QualityFlag[];
-  timestamp: string;
+/**
+ * Layer 1: Protocol Definitions
+ * Shared types used by both Agent and Publisher.
+ */
+
+export enum AccessPurpose {
+  CRAWL_TRAINING = 'CRAWL_TRAINING',
+  RAG_RETRIEVAL = 'RAG_RETRIEVAL',
+  SUMMARY = 'SUMMARY',
+  QUOTATION = 'QUOTATION',
+  EMBEDDING = 'EMBEDDING'
+}
+
+export enum ContentOrigin {
+  HUMAN = 'HUMAN',         // Created by humans. High training value.
+  SYNTHETIC = 'SYNTHETIC', // Created by AI. Risk of model collapse.
+  HYBRID = 'HYBRID'        // Edited by humans, drafted by AI.
+}
+
+export enum QualityFlag {
+  SEO_SPAM = 'SEO_SPAM',
+  INACCURATE = 'INACCURATE',
+  HATE_SPEECH = 'HATE_SPEECH',
+  HIGH_QUALITY = 'HIGH_QUALITY'
+}
+
+/**
+ * Optional Rate Limiting (The Speed Limit)
+ * Defines technical boundaries for the handshake.
+ */
+export interface RateLimitConfig {
+  requestsPerMinute: number;
+  tokensPerMinute?: number;
+}
+
+/**
+ * Optional Monetization (The Settlement Layer)
+ * 
+ * AAMP is neutral. Settlement can happen via:
+ * 1. BROKER: A 3rd party clearing house (e.g., "AI-AdSense").
+ * 2. CRYPTO: Direct on-chain settlement.
+ * 3. TREATY: A private legal contract signed offline (Enterprise).
+ */
+export interface MonetizationConfig {
+  method: 'BROKER' | 'CRYPTO' | 'PRIVATE_TREATY';
+  /**
+   * The destination for settlement. 
+   * - If BROKER: The API URL of the clearing house.
+   * - If CRYPTO: The wallet address.
+   * - If TREATY: The Contract ID or "Contact Sales".
+   */
+  location: string; 
+}
+
+export interface AccessPolicy {
+  version: '1.1';
+  allowTraining: boolean;
+  allowRAG: boolean;
+  attributionRequired: boolean;
+  
+  // Economic Signals
+  allowAdSupportedAccess: boolean; // If true, Agents showing ads are exempt from payment
+  requiresPayment: boolean;        // If true, Access is denied unless Ad-Supported condition is met
+  paymentPointer?: string;         // @deprecated (Legacy support)
+
+  // V1.1: Optional Traffic Control
+  rateLimit?: RateLimitConfig;
+  
+  // V1.1: Optional Settlement Info
+  // If undefined, parties are assumed to have no economic relationship or settled offline.
+  monetization?: MonetizationConfig;
+}
+
+export interface ProtocolHeader {
+  v: '1.1';
+  ts: string;
+  agent_id: string;
+  resource: string;
+  purpose: AccessPurpose;
+  // Access Context
+  context: {
+    ads_displayed: boolean; // Is the AI Agent displaying ads alongside this content?
+  };
+}
+
+export interface SignedAccessRequest {
+  header: ProtocolHeader;
+  signature: string;
+  publicKey?: string;
+}
+
+export interface FeedbackSignal {
+  target_resource: string;
+  agent_id: string;
+  quality_score: number; // 0.0 to 1.0
+  flags: QualityFlag[];
+  timestamp: string;
 }