PR chores: changeset, api-report, cleaning, add catalog-info entry

Signed-off-by: Ruben Vallejo <rvallejo@vmware.com>
2023-09-07 15:15:34 -04:00
parent 362a5e293f
commit ae34255836
14 changed files with 112 additions and 208 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-auth-backend-module-pinniped-provider': minor
+---
+
+Add new Pinniped auth module and authenticator to be used alongside the new Pinniped auth provider.
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-auth-backend': patch
+---
+
+Add Pinniped Auth Provider to list of default auth providers
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-auth-node': patch
+---
+
+Adding optional audience parameter to OAuthState type declaration
@@ -0,0 +1,28 @@
+## API Report File for "@backstage/plugin-auth-backend-module-pinniped-provider"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { BaseClient } from 'openid-client';
+import { OAuthAuthenticator } from '@backstage/plugin-auth-node';
+import { Strategy } from 'openid-client';
+import { TokenSet } from 'openid-client';
+
+// @public (undocumented)
+export const authModulePinnipedProvider: () => BackendFeature;
+
+// @public (undocumented)
+export const pinnipedAuthenticator: OAuthAuthenticator<
+  Promise<{
+    providerStrategy: Strategy<
+      {
+        tokenset: TokenSet;
+      },
+      BaseClient
+    >;
+    client: BaseClient;
+  }>,
+  unknown
+>;
+```
@@ -0,0 +1,10 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: backstage-plugin-auth-backend-module-pinniped-provider
+  title: '@backstage/plugin-auth-backend-module-pinniped-provider'
+  description: The pinniped-provider backend module for the auth plugin.
+spec:
+  lifecycle: experimental
+  type: backstage-backend-plugin-module
+  owner: maintainers
@@ -23,4 +23,4 @@ const backend = createBackend();
 backend.add(authPlugin);
 backend.add(authModulePinnipedProvider);

-backend.start();
+backend.start();
@@ -353,7 +353,7 @@ describe('pinnipedAuthenticator', () => {
      );

      expect(handlerResponse.session.idToken).toEqual(clusterScopedIdToken);
-    }, 70000);
+    });

    it('fails on network error during token exchange', async () => {
      mswServer.use(
@@ -21,6 +21,7 @@ import {
 } from '@backstage/plugin-auth-node';
 import { Issuer, TokenSet, Strategy as OidcStrategy } from 'openid-client';

+/** @public */
 export const pinnipedAuthenticator = createOAuthAuthenticator({
  defaultProfileTransform: async (_r, _c) => ({ profile: {} }),
  async initialize({ callbackUrl, config }) {
@@ -114,7 +115,7 @@ export const pinnipedAuthenticator = createOAuthAuthenticator({
          : Promise.resolve(user.tokenset.id_token)
        ).then(idToken => {
          resolve({
-            fullProfile: { provider: ' ', id: ' ', displayName: ' ' },
+            fullProfile: { provider: '', id: '', displayName: '' },
            session: {
              accessToken: user.tokenset.access_token!,
              tokenType: user.tokenset.token_type ?? 'bearer',
@@ -152,7 +153,7 @@ export const pinnipedAuthenticator = createOAuthAuthenticator({
      }

      resolve({
-        fullProfile: { provider: ' ', id: ' ', displayName: ' ' },
+        fullProfile: { provider: '', id: '', displayName: '' },
        session: {
          accessToken: tokenset.access_token!,
          tokenType: tokenset.token_type ?? 'bearer',
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * 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.
+ */
+
+export interface Config {
+  /** Configuration options for the auth plugin */
+  auth?: {
+    providers?: {
+      pinniped?: {
+        [authEnv: string]: {
+          clientId: string;
+          federationDomain: string;
+          /**
+           * @visibility secret
+           */
+          clientSecret: string;
+          scope?: string;
+        };
+      };
+    };
+  };
+}
@@ -14,9 +14,14 @@
 * limitations under the License.
 */
 import { createBackendModule } from '@backstage/backend-plugin-api';
-import { authProvidersExtensionPoint, commonSignInResolvers, createOAuthProviderFactory } from '@backstage/plugin-auth-node';
+import {
+  authProvidersExtensionPoint,
+  commonSignInResolvers,
+  createOAuthProviderFactory,
+} from '@backstage/plugin-auth-node';
 import { pinnipedAuthenticator } from './authenticator';

+/** @public */
 export const authModulePinnipedProvider = createBackendModule({
  pluginId: 'auth',
  moduleId: 'pinniped-provider',
@@ -31,10 +36,10 @@ export const authModulePinnipedProvider = createBackendModule({
          factory: createOAuthProviderFactory({
            authenticator: pinnipedAuthenticator,
            signInResolverFactories: {
-              ...commonSignInResolvers
-            }
-          })
-        })
+              ...commonSignInResolvers,
+            },
+          }),
+        });
      },
    });
  },
@@ -620,18 +620,7 @@ export const providers: Readonly<{
    resolvers: never;
  }>;
  pinniped: Readonly<{
-    create: (
-      options?:
-        | {
-            authHandler?: AuthHandler<OidcAuthResult> | undefined;
-            signIn?:
-              | {
-                  resolver: SignInResolver<OidcAuthResult>;
-                }
-              | undefined;
-          }
-        | undefined,
-    ) => AuthProviderFactory;
+    create: () => AuthProviderFactory_2;
    resolvers: never;
  }>;
  saml: Readonly<{
@@ -32,7 +32,6 @@
    "clean": "backstage-cli package clean"
  },
  "dependencies": {
-    "-": "^0.0.1",
    "@backstage/backend-common": "workspace:^",
    "@backstage/backend-plugin-api": "workspace:^",
    "@backstage/catalog-client": "workspace:^",
@@ -59,21 +58,18 @@
    "cookie-parser": "^1.4.5",
    "cookie-signature": "^1.2.1",
    "cors": "^2.8.5",
-    "d": "^1.0.1",
-    "e": "^0.2.32",
    "express": "^4.17.1",
    "express-promise-router": "^4.1.0",
    "express-session": "^1.17.1",
    "fs-extra": "10.1.0",
    "google-auth-library": "^8.0.0",
    "jose": "^4.6.0",
-    "jwt-decode": "^3.1.2",
+    "jwt-decode": "^3.1.0",
    "knex": "^2.0.0",
    "lodash": "^4.17.21",
    "luxon": "^3.0.0",
    "minimatch": "^5.0.0",
    "morgan": "^1.10.0",
-    "njwt": "^2.0.0",
    "node-cache": "^5.1.2",
    "node-fetch": "^2.6.7",
    "openid-client": "^5.2.1",
@@ -88,7 +84,6 @@
    "passport-onelogin-oauth": "^0.0.1",
    "passport-saml": "^3.1.2",
    "uuid": "^8.0.0",
-    "v": "^0.3.0",
    "winston": "^3.2.1",
    "yn": "^4.0.0"
  },
@@ -399,6 +399,7 @@ export type OAuthState = {
  scope?: string;
  redirectUrl?: string;
  flow?: string;
+  audience?: string;
 };

 // @public (undocumented)
@@ -5,13 +5,6 @@ __metadata:
  version: 6
  cacheKey: 8

-"-@npm:^0.0.1":
-  version: 0.0.1
-  resolution: "-@npm:0.0.1"
-  checksum: 33786d96a8c404f3ce4db242b50d9a8f6013b3a0673bba52186b92f016429135ec2d9b9f77abf85c2a2b757c85e9b33a1f44d5dbf9740fd6294de87198681fd6
-  languageName: node
-  linkType: hard
-
 "@aashutoshrathi/word-wrap@npm:^1.2.3":
  version: 1.2.6
  resolution: "@aashutoshrathi/word-wrap@npm:1.2.6"
@@ -5007,7 +5000,6 @@ __metadata:
  version: 0.0.0-use.local
  resolution: "@backstage/plugin-auth-backend@workspace:plugins/auth-backend"
  dependencies:
-    "-": ^0.0.1
    "@backstage/backend-common": "workspace:^"
    "@backstage/backend-defaults": "workspace:^"
    "@backstage/backend-plugin-api": "workspace:^"
@@ -5048,22 +5040,19 @@ __metadata:
    cookie-parser: ^1.4.5
    cookie-signature: ^1.2.1
    cors: ^2.8.5
-    d: ^1.0.1
-    e: ^0.2.32
    express: ^4.17.1
    express-promise-router: ^4.1.0
    express-session: ^1.17.1
    fs-extra: 10.1.0
    google-auth-library: ^8.0.0
    jose: ^4.6.0
-    jwt-decode: ^3.1.2
+    jwt-decode: ^3.1.0
    knex: ^2.0.0
    lodash: ^4.17.21
    luxon: ^3.0.0
    minimatch: ^5.0.0
    morgan: ^1.10.0
    msw: ^1.0.0
-    njwt: ^2.0.0
    node-cache: ^5.1.2
    node-fetch: ^2.6.7
    openid-client: ^5.2.1
@@ -5079,7 +5068,6 @@ __metadata:
    passport-saml: ^3.1.2
    supertest: ^6.1.3
    uuid: ^8.0.0
-    v: ^0.3.0
    winston: ^3.2.1
    yn: ^4.0.0
  languageName: unknown
@@ -18310,7 +18298,7 @@ __metadata:
  languageName: node
  linkType: hard

-"@types/node@npm:^15.0.1, @types/node@npm:^15.6.1":
+"@types/node@npm:^15.6.1":
  version: 15.14.9
  resolution: "@types/node@npm:15.14.9"
  checksum: 49f7f0522a3af4b8389aee660e88426490cd54b86356672a1fedb49919a8797c00d090ec2dcc4a5df34edc2099d57fc2203d796c4e7fbd382f2022ccd789eee7
@@ -20431,13 +20419,6 @@ __metadata:
  languageName: node
  linkType: hard

-"async-limiter@npm:~1.0.0":
-  version: 1.0.1
-  resolution: "async-limiter@npm:1.0.1"
-  checksum: 2b849695b465d93ad44c116220dee29a5aeb63adac16c1088983c339b0de57d76e82533e8e364a93a9f997f28bbfc6a92948cefc120652bd07f3b59f8d75cf2b
-  languageName: node
-  linkType: hard
-
 "async-lock@npm:^1.1.0":
  version: 1.2.4
  resolution: "async-lock@npm:1.2.4"
@@ -23581,16 +23562,6 @@ __metadata:
  languageName: node
  linkType: hard

-"d@npm:1, d@npm:^1.0.1":
-  version: 1.0.1
-  resolution: "d@npm:1.0.1"
-  dependencies:
-    es5-ext: ^0.10.50
-    type: ^1.0.1
-  checksum: 49ca0639c7b822db670de93d4fbce44b4aa072cd848c76292c9978a8cd0fff1028763020ff4b0f147bd77bfe29b4c7f82e0f71ade76b2a06100543cdfd948d19
-  languageName: node
-  linkType: hard
-
 "dagre@npm:^0.8.5":
  version: 0.8.5
  resolution: "dagre@npm:0.8.5"
@@ -23676,16 +23647,6 @@ __metadata:
  languageName: node
  linkType: hard

-"deasync@npm:^0.1.9":
-  version: 0.1.28
-  resolution: "deasync@npm:0.1.28"
-  dependencies:
-    bindings: ^1.5.0
-    node-addon-api: ^1.7.1
-  checksum: e0c1ef427875c897e0d903a08410df1d0a3dfd0d2a0a1e43fb6c2824dfbc504b810bd08a0d30653117259316e1aa65409c96dbed40101c934f75bac7499e1265
-  languageName: node
-  linkType: hard
-
 "debounce@npm:^1.1.0, debounce@npm:^1.2.0":
  version: 1.2.1
  resolution: "debounce@npm:1.2.1"
@@ -23693,7 +23654,7 @@ __metadata:
  languageName: node
  linkType: hard

-"debug@npm:2.6.9, debug@npm:^2.6.0, debug@npm:^2.6.1":
+"debug@npm:2.6.9, debug@npm:^2.6.0":
  version: 2.6.9
  resolution: "debug@npm:2.6.9"
  dependencies:
@@ -23714,7 +23675,7 @@ __metadata:
  languageName: node
  linkType: hard

-"debug@npm:^3.1.0, debug@npm:^3.2.7":
+"debug@npm:^3.2.7":
  version: 3.2.7
  resolution: "debug@npm:3.2.7"
  dependencies:
@@ -24407,13 +24368,6 @@ __metadata:
  languageName: unknown
  linkType: soft

-"e@npm:^0.2.32":
-  version: 0.2.32
-  resolution: "e@npm:0.2.32"
-  checksum: 6fcebe65c37d44e69b03d1db3ea1a949855aaae227a3a7f80e807983d6f31f9dc4c9420c02ec6d37046ca0c5523fb836215c10e1cd9d8f438e6df701dc24de35
-  languageName: node
-  linkType: hard
-
 "eastasianwidth@npm:^0.2.0":
  version: 0.2.0
  resolution: "eastasianwidth@npm:0.2.0"
@@ -24452,7 +24406,7 @@ __metadata:
  languageName: node
  linkType: hard

-"ecdsa-sig-formatter@npm:1.0.11, ecdsa-sig-formatter@npm:^1.0.11, ecdsa-sig-formatter@npm:^1.0.5":
+"ecdsa-sig-formatter@npm:1.0.11, ecdsa-sig-formatter@npm:^1.0.11":
  version: 1.0.11
  resolution: "ecdsa-sig-formatter@npm:1.0.11"
  dependencies:
@@ -24818,17 +24772,6 @@ __metadata:
  languageName: node
  linkType: hard

-"es5-ext@npm:^0.10.35, es5-ext@npm:^0.10.50":
-  version: 0.10.62
-  resolution: "es5-ext@npm:0.10.62"
-  dependencies:
-    es6-iterator: ^2.0.3
-    es6-symbol: ^3.1.3
-    next-tick: ^1.1.0
-  checksum: 25f42f6068cfc6e393cf670bc5bba249132c5f5ec2dd0ed6e200e6274aca2fed8e9aec8a31c76031744c78ca283c57f0b41c7e737804c6328c7b8d3fbcba7983
-  languageName: node
-  linkType: hard
-
 "es6-error@npm:^4.1.1":
  version: 4.1.1
  resolution: "es6-error@npm:4.1.1"
@@ -24836,17 +24779,6 @@ __metadata:
  languageName: node
  linkType: hard

-"es6-iterator@npm:^2.0.3":
-  version: 2.0.3
-  resolution: "es6-iterator@npm:2.0.3"
-  dependencies:
-    d: 1
-    es5-ext: ^0.10.35
-    es6-symbol: ^3.1.1
-  checksum: 6e48b1c2d962c21dee604b3d9f0bc3889f11ed5a8b33689155a2065d20e3107e2a69cc63a71bd125aeee3a589182f8bbcb5c8a05b6a8f38fa4205671b6d09697
-  languageName: node
-  linkType: hard
-
 "es6-object-assign@npm:^1.1.0":
  version: 1.1.0
  resolution: "es6-object-assign@npm:1.1.0"
@@ -24854,16 +24786,6 @@ __metadata:
  languageName: node
  linkType: hard

-"es6-symbol@npm:^3.1.1, es6-symbol@npm:^3.1.3":
-  version: 3.1.3
-  resolution: "es6-symbol@npm:3.1.3"
-  dependencies:
-    d: ^1.0.1
-    ext: ^1.1.2
-  checksum: cd49722c2a70f011eb02143ef1c8c70658d2660dead6641e160b94619f408b9cf66425515787ffe338affdf0285ad54f4eae30ea5bd510e33f8659ec53bcaa70
-  languageName: node
-  linkType: hard
-
 "esbuild-loader@npm:^2.18.0":
  version: 2.21.0
  resolution: "esbuild-loader@npm:2.21.0"
@@ -26185,15 +26107,6 @@ __metadata:
  languageName: node
  linkType: hard

-"ext@npm:^1.1.2":
-  version: 1.7.0
-  resolution: "ext@npm:1.7.0"
-  dependencies:
-    type: ^2.7.2
-  checksum: ef481f9ef45434d8c867cfd09d0393b60945b7c8a1798bedc4514cb35aac342ccb8d8ecb66a513e6a2b4ec1e294a338e3124c49b29736f8e7c735721af352c31
-  languageName: node
-  linkType: hard
-
 "extend@npm:3.0.2, extend@npm:^3.0.0, extend@npm:^3.0.2, extend@npm:~3.0.2":
  version: 3.0.2
  resolution: "extend@npm:3.0.2"
@@ -31210,7 +31123,7 @@ __metadata:
  languageName: node
  linkType: hard

-"jwt-decode@npm:*, jwt-decode@npm:^3.1.0, jwt-decode@npm:^3.1.2":
+"jwt-decode@npm:*, jwt-decode@npm:^3.1.0":
  version: 3.1.2
  resolution: "jwt-decode@npm:3.1.2"
  checksum: 20a4b072d44ce3479f42d0d2c8d3dabeb353081ba4982e40b83a779f2459a70be26441be6c160bfc8c3c6eadf9f6380a036fbb06ac5406b5674e35d8c4205eeb
@@ -33698,13 +33611,6 @@ __metadata:
  languageName: node
  linkType: hard

-"next-tick@npm:^1.1.0":
-  version: 1.1.0
-  resolution: "next-tick@npm:1.1.0"
-  checksum: 83b5cf36027a53ee6d8b7f9c0782f2ba87f4858d977342bfc3c20c21629290a2111f8374d13a81221179603ffc4364f38374b5655d17b6a8f8a8c77bdea4fe8b
-  languageName: node
-  linkType: hard
-
 "nimma@npm:0.2.2":
  version: 0.2.2
  resolution: "nimma@npm:0.2.2"
@@ -33737,17 +33643,6 @@ __metadata:
  languageName: node
  linkType: hard

-"njwt@npm:^2.0.0":
-  version: 2.0.0
-  resolution: "njwt@npm:2.0.0"
-  dependencies:
-    "@types/node": ^15.0.1
-    ecdsa-sig-formatter: ^1.0.5
-    uuid: ^8.3.2
-  checksum: 3c6c33b2fd044bca7468171f5dca064f5a4f59ce0e63b567df62c1a8d720e3c3d65921d5e99ae72eb22fde3285ef42b6009b4c4469f06e3a0e66d88a6f393373
-  languageName: node
-  linkType: hard
-
 "no-case@npm:^3.0.4":
  version: 3.0.4
  resolution: "no-case@npm:3.0.4"
@@ -33774,15 +33669,6 @@ __metadata:
  languageName: node
  linkType: hard

-"node-addon-api@npm:^1.7.1":
-  version: 1.7.2
-  resolution: "node-addon-api@npm:1.7.2"
-  dependencies:
-    node-gyp: latest
-  checksum: 938922b3d7cb34ee137c5ec39df6289a3965e8cab9061c6848863324c21a778a81ae3bc955554c56b6b86962f6ccab2043dd5fa3f33deab633636bd28039333f
-  languageName: node
-  linkType: hard
-
 "node-addon-api@npm:^3.2.1":
  version: 3.2.1
  resolution: "node-addon-api@npm:3.2.1"
@@ -36789,7 +36675,7 @@ __metadata:
  languageName: node
  linkType: hard

-"randombytes@npm:^2.0.0, randombytes@npm:^2.0.1, randombytes@npm:^2.0.3, randombytes@npm:^2.0.5, randombytes@npm:^2.1.0":
+"randombytes@npm:^2.0.0, randombytes@npm:^2.0.1, randombytes@npm:^2.0.5, randombytes@npm:^2.1.0":
  version: 2.1.0
  resolution: "randombytes@npm:2.1.0"
  dependencies:
@@ -39338,20 +39224,6 @@ __metadata:
  languageName: node
  linkType: hard

-"simple-websocket@npm:^5.0.0":
-  version: 5.1.1
-  resolution: "simple-websocket@npm:5.1.1"
-  dependencies:
-    debug: ^3.1.0
-    inherits: ^2.0.1
-    randombytes: ^2.0.3
-    readable-stream: ^2.0.5
-    safe-buffer: ^5.0.1
-    ws: ^3.3.1
-  checksum: 846ba5a4e8419a4b3186e8618ed55969d498d494c8c78002a7f6adfef51edfb1f673380ad28cd92d59c8a70d2247395ad8ad1117c1597839500e6c5efd1c3f30
-  languageName: node
-  linkType: hard
-
 "sinon@npm:^14.0.2":
  version: 14.0.2
  resolution: "sinon@npm:14.0.2"
@@ -41463,20 +41335,6 @@ __metadata:
  languageName: node
  linkType: hard

-"type@npm:^1.0.1":
-  version: 1.2.0
-  resolution: "type@npm:1.2.0"
-  checksum: dae8c64f82c648b985caf321e9dd6e8b7f4f2e2d4f846fc6fd2c8e9dc7769382d8a52369ddbaccd59aeeceb0df7f52fb339c465be5f2e543e81e810e413451ee
-  languageName: node
-  linkType: hard
-
-"type@npm:^2.7.2":
-  version: 2.7.2
-  resolution: "type@npm:2.7.2"
-  checksum: 0f42379a8adb67fe529add238a3e3d16699d95b42d01adfe7b9a7c5da297f5c1ba93de39265ba30ffeb37dfd0afb3fb66ae09f58d6515da442219c086219f6f4
-  languageName: node
-  linkType: hard
-
 "typed-array-buffer@npm:^1.0.0":
  version: 1.0.0
  resolution: "typed-array-buffer@npm:1.0.0"
@@ -41664,13 +41522,6 @@ __metadata:
  languageName: node
  linkType: hard

-"ultron@npm:~1.1.0":
-  version: 1.1.1
-  resolution: "ultron@npm:1.1.1"
-  checksum: aa7b5ebb1b6e33287b9d873c6756c4b7aa6d1b23d7162ff25b0c0ce5c3c7e26e2ab141a5dc6e96c10ac4d00a372e682ce298d784f06ffcd520936590b4bc0653
-  languageName: node
-  linkType: hard
-
 "unbox-primitive@npm:^1.0.2":
  version: 1.0.2
  resolution: "unbox-primitive@npm:1.0.2"
@@ -42240,20 +42091,6 @@ __metadata:
  languageName: node
  linkType: hard

-"v@npm:^0.3.0":
-  version: 0.3.0
-  resolution: "v@npm:0.3.0"
-  dependencies:
-    deasync: ^0.1.9
-    debug: ^2.6.1
-    simple-websocket: ^5.0.0
-  dependenciesMeta:
-    deasync:
-      optional: true
-  checksum: 55a52287b7d417f348516d50e2103f3ef46db371e736da94d55ae2fdc61bdeb3f58eea689ffa69aebe2e93a1abd7a9424eabc552f6060884e434b872229b2045
-  languageName: node
-  linkType: hard
-
 "valid-url@npm:^1.0.9":
  version: 1.0.9
  resolution: "valid-url@npm:1.0.9"
@@ -43082,17 +42919,6 @@ __metadata:
  languageName: node
  linkType: hard

-"ws@npm:^3.3.1":
-  version: 3.3.3
-  resolution: "ws@npm:3.3.3"
-  dependencies:
-    async-limiter: ~1.0.0
-    safe-buffer: ~5.1.0
-    ultron: ~1.1.0
-  checksum: 20b7bf34bb88715b9e2d435b76088d770e063641e7ee697b07543815fabdb752335261c507a973955e823229d0af8549f39cc669825e5c8404aa0422615c81d9
-  languageName: node
-  linkType: hard
-
 "ws@npm:^5.2.0 || ^6.0.0 || ^7.0.0, ws@npm:^7.4.6":
  version: 7.5.9
  resolution: "ws@npm:7.5.9"