@fedify/fedify 2.4.0-dev.2164 → 2.4.0-dev.2190

package/dist/{http-DC1cqAQ2.d.cts → http-BrwKINQn.d.cts}

@@ -601,6 +601,30 @@ interface VerifyRequestOptions {
   */
   spec?: HttpMessageSignaturesSpec;
   /**
+  * The maximum number of [RFC 9421] signatures of a request to verify.
+  * A request can carry several signatures, each of which may make Fedify
+  * fetch the key that it names, so only the first ones in the order of
+  * the `Signature-Input` header are verified, and the rest are ignored as
+  * if they were absent.  Every signature among the first ones counts, even
+  * if it fails before its key is fetched, e.g., because it is too old, or
+  * names the same key as another one.  The key of a key ID is looked up
+  * only once for all the signatures that name it.
+  *
+  * It has to be a positive integer, or `Infinity` to verify every
+  * signature, which lets a single request make Fedify fetch any number of
+  * keys.  Draft-cavage HTTP Signatures carry a single signature, so this
+  * option does not affect them.
+  *
+  * Three by default.
+  *
+  * [RFC 9421]: https://www.rfc-editor.org/rfc/rfc9421
+  * @throws {RangeError} Thrown by {@link verifyRequest} and
+  *         {@link verifyRequestDetailed} if the value is not a positive
+  *         integer or `Infinity`.
+  * @since 2.4.0
+  */
+  maxSignatures?: number;
+  /**
   * The OpenTelemetry tracer provider.  If omitted, the global tracer provider
   * is used.
   * @since 1.3.0
@@ -651,6 +675,8 @@ type VerifyRequestDetailedResult = {
 * @param options Options for verifying the request.
 * @returns The public key of the verified signature, or `null` if the signature
 *          could not be verified.
+* @throws {RangeError} Thrown if {@link VerifyRequestOptions.maxSignatures}
+*         is not a positive integer or `Infinity`.
 */
 declare function verifyRequest(request: Request, options?: VerifyRequestOptions): Promise<CryptographicKey | null>;
 /**
@@ -660,6 +686,8 @@ declare function verifyRequest(request: Request, options?: VerifyRequestOptions)
 * @param request The request to verify.
 * @param options Options for verifying the request.
 * @returns The verified public key, or a structured verification failure.
+* @throws {RangeError} Thrown if {@link VerifyRequestOptions.maxSignatures}
+*         is not a positive integer or `Infinity`.
 * @since 2.1.0
 */
 declare function verifyRequestDetailed(request: Request, options?: VerifyRequestOptions): Promise<VerifyRequestDetailedResult>;