Adds rudimentary email enumeration protection for auth emulator (#6702)

* Added rudimentary suppport for email enumeration protection * Removed custom test script for auth * Updated tests for improved email privacy * Added Emulator-specific configuration for enableImprovedEmailPrivacy * Updated integration tests to include enableImprovedEmailPrivacy config * Added TODO message to implement case for VERIFY_AND_CHANGE_EMAIL * Updated test title * Ran new formatter * Added a changelog entry
firebase · Jan 29, 2024 · 02e711e · 02e711e
1 parent 3182a1b
commit 02e711e
Show file tree

Hide file tree

Showing 9 changed files with 281 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+- Added rudimentary email enumeration protection for auth emulator. (#6702)
diff --git a/scripts/emulator-import-export-tests/tests.ts b/scripts/emulator-import-export-tests/tests.ts
@@ -277,6 +277,9 @@ describe("import/export end to end", () => {
         signIn: {
           allowDuplicateEmails: false,
         },
+        emailPrivacyConfig: {
+          enableImprovedEmailPrivacy: false,
+        },
       });
 
       const accountsPath = path.join(exportPath, "auth_export", "accounts.json");
@@ -382,6 +385,9 @@ describe("import/export end to end", () => {
         signIn: {
           allowDuplicateEmails: false,
         },
+        emailPrivacyConfig: {
+          enableImprovedEmailPrivacy: false,
+        },
       });
 
       const accountsPath = path.join(exportPath, "auth_export", "accounts.json");
@@ -447,6 +453,9 @@ describe("import/export end to end", () => {
       signIn: {
         allowDuplicateEmails: false,
       },
+      emailPrivacyConfig: {
+        enableImprovedEmailPrivacy: false,
+      },
     });
 
     const accountsPath = path.join(exportPath, "auth_export", "accounts.json");

diff --git a/src/emulator/auth/operations.ts b/src/emulator/auth/operations.ts
@@ -638,13 +638,20 @@ function createAuthUri(
     }
   }
 
-  return {
-    kind: "identitytoolkit#CreateAuthUriResponse",
-    registered,
-    allProviders,
-    sessionId,
-    signinMethods,
-  };
+  if (state.enableImprovedEmailPrivacy) {
+    return {
+      kind: "identitytoolkit#CreateAuthUriResponse",
+      sessionId,
+    };
+  } else {
+    return {
+      kind: "identitytoolkit#CreateAuthUriResponse",
+      registered,
+      allProviders,
+      sessionId,
+      signinMethods,
+    };
+  }
 }
 
 const SESSION_COOKIE_MIN_VALID_DURATION = 5 * 60; /* 5 minutes in seconds */
@@ -879,7 +886,14 @@ function sendOobCode(
       mode = "resetPassword";
       assert(reqBody.email, "MISSING_EMAIL");
       email = canonicalizeEmailAddress(reqBody.email);
-      assert(state.getUserByEmail(email), "EMAIL_NOT_FOUND");
+      const maybeUser = state.getUserByEmail(email);
+      if (state.enableImprovedEmailPrivacy && !maybeUser) {
+        return {
+          kind: "identitytoolkit#GetOobConfirmationCodeResponse",
+          email,
+        };
+      }
+      assert(maybeUser, "EMAIL_NOT_FOUND");
       break;
     case "VERIFY_EMAIL":
       mode = "verifyEmail";
@@ -898,7 +912,7 @@ function sendOobCode(
         email = user.email;
       }
       break;
-
+    // TODO: implement case for requestType VERIFY_AND_CHANGE_EMAIL.
     default:
       throw new NotImplementedError(reqBody.requestType);
   }
@@ -1726,10 +1740,21 @@ async function signInWithPassword(
 
   const email = canonicalizeEmailAddress(reqBody.email);
   let user = state.getUserByEmail(email);
-  assert(user, "EMAIL_NOT_FOUND");
-  assert(!user.disabled, "USER_DISABLED");
-  assert(user.passwordHash && user.salt, "INVALID_PASSWORD");
-  assert(user.passwordHash === hashPassword(reqBody.password, user.salt), "INVALID_PASSWORD");
+
+  if (state.enableImprovedEmailPrivacy) {
+    assert(user, "INVALID_LOGIN_CREDENTIALS");
+    assert(!user.disabled, "USER_DISABLED");
+    assert(user.passwordHash && user.salt, "INVALID_LOGIN_CREDENTIALS");
+    assert(
+      user.passwordHash === hashPassword(reqBody.password, user.salt),
+      "INVALID_LOGIN_CREDENTIALS",
+    );
+  } else {
+    assert(user, "EMAIL_NOT_FOUND");
+    assert(!user.disabled, "USER_DISABLED");
+    assert(user.passwordHash && user.salt, "INVALID_PASSWORD");
+    assert(user.passwordHash === hashPassword(reqBody.password, user.salt), "INVALID_PASSWORD");
+  }
 
   const response = {
     kind: "identitytoolkit#VerifyPasswordResponse",
@@ -1904,6 +1929,9 @@ function getEmulatorProjectConfig(state: ProjectState): Schemas["EmulatorV1Proje
     signIn: {
       allowDuplicateEmails: !state.oneAccountPerEmail,
     },
+    emailPrivacyConfig: {
+      enableImprovedEmailPrivacy: state.enableImprovedEmailPrivacy,
+    },
   };
 }
 
@@ -1918,6 +1946,9 @@ function updateEmulatorProjectConfig(
   if (reqBody.signIn?.allowDuplicateEmails != null) {
     updateMask.push("signIn.allowDuplicateEmails");
   }
+  if (reqBody.emailPrivacyConfig?.enableImprovedEmailPrivacy != null) {
+    updateMask.push("emailPrivacyConfig.enableImprovedEmailPrivacy");
+  }
   ctx.params.query.updateMask = updateMask.join();
 
   updateConfig(state, reqBody, ctx);

diff --git a/src/emulator/auth/schema.ts b/src/emulator/auth/schema.ts
@@ -4144,6 +4144,9 @@ export interface components {
       signIn?: {
         allowDuplicateEmails?: boolean;
       };
+      emailPrivacyConfig?: {
+        enableImprovedEmailPrivacy?: boolean,
+      },
     };
     /** @description Details of all pending confirmation codes. */
     EmulatorV1ProjectsOobCodes: {

diff --git a/src/emulator/auth/state.ts b/src/emulator/auth/state.ts
@@ -41,6 +41,8 @@ export abstract class ProjectState {
 
   abstract get oneAccountPerEmail(): boolean;
 
+  abstract get enableImprovedEmailPrivacy(): boolean;
+
   abstract get authCloudFunction(): AuthCloudFunction;
 
   abstract get allowPasswordSignup(): boolean;
@@ -578,6 +580,9 @@ export class AgentProjectState extends ProjectState {
   private _config: Config = {
     signIn: { allowDuplicateEmails: false },
     blockingFunctions: {},
+    emailPrivacyConfig: {
+      enableImprovedEmailPrivacy: false,
+    },
   };
 
   constructor(projectId: string) {
@@ -596,6 +601,14 @@ export class AgentProjectState extends ProjectState {
     this._config.signIn.allowDuplicateEmails = !oneAccountPerEmail;
   }
 
+  get enableImprovedEmailPrivacy() {
+    return !!this._config.emailPrivacyConfig.enableImprovedEmailPrivacy;
+  }
+
+  set enableImprovedEmailPrivacy(improveEmailPrivacy: boolean) {
+    this._config.emailPrivacyConfig.enableImprovedEmailPrivacy = improveEmailPrivacy;
+  }
+
   get allowPasswordSignup() {
     return true;
   }
@@ -659,6 +672,8 @@ export class AgentProjectState extends ProjectState {
     if (!updateMask) {
       this.oneAccountPerEmail = !update.signIn?.allowDuplicateEmails ?? true;
       this.blockingFunctionsConfig = update.blockingFunctions ?? {};
+      this.enableImprovedEmailPrivacy =
+        update.emailPrivacyConfig?.enableImprovedEmailPrivacy ?? false;
       return this.config;
     }
     return applyMask(updateMask, this.config, update);
@@ -748,6 +763,10 @@ export class TenantProjectState extends ProjectState {
     return this.parentProject.oneAccountPerEmail;
   }
 
+  get enableImprovedEmailPrivacy() {
+    return this.parentProject.enableImprovedEmailPrivacy;
+  }
+
   get authCloudFunction() {
     return this.parentProject.authCloudFunction;
   }
@@ -853,13 +872,16 @@ export type SignInConfig = MakeRequired<
 export type BlockingFunctionsConfig =
   Schemas["GoogleCloudIdentitytoolkitAdminV2BlockingFunctionsConfig"];
 
+export type EmailPrivacyConfig = Schemas["GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig"];
+
 // Serves as a substitute for Schemas["GoogleCloudIdentitytoolkitAdminV2Config"],
 // i.e. the configuration object for top-level AgentProjectStates. Emulator
 // fixes certain configurations for ease of use / testing, so as non-standard
 // behavior, Config only stores the configurable fields.
 export type Config = {
   signIn: SignInConfig;
   blockingFunctions: BlockingFunctionsConfig;
+  emailPrivacyConfig: EmailPrivacyConfig;
 };
 
 export interface RefreshTokenRecord {

diff --git a/src/test/emulators/auth/createAuthUri.spec.ts b/src/test/emulators/auth/createAuthUri.spec.ts
@@ -8,6 +8,7 @@ import {
   signInWithEmailLink,
   updateProjectConfig,
   registerTenant,
+  updateConfig,
 } from "./helpers";
 
 describeAuthEmulator("accounts:createAuthUri", ({ authApi }) => {
@@ -23,6 +24,28 @@ describeAuthEmulator("accounts:createAuthUri", ({ authApi }) => {
       });
   });
 
+  it("should not show registered field with improved email privacy enabled", async () => {
+    await updateConfig(
+      authApi(),
+      PROJECT_ID,
+      {
+        emailPrivacyConfig: {
+          enableImprovedEmailPrivacy: true,
+        },
+      },
+      "emailPrivacyConfig",
+    );
+    await authApi()
+      .post("/identitytoolkit.googleapis.com/v1/accounts:createAuthUri")
+      .send({ continueUri: "http://example.com/", identifier: "notregistered@example.com" })
+      .query({ key: "fake-api-key" })
+      .then((res) => {
+        expectStatusCode(200, res);
+        expect(res.body).to.not.have.property("registered");
+        expect(res.body).to.have.property("sessionId").that.is.a("string");
+      });
+  });
+
   it("should return providers for a registered user", async () => {
     const user = { email: "alice@example.com", password: "notasecret" };
     await registerUser(authApi(), user);
@@ -39,6 +62,32 @@ describeAuthEmulator("accounts:createAuthUri", ({ authApi }) => {
       });
   });
 
+  it("should not return providers for a registered user with improved email privacy enabled", async () => {
+    const user = { email: "alice@example.com", password: "notasecret" };
+    await updateConfig(
+      authApi(),
+      PROJECT_ID,
+      {
+        emailPrivacyConfig: {
+          enableImprovedEmailPrivacy: true,
+        },
+      },
+      "emailPrivacyConfig",
+    );
+    await registerUser(authApi(), user);
+    await authApi()
+      .post("/identitytoolkit.googleapis.com/v1/accounts:createAuthUri")
+      .send({ continueUri: "http://example.com/", identifier: user.email })
+      .query({ key: "fake-api-key" })
+      .then((res) => {
+        expectStatusCode(200, res);
+        expect(res.body).to.not.have.property("registered");
+        expect(res.body).to.not.have.property("allProviders").eql(["password"]);
+        expect(res.body).to.not.have.property("signinMethods").eql(["password"]);
+        expect(res.body).to.have.property("sessionId").that.is.a("string");
+      });
+  });
+
   it("should return existing sessionId if provided", async () => {
     await authApi()
       .post("/identitytoolkit.googleapis.com/v1/accounts:createAuthUri")

diff --git a/src/test/emulators/auth/misc.spec.ts b/src/test/emulators/auth/misc.spec.ts
@@ -552,6 +552,9 @@ describeAuthEmulator("emulator utility APIs", ({ authApi }) => {
         expect(res.body).to.have.property("signIn").eql({
           allowDuplicateEmails: false /* default value */,
         });
+        expect(res.body).to.have.property("emailPrivacyConfig").eql({
+          enableImprovedEmailPrivacy: false /* default value */,
+        });
       });
   });
 
@@ -564,7 +567,7 @@ describeAuthEmulator("emulator utility APIs", ({ authApi }) => {
       });
   });
 
-  it("should update allowDuplicateEmails on PATCH /emulator/v1/projects/{PROJECT_ID}/config", async () => {
+  it("should only update allowDuplicateEmails on PATCH /emulator/v1/projects/{PROJECT_ID}/config", async () => {
     await authApi()
       .patch(`/emulator/v1/projects/${PROJECT_ID}/config`)
       .send({ signIn: { allowDuplicateEmails: true } })
@@ -573,6 +576,9 @@ describeAuthEmulator("emulator utility APIs", ({ authApi }) => {
         expect(res.body).to.have.property("signIn").eql({
           allowDuplicateEmails: true,
         });
+        expect(res.body).to.have.property("emailPrivacyConfig").eql({
+          enableImprovedEmailPrivacy: false,
+        });
       });
     await authApi()
       .patch(`/emulator/v1/projects/${PROJECT_ID}/config`)
@@ -582,6 +588,69 @@ describeAuthEmulator("emulator utility APIs", ({ authApi }) => {
         expect(res.body).to.have.property("signIn").eql({
           allowDuplicateEmails: false,
         });
+        expect(res.body).to.have.property("emailPrivacyConfig").eql({
+          enableImprovedEmailPrivacy: false,
+        });
+      });
+  });
+
+  it("should only update enableImprovedEmailPrivacy on PATCH /emulator/v1/projects/{PROJECT_ID}/config", async () => {
+    await authApi()
+      .patch(`/emulator/v1/projects/${PROJECT_ID}/config`)
+      .send({ emailPrivacyConfig: { enableImprovedEmailPrivacy: true } })
+      .then((res) => {
+        expectStatusCode(200, res);
+        expect(res.body).to.have.property("signIn").eql({
+          allowDuplicateEmails: false,
+        });
+        expect(res.body).to.have.property("emailPrivacyConfig").eql({
+          enableImprovedEmailPrivacy: true,
+        });
+      });
+    await authApi()
+      .patch(`/emulator/v1/projects/${PROJECT_ID}/config`)
+      .send({ emailPrivacyConfig: { enableImprovedEmailPrivacy: false } })
+      .then((res) => {
+        expectStatusCode(200, res);
+        expect(res.body).to.have.property("signIn").eql({
+          allowDuplicateEmails: false,
+        });
+        expect(res.body).to.have.property("emailPrivacyConfig").eql({
+          enableImprovedEmailPrivacy: false,
+        });
+      });
+  });
+
+  it("should update both allowDuplicateEmails and enableImprovedEmailPrivacy on PATCH /emulator/v1/projects/{PROJECT_ID}/config", async () => {
+    await authApi()
+      .patch(`/emulator/v1/projects/${PROJECT_ID}/config`)
+      .send({
+        signIn: { allowDuplicateEmails: true },
+        emailPrivacyConfig: { enableImprovedEmailPrivacy: true },
+      })
+      .then((res) => {
+        expectStatusCode(200, res);
+        expect(res.body).to.have.property("signIn").eql({
+          allowDuplicateEmails: true,
+        });
+        expect(res.body).to.have.property("emailPrivacyConfig").eql({
+          enableImprovedEmailPrivacy: true,
+        });
+      });
+    await authApi()
+      .patch(`/emulator/v1/projects/${PROJECT_ID}/config`)
+      .send({
+        signIn: { allowDuplicateEmails: false },
+        emailPrivacyConfig: { enableImprovedEmailPrivacy: false },
+      })
+      .then((res) => {
+        expectStatusCode(200, res);
+        expect(res.body).to.have.property("signIn").eql({
+          allowDuplicateEmails: false,
+        });
+        expect(res.body).to.have.property("emailPrivacyConfig").eql({
+          enableImprovedEmailPrivacy: false,
+        });
       });
   });
 });