@backstage/plugin-auth-backend-module-auth0-provider 0.3.0-next.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/plugin-auth-backend-module-auth0-provider
 
+## 0.3.0
+
+### Minor Changes
+
+- 36804fe: feat: Added organization option to authorization params of the strategy
+
+### Patch Changes
+
+- 867c905: Add support for organizational invites in auth0 strategy
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.7.0
+  - @backstage/plugin-auth-node@0.6.13
+
+## 0.3.0-next.1
+
+### Patch Changes
+
+- 867c905: Add support for organizational invites in auth0 strategy
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.7.0-next.1
+  - @backstage/plugin-auth-node@0.6.13-next.1
+
 ## 0.3.0-next.0
 
 ### Minor Changes

package/dist/strategy.cjs.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var Auth0InternalStrategy = require('passport-auth0');
+var errors = require('@backstage/errors');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -19,13 +20,26 @@ class Auth0Strategy extends Auth0InternalStrategy__default.default {
     super(optionsWithURLs, verify);
     this.organization = options.organization;
   }
+  authenticate(req, options) {
+    const { organization, invitation } = req.query;
+    if (organization && this.organization && organization !== this.organization) {
+      throw new errors.InputError(
+        "Organization mismatch. The organization provided in the request does not match the organization configured in the strategy."
+      );
+    }
+    super.authenticate(req, {
+      ...options,
+      ...organization ? { organization } : {},
+      ...invitation ? { invitation } : {}
+    });
+  }
   authorizationParams(options) {
     const params = super.authorizationParams(options);
-    if (this.organization) {
-      return {
-        ...params,
-        organization: this.organization
-      };
+    if (options.organization || this.organization) {
+      params.organization = options.organization || this.organization;
+    }
+    if (options.invitation) {
+      params.invitation = options.invitation;
     }
     return params;
   }

package/dist/strategy.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"strategy.cjs.js","sources":["../src/strategy.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Auth0InternalStrategy from 'passport-auth0';\nimport type { StateStore } from 'passport-oauth2';\n\n/** @public */\nexport interface Auth0StrategyOptionsWithRequest {\n  clientID: string;\n  clientSecret: string;\n  callbackURL: string;\n  domain: string;\n  passReqToCallback: true;\n  store: StateStore;\n  organization?: string;\n}\n\n/** @public */\nexport class Auth0Strategy extends Auth0InternalStrategy {\n  private organization: string | undefined;\n\n  constructor(\n    options: Auth0StrategyOptionsWithRequest,\n    verify: Auth0InternalStrategy.VerifyFunction,\n  ) {\n    const optionsWithURLs = {\n      ...options,\n      authorizationURL: `https://${options.domain}/authorize`,\n      tokenURL: `https://${options.domain}/oauth/token`,\n      userInfoURL: `https://${options.domain}/userinfo`,\n      apiUrl: `https://${options.domain}/api`,\n    };\n    super(optionsWithURLs, verify);\n    this.organization = options.organization;\n  }\n\n  authorizationParams(options: Record<string, any>): Record<string, any> {\n    const params = super.authorizationParams(options);\n\n    if (this.organization) {\n      return {\n        ...params,\n        organization: this.organization,\n      };\n    }\n    return params;\n  }\n}\n"],"names":["Auth0InternalStrategy"],"mappings":";;;;;;;;AA+BO,MAAM,sBAAsBA,sCAAA,CAAsB;AAAA,EAC/C,YAAA;AAAA,EAER,WAAA,CACE,SACA,MAAA,EACA;AACA,IAAA,MAAM,eAAA,GAAkB;AAAA,MACtB,GAAG,OAAA;AAAA,MACH,gBAAA,EAAkB,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,UAAA,CAAA;AAAA,MAC3C,QAAA,EAAU,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,YAAA,CAAA;AAAA,MACnC,WAAA,EAAa,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,SAAA,CAAA;AAAA,MACtC,MAAA,EAAQ,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,IAAA;AAAA,KACnC;AACA,IAAA,KAAA,CAAM,iBAAiB,MAAM,CAAA;AAC7B,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAAA,EAC9B;AAAA,EAEA,oBAAoB,OAAA,EAAmD;AACrE,IAAA,MAAM,MAAA,GAAS,KAAA,CAAM,mBAAA,CAAoB,OAAO,CAAA;AAEhD,IAAA,IAAI,KAAK,YAAA,EAAc;AACrB,MAAA,OAAO;AAAA,QACL,GAAG,MAAA;AAAA,QACH,cAAc,IAAA,CAAK;AAAA,OACrB;AAAA,IACF;AACA,IAAA,OAAO,MAAA;AAAA,EACT;AACF;;;;"}
+{"version":3,"file":"strategy.cjs.js","sources":["../src/strategy.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Auth0InternalStrategy from 'passport-auth0';\nimport type { StateStore } from 'passport-oauth2';\nimport type express from 'express';\nimport { InputError } from '@backstage/errors';\n\n/** @public */\nexport interface Auth0StrategyOptionsWithRequest {\n  clientID: string;\n  clientSecret: string;\n  callbackURL: string;\n  domain: string;\n  passReqToCallback: true;\n  store: StateStore;\n  organization?: string;\n}\n\n/** @public */\nexport class Auth0Strategy extends Auth0InternalStrategy {\n  private organization: string | undefined;\n\n  constructor(\n    options: Auth0StrategyOptionsWithRequest,\n    verify: Auth0InternalStrategy.VerifyFunction,\n  ) {\n    const optionsWithURLs = {\n      ...options,\n      authorizationURL: `https://${options.domain}/authorize`,\n      tokenURL: `https://${options.domain}/oauth/token`,\n      userInfoURL: `https://${options.domain}/userinfo`,\n      apiUrl: `https://${options.domain}/api`,\n    };\n    super(optionsWithURLs, verify);\n    this.organization = options.organization;\n  }\n\n  authenticate(req: express.Request, options: Record<string, any>): void {\n    const { organization, invitation } = req.query;\n\n    // Throw an error if the organization in the request does not match the organization configured in the strategy\n    if (\n      organization &&\n      this.organization &&\n      organization !== this.organization\n    ) {\n      throw new InputError(\n        'Organization mismatch. The organization provided in the request does not match the organization configured in the strategy.',\n      );\n    }\n\n    super.authenticate(req, {\n      ...options,\n      ...(organization ? { organization } : {}),\n      ...(invitation ? { invitation } : {}),\n    });\n  }\n\n  authorizationParams(options: Record<string, any>): Record<string, any> {\n    const params = super.authorizationParams(options);\n\n    if (options.organization || this.organization) {\n      params.organization = options.organization || this.organization;\n    }\n\n    if (options.invitation) {\n      params.invitation = options.invitation;\n    }\n\n    return params;\n  }\n}\n"],"names":["Auth0InternalStrategy","InputError"],"mappings":";;;;;;;;;AAiCO,MAAM,sBAAsBA,sCAAA,CAAsB;AAAA,EAC/C,YAAA;AAAA,EAER,WAAA,CACE,SACA,MAAA,EACA;AACA,IAAA,MAAM,eAAA,GAAkB;AAAA,MACtB,GAAG,OAAA;AAAA,MACH,gBAAA,EAAkB,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,UAAA,CAAA;AAAA,MAC3C,QAAA,EAAU,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,YAAA,CAAA;AAAA,MACnC,WAAA,EAAa,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,SAAA,CAAA;AAAA,MACtC,MAAA,EAAQ,CAAA,QAAA,EAAW,OAAA,CAAQ,MAAM,CAAA,IAAA;AAAA,KACnC;AACA,IAAA,KAAA,CAAM,iBAAiB,MAAM,CAAA;AAC7B,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAAA,EAC9B;AAAA,EAEA,YAAA,CAAa,KAAsB,OAAA,EAAoC;AACrE,IAAA,MAAM,EAAE,YAAA,EAAc,UAAA,EAAW,GAAI,GAAA,CAAI,KAAA;AAGzC,IAAA,IACE,YAAA,IACA,IAAA,CAAK,YAAA,IACL,YAAA,KAAiB,KAAK,YAAA,EACtB;AACA,MAAA,MAAM,IAAIC,iBAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AAEA,IAAA,KAAA,CAAM,aAAa,GAAA,EAAK;AAAA,MACtB,GAAG,OAAA;AAAA,MACH,GAAI,YAAA,GAAe,EAAE,YAAA,KAAiB,EAAC;AAAA,MACvC,GAAI,UAAA,GAAa,EAAE,UAAA,KAAe;AAAC,KACpC,CAAA;AAAA,EACH;AAAA,EAEA,oBAAoB,OAAA,EAAmD;AACrE,IAAA,MAAM,MAAA,GAAS,KAAA,CAAM,mBAAA,CAAoB,OAAO,CAAA;AAEhD,IAAA,IAAI,OAAA,CAAQ,YAAA,IAAgB,IAAA,CAAK,YAAA,EAAc;AAC7C,MAAA,MAAA,CAAO,YAAA,GAAe,OAAA,CAAQ,YAAA,IAAgB,IAAA,CAAK,YAAA;AAAA,IACrD;AAEA,IAAA,IAAI,QAAQ,UAAA,EAAY;AACtB,MAAA,MAAA,CAAO,aAAa,OAAA,CAAQ,UAAA;AAAA,IAC9B;AAEA,IAAA,OAAO,MAAA;AAAA,EACT;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-auth-backend-module-auth0-provider",
-  "version": "0.3.0-next.0",
+  "version": "0.3.0",
   "description": "The auth0-provider backend module for the auth plugin.",
   "backstage": {
     "role": "backend-plugin-module",
@@ -37,19 +37,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.7.0-next.0",
-    "@backstage/plugin-auth-node": "0.6.12-next.0",
+    "@backstage/backend-plugin-api": "^1.7.0",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-auth-node": "^0.6.13",
     "express": "^4.22.0",
     "passport": "^0.7.0",
     "passport-auth0": "^1.4.3",
     "passport-oauth2": "^1.6.1"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "0.15.1-next.0",
-    "@backstage/backend-test-utils": "1.10.4-next.0",
-    "@backstage/cli": "0.35.3-next.0",
-    "@backstage/plugin-auth-backend": "0.26.1-next.0",
-    "@backstage/types": "1.2.2",
+    "@backstage/backend-defaults": "^0.15.2",
+    "@backstage/backend-test-utils": "^1.11.0",
+    "@backstage/cli": "^0.35.4",
+    "@backstage/plugin-auth-backend": "^0.27.0",
+    "@backstage/types": "^1.2.2",
     "@types/passport": "^1.0.3",
     "@types/passport-auth0": "^1.0.5",
     "@types/passport-oauth2": "^1.4.15",