@mayurajs/auth-cognito 0.0.0-stage → 1.1.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,41 @@
-# Temporary Holding Version
+# @mayurajs/auth-cognito
 
-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.
+[Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-verifying-a-jwt.html)
+user pool tokens as Mayura server identities: verified with the pool's published keys, on any runtime, with no
+dependency (no AWS SDK).
+
+```bash
+npm install mayura @mayurajs/auth-cognito
+```
+
+```ts
+import { mapCapabilities, principalId } from 'mayura/auth';
+import { cognitoAuthenticator } from '@mayurajs/auth-cognito';
+
+const authenticate = cognitoAuthenticator({
+  userPoolId: 'us-east-1_AbCdEf123',
+  clientIds: ['1example23456789abcdefghij'],
+  identity: session => ({
+    principalId: principalId('cognito', session.subject),
+    projectId: 'acme',
+    agentIds: ['support'],
+    capabilities: mapCapabilities(session.groups, { agents: ['runs:submit', 'runs:read'] }),
+  }),
+});
+// createAgentServer({ ..., authenticate })
+```
+
+- **Which tokens.** RS256 tokens issued by the pool (`https://cognito-idp.<region>.amazonaws.com/<userPoolId>`, the
+  region read from the pool id), checked against its `/.well-known/jwks.json`, for one of your app clients. Access
+  tokens by default (`token_use` `access`, the client in `client_id`); with `tokenUse: 'id'`, ID tokens instead (the
+  client in `aud`). One is never accepted for the other.
+- **Refused.** Machine tokens (client credentials: no user name, the client as subject) unless `allowMachines`.
+  Cognito can revoke tokens (sign-out, revoked refresh tokens) that still verify until they expire: keep access tokens
+  short-lived.
+- **What you get.** `identity` receives the session: `tokenUse`, `subject` (`sub`, the stable key), `username`,
+  `clientId`, `machine`, `groups` (`cognito:groups`), `scopes` (access tokens), `email` and `emailVerified` (ID
+  tokens), and the raw `claims`. Nothing is granted unless `identity` grants it.
+- Options: `userPoolId`, `clientIds`, `identity`, `tokenUse` (`access`), `allowMachines`, `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,50 @@
+import { type Authenticator, type IdentityGrant, type JwtClaims } from 'mayura/auth';
+/** A verified Amazon Cognito user pool token: an access token, or with `tokenUse: 'id'` an ID token. */
+export interface CognitoSession {
+    readonly tokenUse: 'access' | 'id';
+    /** The user's id in the pool (`sub`), the stable key; or for a machine its app client id. */
+    readonly subject: string;
+    /** The user name (`username`, or `cognito:username` in ID tokens); null for a machine. */
+    readonly username: string | null;
+    /** The app client the token was issued to (`client_id`, or `aud` in ID tokens). */
+    readonly clientId: string;
+    /** Whether a machine holds it (client credentials: no user, its own client as subject). */
+    readonly machine: boolean;
+    /** The user pool groups the user is in (`cognito:groups`). */
+    readonly groups: readonly string[];
+    /** The scopes granted (`scope`, access tokens only). */
+    readonly scopes: readonly string[];
+    /** The email and whether it is verified (ID tokens only). */
+    readonly email: string | null;
+    readonly emailVerified: boolean;
+    /** The token's claims, as verified. */
+    readonly claims: JwtClaims;
+}
+export interface CognitoAuthenticatorOptions {
+    /** The user pool's id, such as `us-east-1_AbCdEf123`; its region is read from it. */
+    readonly userPoolId: string;
+    /** The app clients whose tokens are accepted. */
+    readonly clientIds: readonly string[];
+    /** What a token's holder may do, or null to refuse; for example from `session.groups` with `mapCapabilities`. */
+    readonly identity: (session: CognitoSession) => IdentityGrant | null | Promise<IdentityGrant | null>;
+    /** Which tokens are accepted: `access` (the default, as APIs should), or `id`; never both. */
+    readonly tokenUse?: 'access' | 'id';
+    /** Accept machine (client credentials) access tokens; refused by default. */
+    readonly allowMachines?: boolean;
+    /** 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;
+}
+/** A Cognito session from verified claims; undefined when they are not a Cognito access or ID token's. */
+export declare function cognitoSession(claims: JwtClaims): CognitoSession | undefined;
+/**
+ * A server `authenticate` for Amazon Cognito user pool tokens: RS256 with the pool's published keys, issued by the pool
+ * (`https://cognito-idp.<region>.amazonaws.com/<pool>`) to one of your app clients. Access tokens by default, ID tokens
+ * only with `tokenUse: 'id'`, never one for the other. Machine tokens only with `allowMachines`. Cognito can revoke
+ * tokens that stay valid until they expire; keep them short-lived. `identity` decides what the holder may do.
+ */
+export declare function cognitoAuthenticator(options: CognitoAuthenticatorOptions): 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,EAA6C,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAEhI,wGAAwG;AACxG,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IACnC,6FAA6F;IAC7F,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0FAA0F;IAC1F,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,8DAA8D;IAC9D,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,wDAAwD;IACxD,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,6DAA6D;IAC7D,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C,qFAAqF;IACrF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,iDAAiD;IACjD,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,iHAAiH;IACjH,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IACrG,8FAA8F;IAC9F,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACpC,6EAA6E;IAC7E,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,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;AAKD,0GAA0G;AAC1G,wBAAgB,cAAc,CAAC,MAAM,EAAE,SAAS,GAAG,cAAc,GAAG,SAAS,CAc5E;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,aAAa,CAuBxF"}

package/dist/index.js

@@ -0,0 +1,59 @@
+import { MayuraError } from 'mayura';
+import { jwtAuthenticator, jwtVerifier, remoteJwks } from 'mayura/auth';
+const text = (value) => typeof value === 'string' && value !== '' ? value : null;
+const strings = (value) => Array.isArray(value) ? value.filter((item) => typeof item === 'string') : [];
+/** A Cognito session from verified claims; undefined when they are not a Cognito access or ID token's. */
+export function cognitoSession(claims) {
+    const tokenUse = claims['token_use'];
+    if (tokenUse !== 'access' && tokenUse !== 'id')
+        return undefined;
+    const clientId = tokenUse === 'access' ? text(claims['client_id']) : text(claims.aud);
+    if (clientId === null || typeof claims.sub !== 'string' || claims.sub === '')
+        return undefined;
+    const username = text(claims[tokenUse === 'access' ? 'username' : 'cognito:username']);
+    return Object.freeze({
+        tokenUse, subject: claims.sub, username, clientId,
+        // A client credentials token names no user, and its subject is its own client.
+        machine: tokenUse === 'access' && username === null && claims.sub === clientId,
+        groups: Object.freeze(strings(claims['cognito:groups'])),
+        scopes: Object.freeze(tokenUse === 'access' && typeof claims['scope'] === 'string' ? claims['scope'].split(' ').filter(Boolean) : []),
+        email: text(claims['email']), emailVerified: claims['email_verified'] === true, claims,
+    });
+}
+/**
+ * A server `authenticate` for Amazon Cognito user pool tokens: RS256 with the pool's published keys, issued by the pool
+ * (`https://cognito-idp.<region>.amazonaws.com/<pool>`) to one of your app clients. Access tokens by default, ID tokens
+ * only with `tokenUse: 'id'`, never one for the other. Machine tokens only with `allowMachines`. Cognito can revoke
+ * tokens that stay valid until they expire; keep them short-lived. `identity` decides what the holder may do.
+ */
+export function cognitoAuthenticator(options) {
+    if (!options || typeof options.identity !== 'function')
+        throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): identity decides what a token\'s holder may do.');
+    const pool = typeof options.userPoolId === 'string' ? /^([a-z]{2}(?:-[a-z]+)+-\d{1,2})_[0-9A-Za-z]{1,64}$/u.exec(options.userPoolId) : null;
+    if (!pool)
+        throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): userPoolId is the user pool\'s id, such as us-east-1_AbCdEf123.');
+    const clientIds = options.clientIds;
+    if (!Array.isArray(clientIds) || clientIds.length === 0 || clientIds.some(id => typeof id !== 'string' || !/^[0-9a-z]{1,128}$/u.test(id)))
+        throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): clientIds are the user pool\'s app client ids.');
+    const tokenUse = options.tokenUse ?? 'access';
+    if (tokenUse !== 'access' && tokenUse !== 'id')
+        throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): tokenUse is access or id.');
+    if (options.allowMachines !== undefined && typeof options.allowMachines !== 'boolean')
+        throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): allowMachines must be a boolean.');
+    const issuer = `https://cognito-idp.${pool[1]}.amazonaws.com/${options.userPoolId}`;
+    const verifier = jwtVerifier({
+        // Access tokens carry no audience: the client (client_id, or an ID token's aud) is checked against clientIds below.
+        issuer, audience: false, algorithms: ['RS256'], clockSkewMs: options.clockSkewMs ?? 5_000,
+        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 = cognitoSession(claims);
+            if (!session || session.tokenUse !== tokenUse || !clientIds.includes(session.clientId) || (session.machine && options.allowMachines !== true))
+                return null;
+            return options.identity(session);
+        },
+    });
+}
+//# 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,gBAAgB,EAAE,WAAW,EAAE,UAAU,EAA0D,MAAM,aAAa,CAAC;AA2ChI,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;AAC1F,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,0GAA0G;AAC1G,MAAM,UAAU,cAAc,CAAC,MAAiB;IAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IACrC,IAAI,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACjE,MAAM,QAAQ,GAAG,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACtF,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IAC/F,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACvF,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ;QACjD,+EAA+E;QAC/E,OAAO,EAAE,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,MAAM,CAAC,GAAG,KAAK,QAAQ;QAC9E,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACxD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,IAAI,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;QACrI,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,gBAAgB,CAAC,KAAK,IAAI,EAAE,MAAM;KACvF,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAoC;IACvE,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,yEAAyE,CAAC,CAAC;IAC3K,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,qDAAqD,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5I,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,yFAAyF,CAAC,CAAC;IAC9I,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACpC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,wEAAwE,CAAC,CAAC;IAC7P,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC;IAC9C,IAAI,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;IAC7I,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,aAAa,KAAK,SAAS;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,CAAC;IAC3L,MAAM,MAAM,GAAG,uBAAuB,IAAI,CAAC,CAAC,CAAC,kBAAkB,OAAO,CAAC,UAAU,EAAE,CAAC;IACpF,MAAM,QAAQ,GAAG,WAAW,CAAC;QAC3B,oHAAoH;QACpH,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,KAAK;QACzF,IAAI,EAAE,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,wBAAwB,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;KACjH,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,cAAc,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,aAAa,KAAK,IAAI,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC3J,OAAO,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { MayuraError } from 'mayura';\nimport { jwtAuthenticator, jwtVerifier, remoteJwks, type Authenticator, type IdentityGrant, type JwtClaims } from 'mayura/auth';\n\n/** A verified Amazon Cognito user pool token: an access token, or with `tokenUse: 'id'` an ID token. */\nexport interface CognitoSession {\n  readonly tokenUse: 'access' | 'id';\n  /** The user's id in the pool (`sub`), the stable key; or for a machine its app client id. */\n  readonly subject: string;\n  /** The user name (`username`, or `cognito:username` in ID tokens); null for a machine. */\n  readonly username: string | null;\n  /** The app client the token was issued to (`client_id`, or `aud` in ID tokens). */\n  readonly clientId: string;\n  /** Whether a machine holds it (client credentials: no user, its own client as subject). */\n  readonly machine: boolean;\n  /** The user pool groups the user is in (`cognito:groups`). */\n  readonly groups: readonly string[];\n  /** The scopes granted (`scope`, access tokens only). */\n  readonly scopes: readonly string[];\n  /** The email and whether it is verified (ID tokens only). */\n  readonly email: string | null;\n  readonly emailVerified: boolean;\n  /** The token's claims, as verified. */\n  readonly claims: JwtClaims;\n}\n\nexport interface CognitoAuthenticatorOptions {\n  /** The user pool's id, such as `us-east-1_AbCdEf123`; its region is read from it. */\n  readonly userPoolId: string;\n  /** The app clients whose tokens are accepted. */\n  readonly clientIds: readonly string[];\n  /** What a token's holder may do, or null to refuse; for example from `session.groups` with `mapCapabilities`. */\n  readonly identity: (session: CognitoSession) => IdentityGrant | null | Promise<IdentityGrant | null>;\n  /** Which tokens are accepted: `access` (the default, as APIs should), or `id`; never both. */\n  readonly tokenUse?: 'access' | 'id';\n  /** Accept machine (client credentials) access tokens; refused by default. */\n  readonly allowMachines?: boolean;\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 text = (value: unknown) => typeof value === 'string' && value !== '' ? value : null;\nconst strings = (value: unknown): string[] => Array.isArray(value) ? value.filter((item): item is string => typeof item === 'string') : [];\n\n/** A Cognito session from verified claims; undefined when they are not a Cognito access or ID token's. */\nexport function cognitoSession(claims: JwtClaims): CognitoSession | undefined {\n  const tokenUse = claims['token_use'];\n  if (tokenUse !== 'access' && tokenUse !== 'id') return undefined;\n  const clientId = tokenUse === 'access' ? text(claims['client_id']) : text(claims.aud);\n  if (clientId === null || typeof claims.sub !== 'string' || claims.sub === '') return undefined;\n  const username = text(claims[tokenUse === 'access' ? 'username' : 'cognito:username']);\n  return Object.freeze({\n    tokenUse, subject: claims.sub, username, clientId,\n    // A client credentials token names no user, and its subject is its own client.\n    machine: tokenUse === 'access' && username === null && claims.sub === clientId,\n    groups: Object.freeze(strings(claims['cognito:groups'])),\n    scopes: Object.freeze(tokenUse === 'access' && typeof claims['scope'] === 'string' ? claims['scope'].split(' ').filter(Boolean) : []),\n    email: text(claims['email']), emailVerified: claims['email_verified'] === true, claims,\n  });\n}\n\n/**\n * A server `authenticate` for Amazon Cognito user pool tokens: RS256 with the pool's published keys, issued by the pool\n * (`https://cognito-idp.<region>.amazonaws.com/<pool>`) to one of your app clients. Access tokens by default, ID tokens\n * only with `tokenUse: 'id'`, never one for the other. Machine tokens only with `allowMachines`. Cognito can revoke\n * tokens that stay valid until they expire; keep them short-lived. `identity` decides what the holder may do.\n */\nexport function cognitoAuthenticator(options: CognitoAuthenticatorOptions): Authenticator {\n  if (!options || typeof options.identity !== 'function') throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): identity decides what a token\\'s holder may do.');\n  const pool = typeof options.userPoolId === 'string' ? /^([a-z]{2}(?:-[a-z]+)+-\\d{1,2})_[0-9A-Za-z]{1,64}$/u.exec(options.userPoolId) : null;\n  if (!pool) throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): userPoolId is the user pool\\'s id, such as us-east-1_AbCdEf123.');\n  const clientIds = options.clientIds;\n  if (!Array.isArray(clientIds) || clientIds.length === 0 || clientIds.some(id => typeof id !== 'string' || !/^[0-9a-z]{1,128}$/u.test(id))) throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): clientIds are the user pool\\'s app client ids.');\n  const tokenUse = options.tokenUse ?? 'access';\n  if (tokenUse !== 'access' && tokenUse !== 'id') throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): tokenUse is access or id.');\n  if (options.allowMachines !== undefined && typeof options.allowMachines !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): allowMachines must be a boolean.');\n  const issuer = `https://cognito-idp.${pool[1]}.amazonaws.com/${options.userPoolId}`;\n  const verifier = jwtVerifier({\n    // Access tokens carry no audience: the client (client_id, or an ID token's aud) is checked against clientIds below.\n    issuer, audience: false, algorithms: ['RS256'], clockSkewMs: options.clockSkewMs ?? 5_000,\n    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 = cognitoSession(claims);\n      if (!session || session.tokenUse !== tokenUse || !clientIds.includes(session.clientId) || (session.machine && options.allowMachines !== true)) return null;\n      return options.identity(session);\n    },\n  });\n}\n"]}

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@mayurajs/auth-cognito",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.0",
+  "description": "Amazon Cognito user pool tokens as Mayura server identities, verified with the pool'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-cognito"
+  },
+  "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.1.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/src/index.ts

@@ -0,0 +1,94 @@
+import { MayuraError } from 'mayura';
+import { jwtAuthenticator, jwtVerifier, remoteJwks, type Authenticator, type IdentityGrant, type JwtClaims } from 'mayura/auth';
+
+/** A verified Amazon Cognito user pool token: an access token, or with `tokenUse: 'id'` an ID token. */
+export interface CognitoSession {
+  readonly tokenUse: 'access' | 'id';
+  /** The user's id in the pool (`sub`), the stable key; or for a machine its app client id. */
+  readonly subject: string;
+  /** The user name (`username`, or `cognito:username` in ID tokens); null for a machine. */
+  readonly username: string | null;
+  /** The app client the token was issued to (`client_id`, or `aud` in ID tokens). */
+  readonly clientId: string;
+  /** Whether a machine holds it (client credentials: no user, its own client as subject). */
+  readonly machine: boolean;
+  /** The user pool groups the user is in (`cognito:groups`). */
+  readonly groups: readonly string[];
+  /** The scopes granted (`scope`, access tokens only). */
+  readonly scopes: readonly string[];
+  /** The email and whether it is verified (ID tokens only). */
+  readonly email: string | null;
+  readonly emailVerified: boolean;
+  /** The token's claims, as verified. */
+  readonly claims: JwtClaims;
+}
+
+export interface CognitoAuthenticatorOptions {
+  /** The user pool's id, such as `us-east-1_AbCdEf123`; its region is read from it. */
+  readonly userPoolId: string;
+  /** The app clients whose tokens are accepted. */
+  readonly clientIds: readonly string[];
+  /** What a token's holder may do, or null to refuse; for example from `session.groups` with `mapCapabilities`. */
+  readonly identity: (session: CognitoSession) => IdentityGrant | null | Promise<IdentityGrant | null>;
+  /** Which tokens are accepted: `access` (the default, as APIs should), or `id`; never both. */
+  readonly tokenUse?: 'access' | 'id';
+  /** Accept machine (client credentials) access tokens; refused by default. */
+  readonly allowMachines?: boolean;
+  /** 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 text = (value: unknown) => typeof value === 'string' && value !== '' ? value : null;
+const strings = (value: unknown): string[] => Array.isArray(value) ? value.filter((item): item is string => typeof item === 'string') : [];
+
+/** A Cognito session from verified claims; undefined when they are not a Cognito access or ID token's. */
+export function cognitoSession(claims: JwtClaims): CognitoSession | undefined {
+  const tokenUse = claims['token_use'];
+  if (tokenUse !== 'access' && tokenUse !== 'id') return undefined;
+  const clientId = tokenUse === 'access' ? text(claims['client_id']) : text(claims.aud);
+  if (clientId === null || typeof claims.sub !== 'string' || claims.sub === '') return undefined;
+  const username = text(claims[tokenUse === 'access' ? 'username' : 'cognito:username']);
+  return Object.freeze({
+    tokenUse, subject: claims.sub, username, clientId,
+    // A client credentials token names no user, and its subject is its own client.
+    machine: tokenUse === 'access' && username === null && claims.sub === clientId,
+    groups: Object.freeze(strings(claims['cognito:groups'])),
+    scopes: Object.freeze(tokenUse === 'access' && typeof claims['scope'] === 'string' ? claims['scope'].split(' ').filter(Boolean) : []),
+    email: text(claims['email']), emailVerified: claims['email_verified'] === true, claims,
+  });
+}
+
+/**
+ * A server `authenticate` for Amazon Cognito user pool tokens: RS256 with the pool's published keys, issued by the pool
+ * (`https://cognito-idp.<region>.amazonaws.com/<pool>`) to one of your app clients. Access tokens by default, ID tokens
+ * only with `tokenUse: 'id'`, never one for the other. Machine tokens only with `allowMachines`. Cognito can revoke
+ * tokens that stay valid until they expire; keep them short-lived. `identity` decides what the holder may do.
+ */
+export function cognitoAuthenticator(options: CognitoAuthenticatorOptions): Authenticator {
+  if (!options || typeof options.identity !== 'function') throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): identity decides what a token\'s holder may do.');
+  const pool = typeof options.userPoolId === 'string' ? /^([a-z]{2}(?:-[a-z]+)+-\d{1,2})_[0-9A-Za-z]{1,64}$/u.exec(options.userPoolId) : null;
+  if (!pool) throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): userPoolId is the user pool\'s id, such as us-east-1_AbCdEf123.');
+  const clientIds = options.clientIds;
+  if (!Array.isArray(clientIds) || clientIds.length === 0 || clientIds.some(id => typeof id !== 'string' || !/^[0-9a-z]{1,128}$/u.test(id))) throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): clientIds are the user pool\'s app client ids.');
+  const tokenUse = options.tokenUse ?? 'access';
+  if (tokenUse !== 'access' && tokenUse !== 'id') throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): tokenUse is access or id.');
+  if (options.allowMachines !== undefined && typeof options.allowMachines !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'cognitoAuthenticator(): allowMachines must be a boolean.');
+  const issuer = `https://cognito-idp.${pool[1]}.amazonaws.com/${options.userPoolId}`;
+  const verifier = jwtVerifier({
+    // Access tokens carry no audience: the client (client_id, or an ID token's aud) is checked against clientIds below.
+    issuer, audience: false, algorithms: ['RS256'], clockSkewMs: options.clockSkewMs ?? 5_000,
+    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 = cognitoSession(claims);
+      if (!session || session.tokenUse !== tokenUse || !clientIds.includes(session.clientId) || (session.machine && options.allowMachines !== true)) return null;
+      return options.identity(session);
+    },
+  });
+}