@mayurajs/auth-auth0 0.0.0-stage → 1.2.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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,8 @@
+Mayura
+Copyright 2026 The Mayura Authors
+
+This product includes software developed by the Mayura contributors.
+
+Third-party dependencies retain their own copyright and license terms. Exact
+resolved versions are recorded in pnpm-lock.yaml and reviewed by the release
+artifact and dependency qualification procedures.

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# @mayurajs/auth-auth0
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Auth0](https://auth0.com) access tokens as Mayura server identities: verified with your tenant's published keys, on
+any runtime, with no dependency.
+
+```bash
+npm install mayura @mayurajs/auth-auth0
+```
+
+```ts
+import { mapCapabilities, principalId } from 'mayura/auth';
+import { auth0Authenticator } from '@mayurajs/auth-auth0';
+
+const authenticate = auth0Authenticator({
+  domain: 'acme.us.auth0.com',          // or the custom domain your applications get tokens from
+  audience: 'https://agents.acme.com',  // your API's identifier
+  identity: session => session.orgId ? {
+    principalId: principalId('auth0', session.subject),
+    projectId: session.orgId,
+    agentIds: ['support'],
+    capabilities: mapCapabilities(session.permissions, { 'use:agents': ['runs:submit', 'runs:read'] }),
+  } : null,
+});
+// createAgentServer({ ..., authenticate })
+```
+
+- **What is checked.** Tokens issued by your tenant (`https://<domain>/`, with the trailing slash Auth0 writes) for your
+  API (`audience`, one or several), signed with RS256 by the keys at `https://<domain>/.well-known/jwks.json`. If your
+  API signs with HS256 instead, give its `signingSecret`: then only HS256 is accepted, never the tenant's keys.
+- **What you get.** `identity` receives the token as a session, from either access token profile (Auth0's, or RFC
+  9068): `subject`, `clientId` (`azp` or `client_id`), `machine` (client credentials: `gty`, or a subject ending in
+  `@clients`), `scopes`, `permissions` (with RBAC on), the organization (`orgId`, `orgName`), and the raw `claims`.
+  Auth0 asks APIs to check `org_id` when organizations are used; map it to the project, as above. Nothing is granted
+  unless `identity` grants it.
+- Auth0 subjects such as `auth0|123` hold a character Mayura's ids do not, so `principalId('auth0', subject)` gives a
+  stable hashed id for them.
+- Options: `domain`, `audience`, `identity`, `signingSecret`, `clockSkewMs` (5 s), `maxIdentityMs` (60 s), `fetch`.
+
+See [Authentication and API keys](https://mayurajs.com/docs/guides/authentication/). Apache-2.0.

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { type Authenticator, type IdentityGrant, type JwtClaims } from 'mayura/auth';
+/** A verified Auth0 access token, either token profile (Auth0's, or RFC 9068). */
+export interface Auth0Session {
+    /** The user (`auth0|...`, `google-oauth2|...`), or for a machine `<client id>@clients`. */
+    readonly subject: string;
+    /** The application the token was issued to (`azp`, or `client_id` in the RFC 9068 profile). */
+    readonly clientId: string | null;
+    /** Whether a machine holds it (client credentials) rather than a user. */
+    readonly machine: boolean;
+    /** The scopes granted (`scope`). */
+    readonly scopes: readonly string[];
+    /** The API's permissions granted (`permissions`, with RBAC on). */
+    readonly permissions: readonly string[];
+    /** The organization the user signed in through (`org_id`, `org_name`), when there is one. */
+    readonly orgId: string | null;
+    readonly orgName: string | null;
+    /** The token's claims, as verified. */
+    readonly claims: JwtClaims;
+}
+export interface Auth0AuthenticatorOptions {
+    /** Your tenant's domain, such as `acme.us.auth0.com`, or the custom domain your applications get tokens from. */
+    readonly domain: string;
+    /** Your API's identifier (its audience), which tokens must be issued for. */
+    readonly audience: string | readonly string[];
+    /** What a token's holder may do, or null to refuse; for example from `session.permissions` with `mapCapabilities`. */
+    readonly identity: (session: Auth0Session) => IdentityGrant | null | Promise<IdentityGrant | null>;
+    /** Your API's signing secret, only if it signs with HS256; RS256 with the tenant's keys otherwise. */
+    readonly signingSecret?: string;
+    /** Clock difference allowed; 5 s by default. */
+    readonly clockSkewMs?: number;
+    /** The longest an identity lasts before the token is checked again; 60 s by default. */
+    readonly maxIdentityMs?: number;
+    /** For tests and proxies: the fetch to use for the JWKS. */
+    readonly fetch?: typeof fetch;
+}
+/** An Auth0 session from verified claims, either token profile; undefined when the claims are not an Auth0 access token's. */
+export declare function auth0Session(claims: JwtClaims): Auth0Session | undefined;
+/**
+ * A server `authenticate` for Auth0 access tokens: issued by your tenant (`https://<domain>/`) for your API (its
+ * audience), signed with RS256 by the tenant's published keys (or HS256 with your API's secret, when it signs that
+ * way). `identity` decides what the holder may do; Auth0 asks APIs to check `org_id` when organizations are used.
+ */
+export declare function auth0Authenticator(options: Auth0AuthenticatorOptions): Authenticator;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAyD,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE5I,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC3B,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,+FAA+F;IAC/F,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,0EAA0E;IAC1E,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,mEAAmE;IACnE,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IACxC,6FAA6F;IAC7F,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC,iHAAiH;IACjH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;IAC9C,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IACnG,sGAAsG;IACtG,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,gDAAgD;IAChD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CAC/B;AAID,8HAA8H;AAC9H,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,CAYxE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,aAAa,CAuBpF"}

package/dist/index.js

@@ -0,0 +1,51 @@
+import { MayuraError } from 'mayura';
+import { hmacSecret, jwtAuthenticator, jwtVerifier, remoteJwks } from 'mayura/auth';
+const strings = (value) => Array.isArray(value) ? value.filter((item) => typeof item === 'string') : [];
+/** An Auth0 session from verified claims, either token profile; undefined when the claims are not an Auth0 access token's. */
+export function auth0Session(claims) {
+    if (typeof claims.sub !== 'string' || claims.sub === '')
+        return undefined;
+    const text = (value) => typeof value === 'string' && value !== '' ? value : null;
+    const orgId = text(claims['org_id']);
+    return Object.freeze({
+        subject: claims.sub, clientId: text(claims['azp']) ?? text(claims['client_id']),
+        // Auth0's profile names the grant (gty); in either profile a machine's subject is <client id>@clients.
+        machine: claims['gty'] === 'client-credentials' || claims.sub.endsWith('@clients'),
+        scopes: Object.freeze(typeof claims['scope'] === 'string' ? claims['scope'].split(' ').filter(Boolean) : []),
+        permissions: Object.freeze(strings(claims['permissions'])),
+        orgId, orgName: orgId ? text(claims['org_name']) : null, claims,
+    });
+}
+/**
+ * A server `authenticate` for Auth0 access tokens: issued by your tenant (`https://<domain>/`) for your API (its
+ * audience), signed with RS256 by the tenant's published keys (or HS256 with your API's secret, when it signs that
+ * way). `identity` decides what the holder may do; Auth0 asks APIs to check `org_id` when organizations are used.
+ */
+export function auth0Authenticator(options) {
+    if (!options || typeof options.identity !== 'function')
+        throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): identity decides what a token\'s holder may do.');
+    const domain = typeof options.domain === 'string' ? options.domain.trim().replace(/^https:\/\//u, '').replace(/\/$/u, '') : '';
+    if (!/^[a-z0-9-]+(?:\.[a-z0-9-]+)+$/iu.test(domain))
+        throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): domain is your tenant\'s domain, such as acme.us.auth0.com.');
+    const audience = options.audience;
+    if (!(typeof audience === 'string' && audience !== '') && !(Array.isArray(audience) && audience.length > 0 && audience.every(item => typeof item === 'string' && item !== ''))) {
+        throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): audience is your API\'s identifier.');
+    }
+    if (options.signingSecret !== undefined && typeof options.signingSecret !== 'string')
+        throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): signingSecret is your API\'s signing secret.');
+    const issuer = `https://${domain}/`;
+    const verifier = jwtVerifier({
+        issuer, audience, clockSkewMs: options.clockSkewMs ?? 5_000,
+        ...(options.signingSecret !== undefined
+            ? { algorithms: ['HS256'], keys: hmacSecret(options.signingSecret) }
+            : { algorithms: ['RS256'], keys: remoteJwks({ url: `${issuer}.well-known/jwks.json`, ...(options.fetch ? { fetch: options.fetch } : {}) }) }),
+    });
+    return jwtAuthenticator({
+        verifier, ...(options.maxIdentityMs !== undefined ? { maxIdentityMs: options.maxIdentityMs } : {}),
+        identity: claims => {
+            const session = auth0Session(claims);
+            return session ? options.identity(session) : null;
+        },
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,UAAU,EAA0D,MAAM,aAAa,CAAC;AAsC5I,MAAM,OAAO,GAAG,CAAC,KAAc,EAAY,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAE3I,8HAA8H;AAC9H,MAAM,UAAU,YAAY,CAAC,MAAiB;IAC5C,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IAC1E,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1F,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrC,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC/E,uGAAuG;QACvG,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,oBAAoB,IAAI,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;QAClF,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5G,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;QAC1D,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM;KAChE,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAkC;IACnE,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,uEAAuE,CAAC,CAAC;IACzK,MAAM,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/H,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,mFAAmF,CAAC,CAAC;IAClL,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,IAAI,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC;QAC/K,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,2DAA2D,CAAC,CAAC;IACvG,CAAC;IACD,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,oEAAoE,CAAC,CAAC;IACpM,MAAM,MAAM,GAAG,WAAW,MAAM,GAAG,CAAC;IACpC,MAAM,QAAQ,GAAG,WAAW,CAAC;QAC3B,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,KAAK;QAC3D,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS;YACrC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,OAAO,CAAU,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;YAC7E,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,OAAO,CAAU,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,uBAAuB,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;KACzJ,CAAC,CAAC;IACH,OAAO,gBAAgB,CAAC;QACtB,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClG,QAAQ,EAAE,MAAM,CAAC,EAAE;YACjB,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;YACrC,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpD,CAAC;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { MayuraError } from 'mayura';\nimport { hmacSecret, jwtAuthenticator, jwtVerifier, remoteJwks, type Authenticator, type IdentityGrant, type JwtClaims } from 'mayura/auth';\n\n/** A verified Auth0 access token, either token profile (Auth0's, or RFC 9068). */\nexport interface Auth0Session {\n  /** The user (`auth0|...`, `google-oauth2|...`), or for a machine `<client id>@clients`. */\n  readonly subject: string;\n  /** The application the token was issued to (`azp`, or `client_id` in the RFC 9068 profile). */\n  readonly clientId: string | null;\n  /** Whether a machine holds it (client credentials) rather than a user. */\n  readonly machine: boolean;\n  /** The scopes granted (`scope`). */\n  readonly scopes: readonly string[];\n  /** The API's permissions granted (`permissions`, with RBAC on). */\n  readonly permissions: readonly string[];\n  /** The organization the user signed in through (`org_id`, `org_name`), when there is one. */\n  readonly orgId: string | null;\n  readonly orgName: string | null;\n  /** The token's claims, as verified. */\n  readonly claims: JwtClaims;\n}\n\nexport interface Auth0AuthenticatorOptions {\n  /** Your tenant's domain, such as `acme.us.auth0.com`, or the custom domain your applications get tokens from. */\n  readonly domain: string;\n  /** Your API's identifier (its audience), which tokens must be issued for. */\n  readonly audience: string | readonly string[];\n  /** What a token's holder may do, or null to refuse; for example from `session.permissions` with `mapCapabilities`. */\n  readonly identity: (session: Auth0Session) => IdentityGrant | null | Promise<IdentityGrant | null>;\n  /** Your API's signing secret, only if it signs with HS256; RS256 with the tenant's keys otherwise. */\n  readonly signingSecret?: string;\n  /** Clock difference allowed; 5 s by default. */\n  readonly clockSkewMs?: number;\n  /** The longest an identity lasts before the token is checked again; 60 s by default. */\n  readonly maxIdentityMs?: number;\n  /** For tests and proxies: the fetch to use for the JWKS. */\n  readonly fetch?: typeof fetch;\n}\n\nconst strings = (value: unknown): string[] => Array.isArray(value) ? value.filter((item): item is string => typeof item === 'string') : [];\n\n/** An Auth0 session from verified claims, either token profile; undefined when the claims are not an Auth0 access token's. */\nexport function auth0Session(claims: JwtClaims): Auth0Session | undefined {\n  if (typeof claims.sub !== 'string' || claims.sub === '') return undefined;\n  const text = (value: unknown) => typeof value === 'string' && value !== '' ? value : null;\n  const orgId = text(claims['org_id']);\n  return Object.freeze({\n    subject: claims.sub, clientId: text(claims['azp']) ?? text(claims['client_id']),\n    // Auth0's profile names the grant (gty); in either profile a machine's subject is <client id>@clients.\n    machine: claims['gty'] === 'client-credentials' || claims.sub.endsWith('@clients'),\n    scopes: Object.freeze(typeof claims['scope'] === 'string' ? claims['scope'].split(' ').filter(Boolean) : []),\n    permissions: Object.freeze(strings(claims['permissions'])),\n    orgId, orgName: orgId ? text(claims['org_name']) : null, claims,\n  });\n}\n\n/**\n * A server `authenticate` for Auth0 access tokens: issued by your tenant (`https://<domain>/`) for your API (its\n * audience), signed with RS256 by the tenant's published keys (or HS256 with your API's secret, when it signs that\n * way). `identity` decides what the holder may do; Auth0 asks APIs to check `org_id` when organizations are used.\n */\nexport function auth0Authenticator(options: Auth0AuthenticatorOptions): Authenticator {\n  if (!options || typeof options.identity !== 'function') throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): identity decides what a token\\'s holder may do.');\n  const domain = typeof options.domain === 'string' ? options.domain.trim().replace(/^https:\\/\\//u, '').replace(/\\/$/u, '') : '';\n  if (!/^[a-z0-9-]+(?:\\.[a-z0-9-]+)+$/iu.test(domain)) throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): domain is your tenant\\'s domain, such as acme.us.auth0.com.');\n  const audience = options.audience;\n  if (!(typeof audience === 'string' && audience !== '') && !(Array.isArray(audience) && audience.length > 0 && audience.every(item => typeof item === 'string' && item !== ''))) {\n    throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): audience is your API\\'s identifier.');\n  }\n  if (options.signingSecret !== undefined && typeof options.signingSecret !== 'string') throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): signingSecret is your API\\'s signing secret.');\n  const issuer = `https://${domain}/`;\n  const verifier = jwtVerifier({\n    issuer, audience, clockSkewMs: options.clockSkewMs ?? 5_000,\n    ...(options.signingSecret !== undefined\n      ? { algorithms: ['HS256'] as const, keys: hmacSecret(options.signingSecret) }\n      : { algorithms: ['RS256'] as const, keys: remoteJwks({ url: `${issuer}.well-known/jwks.json`, ...(options.fetch ? { fetch: options.fetch } : {}) }) }),\n  });\n  return jwtAuthenticator({\n    verifier, ...(options.maxIdentityMs !== undefined ? { maxIdentityMs: options.maxIdentityMs } : {}),\n    identity: claims => {\n      const session = auth0Session(claims);\n      return session ? options.identity(session) : null;\n    },\n  });\n}\n"]}

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@mayurajs/auth-auth0",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.2.0",
+  "description": "Auth0 access tokens as Mayura server identities, verified with your tenant's published keys.",
+  "author": {
+    "name": "Aryabh",
+    "email": "dev@rokad.co"
+  },
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KartikeyAI/mayura.git",
+    "directory": "extensions/auth-auth0"
+  },
+  "homepage": "https://github.com/KartikeyAI/mayura#readme",
+  "bugs": {
+    "url": "https://github.com/KartikeyAI/mayura/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0 <23 || >=24.14.1 <25"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src/**/*.ts",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "mayura": "^1.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/src/index.ts

@@ -0,0 +1,85 @@
+import { MayuraError } from 'mayura';
+import { hmacSecret, jwtAuthenticator, jwtVerifier, remoteJwks, type Authenticator, type IdentityGrant, type JwtClaims } from 'mayura/auth';
+
+/** A verified Auth0 access token, either token profile (Auth0's, or RFC 9068). */
+export interface Auth0Session {
+  /** The user (`auth0|...`, `google-oauth2|...`), or for a machine `<client id>@clients`. */
+  readonly subject: string;
+  /** The application the token was issued to (`azp`, or `client_id` in the RFC 9068 profile). */
+  readonly clientId: string | null;
+  /** Whether a machine holds it (client credentials) rather than a user. */
+  readonly machine: boolean;
+  /** The scopes granted (`scope`). */
+  readonly scopes: readonly string[];
+  /** The API's permissions granted (`permissions`, with RBAC on). */
+  readonly permissions: readonly string[];
+  /** The organization the user signed in through (`org_id`, `org_name`), when there is one. */
+  readonly orgId: string | null;
+  readonly orgName: string | null;
+  /** The token's claims, as verified. */
+  readonly claims: JwtClaims;
+}
+
+export interface Auth0AuthenticatorOptions {
+  /** Your tenant's domain, such as `acme.us.auth0.com`, or the custom domain your applications get tokens from. */
+  readonly domain: string;
+  /** Your API's identifier (its audience), which tokens must be issued for. */
+  readonly audience: string | readonly string[];
+  /** What a token's holder may do, or null to refuse; for example from `session.permissions` with `mapCapabilities`. */
+  readonly identity: (session: Auth0Session) => IdentityGrant | null | Promise<IdentityGrant | null>;
+  /** Your API's signing secret, only if it signs with HS256; RS256 with the tenant's keys otherwise. */
+  readonly signingSecret?: string;
+  /** Clock difference allowed; 5 s by default. */
+  readonly clockSkewMs?: number;
+  /** The longest an identity lasts before the token is checked again; 60 s by default. */
+  readonly maxIdentityMs?: number;
+  /** For tests and proxies: the fetch to use for the JWKS. */
+  readonly fetch?: typeof fetch;
+}
+
+const strings = (value: unknown): string[] => Array.isArray(value) ? value.filter((item): item is string => typeof item === 'string') : [];
+
+/** An Auth0 session from verified claims, either token profile; undefined when the claims are not an Auth0 access token's. */
+export function auth0Session(claims: JwtClaims): Auth0Session | undefined {
+  if (typeof claims.sub !== 'string' || claims.sub === '') return undefined;
+  const text = (value: unknown) => typeof value === 'string' && value !== '' ? value : null;
+  const orgId = text(claims['org_id']);
+  return Object.freeze({
+    subject: claims.sub, clientId: text(claims['azp']) ?? text(claims['client_id']),
+    // Auth0's profile names the grant (gty); in either profile a machine's subject is <client id>@clients.
+    machine: claims['gty'] === 'client-credentials' || claims.sub.endsWith('@clients'),
+    scopes: Object.freeze(typeof claims['scope'] === 'string' ? claims['scope'].split(' ').filter(Boolean) : []),
+    permissions: Object.freeze(strings(claims['permissions'])),
+    orgId, orgName: orgId ? text(claims['org_name']) : null, claims,
+  });
+}
+
+/**
+ * A server `authenticate` for Auth0 access tokens: issued by your tenant (`https://<domain>/`) for your API (its
+ * audience), signed with RS256 by the tenant's published keys (or HS256 with your API's secret, when it signs that
+ * way). `identity` decides what the holder may do; Auth0 asks APIs to check `org_id` when organizations are used.
+ */
+export function auth0Authenticator(options: Auth0AuthenticatorOptions): Authenticator {
+  if (!options || typeof options.identity !== 'function') throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): identity decides what a token\'s holder may do.');
+  const domain = typeof options.domain === 'string' ? options.domain.trim().replace(/^https:\/\//u, '').replace(/\/$/u, '') : '';
+  if (!/^[a-z0-9-]+(?:\.[a-z0-9-]+)+$/iu.test(domain)) throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): domain is your tenant\'s domain, such as acme.us.auth0.com.');
+  const audience = options.audience;
+  if (!(typeof audience === 'string' && audience !== '') && !(Array.isArray(audience) && audience.length > 0 && audience.every(item => typeof item === 'string' && item !== ''))) {
+    throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): audience is your API\'s identifier.');
+  }
+  if (options.signingSecret !== undefined && typeof options.signingSecret !== 'string') throw new MayuraError('INVALID_CONFIG', 'auth0Authenticator(): signingSecret is your API\'s signing secret.');
+  const issuer = `https://${domain}/`;
+  const verifier = jwtVerifier({
+    issuer, audience, clockSkewMs: options.clockSkewMs ?? 5_000,
+    ...(options.signingSecret !== undefined
+      ? { algorithms: ['HS256'] as const, keys: hmacSecret(options.signingSecret) }
+      : { algorithms: ['RS256'] as const, keys: remoteJwks({ url: `${issuer}.well-known/jwks.json`, ...(options.fetch ? { fetch: options.fetch } : {}) }) }),
+  });
+  return jwtAuthenticator({
+    verifier, ...(options.maxIdentityMs !== undefined ? { maxIdentityMs: options.maxIdentityMs } : {}),
+    identity: claims => {
+      const session = auth0Session(claims);
+      return session ? options.identity(session) : null;
+    },
+  });
+}