@aamp/protocol 1.1.4 → 1.1.6

package/src/publisher.ts

@@ -2,14 +2,17 @@
  * Layer 2: Publisher Middleware
  * Used by content owners to enforce policy, log access, and filter bots.
  */
-import { HEADERS, MAX_CLOCK_SKEW_MS, WELL_KNOWN_AGENT_PATH } from './constants';
-import { exportPublicKey, signData, verifySignature } from './crypto';
-import { AccessPolicy, AccessPurpose, AgentIdentityManifest, ContentOrigin, EvaluationResult, IdentityCache, SignedAccessRequest, UnauthenticatedStrategy } from './types';
+import { HEADERS, MAX_CLOCK_SKEW_MS, WELL_KNOWN_AGENT_PATH } from './constants.js';
+import { exportPublicKey, signData, verifySignature } from './crypto.js';
+import { AccessPolicy, AccessPurpose, AgentIdentityManifest, ContentOrigin, EvaluationResult, IdentityCache, SignedAccessRequest, UnauthenticatedStrategy } from './types.js';
+import { verifyJwt } from './proof.js';
 
 interface VerificationResult {
   allowed: boolean;
   reason: string;
   identityVerified: boolean;
+  proofUsed?: string; // "WHITELIST", "CREDENTIAL_JWT", "AD_JWT"
+  visitorType?: string; // For audit logs
 }
 
 /**
@@ -18,7 +21,7 @@ interface VerificationResult {
  */
 class MemoryCache implements IdentityCache {
   private store = new Map<string, { val: string, exp: number }>();
-  
+
   async get(key: string): Promise<string | null> {
     const item = this.store.get(key);
     if (!item) return null;
@@ -28,11 +31,11 @@ class MemoryCache implements IdentityCache {
     }
     return item.val;
   }
-  
+
   async set(key: string, value: string, ttlSeconds: number): Promise<void> {
-    this.store.set(key, { 
-      val: value, 
-      exp: Date.now() + (ttlSeconds * 1000) 
+    this.store.set(key, {
+      val: value,
+      exp: Date.now() + (ttlSeconds * 1000)
     });
   }
 }
@@ -42,14 +45,14 @@ export class AAMPPublisher {
   private keyPair: CryptoKeyPair | null = null;
   private unauthenticatedStrategy: UnauthenticatedStrategy;
   private cache: IdentityCache;
-  
+
   // Default TTL: 1 Hour
-  private readonly CACHE_TTL_SECONDS = 3600; 
+  private readonly CACHE_TTL_SECONDS = 3600;
 
   constructor(
-    policy: AccessPolicy, 
+    policy: AccessPolicy,
     strategy: UnauthenticatedStrategy = 'PASSIVE',
-    cacheImpl?: IdentityCache 
+    cacheImpl?: IdentityCache
   ) {
     this.policy = policy;
     this.unauthenticatedStrategy = strategy;
@@ -68,14 +71,20 @@ export class AAMPPublisher {
    * Main Entry Point: Evaluate ANY visitor (Human, Bot, or Agent)
    */
   async evaluateVisitor(
-    reqHeaders: Record<string, string | undefined>, 
+    reqHeaders: Record<string, string | undefined>,
     rawPayload?: string
   ): Promise<EvaluationResult> {
-    
+
     // 1. Check for AAMP Headers
     const hasAamp = reqHeaders[HEADERS.PAYLOAD] && reqHeaders[HEADERS.SIGNATURE] && reqHeaders[HEADERS.PUBLIC_KEY];
 
+    const feedbackToken = reqHeaders[HEADERS.FEEDBACK];
+    if (feedbackToken) {
+      await this.handleFeedback(feedbackToken, reqHeaders);
+    }
+
     if (hasAamp) {
+      console.log("\n🔎 [AAMP Middleware] Detected Agent Headers. Starting Verification...");
       // It claims to be an Agent. Verify it.
       return await this.handleAgent(reqHeaders, rawPayload);
     }
@@ -95,13 +104,13 @@ export class AAMPPublisher {
         allowed: true,
         status: 200,
         reason: "PASSIVE_MODE: Allowed without verification.",
-        visitorType: 'LIKELY_HUMAN' 
+        visitorType: 'LIKELY_HUMAN'
       };
     }
 
     // 3. HYBRID MODE: Heuristic Analysis (The "Lazy Bot" Filter)
     const isHuman = this.performBrowserHeuristics(reqHeaders);
-    
+
     if (isHuman) {
       return {
         allowed: true,
@@ -127,38 +136,27 @@ export class AAMPPublisher {
    */
   private performBrowserHeuristics(headers: Record<string, string | undefined>): boolean {
     const userAgent = headers['user-agent'] || '';
-    
+
     // A. The "Obvious Bot" Blocklist (Fast Fail)
     const botSignatures = ['python-requests', 'curl', 'wget', 'scrapy', 'bot', 'crawler', 'spider'];
-    // Exception: Googlebot (if you want SEO). We'll treat Googlebot as a bot, 
-    // real implementations might white-list it via IP verification (not possible in just JS headers).
     if (botSignatures.some(sig => userAgent.toLowerCase().includes(sig))) {
-       return false;
+      return false;
     }
 
     // B. Trusted Infrastructure Signals (The Real World Solution)
-    // If Cloudflare or Vercel says "This is a real user", we trust them.
-    // Cloudflare: 'cf-visitor' exists. 'cf-ipcountry' exists.
     if (headers['cf-visitor'] || headers['cf-ray']) return true;
-    
-    // Vercel: 'x-vercel-id'
     if (headers['x-vercel-id']) return true;
-    
-    // AWS CloudFront: 'cloudfront-viewer-address'
     if (headers['cloudfront-viewer-address']) return true;
 
     // C. The "Browser Fingerprint" (Fallback for direct connections)
-    // Real browsers almost always send these headers
     const hasAcceptLanguage = !!headers['accept-language'];
-    const hasSecFetchDest = !!headers['sec-fetch-dest']; 
+    const hasSecFetchDest = !!headers['sec-fetch-dest'];
     const hasUpgradeInsecure = !!headers['upgrade-insecure-requests'];
 
-    // If it has typical browser headers, we allow it.
     if (hasAcceptLanguage && (hasSecFetchDest || hasUpgradeInsecure)) {
       return true;
     }
 
-    // If it has no browser headers and no trusted proxy headers -> It's likely a script.
     return false;
   }
 
@@ -171,9 +169,9 @@ export class AAMPPublisher {
       const sigHeader = reqHeaders[HEADERS.SIGNATURE]!;
       const keyHeader = reqHeaders[HEADERS.PUBLIC_KEY]!;
 
-      const headerJson = atob(payloadHeader); 
+      const headerJson = atob(payloadHeader);
       const requestHeader = JSON.parse(headerJson);
-      
+
       const signedRequest: SignedAccessRequest = {
         header: requestHeader,
         signature: sigHeader,
@@ -188,10 +186,20 @@ export class AAMPPublisher {
         ["verify"]
       );
 
+      const proofToken = reqHeaders[HEADERS.PROOF_TOKEN];
+      const paymentCredential = reqHeaders[HEADERS.PAYMENT_CREDENTIAL];
+
       // Verify Core Logic
-      const result = await this.verifyRequestLogic(signedRequest, agentKey, headerJson);
+      const result = await this.verifyRequestLogic(signedRequest, agentKey, proofToken, paymentCredential, headerJson);
 
       if (!result.allowed) {
+        console.log(`⛔ [AAMP BLOCK] 
+        Agent: ${requestHeader.agent_id}
+        Reason: ${result.reason}
+        VisitorType: ${result.visitorType}
+        Proof: ${result.proofUsed || 'None'}
+        Identity Verified: ${result.identityVerified}`);
+
         return {
           allowed: false,
           status: 403,
@@ -200,6 +208,12 @@ export class AAMPPublisher {
         };
       }
 
+      console.log(`✅ [AAMP ALLOW] 
+      Agent: ${requestHeader.agent_id}
+      Reason: AAMP_VERIFIED
+      Payment Method: ${result.proofUsed}
+      Identity Verified: ${result.identityVerified}`);
+
       return {
         allowed: true,
         status: 200,
@@ -209,16 +223,19 @@ export class AAMPPublisher {
       };
 
     } catch (e) {
+      console.error(e);
       return { allowed: false, status: 400, reason: "INVALID_SIGNATURE", visitorType: 'UNIDENTIFIED_BOT' };
     }
   }
 
   private async verifyRequestLogic(
-    request: SignedAccessRequest, 
+    request: SignedAccessRequest,
     requestPublicKey: CryptoKey,
+    proofToken?: string,
+    paymentCredential?: string,
     rawPayload?: string
   ): Promise<VerificationResult> {
-    
+
     // 1. Replay Attack Prevention
     const requestTime = new Date(request.header.ts).getTime();
     if (Math.abs(Date.now() - requestTime) > MAX_CLOCK_SKEW_MS) {
@@ -234,11 +251,14 @@ export class AAMPPublisher {
     let identityVerified = false;
     const claimedDomain = request.header.agent_id;
     const pubKeyString = await exportPublicKey(requestPublicKey);
-    
+
+    console.log(`   🆔 [AAMP Identity] Verifying DNS Binding for: ${claimedDomain}`);
+
     // Check Cache First
     const cachedKey = await this.cache.get(claimedDomain);
-    
+
     if (cachedKey === pubKeyString) {
+      console.log("   ⚡ [AAMP Cache] Identity found in cache.");
       identityVerified = true;
     } else if (this.isDomain(claimedDomain)) {
       // Cache Miss: Perform DNS Fetch
@@ -260,11 +280,53 @@ export class AAMPPublisher {
       return { allowed: false, reason: 'POLICY_DENIED: RAG not allowed.', identityVerified };
     }
 
-    // 5. Policy Check: Economics
+    // 5. Policy Check: Economics (v1.2)
     if (this.policy.requiresPayment) {
-      const isAdExempt = this.policy.allowAdSupportedAccess && request.header.context.ads_displayed;
-      if (!isAdExempt) {
-        return { allowed: false, reason: 'PAYMENT_REQUIRED: Content requires payment or ads.', identityVerified };
+      let paymentSatisfied = false;
+
+      // Method A: Flexible Payment Callback (DB / Custom Logic)
+      if (this.policy.monetization?.checkPayment) {
+        const isPaid = await this.policy.monetization.checkPayment(request.header.agent_id, request.header.purpose);
+        if (isPaid) {
+          console.log(`   💰 [AAMP Audit] Whitelist Check Passed via Callback.`);
+          return { allowed: true, reason: 'OK', identityVerified, proofUsed: 'WHITELIST_CALLBACK' };
+        }
+      }
+
+      // Method B: Payment Credentials (Unified JWT)
+      if (!paymentSatisfied && this.policy.monetization?.paymentConfig && paymentCredential) {
+        const { jwksUrl, issuer } = this.policy.monetization.paymentConfig;
+        console.log(`   🔐 [AAMP Audit] Verifying Payment Credential (Issuer: ${issuer})...`);
+
+        const isValidCredential = await verifyJwt(paymentCredential, jwksUrl, issuer);
+        if (isValidCredential) {
+          console.log(`   ✅ [AAMP Audit] Credential Signature VALID.`);
+          return { allowed: true, reason: 'OK', identityVerified, proofUsed: 'PAYMENT_CREDENTIAL_JWT' };
+        } else {
+          console.log(`   ❌ [AAMP Audit] Credential Signature INVALID.`);
+        }
+      }
+
+      // Method C: Ad-Supported (Proof Verification)
+      if (!paymentSatisfied && this.policy.allowAdSupportedAccess && request.header.context.ads_displayed) {
+        if (proofToken && this.policy.monetization?.adNetwork) {
+          const { jwksUrl, issuer } = this.policy.monetization.adNetwork;
+          console.log(`   📺 [AAMP Audit] Verifying Ad Proof (Issuer: ${issuer})...`);
+
+          const isValidProof = await verifyJwt(proofToken, jwksUrl, issuer);
+          if (isValidProof) {
+            console.log(`   ✅ [AAMP Audit] Ad Proof Signature VALID.`);
+            return { allowed: true, reason: 'OK', identityVerified, proofUsed: 'AD_PROOF_JWT' };
+          } else {
+            console.log(`   ❌ [AAMP Audit] Ad Proof Signature INVALID.`);
+          }
+        } else {
+          console.log(`   ⚠️ [AAMP Audit] Ad Proof MISSING.`);
+        }
+      }
+
+      if (!paymentSatisfied) {
+        return { allowed: false, reason: 'PAYMENT_REQUIRED: Whitelist, Credential, and Ad Proof checks ALL failed.', identityVerified, proofUsed: 'NONE', visitorType: 'VERIFIED_AGENT' };
       }
     }
 
@@ -276,18 +338,42 @@ export class AAMPPublisher {
       // Allow HTTP for localhost testing
       const protocol = (domain.includes('localhost') || domain.match(/:\d+$/)) ? 'http' : 'https';
       const url = `${protocol}://${domain}${WELL_KNOWN_AGENT_PATH}`;
-      
+
+      console.log(`   🌍 [AAMP DNS] Fetching Manifest: ${url} ...`);
+
       // In production, we need a short timeout to prevent hanging
       const controller = new AbortController();
       const timeoutId = setTimeout(() => controller.abort(), 1500); // 1.5s max for DNS check
-      
+
       const response = await fetch(url, { signal: controller.signal });
       clearTimeout(timeoutId);
-      
-      if (!response.ok) return false;
+
+      if (!response.ok) {
+        console.log(`   ❌ [AAMP DNS] Fetch Failed: ${response.status}`);
+        return false;
+      }
+
       const manifest = await response.json() as AgentIdentityManifest;
-      return manifest.agent_id === domain && manifest.public_key === requestKeySpki;
-    } catch { return false; }
+      console.log(`   📄 [AAMP DNS] Manifest received. Agent ID: ${manifest.agent_id}`);
+
+      // CHECK 1: Does the manifest actually belong to the domain?
+      if (manifest.agent_id !== domain) {
+        console.log(`   ❌ [AAMP DNS] Mismatch: Manifest ID ${manifest.agent_id} != Claimed ${domain}`);
+        return false;
+      }
+
+      // CHECK 2: Does the key match?
+      if (manifest.public_key !== requestKeySpki) {
+        console.log(`   ❌ [AAMP DNS] Key Mismatch: DNS Key != Request Key`);
+        return false;
+      }
+
+      console.log(`   ✅ [AAMP DNS] Identity Confirmed.`);
+      return true;
+    } catch (e: any) {
+      console.log(`   ❌ [AAMP DNS] Error: ${e.message}`);
+      return false;
+    }
   }
 
   private isDomain(s: string): boolean {
@@ -304,4 +390,28 @@ export class AAMPPublisher {
       [HEADERS.PROVENANCE_SIG]: signature
     };
   }
+
+  /**
+   * Handling Quality Feedback (The "Dispute" Layer)
+   * This runs when an Agent sends 'x-aamp-feedback'.
+   */
+  private async handleFeedback(token: string, headers: Record<string, string | undefined>) {
+    // NOTE: In production, you would fetch the Agent's specific key. 
+    // For now, we assume standard Discovery or a centralized Key Set (like adNetwork).
+    // Ideally, the SDK config should have a 'qualityOracle' key set.
+
+    // 1. We just Decode it to Log it (Verification is optional but recommended)
+    try {
+      const parts = token.split('.');
+      const payload = JSON.parse(atob(parts[1]));
+
+      console.log(`\n📢 [AAMP QUALITY ALERT] Feedback Received from ${payload.agent_id}`);
+      console.log(`   Reason: ${payload.reason} | Score: ${payload.quality_score}`);
+      console.log(`   Resource: ${payload.url}`);
+      console.log(`   (Signature available for dispute evidence)`);
+
+    } catch (e) {
+      console.log(`   ⚠️ [AAMP Warning] Malformed Feedback Token.`);
+    }
+  }
 }

package/src/types.ts

@@ -43,14 +43,35 @@ export interface IdentityCache {
   set(key: string, value: string, ttlSeconds: number): Promise<void>;
 }
 
+/**
+ * Optional Monetization (The Settlement Layer)
+ */
 /**
  * Optional Monetization (The Settlement Layer)
  */
 export interface MonetizationConfig {
-  method: 'BROKER' | 'CRYPTO' | 'PRIVATE_TREATY';
-  location: string; 
+  // Method 1: Payments (Flexible Callback)
+  // Developers implement their own logic (Database check, CMS lookup, etc.)
+  // Returns TRUE if the agent is a paid subscriber for this specific purpose.
+  checkPayment?: (agentId: string, purpose: string) => boolean | Promise<boolean>;
+
+  // Method 2: Ads (Proof Verification)
+  // Configuration to verify tokens from your Ad Provider (e.g. Google)
+  adNetwork?: {
+    jwksUrl: string;   // e.g. "https://www.googleapis.com/oauth2/v3/certs"
+    issuer: string;    // e.g. "https://accounts.google.com"
+  };
+
+  // Method 3: Payment Credentials (Unified JWT)
+  // Verifies "x-aamp-credential" for Broker or Direct payments.
+  paymentConfig?: {
+    jwksUrl: string;   // e.g. "https://my-site.com/.well-known/jwks.json"
+    issuer: string;    // e.g. "my-site.com"
+  };
 }
 
+
+
 /**
  * Handling Non-AAMP Visitors
  * 
@@ -65,15 +86,15 @@ export interface AccessPolicy {
   allowTraining: boolean;
   allowRAG: boolean;
   attributionRequired: boolean;
-  
+
   // Economic Signals
-  allowAdSupportedAccess: boolean; 
-  requiresPayment: boolean;        
+  allowAdSupportedAccess: boolean;
+  requiresPayment: boolean;
   paymentPointer?: string;
 
   // Identity Strictness
-  requireIdentityBinding?: boolean; 
-  
+  requireIdentityBinding?: boolean;
+
   // V1.1: Optional Settlement Info
   monetization?: MonetizationConfig;
 }
@@ -81,7 +102,7 @@ export interface AccessPolicy {
 export interface ProtocolHeader {
   v: '1.1';
   ts: string;
-  agent_id: string; 
+  agent_id: string;
   resource: string;
   purpose: AccessPurpose;
   context: {
@@ -98,11 +119,12 @@ export interface SignedAccessRequest {
 export interface FeedbackSignal {
   target_resource: string;
   agent_id: string;
-  quality_score: number; 
+  quality_score: number;
   flags: QualityFlag[];
   timestamp: string;
 }
 
+// Result of the full evaluation pipeline
 // Result of the full evaluation pipeline
 export interface EvaluationResult {
   allowed: boolean;
@@ -110,4 +132,15 @@ export interface EvaluationResult {
   reason: string;
   visitorType: 'VERIFIED_AGENT' | 'LIKELY_HUMAN' | 'UNIDENTIFIED_BOT';
   metadata?: any;
+  payment_status?: 'PAID_SUBSCRIBER' | 'AD_FUNDED' | 'UNPAID';
+  proofUsed?: string;
+}
+
+// Signed Quality Feedback (The "Report Card")
+export interface FeedbackSignalToken {
+  url: string;           // The resource being flagged
+  agent_id: string;      // Who is flagging it (e.g. "bot.openai.com")
+  quality_score: number; // 0.0 to 1.0
+  reason: string;        // e.g. "SEO_SPAM", "HATE_SPEECH"
+  timestamp: number;
 }

package/test/handshake.spec.ts

@@ -3,10 +3,10 @@
  * Run using: npm test
  * Location: sdk/typescript/test/handshake.spec.ts
  */
-import { AAMPAgent } from '../src/agent';
-import { AAMPPublisher } from '../src/publisher';
-import { AccessPurpose } from '../src/types';
-import { HEADERS } from '../src/constants';
+import { AAMPAgent } from '../src/agent.js';
+import { AAMPPublisher } from '../src/publisher.js';
+import { AccessPurpose } from '../src/types.js';
+import { HEADERS } from '../src/constants.js';
 
 async function runTest() {
   console.log("--- STARTING AAMP HANDSHAKE TEST ---");
@@ -29,7 +29,7 @@ async function runTest() {
   // TEST CASE A: Requesting RAG without Ads (Should FAIL due to Payment Requirement)
   console.log("\n[TEST A] Requesting RAG (No Ads)...");
   const reqA = await agent.createAccessRequest('/doc/1', AccessPurpose.RAG_RETRIEVAL, { adsDisplayed: false });
-  
+
   const payloadA = JSON.stringify(reqA.header);
   const headersA = {
     [HEADERS.PAYLOAD]: btoa(payloadA),
@@ -45,7 +45,7 @@ async function runTest() {
   // TEST CASE B: Requesting RAG WITH Ads (Should SUCCEED via Exemption)
   console.log("\n[TEST B] Requesting RAG (With Ads)...");
   const reqB = await agent.createAccessRequest('/doc/1', AccessPurpose.RAG_RETRIEVAL, { adsDisplayed: true });
-  
+
   const payloadB = JSON.stringify(reqB.header);
   const headersB = {
     [HEADERS.PAYLOAD]: btoa(payloadB),

package/tsconfig.json

@@ -1,8 +1,12 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "module": "CommonJS",
-    "lib": ["ES2020", "DOM"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": [
+      "ES2020",
+      "DOM"
+    ],
     "declaration": true,
     "outDir": "./dist",
     "rootDir": "./src",
@@ -11,5 +15,7 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true
   },
-  "include": ["src/**/*"]
+  "include": [
+    "src/**/*"
+  ]
 }