@backstage/plugin-auth-backend 0.13.0 → 0.13.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-auth-backend
 
+## 0.13.1-next.0
+
+### Patch Changes
+
+- cfc0f19699: Updated dependency `fs-extra` to `10.1.0`.
+- 787ae0d541: Add more common predefined sign-in resolvers to auth providers.
+
+  Add the existing resolver to more providers (already available at `google`):
+
+  - `providers.microsoft.resolvers.emailLocalPartMatchingUserEntityName()`
+  - `providers.okta.resolvers.emailLocalPartMatchingUserEntityName()`
+
+  Add a new resolver for simple email-to-email matching:
+
+  - `providers.google.resolvers.emailMatchingUserEntityProfileEmail()`
+  - `providers.microsoft.resolvers.emailMatchingUserEntityProfileEmail()`
+  - `providers.okta.resolvers.emailMatchingUserEntityProfileEmail()`
+
+- 9ec4e0613e: Update to `jose` 4.6.0
+- Updated dependencies
+  - @backstage/backend-common@0.13.3-next.0
+  - @backstage/plugin-auth-node@0.2.1-next.0
+
 ## 0.13.0
 
 ### Minor Changes

package/dist/index.cjs.js

@@ -763,10 +763,6 @@ const createAuth0Provider = auth0.create;
 
 const ALB_JWT_HEADER = "x-amzn-oidc-data";
 const ALB_ACCESS_TOKEN_HEADER = "x-amzn-oidc-accesstoken";
-const getJWTHeaders = (input) => {
-  const encoded = input.split(".")[0];
-  return JSON.parse(Buffer.from(encoded, "base64").toString("utf8"));
-};
 class AwsAlbAuthProvider {
   constructor(options) {
     this.region = options.region;
@@ -801,9 +797,8 @@ class AwsAlbAuthProvider {
       throw new errors.AuthenticationError(`Missing ALB OIDC header: ${ALB_ACCESS_TOKEN_HEADER}`);
     }
     try {
-      const headers = getJWTHeaders(jwt);
-      const key = await this.getKey(headers.kid);
-      const claims = jose.JWT.verify(jwt, key);
+      const verifyResult = await jose.jwtVerify(jwt, this.getKey);
+      const claims = verifyResult.payload;
       if (this.issuer && claims.iss !== this.issuer) {
         throw new errors.AuthenticationError("Issuer mismatch on JWT token");
       }
@@ -843,14 +838,17 @@ class AwsAlbAuthProvider {
       profile
     };
   }
-  async getKey(keyId) {
-    const optionalCacheKey = this.keyCache.get(keyId);
+  async getKey(header) {
+    if (!header.kid) {
+      throw new errors.AuthenticationError("No key id was specified in header");
+    }
+    const optionalCacheKey = this.keyCache.get(header.kid);
     if (optionalCacheKey) {
       return crypto__namespace.createPublicKey(optionalCacheKey);
     }
-    const keyText = await fetch__default["default"](`https://public-keys.auth.elb.${encodeURIComponent(this.region)}.amazonaws.com/${encodeURIComponent(keyId)}`).then((response) => response.text());
+    const keyText = await fetch__default["default"](`https://public-keys.auth.elb.${encodeURIComponent(this.region)}.amazonaws.com/${encodeURIComponent(header.kid)}`).then((response) => response.text());
     const keyValue = crypto__namespace.createPublicKey(keyText);
-    this.keyCache.set(keyId, keyValue.export({ format: "pem", type: "spki" }));
+    this.keyCache.set(header.kid, keyValue.export({ format: "pem", type: "spki" }));
     return keyValue;
   }
 }
@@ -1257,6 +1255,17 @@ const commonByEmailLocalPartResolver = async (info, ctx) => {
     entityRef: { name: localPart }
   });
 };
+const commonByEmailResolver = async (info, ctx) => {
+  const { profile } = info;
+  if (!profile.email) {
+    throw new Error("Login failed, user profile does not contain an email");
+  }
+  return ctx.signInWithCatalogUser({
+    filter: {
+      "spec.profile.email": profile.email
+    }
+  });
+};
 
 class GoogleAuthProvider {
   constructor(options) {
@@ -1354,6 +1363,7 @@ const google = createAuthProviderIntegration({
   },
   resolvers: {
     emailLocalPartMatchingUserEntityName: () => commonByEmailLocalPartResolver,
+    emailMatchingUserEntityProfileEmail: () => commonByEmailResolver,
     emailMatchingUserEntityAnnotation() {
       return async (info, ctx) => {
         const { profile } = info;
@@ -1483,6 +1493,8 @@ const microsoft = createAuthProviderIntegration({
     });
   },
   resolvers: {
+    emailLocalPartMatchingUserEntityName: () => commonByEmailLocalPartResolver,
+    emailMatchingUserEntityProfileEmail: () => commonByEmailResolver,
     emailMatchingUserEntityAnnotation() {
       return async (info, ctx) => {
         const { profile } = info;
@@ -1659,7 +1671,7 @@ class Oauth2ProxyAuthProvider {
     if (!jwt) {
       throw new errors.AuthenticationError(`Missing or in incorrect format - Oauth2Proxy OIDC header: ${OAUTH2_PROXY_JWT_HEADER}`);
     }
-    const decodedJWT = jose.JWT.decode(jwt);
+    const decodedJWT = jose.decodeJwt(jwt);
     return {
       fullProfile: decodedJWT,
       accessToken: jwt
@@ -1919,6 +1931,8 @@ const okta = createAuthProviderIntegration({
     });
   },
   resolvers: {
+    emailLocalPartMatchingUserEntityName: () => commonByEmailLocalPartResolver,
+    emailMatchingUserEntityProfileEmail: () => commonByEmailResolver,
     emailMatchingUserEntityAnnotation() {
       return async (info, ctx) => {
         const { profile } = info;
@@ -2299,10 +2313,10 @@ class TokenFactory {
       throw new Error('"sub" claim provided by the auth resolver is not a valid EntityRef.');
     }
     this.logger.info(`Issuing token for ${sub}, with entities ${ent != null ? ent : []}`);
-    return jose.JWS.sign({ iss, sub, aud, iat, exp, ent }, key, {
-      alg: key.alg,
-      kid: key.kid
-    });
+    if (!key.alg) {
+      throw new errors.AuthenticationError("No algorithm was provided in the key");
+    }
+    return new jose.SignJWT({ iss, sub, aud, iat, exp }).setProtectedHeader({ alg: key.alg, kid: key.kid }).setIssuer(iss).setAudience(aud).setSubject(sub).setIssuedAt(iat).setExpirationTime(exp).sign(await jose.importJWK(key));
   }
   async listPublicKeys() {
     const { items: keys } = await this.keyStore.listKeys();
@@ -2339,14 +2353,14 @@ class TokenFactory {
       seconds: this.keyDurationSeconds
     }).toJSDate();
     const promise = (async () => {
-      const key = await jose.JWK.generate("EC", "P-256", {
-        use: "sig",
-        kid: uuid.v4(),
-        alg: "ES256"
-      });
-      this.logger.info(`Created new signing key ${key.kid}`);
-      await this.keyStore.addKey(key.toJWK(false));
-      return key;
+      const key = await jose.generateKeyPair("ES256");
+      const publicKey = await jose.exportJWK(key.publicKey);
+      const privateKey = await jose.exportJWK(key.privateKey);
+      publicKey.kid = privateKey.kid = uuid.v4();
+      publicKey.alg = privateKey.alg = "ES256";
+      this.logger.info(`Created new signing key ${publicKey.kid}`);
+      await this.keyStore.addKey(publicKey);
+      return privateKey;
     })();
     this.privateKeyPromise = promise;
     try {