@fedify/fedify 2.5.0-dev.2440 → 2.5.0-dev.2448

package/dist/ld-CcuZ4NZa.d.ts

@@ -0,0 +1,250 @@
+/// <reference lib="esnext.temporal" />
+import { a as KeyCache, v as VerificationObservationOptions } from "./key-DhsBxxZN.js";
+import { Activity, Actor, CryptographicKey } from "@fedify/vocab";
+import { MeterProvider, TracerProvider } from "@opentelemetry/api";
+import { DocumentLoader } from "@fedify/vocab-runtime";
+
+//#region src/sig/owner.d.ts
+/**
+* Options for {@link doesActorOwnKey}.
+* @since 0.8.0
+*/
+interface DoesActorOwnKeyOptions {
+  /**
+  * The document loader to use for fetching the actor.
+  */
+  documentLoader?: DocumentLoader;
+  /**
+  * The context loader to use for JSON-LD context retrieval.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The OpenTelemetry tracer provider to use for tracing.  If omitted,
+  * the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+}
+/**
+* Checks if the actor of the given activity owns the specified key.
+*
+* Ownership is never taken from what the activity or the key say about
+* themselves, as both are written by whoever sent the activity.  It is
+* established from a document that the owner itself serves: either the key's
+* claimed owner links back to the key, or the actor the activity claims lists
+* the key as its own.
+*
+* @param activity The activity to check.
+* @param key The public key to check.
+* @param options Options for checking the key ownership.
+* @returns Whether the actor is the owner of the key.
+*/
+declare function doesActorOwnKey(activity: Activity, key: CryptographicKey, options: DoesActorOwnKeyOptions): Promise<boolean>;
+/**
+* Options for {@link getKeyOwner}.
+* @since 0.8.0
+*/
+interface GetKeyOwnerOptions {
+  /**
+  * The document loader to use for fetching the key and its owner.
+  */
+  documentLoader?: DocumentLoader;
+  /**
+  * The context loader to use for JSON-LD context retrieval.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The OpenTelemetry tracer provider to use for tracing.  If omitted,
+  * the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+}
+/**
+* Gets the actor that owns the specified key.  Returns `null` if the key has no
+* known owner.
+*
+* The owner is only returned when the key and the owner link to each other:
+* a document that merely claims to own a key is not enough, as the claim and
+* the key can come from the same host.
+*
+* @param keyId The ID of the key to check, or the key itself.
+* @param options Options for getting the key owner.
+* @returns The actor that owns the key, or `null` if the key has no known
+*          owner.
+* @since 0.7.0
+*/
+declare function getKeyOwner(keyId: URL | CryptographicKey, options: GetKeyOwnerOptions): Promise<Actor | null>;
+//#endregion
+//#region src/sig/ld.d.ts
+/**
+* How a context loader marked by {@link markEffectiveContextLoader} already
+* resolves contexts.
+* @internal
+*/
+type EffectiveContextLoaderPolicy = "standard" | "normalization";
+/**
+* A signature of a JSON-LD document.
+* @since 1.0.0
+*/
+interface Signature {
+  "@context"?: "https://w3id.org/identity/v1";
+  type: "RsaSignature2017";
+  id?: string;
+  creator: string;
+  created: string;
+  signatureValue: string;
+}
+/**
+* Attaches a LD signature to the given JSON-LD document.
+* @param jsonLd The JSON-LD document to attach the signature to.  It is not
+*               modified.
+* @param signature The signature to attach.
+* @returns The JSON-LD document with the attached signature.
+* @throws {TypeError} If the input document is not a valid JSON-LD document.
+* @since 1.0.0
+*/
+declare function attachSignature(jsonLd: unknown, signature: Signature): {
+  signature: Signature;
+};
+/**
+* Options for creating Linked Data Signatures.
+* @since 1.0.0
+*/
+interface CreateSignatureOptions {
+  /**
+  * The context loader for loading remote JSON-LD contexts.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The time when the signature was created.  If not specified, the current
+  * time will be used.
+  */
+  created?: Temporal.Instant;
+}
+/**
+* Creates a LD signature for the given JSON-LD document.
+* @param jsonLd The JSON-LD document to sign.
+* @param privateKey The private key to sign the document.
+* @param keyId The ID of the public key that corresponds to the private key.
+* @param options Additional options for creating the signature.
+*                See also {@link CreateSignatureOptions}.
+* @return The created signature.
+* @throws {TypeError} If the private key is invalid or unsupported.
+* @since 1.0.0
+*/
+declare function createSignature(jsonLd: unknown, privateKey: CryptoKey, keyId: URL, {
+  contextLoader,
+  created
+}?: CreateSignatureOptions): Promise<Signature>;
+/**
+* Options for signing JSON-LD documents.
+* @since 1.0.0
+*/
+interface SignJsonLdOptions extends CreateSignatureOptions {
+  /**
+  * The OpenTelemetry tracer provider for tracing the signing process.
+  * If omitted, the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+}
+/**
+* Signs the given JSON-LD document with the private key and returns the signed
+* JSON-LD document.
+* @param jsonLd The JSON-LD document to sign.
+* @param privateKey The private key to sign the document.
+* @param keyId The key ID to use in the signature.  It will be used by the
+*              verifier to fetch the corresponding public key.
+* @param options Additional options for signing the document.
+*                See also {@link SignJsonLdOptions}.
+* @returns The signed JSON-LD document.
+* @throws {TypeError} If the private key is invalid or unsupported.
+* @since 1.0.0
+*/
+declare function signJsonLd(jsonLd: unknown, privateKey: CryptoKey, keyId: URL, options: SignJsonLdOptions): Promise<{
+  signature: Signature;
+}>;
+/**
+* Checks if the given JSON-LD document has a Linked Data Signature-like
+* object, without restricting it to a single suite-specific shape.
+* @param jsonLd The JSON-LD document to check.
+* @returns `true` if the document has a signature-like object; `false`
+*          otherwise.
+* @since 2.2.0
+*/
+declare function hasSignatureLike(jsonLd: unknown): boolean;
+/**
+* Detaches Linked Data Signatures from the given JSON-LD document.
+* @param jsonLd The JSON-LD document to modify.
+* @returns The modified JSON-LD document.  If the input document does not
+*          contain a signature, the original document is returned.
+* @since 1.0.0
+*/
+declare function detachSignature(jsonLd: unknown): unknown;
+/**
+* Options for verifying Linked Data Signatures.
+* @since 1.0.0
+*/
+interface VerifySignatureOptions extends VerificationObservationOptions {
+  /**
+  * The document loader to use for fetching the public key.
+  */
+  documentLoader?: DocumentLoader;
+  /**
+  * The context loader to use for JSON-LD context retrieval.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The key cache to use for caching public keys.
+  */
+  keyCache?: KeyCache;
+  /**
+  * The OpenTelemetry tracer provider for tracing the verification process.
+  * If omitted, the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+  /**
+  * The OpenTelemetry meter provider.  If omitted, the global meter provider
+  * is used.
+  * @since 2.3.0
+  */
+  meterProvider?: MeterProvider;
+}
+/**
+* Verifies Linked Data Signatures of the given JSON-LD document.
+*
+* This is a low-level utility that only checks the cryptographic signature
+* and (optionally) the cached key.  It does not run the JSON-LD parsing,
+* attribution, and owner checks that a complete inbound LD verification
+* needs.  For incoming activities, prefer {@link verifyJsonLd}, which is
+* the public verification entry point and the one that emits the
+* `activitypub.signature.verification.duration` metric for the LD path.
+* `verifySignature` itself only emits
+* `activitypub.signature.key_fetch.duration`, since the rest of the work
+* that the verification-duration metric is meant to cover happens in
+* `verifyJsonLd`.
+* @param jsonLd The JSON-LD document to verify.
+* @param options Options for verifying the signature.
+* @returns The public key that signed the document or `null` if the signature
+*          is invalid or the key is not found.
+* @since 1.0.0
+*/
+declare function verifySignature(jsonLd: unknown, options?: VerifySignatureOptions): Promise<CryptographicKey | null>;
+/**
+* Options for verifying JSON-LD documents.
+*/
+interface VerifyJsonLdOptions extends VerifySignatureOptions {}
+/**
+* Verify the authenticity of the given JSON-LD document using Linked Data
+* Signatures.  If the document is signed, this function verifies the signature
+* and checks if the document is attributed to the owner of the public key.
+* If the document is not signed, this function returns `false`.
+* @param jsonLd The JSON-LD document to verify.
+* @param options Options for verifying the document.
+* @returns `true` if the document is authentic; `false` otherwise.
+*/
+declare function verifyJsonLd(jsonLd: unknown, options?: VerifyJsonLdOptions): Promise<boolean>;
+//#endregion
+export { VerifySignatureOptions as a, detachSignature as c, verifyJsonLd as d, verifySignature as f, getKeyOwner as g, doesActorOwnKey as h, VerifyJsonLdOptions as i, hasSignatureLike as l, GetKeyOwnerOptions as m, EffectiveContextLoaderPolicy as n, attachSignature as o, DoesActorOwnKeyOptions as p, SignJsonLdOptions as r, createSignature as s, CreateSignatureOptions as t, signJsonLd as u };

package/dist/ld-Cel1RRZ5.d.cts

@@ -0,0 +1,250 @@
+/// <reference lib="esnext.temporal" />
+import { a as KeyCache, v as VerificationObservationOptions } from "./key-nYGY4QB9.cjs";
+import { Activity, Actor, CryptographicKey } from "@fedify/vocab";
+import { DocumentLoader } from "@fedify/vocab-runtime";
+import { MeterProvider, TracerProvider } from "@opentelemetry/api";
+
+//#region src/sig/owner.d.ts
+/**
+* Options for {@link doesActorOwnKey}.
+* @since 0.8.0
+*/
+interface DoesActorOwnKeyOptions {
+  /**
+  * The document loader to use for fetching the actor.
+  */
+  documentLoader?: DocumentLoader;
+  /**
+  * The context loader to use for JSON-LD context retrieval.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The OpenTelemetry tracer provider to use for tracing.  If omitted,
+  * the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+}
+/**
+* Checks if the actor of the given activity owns the specified key.
+*
+* Ownership is never taken from what the activity or the key say about
+* themselves, as both are written by whoever sent the activity.  It is
+* established from a document that the owner itself serves: either the key's
+* claimed owner links back to the key, or the actor the activity claims lists
+* the key as its own.
+*
+* @param activity The activity to check.
+* @param key The public key to check.
+* @param options Options for checking the key ownership.
+* @returns Whether the actor is the owner of the key.
+*/
+declare function doesActorOwnKey(activity: Activity, key: CryptographicKey, options: DoesActorOwnKeyOptions): Promise<boolean>;
+/**
+* Options for {@link getKeyOwner}.
+* @since 0.8.0
+*/
+interface GetKeyOwnerOptions {
+  /**
+  * The document loader to use for fetching the key and its owner.
+  */
+  documentLoader?: DocumentLoader;
+  /**
+  * The context loader to use for JSON-LD context retrieval.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The OpenTelemetry tracer provider to use for tracing.  If omitted,
+  * the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+}
+/**
+* Gets the actor that owns the specified key.  Returns `null` if the key has no
+* known owner.
+*
+* The owner is only returned when the key and the owner link to each other:
+* a document that merely claims to own a key is not enough, as the claim and
+* the key can come from the same host.
+*
+* @param keyId The ID of the key to check, or the key itself.
+* @param options Options for getting the key owner.
+* @returns The actor that owns the key, or `null` if the key has no known
+*          owner.
+* @since 0.7.0
+*/
+declare function getKeyOwner(keyId: URL | CryptographicKey, options: GetKeyOwnerOptions): Promise<Actor | null>;
+//#endregion
+//#region src/sig/ld.d.ts
+/**
+* How a context loader marked by {@link markEffectiveContextLoader} already
+* resolves contexts.
+* @internal
+*/
+type EffectiveContextLoaderPolicy = "standard" | "normalization";
+/**
+* A signature of a JSON-LD document.
+* @since 1.0.0
+*/
+interface Signature {
+  "@context"?: "https://w3id.org/identity/v1";
+  type: "RsaSignature2017";
+  id?: string;
+  creator: string;
+  created: string;
+  signatureValue: string;
+}
+/**
+* Attaches a LD signature to the given JSON-LD document.
+* @param jsonLd The JSON-LD document to attach the signature to.  It is not
+*               modified.
+* @param signature The signature to attach.
+* @returns The JSON-LD document with the attached signature.
+* @throws {TypeError} If the input document is not a valid JSON-LD document.
+* @since 1.0.0
+*/
+declare function attachSignature(jsonLd: unknown, signature: Signature): {
+  signature: Signature;
+};
+/**
+* Options for creating Linked Data Signatures.
+* @since 1.0.0
+*/
+interface CreateSignatureOptions {
+  /**
+  * The context loader for loading remote JSON-LD contexts.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The time when the signature was created.  If not specified, the current
+  * time will be used.
+  */
+  created?: Temporal.Instant;
+}
+/**
+* Creates a LD signature for the given JSON-LD document.
+* @param jsonLd The JSON-LD document to sign.
+* @param privateKey The private key to sign the document.
+* @param keyId The ID of the public key that corresponds to the private key.
+* @param options Additional options for creating the signature.
+*                See also {@link CreateSignatureOptions}.
+* @return The created signature.
+* @throws {TypeError} If the private key is invalid or unsupported.
+* @since 1.0.0
+*/
+declare function createSignature(jsonLd: unknown, privateKey: CryptoKey, keyId: URL, {
+  contextLoader,
+  created
+}?: CreateSignatureOptions): Promise<Signature>;
+/**
+* Options for signing JSON-LD documents.
+* @since 1.0.0
+*/
+interface SignJsonLdOptions extends CreateSignatureOptions {
+  /**
+  * The OpenTelemetry tracer provider for tracing the signing process.
+  * If omitted, the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+}
+/**
+* Signs the given JSON-LD document with the private key and returns the signed
+* JSON-LD document.
+* @param jsonLd The JSON-LD document to sign.
+* @param privateKey The private key to sign the document.
+* @param keyId The key ID to use in the signature.  It will be used by the
+*              verifier to fetch the corresponding public key.
+* @param options Additional options for signing the document.
+*                See also {@link SignJsonLdOptions}.
+* @returns The signed JSON-LD document.
+* @throws {TypeError} If the private key is invalid or unsupported.
+* @since 1.0.0
+*/
+declare function signJsonLd(jsonLd: unknown, privateKey: CryptoKey, keyId: URL, options: SignJsonLdOptions): Promise<{
+  signature: Signature;
+}>;
+/**
+* Checks if the given JSON-LD document has a Linked Data Signature-like
+* object, without restricting it to a single suite-specific shape.
+* @param jsonLd The JSON-LD document to check.
+* @returns `true` if the document has a signature-like object; `false`
+*          otherwise.
+* @since 2.2.0
+*/
+declare function hasSignatureLike(jsonLd: unknown): boolean;
+/**
+* Detaches Linked Data Signatures from the given JSON-LD document.
+* @param jsonLd The JSON-LD document to modify.
+* @returns The modified JSON-LD document.  If the input document does not
+*          contain a signature, the original document is returned.
+* @since 1.0.0
+*/
+declare function detachSignature(jsonLd: unknown): unknown;
+/**
+* Options for verifying Linked Data Signatures.
+* @since 1.0.0
+*/
+interface VerifySignatureOptions extends VerificationObservationOptions {
+  /**
+  * The document loader to use for fetching the public key.
+  */
+  documentLoader?: DocumentLoader;
+  /**
+  * The context loader to use for JSON-LD context retrieval.
+  */
+  contextLoader?: DocumentLoader;
+  /**
+  * The key cache to use for caching public keys.
+  */
+  keyCache?: KeyCache;
+  /**
+  * The OpenTelemetry tracer provider for tracing the verification process.
+  * If omitted, the global tracer provider is used.
+  * @since 1.3.0
+  */
+  tracerProvider?: TracerProvider;
+  /**
+  * The OpenTelemetry meter provider.  If omitted, the global meter provider
+  * is used.
+  * @since 2.3.0
+  */
+  meterProvider?: MeterProvider;
+}
+/**
+* Verifies Linked Data Signatures of the given JSON-LD document.
+*
+* This is a low-level utility that only checks the cryptographic signature
+* and (optionally) the cached key.  It does not run the JSON-LD parsing,
+* attribution, and owner checks that a complete inbound LD verification
+* needs.  For incoming activities, prefer {@link verifyJsonLd}, which is
+* the public verification entry point and the one that emits the
+* `activitypub.signature.verification.duration` metric for the LD path.
+* `verifySignature` itself only emits
+* `activitypub.signature.key_fetch.duration`, since the rest of the work
+* that the verification-duration metric is meant to cover happens in
+* `verifyJsonLd`.
+* @param jsonLd The JSON-LD document to verify.
+* @param options Options for verifying the signature.
+* @returns The public key that signed the document or `null` if the signature
+*          is invalid or the key is not found.
+* @since 1.0.0
+*/
+declare function verifySignature(jsonLd: unknown, options?: VerifySignatureOptions): Promise<CryptographicKey | null>;
+/**
+* Options for verifying JSON-LD documents.
+*/
+interface VerifyJsonLdOptions extends VerifySignatureOptions {}
+/**
+* Verify the authenticity of the given JSON-LD document using Linked Data
+* Signatures.  If the document is signed, this function verifies the signature
+* and checks if the document is attributed to the owner of the public key.
+* If the document is not signed, this function returns `false`.
+* @param jsonLd The JSON-LD document to verify.
+* @param options Options for verifying the document.
+* @returns `true` if the document is authentic; `false` otherwise.
+*/
+declare function verifyJsonLd(jsonLd: unknown, options?: VerifyJsonLdOptions): Promise<boolean>;
+//#endregion
+export { VerifySignatureOptions as a, detachSignature as c, verifyJsonLd as d, verifySignature as f, getKeyOwner as g, doesActorOwnKey as h, VerifyJsonLdOptions as i, hasSignatureLike as l, GetKeyOwnerOptions as m, EffectiveContextLoaderPolicy as n, attachSignature as o, DoesActorOwnKeyOptions as p, SignJsonLdOptions as r, createSignature as s, CreateSignatureOptions as t, signJsonLd as u };

package/dist/{metrics-DIM8ZCKq.mjs → metrics-B-QxRSSR.mjs}

@@ -1,7 +1,7 @@
 import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { n as version, t as name } from "./deno-DR1uYWpm.mjs";
+import { n as version, t as name } from "./deno-Dpewt_jJ.mjs";
 import { metrics } from "@opentelemetry/api";
 import { FetchError } from "@fedify/vocab-runtime";
 //#region src/federation/metrics.ts

package/dist/{middleware-Bx_QxJ0s.mjs → middleware-BdlNa8BD.mjs}

@@ -1,5 +1,5 @@
 import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { n as FederationImpl } from "./middleware-CDdFG6xf.mjs";
+import { n as FederationImpl } from "./middleware-CuVa0UuS.mjs";
 export { FederationImpl };