@guardian/pan-domain-node 0.5.0 → 1.0.0

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+
+@guardian/digital-cms
+<!-- Please include the Editorial Tools Team in PRs especially if it is a major change. We rely on this library for log in across all our tools. Thank you. -->

package/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+on:
+  workflow_dispatch:
+  pull_request:
+
+  # triggering CI default branch improves caching
+  # see https://docs.github.com/en/free-pro-team@latest/actions/guides/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache
+  push:
+    branches:
+      - main
+
+jobs:
+  CI:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+          cache-dependency-path: 'package-lock.json'
+
+      - name: JS Build
+        run: |
+          npm ci
+          npm run build
+          npm test

package/.github/workflows/node-release.yml

@@ -0,0 +1,57 @@
+name: CD
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  CD:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+          cache-dependency-path: "package-lock.json"
+
+      - name: Install
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm run test
+
+      - name: Use GitHub App Token
+        uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ secrets.GU_CHANGESETS_APP_ID }}
+          private-key: ${{ secrets.GU_CHANGESETS_PRIVATE_KEY }}
+
+      - name: Set git user to Gu Changesets app
+        run: |
+          git config user.name "gu-changesets-release-pr[bot]"
+          git config user.email "gu-changesets-release-pr[bot]@users.noreply.github.com"
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: npx changeset publish
+          title: "🦋 Release package updates"
+          commit: "Bump package version"
+          setupGitUser: false
+
+        env:
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,123 @@
 # @guardian/pan-domain-node
 
+## 1.0.0
+
+### Major Changes
+
+- f91598a: # Changes
+  Adds a 24-hour grace period after cookie expiry, during which requests will still be considered authenticated.
+
+  This is modelled by changing `AuthenticatedStatus` into a discriminated union with the following properties (among others):
+
+  ### `success`
+
+  Whether to treat request as authenticated or not. **This will remain true after cookie expiry for the length of the grace period.**
+
+  [Almost all consumers](https://docs.google.com/spreadsheets/d/19XABaP9ua935TYJARkL8tstnizL69gIJ9av8C3UQBYw/edit?gid=0#gid=0) of this library check **only** the `AUTHORISED` status right now. These should all be able to switch to checking just this single boolean, implicitly getting grace period functionality in the process.
+
+  ### `shouldRefreshCredentials`
+
+  Whether to try and get fresh credentials.
+
+  This allows page endpoints to redirect to auth, and API endpoints to tell the frontend to show a warning message to the user.
+
+  ### `mustRefreshByEpochTimeMillis`
+
+  The time at which the grace period ends and the request will be treated as unauthenticated. This allows library consumers to warn the user in the app UI when they are near the end of the grace period, as Composer does: https://github.com/guardian/flexible-content/pull/5210
+
+  ```
+  Panda cookie:               issued     expires                       `mustRefreshByEpochTimeMillis`
+                              |          |                             |
+                              |--1 hour--|                             |
+  Grace period:                          [------------- 24 hours ------]
+
+  `success`:         --false-][-true-----------------------------------][-false-------->
+  `shouldRefreshCredentials`  [-false---][-true------------------------]
+  ```
+
+  # Why have we made this change?
+
+  The Panda authentication cookie expires after 1 hour, and top-level navigation requests (page loads) trigger automatic re-authentication after this point.
+
+  Unfortunately API requests cannot trigger re-authentication on their own, and background refresh mechanisms (e.g. iframe-based method used by [Pandular](https://github.com/guardian/pandular)) are increasingly blocked by browsers due to third-party cookie restrictions.
+
+  We would like to enforce a 24-hour grace period
+
+  # How to update consuming code
+
+  At a minimum, switch from
+
+  ```typescript
+  const authResult = await panda.verify(cookieHeader);
+  if (
+    authResult.status === AuthenticationStatus.AUTHORISED &&
+    authResult.user
+  ) {
+    return authResult.user.email;
+  }
+  ```
+
+  to
+
+  ```typescript
+  const authResult = await panda.verify(cookieHeader);
+  if (authResult.success) {
+    return authResult.user.email;
+  }
+  ```
+
+  This will implicitly give you grace period functionality, because `success` will remain true during the grace period.
+
+  However, we **strongly** recommend all consumers to take account of `shouldRefreshCredentials`. What you do with the result should depend on whether your endpoint can trigger re-auth.
+
+  ## Endpoints that can refresh credentials
+
+  Endpoints that **can** refresh credentials, e.g. page endpoints that can redirect to an auth flow, should send the user to re-auth if `shouldRefreshCredentials` is `true`:
+
+  ```typescript
+  const authResult = await panda.verify(headers.cookie);
+  if (authResult.success) {
+    if (authResult.shouldRefreshCredentials) {
+      // Send for auth
+    } else {
+      // Can perform action with user
+      return authResult.user;
+    }
+  }
+  ```
+
+  ## Endpoints that cannot refresh credentials
+
+  Endpoints that **cannot** refresh credentials, e.g. API endpoints, should log appropriately and return something to the client that can be used to warn the user that they need to refresh their session.
+
+  ```typescript
+  const authResult = await panda.verify(headers.cookie);
+  if (authResult.success) {
+    const user = authResult.user;
+    // Handle request
+    // When returning response:
+    if (authResult.shouldRefreshCredentials) {
+      const mustRefreshByEpochTimeMillis =
+        authResult.mustRefreshByEpochTimeMillis;
+      const remainingTime = mustRefreshByEpochTimeMillis - Date.now();
+      console.warn(
+        `Stale Panda auth, will expire in ${remainingTime} milliseconds`
+      );
+      // Can still return 200, but depending on the type of API,
+      // we may want to return some extra information so the client
+      // can warn the user they need to refresh their session.
+    } else {
+      // It's a fresh session. Nothing to worry about!
+    }
+  }
+  ```
+
+## 0.5.1
+
+### Patch Changes
+
+- bdd4adb: Testing changeset release and capitalising some text
+
 ## 0.5.0
 
 ### Minor Changes

package/CODEOWNERS

@@ -0,0 +1 @@
+* @guardian/workflow-and-collaboration

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/README.md

@@ -0,0 +1,95 @@
+# Pan Domain Node 
+
+Pan domain authentication provides distributed authentication for multiple webapps running in the same domain. Each
+application can authenticate users against an OAuth provider and store the authentication information in a common cookie.
+Each application can read this cookie and check if the user is allowed in the specific application and allow access accordingly.
+
+This means that users are only prompted to provide authentication credentials once across the domain and any inter-app
+interactions (e.g javascript Cross-Origin requests) can be easily secured.
+
+## What's provided
+
+The main [pan-domain-authentication](https://github.com/guardian/pan-domain-authentication) repository provides the
+functionality for signing and verifying login cookies in Scala.
+
+The `pan-domain-node` library provides an implementation of *verification only* for node apps.
+
+## Grace period
+We continue to consider the request authenticated for a period of time after the cookie expiry.
+
+This is to allow API requests which cannot directly send the user for re-auth to indicate to the user that they must take some action to refresh their credentials (usually, refreshing the page).
+
+When the cookie is expired but we're still within this grace period, `shouldRefreshCredentials` will be `true`, which means:
+- Endpoints that can refresh credentials (e.g. page endpoints that can redirect) should do so
+- Endpoints that cannot refresh credentials (e.g. API endpoints) should tell the user to take some action to refresh credentials
+
+```
+Panda cookie:               issued     expires                       `mustRefreshByEpochTimeMillis`
+                            |          |                             |
+                            |--1 hour--|                             |
+Grace period:                          [------------- 24 hours ------]
+
+`success`:         --false-][-true-----------------------------------][-false-------->
+`shouldRefreshCredentials`  [-false---][-true------------------------]
+```
+
+## Example usage
+### Installation
+[![npm version](https://badge.fury.io/js/%40guardian%2Fpan-domain-node.svg)](https://badge.fury.io/js/%40guardian%2Fpan-domain-node)
+```
+npm install --save-dev @guardian/pan-domain-node
+```
+
+### Initialisation
+```typescript
+import { PanDomainAuthentication, AuthenticationStatus, User, guardianValidation } from '@guardian/pan-domain-node';
+
+const panda = new PanDomainAuthentication(
+  "gutoolsAuth-assym", // cookie name
+  "eu-west-1", // AWS region
+  "pan-domain-auth-settings", // Settings bucket
+  "local.dev-gutools.co.uk.settings.public", // Settings file
+  guardianValidation
+);
+
+// alternatively customise the validation function and pass at construction
+function customValidation(user: User): boolean {
+  const isInCorrectDomain = user.email.indexOf('test.com') !== -1;
+  return isInCorrectDomain && user.multifactor;
+}
+```
+
+### Verification: page endpoints
+This is for endpoints that **can** refresh credentials, e.g. a page endpoint that can redirect to an auth flow:
+```typescript
+const authenticationResult = await panda.verify(headers.cookie);
+if (authenticationResult.success) {
+    if (authenticationResult.shouldRefreshCredentials) {
+        // Send for auth
+    } else {
+        // Can perform action with user
+        return authenticationResult.user;
+    }
+}
+```
+
+### Verification: API endpoints
+This is for endpoints that **cannot** refresh credentials, e.g. API endpoints:
+```typescript
+const authenticationResult = await panda.verify(headers.cookie);
+if (authenticationResult.success) {
+  const user = authenticationResult.user;
+  // Handle request
+  // When returning response:
+  if (authenticationResult.shouldRefreshCredentials) {
+    const mustRefreshByEpochTimeMillis = authenticationResult.mustRefreshByEpochTimeMillis;
+    const remainingTime = mustRefreshByEpochTimeMillis - Date.now();
+    console.warn(`Stale Panda auth, will expire in ${remainingTime} milliseconds`);
+    // Can still return 200, but depending on the type of API,
+    // we may want to return some extra information so the client
+    // can warn the user they need to refresh their session.
+   } else {
+    // It's a fresh session. Nothing to worry about!
+  }
+}
+```

package/dist/src/api.d.ts

@@ -1,10 +1,35 @@
 export { PanDomainAuthentication } from './panda';
-export declare enum AuthenticationStatus {
-    INVALID_COOKIE = "Invalid Cookie",
-    EXPIRED = "Expired",
-    NOT_AUTHORISED = "Not Authorised",
-    AUTHORISED = "Authorised"
+export declare const gracePeriodInMillis: number;
+interface Result {
+    success: boolean;
 }
+interface Success extends Result {
+    success: true;
+    shouldRefreshCredentials: boolean;
+    user: User;
+}
+interface Failure extends Result {
+    success: false;
+    reason: string;
+}
+export interface FreshSuccess extends Success {
+    shouldRefreshCredentials: false;
+}
+export interface StaleSuccess extends Success {
+    shouldRefreshCredentials: true;
+    mustRefreshByEpochTimeMillis: number;
+}
+export interface UserValidationFailure extends Failure {
+    reason: 'invalid-user';
+    user: User;
+}
+export interface CookieFailure extends Failure {
+    reason: 'no-cookie' | 'invalid-cookie' | 'expired-cookie';
+}
+export interface UnknownFailure extends Failure {
+    reason: 'unknown';
+}
+export declare type AuthenticationResult = FreshSuccess | StaleSuccess | CookieFailure | UserValidationFailure | UnknownFailure;
 export interface User {
     firstName: string;
     lastName: string;
@@ -15,9 +40,5 @@ export interface User {
     expires: number;
     multifactor: boolean;
 }
-export interface AuthenticationResult {
-    status: AuthenticationStatus;
-    user?: User;
-}
 export declare type ValidateUserFn = (user: User) => boolean;
 export declare function guardianValidation(user: User): boolean;

package/dist/src/api.js

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.guardianValidation = exports.AuthenticationStatus = void 0;
+exports.guardianValidation = exports.gracePeriodInMillis = void 0;
 var panda_1 = require("./panda");
 Object.defineProperty(exports, "PanDomainAuthentication", { enumerable: true, get: function () { return panda_1.PanDomainAuthentication; } });
-var AuthenticationStatus;
-(function (AuthenticationStatus) {
-    AuthenticationStatus["INVALID_COOKIE"] = "Invalid Cookie";
-    AuthenticationStatus["EXPIRED"] = "Expired";
-    AuthenticationStatus["NOT_AUTHORISED"] = "Not Authorised";
-    AuthenticationStatus["AUTHORISED"] = "Authorised";
-})(AuthenticationStatus = exports.AuthenticationStatus || (exports.AuthenticationStatus = {}));
+// We continue to consider the request authenticated for
+// a period of time after the cookie expiry. This is to allow
+// API requests which cannot directly send the user for re-auth to
+// indicate to the user that they must take some action to refresh their
+// credentials (usually, refreshing the page).
+// Panda cookie:               issued     expires
+//                             |          |
+//                             |--1 hour--|
+// Grace period:                          [------------- 24 hours ------]
+// `success`:         --false-][-true-----------------------------------][-false-------->
+// `shouldRefreshCredentials`  [-false---][-true------------------------]
+exports.gracePeriodInMillis = 24 * 60 * 60 * 1000;
 function guardianValidation(user) {
     const isGuardianUser = user.email.indexOf('guardian.co.uk') !== -1;
     return isGuardianUser && user.multifactor;

package/dist/src/panda.d.ts

@@ -10,7 +10,7 @@ export declare class PanDomainAuthentication {
     keyFile: string;
     validateUser: ValidateUserFn;
     publicKey: Promise<PublicKeyHolder>;
-    keyCacheTime: number;
+    keyCacheTimeInMillis: number;
     keyUpdateTimer?: NodeJS.Timeout;
     constructor(cookieName: string, region: string, bucket: string, keyFile: string, validateUser: ValidateUserFn);
     stop(): void;