@fedify/vocab-tools 2.4.0-dev.2063 → 2.4.0-dev.2071

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.4.0-dev.2063+366c0362",
+  "version": "2.4.0-dev.2071+8b9dccb9",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts"

package/dist/mod.cjs

@@ -8,7 +8,7 @@ let yaml = require("yaml");
 let es_toolkit = require("es-toolkit");
 //#region deno.json
 var name = "@fedify/vocab-tools";
-var version = "2.4.0-dev.2063+366c0362";
+var version = "2.4.0-dev.2071+8b9dccb9";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -1673,13 +1673,22 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         ${JSON.stringify(version)},
       );
       return await tracer.startActiveSpan("activitypub.lookup_object", async (span) => {
-        if (isPortableIri(url)) {
+        const dereferencePortable = async (
+          portableUrl: URL,
+          extra: {
+            inferredGateways?: readonly URL[];
+            response?: RemoteDocument;
+            contextLoader?: DocumentLoader;
+          } = {},
+        ) => {
           try {
-            const obj = await dereferencePortableIri(url, {
+            const obj = await dereferencePortableIri(portableUrl, {
               documentLoader,
-              contextLoader,
+              contextLoader: extra.contextLoader ?? contextLoader,
               tracerProvider,
               gateways: options.gateways,
+              inferredGateways: extra.inferredGateways,
+              response: extra.response,
               verifyPortableObject: options.verifyPortableObject,
               referrer: {
                 object: this,
@@ -1697,7 +1706,10 @@ async function* generateProperty(type, property, types, moduleVarNames) {
                 }),
             });
             if (obj != null) {
-              span.setAttribute("activitypub.object.id", (obj.id ?? url).href);
+              span.setAttribute(
+                "activitypub.object.id",
+                (obj.id ?? portableUrl).href,
+              );
               span.setAttribute(
                 "activitypub.object.type",
                 // @ts-ignore: obj.constructor always has a typeId.
@@ -1714,12 +1726,20 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           } finally {
             span.end();
           }
-        }
+        };
+        if (isPortableIri(url)) return await dereferencePortable(url);
         const lookupUrl = formatIri(url);
-        const inPortableChain = isInPortableChain(this);
-        if (inPortableChain && isCompatibleEf61Iri(url)) {
-          span.end();
-          return rejectPortableChainReference(lookupUrl, options.crossOrigin);
+        const portableMode = isPortableMode(this, options);
+        if (portableMode) {
+          const compatible = parseCompatibleEf61Reference(url);
+          if (compatible === null) {
+            span.end();
+            return rejectMalformedCompatibleReference(lookupUrl, options);
+          } else if (compatible != null) {
+            return await dereferencePortable(compatible.id, {
+              inferredGateways: [compatible.gateway],
+            });
+          }
         }
         let fetchResult: RemoteDocument;
         try {
@@ -1740,63 +1760,90 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           throw error;
         }
         const { document, documentUrl } = fetchResult;
-        const baseUrl = parseIri(documentUrl);
+        // In portable mode, the document may turn out to be a portable object,
+        // which has to be verified with the same context documents:
+        const snapshot = portableMode
+          ? createSnapshotContextLoader(contextLoader)
+          : null;
         try {
-          const obj = await this.#${property.singularName}_fromJsonLd(
-            document,
-            { documentLoader, contextLoader, tracerProvider, baseUrl }
-          );
-          if (
-            inPortableChain &&
-            (isCompatibleEf61Iri(documentUrl) ||
-              (obj.id != null &&
-                (isPortableIri(obj.id) || isCompatibleEf61Iri(obj.id))))
-          ) {
-            return rejectPortableChainReference(
-              documentUrl,
-              options.crossOrigin,
+          let claim: PortableResponseClaim | null | undefined;
+          try {
+            const baseUrl = parseIri(documentUrl);
+            const obj = await this.#${property.singularName}_fromJsonLd(
+              document,
+              {
+                documentLoader,
+                contextLoader: snapshot?.loader ?? contextLoader,
+                tracerProvider,
+                baseUrl,
+              }
             );
-          }
-          if (obj?.id != null && !isTrustedIriOrigin(options, obj.id, baseUrl)) {
-            if (options.crossOrigin === "throw") {
-              throw new Error(
-                "The object's @id (" + obj.id.href + ") has a different origin " +
-                "than the document URL (" + baseUrl.href + "); refusing to return " +
-                "the object.  If you want to bypass this check and are aware of" +
-                'the security implications, set the crossOrigin option to "trust".'
+            if (snapshot == null) {
+              markUnverifiedPortableClaim(obj, url, documentUrl);
+            } else {
+              claim = getPortableResponseClaim(documentUrl, obj.id);
+            }
+            if (claim === undefined) {
+              if (
+                obj?.id != null &&
+                !isTrustedIriOrigin(options, obj.id, baseUrl)
+              ) {
+                if (options.crossOrigin === "throw") {
+                  throw new Error(
+                    "The object's @id (" + obj.id.href + ") has a different origin " +
+                    "than the document URL (" + baseUrl.href + "); refusing to return " +
+                    "the object.  If you want to bypass this check and are aware of" +
+                    'the security implications, set the crossOrigin option to "trust".'
+                  );
+                }
+                getLogger(["fedify", "vocab"]).warn(
+                  "The object's @id ({objectId}) has a different origin than the document " +
+                  "URL ({documentUrl}); refusing to return the object.  If you want to " +
+                  "bypass this check and are aware of the security implications, " +
+                  'set the crossOrigin option to "trust".',
+                  { ...fetchResult, objectId: obj.id.href },
+                );
+                span.end();
+                return null;
+              }
+              span.setAttribute("activitypub.object.id", (obj.id ?? url).href);
+              span.setAttribute(
+                "activitypub.object.type",
+                // @ts-ignore: obj.constructor always has a typeId.
+                obj.constructor.typeId.href
               );
+              span.end();
+              return obj;
             }
-            getLogger(["fedify", "vocab"]).warn(
-              "The object's @id ({objectId}) has a different origin than the document " +
-              "URL ({documentUrl}); refusing to return the object.  If you want to " +
-              "bypass this check and are aware of the security implications, " +
-              'set the crossOrigin option to "trust".',
-              { ...fetchResult, objectId: obj.id.href },
-            );
-            return null;
+          } catch (e) {
+            if (options.suppressError) {
+              getLogger(["fedify", "vocab"]).error(
+                "Failed to parse {url}: {error}",
+                { error: e, url: lookupUrl }
+              );
+              span.end();
+              return null;
+            }
+            span.setStatus({
+              code: SpanStatusCode.ERROR,
+              message: String(e),
+            });
+            span.end();
+            throw e;
           }
-          span.setAttribute("activitypub.object.id", (obj.id ?? url).href);
-          span.setAttribute(
-            "activitypub.object.type",
-            // @ts-ignore: obj.constructor always has a typeId.
-            obj.constructor.typeId.href
-          );
-          return obj;
-        } catch (e) {
-          if (options.suppressError) {
-            getLogger(["fedify", "vocab"]).error(
-              "Failed to parse {url}: {error}",
-              { error: e, url: lookupUrl }
-            );
-            return null;
+          // The document stands for a portable object, so it is verified as
+          // one instead of being trusted because of where it came from:
+          if (claim === null) {
+            span.end();
+            return rejectMalformedCompatibleReference(documentUrl, options);
           }
-          span.setStatus({
-            code: SpanStatusCode.ERROR,
-            message: String(e),
+          return await dereferencePortable(claim.id, {
+            inferredGateways: claim.inferredGateways,
+            response: fetchResult,
+            contextLoader: snapshot?.loader,
           });
-          throw e;
         } finally {
-          span.end();
+          snapshot?.release();
         }
       });
     }
@@ -1918,7 +1965,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           } else if (
             !isTrustedIriOrigin(options, v.id, ${trustOwner}) ||
             isUnsecuredPortableObject(this) ||
-            (isInPortableChain(this) && isCompatibleEf61Iri(v.id))
+            mustDereferencePortableObject(this, ${trustOwner}, v.id, options)
           ) {
             v = v.id;
           }
@@ -1927,6 +1974,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           const fetched =
             await this.#fetch${(0, es_toolkit.pascalCase)(property.singularName)}(v, options);
           if (fetched == null) return null;
+          // Not cached, so that it is verified when the portable object
+          // policy applies later:
+          if (isUnverifiedPortableClaim(fetched)) return fetched;
           this.${await getFieldName(property.uri)}[0] = fetched;
           this.${await getFieldName(property.uri, "#_trust")}.add(0);
           this._cachedJsonLd = undefined;
@@ -1962,7 +2012,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         if (v?.id != null &&
             ((${type.trustEmbeddedObjects === false ? "" : "this.id != null && "}!isTrustedIriOrigin(options, v.id, ${trustOwner})) ||
               isUnsecuredPortableObject(this) ||
-              (isInPortableChain(this) && isCompatibleEf61Iri(v.id))) &&
+              mustDereferencePortableObject(
+                this, ${trustOwner}, v.id, options,
+              )) &&
             !this.${await getFieldName(property.uri, "#_trust")}.has(0)) {
           if (options.crossOrigin === "throw") {
             throw new Error(
@@ -2039,7 +2091,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             } else if (
               !isTrustedIriOrigin(options, v.id, ${trustOwner}) ||
               isUnsecuredPortableObject(this) ||
-              (isInPortableChain(this) && isCompatibleEf61Iri(v.id))
+              mustDereferencePortableObject(this, ${trustOwner}, v.id, options)
             ) {
               v = v.id;
             }
@@ -2048,6 +2100,12 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             const fetched =
               await this.#fetch${(0, es_toolkit.pascalCase)(property.singularName)}(v, options);
             if (fetched == null) continue;
+            // Not cached, so that it is verified when the portable object
+            // policy applies later:
+            if (isUnverifiedPortableClaim(fetched)) {
+              yield fetched;
+              continue;
+            }
             vs[i] = fetched;
             this.${await getFieldName(property.uri, "#_trust")}.add(i);
             this._cachedJsonLd = undefined;
@@ -2084,7 +2142,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           if (v?.id != null &&
               ((${type.trustEmbeddedObjects === false ? "" : "this.id != null && "}!isTrustedIriOrigin(options, v.id, ${trustOwner})) ||
                 isUnsecuredPortableObject(this) ||
-                (isInPortableChain(this) && isCompatibleEf61Iri(v.id))) &&
+                mustDereferencePortableObject(
+                  this, ${trustOwner}, v.id, options,
+                )) &&
               !this.${await getFieldName(property.uri, "#_trust")}.has(i)) {
             if (options.crossOrigin === "throw") {
               throw new Error(
@@ -2129,13 +2189,19 @@ const INTERNAL_RUNTIME_IMPORTS = [
 ].join(",\n    ");
 const PORTABLE_DEREFERENCE_IMPORTS = [
 	"copyPortableProvenance",
+	"createSnapshotContextLoader",
 	"dereferencePortableIri",
-	"isCompatibleEf61Iri",
-	"isInPortableChain",
+	"getPortableResponseClaim",
 	"isPortableIri",
+	"isPortableMode",
 	"isUnsecuredPortableObject",
+	"isUnverifiedPortableClaim",
+	"markUnverifiedPortableClaim",
+	"mustDereferencePortableObject",
+	"parseCompatibleEf61Reference",
+	"type PortableResponseClaim",
 	"recordPortableReferrer",
-	"rejectPortableChainReference",
+	"rejectMalformedCompatibleReference",
 	"warnUnverifiableEmbeddedObject"
 ].join(",\n    ");
 const SIGNED_REPRESENTATION_IMPORTS = [

package/dist/mod.js

@@ -7,7 +7,7 @@ import { parse } from "yaml";
 import { pascalCase } from "es-toolkit";
 //#region deno.json
 var name = "@fedify/vocab-tools";
-var version = "2.4.0-dev.2063+366c0362";
+var version = "2.4.0-dev.2071+8b9dccb9";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -1672,13 +1672,22 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         ${JSON.stringify(version)},
       );
       return await tracer.startActiveSpan("activitypub.lookup_object", async (span) => {
-        if (isPortableIri(url)) {
+        const dereferencePortable = async (
+          portableUrl: URL,
+          extra: {
+            inferredGateways?: readonly URL[];
+            response?: RemoteDocument;
+            contextLoader?: DocumentLoader;
+          } = {},
+        ) => {
           try {
-            const obj = await dereferencePortableIri(url, {
+            const obj = await dereferencePortableIri(portableUrl, {
               documentLoader,
-              contextLoader,
+              contextLoader: extra.contextLoader ?? contextLoader,
               tracerProvider,
               gateways: options.gateways,
+              inferredGateways: extra.inferredGateways,
+              response: extra.response,
               verifyPortableObject: options.verifyPortableObject,
               referrer: {
                 object: this,
@@ -1696,7 +1705,10 @@ async function* generateProperty(type, property, types, moduleVarNames) {
                 }),
             });
             if (obj != null) {
-              span.setAttribute("activitypub.object.id", (obj.id ?? url).href);
+              span.setAttribute(
+                "activitypub.object.id",
+                (obj.id ?? portableUrl).href,
+              );
               span.setAttribute(
                 "activitypub.object.type",
                 // @ts-ignore: obj.constructor always has a typeId.
@@ -1713,12 +1725,20 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           } finally {
             span.end();
           }
-        }
+        };
+        if (isPortableIri(url)) return await dereferencePortable(url);
         const lookupUrl = formatIri(url);
-        const inPortableChain = isInPortableChain(this);
-        if (inPortableChain && isCompatibleEf61Iri(url)) {
-          span.end();
-          return rejectPortableChainReference(lookupUrl, options.crossOrigin);
+        const portableMode = isPortableMode(this, options);
+        if (portableMode) {
+          const compatible = parseCompatibleEf61Reference(url);
+          if (compatible === null) {
+            span.end();
+            return rejectMalformedCompatibleReference(lookupUrl, options);
+          } else if (compatible != null) {
+            return await dereferencePortable(compatible.id, {
+              inferredGateways: [compatible.gateway],
+            });
+          }
         }
         let fetchResult: RemoteDocument;
         try {
@@ -1739,63 +1759,90 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           throw error;
         }
         const { document, documentUrl } = fetchResult;
-        const baseUrl = parseIri(documentUrl);
+        // In portable mode, the document may turn out to be a portable object,
+        // which has to be verified with the same context documents:
+        const snapshot = portableMode
+          ? createSnapshotContextLoader(contextLoader)
+          : null;
         try {
-          const obj = await this.#${property.singularName}_fromJsonLd(
-            document,
-            { documentLoader, contextLoader, tracerProvider, baseUrl }
-          );
-          if (
-            inPortableChain &&
-            (isCompatibleEf61Iri(documentUrl) ||
-              (obj.id != null &&
-                (isPortableIri(obj.id) || isCompatibleEf61Iri(obj.id))))
-          ) {
-            return rejectPortableChainReference(
-              documentUrl,
-              options.crossOrigin,
+          let claim: PortableResponseClaim | null | undefined;
+          try {
+            const baseUrl = parseIri(documentUrl);
+            const obj = await this.#${property.singularName}_fromJsonLd(
+              document,
+              {
+                documentLoader,
+                contextLoader: snapshot?.loader ?? contextLoader,
+                tracerProvider,
+                baseUrl,
+              }
             );
-          }
-          if (obj?.id != null && !isTrustedIriOrigin(options, obj.id, baseUrl)) {
-            if (options.crossOrigin === "throw") {
-              throw new Error(
-                "The object's @id (" + obj.id.href + ") has a different origin " +
-                "than the document URL (" + baseUrl.href + "); refusing to return " +
-                "the object.  If you want to bypass this check and are aware of" +
-                'the security implications, set the crossOrigin option to "trust".'
+            if (snapshot == null) {
+              markUnverifiedPortableClaim(obj, url, documentUrl);
+            } else {
+              claim = getPortableResponseClaim(documentUrl, obj.id);
+            }
+            if (claim === undefined) {
+              if (
+                obj?.id != null &&
+                !isTrustedIriOrigin(options, obj.id, baseUrl)
+              ) {
+                if (options.crossOrigin === "throw") {
+                  throw new Error(
+                    "The object's @id (" + obj.id.href + ") has a different origin " +
+                    "than the document URL (" + baseUrl.href + "); refusing to return " +
+                    "the object.  If you want to bypass this check and are aware of" +
+                    'the security implications, set the crossOrigin option to "trust".'
+                  );
+                }
+                getLogger(["fedify", "vocab"]).warn(
+                  "The object's @id ({objectId}) has a different origin than the document " +
+                  "URL ({documentUrl}); refusing to return the object.  If you want to " +
+                  "bypass this check and are aware of the security implications, " +
+                  'set the crossOrigin option to "trust".',
+                  { ...fetchResult, objectId: obj.id.href },
+                );
+                span.end();
+                return null;
+              }
+              span.setAttribute("activitypub.object.id", (obj.id ?? url).href);
+              span.setAttribute(
+                "activitypub.object.type",
+                // @ts-ignore: obj.constructor always has a typeId.
+                obj.constructor.typeId.href
               );
+              span.end();
+              return obj;
             }
-            getLogger(["fedify", "vocab"]).warn(
-              "The object's @id ({objectId}) has a different origin than the document " +
-              "URL ({documentUrl}); refusing to return the object.  If you want to " +
-              "bypass this check and are aware of the security implications, " +
-              'set the crossOrigin option to "trust".',
-              { ...fetchResult, objectId: obj.id.href },
-            );
-            return null;
+          } catch (e) {
+            if (options.suppressError) {
+              getLogger(["fedify", "vocab"]).error(
+                "Failed to parse {url}: {error}",
+                { error: e, url: lookupUrl }
+              );
+              span.end();
+              return null;
+            }
+            span.setStatus({
+              code: SpanStatusCode.ERROR,
+              message: String(e),
+            });
+            span.end();
+            throw e;
           }
-          span.setAttribute("activitypub.object.id", (obj.id ?? url).href);
-          span.setAttribute(
-            "activitypub.object.type",
-            // @ts-ignore: obj.constructor always has a typeId.
-            obj.constructor.typeId.href
-          );
-          return obj;
-        } catch (e) {
-          if (options.suppressError) {
-            getLogger(["fedify", "vocab"]).error(
-              "Failed to parse {url}: {error}",
-              { error: e, url: lookupUrl }
-            );
-            return null;
+          // The document stands for a portable object, so it is verified as
+          // one instead of being trusted because of where it came from:
+          if (claim === null) {
+            span.end();
+            return rejectMalformedCompatibleReference(documentUrl, options);
           }
-          span.setStatus({
-            code: SpanStatusCode.ERROR,
-            message: String(e),
+          return await dereferencePortable(claim.id, {
+            inferredGateways: claim.inferredGateways,
+            response: fetchResult,
+            contextLoader: snapshot?.loader,
           });
-          throw e;
         } finally {
-          span.end();
+          snapshot?.release();
         }
       });
     }
@@ -1917,7 +1964,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           } else if (
             !isTrustedIriOrigin(options, v.id, ${trustOwner}) ||
             isUnsecuredPortableObject(this) ||
-            (isInPortableChain(this) && isCompatibleEf61Iri(v.id))
+            mustDereferencePortableObject(this, ${trustOwner}, v.id, options)
           ) {
             v = v.id;
           }
@@ -1926,6 +1973,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           const fetched =
             await this.#fetch${pascalCase(property.singularName)}(v, options);
           if (fetched == null) return null;
+          // Not cached, so that it is verified when the portable object
+          // policy applies later:
+          if (isUnverifiedPortableClaim(fetched)) return fetched;
           this.${await getFieldName(property.uri)}[0] = fetched;
           this.${await getFieldName(property.uri, "#_trust")}.add(0);
           this._cachedJsonLd = undefined;
@@ -1961,7 +2011,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         if (v?.id != null &&
             ((${type.trustEmbeddedObjects === false ? "" : "this.id != null && "}!isTrustedIriOrigin(options, v.id, ${trustOwner})) ||
               isUnsecuredPortableObject(this) ||
-              (isInPortableChain(this) && isCompatibleEf61Iri(v.id))) &&
+              mustDereferencePortableObject(
+                this, ${trustOwner}, v.id, options,
+              )) &&
             !this.${await getFieldName(property.uri, "#_trust")}.has(0)) {
           if (options.crossOrigin === "throw") {
             throw new Error(
@@ -2038,7 +2090,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             } else if (
               !isTrustedIriOrigin(options, v.id, ${trustOwner}) ||
               isUnsecuredPortableObject(this) ||
-              (isInPortableChain(this) && isCompatibleEf61Iri(v.id))
+              mustDereferencePortableObject(this, ${trustOwner}, v.id, options)
             ) {
               v = v.id;
             }
@@ -2047,6 +2099,12 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             const fetched =
               await this.#fetch${pascalCase(property.singularName)}(v, options);
             if (fetched == null) continue;
+            // Not cached, so that it is verified when the portable object
+            // policy applies later:
+            if (isUnverifiedPortableClaim(fetched)) {
+              yield fetched;
+              continue;
+            }
             vs[i] = fetched;
             this.${await getFieldName(property.uri, "#_trust")}.add(i);
             this._cachedJsonLd = undefined;
@@ -2083,7 +2141,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           if (v?.id != null &&
               ((${type.trustEmbeddedObjects === false ? "" : "this.id != null && "}!isTrustedIriOrigin(options, v.id, ${trustOwner})) ||
                 isUnsecuredPortableObject(this) ||
-                (isInPortableChain(this) && isCompatibleEf61Iri(v.id))) &&
+                mustDereferencePortableObject(
+                  this, ${trustOwner}, v.id, options,
+                )) &&
               !this.${await getFieldName(property.uri, "#_trust")}.has(i)) {
             if (options.crossOrigin === "throw") {
               throw new Error(
@@ -2128,13 +2188,19 @@ const INTERNAL_RUNTIME_IMPORTS = [
 ].join(",\n    ");
 const PORTABLE_DEREFERENCE_IMPORTS = [
 	"copyPortableProvenance",
+	"createSnapshotContextLoader",
 	"dereferencePortableIri",
-	"isCompatibleEf61Iri",
-	"isInPortableChain",
+	"getPortableResponseClaim",
 	"isPortableIri",
+	"isPortableMode",
 	"isUnsecuredPortableObject",
+	"isUnverifiedPortableClaim",
+	"markUnverifiedPortableClaim",
+	"mustDereferencePortableObject",
+	"parseCompatibleEf61Reference",
+	"type PortableResponseClaim",
 	"recordPortableReferrer",
-	"rejectPortableChainReference",
+	"rejectMalformedCompatibleReference",
 	"warnUnverifiableEmbeddedObject"
 ].join(",\n    ");
 const SIGNED_REPRESENTATION_IMPORTS = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.4.0-dev.2063+366c0362",
+  "version": "2.4.0-dev.2071+8b9dccb9",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {