@qauth-labs/resource-guard 0.0.0 → 0.1.4-rc.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 QAuth Labs
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1 +1,247 @@
-\# @qauth-labs/resource-guard — placeholder, see https://github.com/qauth-labs/qauth
+# @qauth-labs/resource-guard
+
+> Targets the **MCP Authorization** specification, **revision 2026-07-28**, and
+> **RFC 9728** (OAuth 2.0 Protected Resource Metadata).
+
+The resource-server (RS) side SDK for protecting an **MCP server** with a
+self-hosted **[QAuth](../../../README.md)** OAuth 2.1 authorization server.
+
+Drop it into an MCP server and you get spec-correct OAuth in minutes:
+
+- **RFC 9728** Protected Resource Metadata at
+  `/.well-known/oauth-protected-resource[/<path>]`
+- **RFC 6750 §3** `401` / `403` `WWW-Authenticate: Bearer` challenges, with the
+  `resource_metadata` pointer (and the well-known doc as the fallback per MCP
+  2026-07-28)
+- **Scope guidance on the first 401**: the scopes the operation needs are
+  advertised on the credential-absent `401` as well as the `403`, so a client
+  authorizes in one round instead of fetching PRM and guessing. `offline_access`
+  is filtered out of both advertisement surfaces — it concerns refresh-token
+  issuance at the AS, not access to this resource
+- Bearer-token validation in two modes — local **JWT** verification against the
+  QAuth JWKS, or **RFC 7662** introspection
+- **No token passthrough**: tokens not audience-bound to this resource
+  (**RFC 8707**) are rejected, and the inbound token is never forwarded upstream
+- **Step-up** `403 insufficient_scope` scope challenges for incremental consent
+
+It ships both a **Fastify 5 plugin** and a **framework-agnostic core**
+(`ResourceGuard`) for non-Fastify hosts.
+
+> Targets the MCP Authorization profile **revision 2026-07-28** and QAuth's AS
+> contract (JWKS at `/.well-known/jwks.json`, discovery at
+> `/.well-known/oauth-authorization-server`, introspection at
+> `/oauth/introspect`). See [ADR-007](../../../docs/adr/007-mcp-first-positioning.md).
+
+## Install
+
+```bash
+pnpm add @qauth-labs/resource-guard
+# The Fastify entry also needs fastify@5 (an optional peer dependency).
+pnpm add fastify
+```
+
+Two entry points: `@qauth-labs/resource-guard` is the framework-agnostic core
+and never imports Fastify; `@qauth-labs/resource-guard/fastify` is the Fastify 5
+plugin. `jose` comes with the package.
+
+## Quick start (Fastify)
+
+```ts
+import Fastify from 'fastify';
+import { resourceGuardPlugin } from '@qauth-labs/resource-guard/fastify';
+
+const app = Fastify();
+
+await app.register(resourceGuardPlugin, {
+  // This resource's canonical URL — the `aud` every accepted token must carry.
+  resource: 'https://memory.mcp.example.com',
+  // Your QAuth instance (the issuer identifier).
+  authorizationServer: 'https://auth.example.com',
+  // Default scopes required for any protected route.
+  requiredScopes: ['mcp:read'],
+  // 'jwt' (default, offline) | 'introspection' (RFC 7662, online).
+  validationMode: 'jwt',
+});
+
+// Require a valid, audience-bound bearer carrying the default scopes:
+app.get('/mcp/memory', { preHandler: app.requireBearer }, async (req) => {
+  return { subject: req.tokenClaims?.sub };
+});
+
+// Step-up: this route additionally requires `mcp:write`. A token missing it
+// gets a 403 insufficient_scope challenge advertising the full required set.
+app.put('/mcp/memory/:key', { preHandler: app.requireScopes('mcp:write') }, async (req) => {
+  return { ok: true };
+});
+```
+
+Registering the plugin automatically:
+
+1. serves the RFC 9728 metadata document (`GET /.well-known/oauth-protected-resource`,
+   plus the nested path for a path-bearing `resource`),
+2. decorates the instance with `resourceGuard`, `requireBearer`, and `requireScopes(...)`,
+3. converts guard failures into the correct Bearer challenge responses.
+
+The validated claims are available on `request.tokenClaims`
+(`{ sub, clientId, scopes, audience, issuer, expiresAt, issuedAt, raw }`).
+
+### Several resources in one app
+
+A Fastify scope carries one guard. Register each further guard, together with the
+routes it protects, in an encapsulated child scope; there the decorators refer to
+that scope's guard. A second registration on the same scope fails at boot with
+`ResourceGuardConfigError`.
+
+```ts
+await app.register(async (admin) => {
+  await admin.register(resourceGuardPlugin, {
+    resource: 'https://mcp.example.com/admin',
+    authorizationServer: 'https://auth.example.com',
+    requiredScopes: ['mcp:admin'],
+  });
+  admin.get('/admin', { preHandler: admin.requireBearer }, async () => ({ ok: true }));
+});
+```
+
+## The handshake (what an MCP client sees)
+
+```
+client → GET /mcp/memory                         (no token)
+server → 401  WWW-Authenticate: Bearer scope="mcp:read",
+              resource_metadata="https://…/.well-known/oauth-protected-resource"
+client → GET /.well-known/oauth-protected-resource
+server → 200  { resource, authorization_servers: ["https://auth.example.com"], … }
+client → (discovers AS, runs authorization_code + PKCE against QAuth, gets a
+          token with aud=https://memory.mcp.example.com)
+client → GET /mcp/memory   Authorization: Bearer <token>
+server → 200  ✅  (resource-guard verified signature, issuer, audience, scopes)
+```
+
+## Validation modes
+
+### `jwt` (default, recommended)
+
+Verifies the bearer locally against the QAuth JWKS using `jose`
+(`createRemoteJWKSet`). Checks the EdDSA signature, `iss`, `exp`, and that
+`aud` contains this resource. No per-request call to the AS. The JWKS is cached
+in-process; control freshness with `jwksCacheTtlMs` (default 5 min) so rotated
+AS keys are picked up automatically.
+
+### `introspection` (RFC 7662)
+
+Verifies the bearer locally exactly as `jwt` mode does, then calls the QAuth
+introspection endpoint for the authoritative verdict — use for near-real-time
+revocation (or to receive the detached PQC signature QAuth delivers over
+introspection). Only a token that passes the local check is introspected: the
+AS never reports a token it did not sign as active, so a made-up bearer is
+refused here without spending one of the RS's rate-limited introspection
+calls. If the JWKS cannot be fetched, the token is introspected anyway rather
+than refused. For an AS that issues opaque tokens, set
+`introspectionLocalCheck: false`; every bearer is then introspected, so rate-limit
+your own callers. QAuth limits introspection per caller address
+(`INTROSPECT_RATE_LIMIT`, 30 per minute by default), so size it for this RS's
+traffic. Requires confidential client credentials (RFC 7662 mandates client
+authentication):
+
+```ts
+await app.register(resourceGuardPlugin, {
+  resource: 'https://memory.mcp.example.com',
+  authorizationServer: 'https://auth.example.com',
+  validationMode: 'introspection',
+  introspectionClient: {
+    clientId: process.env.INTROSPECT_CLIENT_ID!,
+    clientSecret: process.env.INTROSPECT_CLIENT_SECRET!,
+  },
+});
+```
+
+Even though QAuth only returns `active: true` to an audience-authoritative
+introspection client, `resource-guard` re-checks `aud` locally as defence-in-depth,
+so the no-passthrough guarantee never depends solely on AS-side configuration.
+
+## Configuration
+
+| Option                    | Type                         | Default                                        | Notes                                                               |
+| ------------------------- | ---------------------------- | ---------------------------------------------- | ------------------------------------------------------------------- |
+| `resource`                | `string` (required)          | —                                              | Resource identifier; `aud` tokens must carry (RFC 8707)             |
+| `authorizationServer`     | `string` (required)          | —                                              | QAuth issuer identifier                                             |
+| `requiredScopes`          | `string[]`                   | `[]`                                           | Default scopes for any protected route                              |
+| `validationMode`          | `'jwt' \| 'introspection'`   | `'jwt'`                                        | Token-validation strategy                                           |
+| `jwksUri`                 | `string`                     | `${authorizationServer}/.well-known/jwks.json` | Both modes: introspection verifies locally first                    |
+| `jwksCacheTtlMs`          | `number`                     | `300000`                                       | JWKS cache/cooldown                                                 |
+| `introspectionEndpoint`   | `string`                     | `${authorizationServer}/oauth/introspect`      | Introspection mode                                                  |
+| `introspectionClient`     | `{ clientId, clientSecret }` | —                                              | **Required** in introspection mode                                  |
+| `introspectionLocalCheck` | `boolean`                    | `true`                                         | Verify locally before introspecting; `false` only for opaque tokens |
+| `allowedAlgorithms`       | `string[]`                   | `['EdDSA']`                                    | Pinned to defend against alg-confusion                              |
+| `metadataCacheControl`    | `string`                     | `public, max-age=3600`                         | `Cache-Control` for the PRM document                                |
+| `fetch`                   | `FetchLike`                  | global `fetch`                                 | Injectable (tests / SSRF-guarded client)                            |
+
+## Framework-agnostic core
+
+```ts
+import { ResourceGuard, ResourceGuardError } from '@qauth-labs/resource-guard';
+
+const guard = new ResourceGuard({
+  resource: 'https://memory.mcp.example.com',
+  authorizationServer: 'https://auth.example.com',
+  requiredScopes: ['mcp:read'],
+});
+
+try {
+  const claims = await guard.authenticate(req.headers.authorization, ['mcp:write']);
+  // claims.sub, claims.scopes, claims.audience, …
+} catch (err) {
+  if (err instanceof ResourceGuardError) {
+    res.statusCode = err.statusCode; // 401 | 403
+    res.setHeader('WWW-Authenticate', guard.challengeHeader(err));
+    res.end();
+  }
+}
+```
+
+- `guard.getProtectedResourceMetadata()` — the RFC 9728 document to serve.
+- `guard.getMetadataPath()` / `getMetadataUrl()` — well-known path / absolute URL.
+- `guard.assertScopes(claims, ['mcp:write'])` — mid-handler step-up check.
+
+## Security model
+
+- **Audience binding (RFC 8707).** Both validators reject any token whose `aud`
+  does not include `resource`. This is the no-passthrough control: a token
+  minted for another resource cannot be replayed here.
+- **No upstream forwarding.** The core only validates and returns _claims_; it
+  never returns the raw token to a call site or forwards it to upstream APIs.
+- **Algorithm pinning.** JWT mode accepts `EdDSA` only by default, closing
+  algorithm-confusion attacks.
+- **Exact scope matching.** Scopes are compared exactly and case-sensitively
+  (RFC 6749 §3.3) — no prefix or wildcard semantics. QAuth's scope vocabulary
+  declares no scope hierarchy (no scope implies another), so the MCP 2026-07-28
+  requirement that servers account for hierarchies is satisfied by construction.
+  A host whose own vocabulary _is_ hierarchical must list the implied scopes
+  itself in `requiredScopes` / `requireScopes(...)`.
+- **Fail closed.** Transport errors, non-2xx introspection responses, malformed
+  tokens, and unknown signing keys all fail validation. Error reasons are short
+  and non-sensitive; **the token is never echoed** in a challenge or a log.
+
+## Runnable example
+
+A minimal MCP-style memory server is in [`examples/memory-mcp/server.ts`](./examples/memory-mcp/server.ts).
+It is the RS half of the Claude Code → QAuth → MCP quickstart:
+
+```bash
+QAUTH_ISSUER=http://localhost:3000 \
+MCP_RESOURCE=http://localhost:8088 \
+npx tsx examples/memory-mcp/server.ts
+```
+
+## Standards
+
+RFC 9728 (Protected Resource Metadata) · RFC 8707 (Resource Indicators) ·
+RFC 7662 (Token Introspection) · RFC 6750 §3 (Bearer challenges) ·
+RFC 8414 (AS Metadata) · MCP Authorization 2026-07-28.
+
+## Testing
+
+```bash
+pnpm nx test resource-guard
+pnpm nx build resource-guard
+```

package/dist/fastify.d.ts

@@ -0,0 +1,9 @@
+/**
+ * `@qauth-labs/resource-guard/fastify` — the Fastify 5 adapter.
+ *
+ * {@link resourceGuardPlugin} (also the default export) serves RFC 9728
+ * metadata and decorates the instance with `resourceGuard`, `requireBearer`
+ * and `requireScopes`. It needs `fastify` (an optional peer dependency of the
+ * package); the root entry `@qauth-labs/resource-guard` does not.
+ */
+export { default, resourceGuardPlugin, type ResourceGuardPluginOptions, sendBearerChallenge, } from './lib/fastify-plugin.js';

package/dist/fastify.js

@@ -0,0 +1,9 @@
+/**
+ * `@qauth-labs/resource-guard/fastify` — the Fastify 5 adapter.
+ *
+ * {@link resourceGuardPlugin} (also the default export) serves RFC 9728
+ * metadata and decorates the instance with `resourceGuard`, `requireBearer`
+ * and `requireScopes`. It needs `fastify` (an optional peer dependency of the
+ * package); the root entry `@qauth-labs/resource-guard` does not.
+ */
+export { default, resourceGuardPlugin, sendBearerChallenge, } from './lib/fastify-plugin.js';

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * `@qauth-labs/resource-guard` — the resource-server-side SDK for wiring an
+ * MCP server (or any OAuth 2.1 resource server) to a self-hosted QAuth
+ * authorization server.
+ *
+ * Two entry points:
+ *
+ * - this one, the framework-agnostic core: {@link ResourceGuard}, the
+ *   validators, the RFC 9728 metadata and RFC 6750 challenge helpers. It never
+ *   imports Fastify.
+ * - `@qauth-labs/resource-guard/fastify` — the Fastify 5 plugin, which serves
+ *   RFC 9728 metadata and decorates the instance with `requireBearer` /
+ *   `requireScopes` preHandlers. `fastify` is an optional peer dependency,
+ *   needed only for that entry.
+ *
+ * See the package README and `examples/memory-mcp` for usage.
+ */
+export { extractBearerToken, ResourceGuard } from './lib/core.js';
+export { type BearerErrorCode, InsufficientScopeError, IntrospectionError, InvalidTokenError, MissingTokenError, ResourceGuardConfigError, ResourceGuardError, } from './lib/errors.js';
+export { buildProtectedResourceMetadata, metadataPathForResource, metadataUrlForResource, PRM_WELL_KNOWN_PREFIX, type ProtectedResourceMetadata, } from './lib/metadata.js';
+export { buildWwwAuthenticate, type ChallengeParams } from './lib/challenge.js';
+export { hasRequiredScopes, missingScopes, parseScopes } from './lib/scope.js';
+export { IntrospectionValidator, type IntrospectionValidatorOptions, } from './lib/introspection-validator.js';
+export { JwtValidator, type JwtValidatorOptions } from './lib/jwt-validator.js';
+export type { FetchLike, IntrospectionClientCredentials, ResourceGuardConfig, ValidatedToken, ValidationMode, } from './types.js';

package/dist/index.js

@@ -0,0 +1,30 @@
+/**
+ * `@qauth-labs/resource-guard` — the resource-server-side SDK for wiring an
+ * MCP server (or any OAuth 2.1 resource server) to a self-hosted QAuth
+ * authorization server.
+ *
+ * Two entry points:
+ *
+ * - this one, the framework-agnostic core: {@link ResourceGuard}, the
+ *   validators, the RFC 9728 metadata and RFC 6750 challenge helpers. It never
+ *   imports Fastify.
+ * - `@qauth-labs/resource-guard/fastify` — the Fastify 5 plugin, which serves
+ *   RFC 9728 metadata and decorates the instance with `requireBearer` /
+ *   `requireScopes` preHandlers. `fastify` is an optional peer dependency,
+ *   needed only for that entry.
+ *
+ * See the package README and `examples/memory-mcp` for usage.
+ */
+// Framework-agnostic core.
+export { extractBearerToken, ResourceGuard } from './lib/core.js';
+// Errors (for `instanceof` checks and custom error handling).
+export { InsufficientScopeError, IntrospectionError, InvalidTokenError, MissingTokenError, ResourceGuardConfigError, ResourceGuardError, } from './lib/errors.js';
+// RFC 9728 metadata helpers.
+export { buildProtectedResourceMetadata, metadataPathForResource, metadataUrlForResource, PRM_WELL_KNOWN_PREFIX, } from './lib/metadata.js';
+// Challenge construction (RFC 6750 §3.1).
+export { buildWwwAuthenticate } from './lib/challenge.js';
+// Scope helpers.
+export { hasRequiredScopes, missingScopes, parseScopes } from './lib/scope.js';
+// Validators (advanced / custom wiring).
+export { IntrospectionValidator, } from './lib/introspection-validator.js';
+export { JwtValidator } from './lib/jwt-validator.js';

package/dist/lib/challenge.d.ts

@@ -0,0 +1,32 @@
+/**
+ * `WWW-Authenticate: Bearer` challenge construction.
+ *
+ * RFC 6750 §3 defines the challenge sent with a 401/403 to a Bearer-protected
+ * resource. RFC 9728 §5.1 adds the `resource_metadata` parameter so the client
+ * can discover the AS. Under MCP 2026-07-28 this header is OPTIONAL when the
+ * resource exposes the `.well-known` PRM document, but emitting it is the
+ * fastest path for a client and is recommended — `resource-guard` always emits it.
+ */
+import type { ResourceGuardError } from './errors.js';
+export interface ChallengeParams {
+    /** Absolute URL of the RFC 9728 PRM document (`resource_metadata`). */
+    resourceMetadataUrl: string;
+    /** RFC 6750 `error` code; omit for a credential-absent challenge. */
+    error?: string;
+    /** Human-readable `error_description` (never include the token). */
+    errorDescription?: string;
+    /** Space-separated scopes that would satisfy the request (`scope`). */
+    scope?: string[];
+}
+/**
+ * Build the `WWW-Authenticate` header value. Parameter order follows common
+ * practice (`error` first, then descriptors); RFC 6750 does not mandate order.
+ */
+export declare function buildWwwAuthenticate(params: ChallengeParams): string;
+/**
+ * Derive the `WWW-Authenticate` value for a guard error. Centralises the
+ * RFC 6750 §3.1 mapping so the Fastify layer and any other adapter stay
+ * consistent. `InsufficientScopeError` and `MissingTokenError` both contribute
+ * the `scope` challenge (see below).
+ */
+export declare function challengeForError(error: ResourceGuardError, resourceMetadataUrl: string): string;

package/dist/lib/challenge.js

@@ -0,0 +1,72 @@
+/**
+ * `WWW-Authenticate: Bearer` challenge construction.
+ *
+ * RFC 6750 §3 defines the challenge sent with a 401/403 to a Bearer-protected
+ * resource. RFC 9728 §5.1 adds the `resource_metadata` parameter so the client
+ * can discover the AS. Under MCP 2026-07-28 this header is OPTIONAL when the
+ * resource exposes the `.well-known` PRM document, but emitting it is the
+ * fastest path for a client and is recommended — `resource-guard` always emits it.
+ */
+import { advertisableScopes } from './scope.js';
+/**
+ * Escape a value for an HTTP `auth-param` quoted-string (RFC 7235 / RFC 9110).
+ * Only `"` and `\` are special inside a quoted-string; the values we emit
+ * (URLs, fixed error codes, scope tokens) contain neither in practice, but we
+ * escape defensively to keep the header well-formed and uninjectable.
+ */
+function quote(value) {
+    return `"${value.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
+}
+/**
+ * Build the `WWW-Authenticate` header value. Parameter order follows common
+ * practice (`error` first, then descriptors); RFC 6750 does not mandate order.
+ */
+export function buildWwwAuthenticate(params) {
+    const parts = [];
+    if (params.error) {
+        parts.push(`error=${quote(params.error)}`);
+    }
+    if (params.errorDescription) {
+        parts.push(`error_description=${quote(params.errorDescription)}`);
+    }
+    if (params.scope && params.scope.length > 0) {
+        parts.push(`scope=${quote(params.scope.join(' '))}`);
+    }
+    parts.push(`resource_metadata=${quote(params.resourceMetadataUrl)}`);
+    return `Bearer ${parts.join(', ')}`;
+}
+/**
+ * Derive the `WWW-Authenticate` value for a guard error. Centralises the
+ * RFC 6750 §3.1 mapping so the Fastify layer and any other adapter stay
+ * consistent. `InsufficientScopeError` and `MissingTokenError` both contribute
+ * the `scope` challenge (see below).
+ */
+export function challengeForError(error, resourceMetadataUrl) {
+    const params = { resourceMetadataUrl };
+    if (error.bearerError) {
+        params.error = error.bearerError;
+    }
+    // Only attach a description for token errors; a bare 401 (missing token)
+    // carries no `error`, and we avoid leaking validator internals beyond the
+    // short, non-sensitive reason already on the error.
+    if (error.bearerError === 'invalid_token' && 'reason' in error) {
+        params.errorDescription = error.reason;
+    }
+    // `scope` is advertised on the 403 step-up challenge and — since #284 — on
+    // the credential-absent 401 as well: MCP Authorization 2026-07-28 ("Scope
+    // Selection Strategy") says the RS SHOULD tell an unauthenticated client
+    // what the operation needs, so it can authorize in one round instead of
+    // fetching PRM and guessing. The 401 still carries NO `error` parameter:
+    // RFC 6750 §3.1 omits it when no credentials were presented, and only
+    // `scope` is added.
+    //
+    // `invalid_token` is deliberately excluded — the client already holds a
+    // token, so the remedy is re-authentication, not a wider scope set, and
+    // repeating the requirement there would invite pointless re-consent loops.
+    if (error.bearerError !== 'invalid_token' && 'requiredScopes' in error) {
+        // `buildWwwAuthenticate` omits an empty `scope`, so a route with no
+        // configured scopes yields a bare challenge rather than `scope=""`.
+        params.scope = advertisableScopes(error.requiredScopes);
+    }
+    return buildWwwAuthenticate(params);
+}