feat(auth): Recognize `FIREBASE_AUTH_EMULATOR_HOST` environment variable #414

maku693 · 2020-12-18T17:21:05Z

If FIREBASE_AUTH_EMULATOR_HOST is set, auth API request will be sent to the host according to the environment variable.

Discussion

#409

~~Reflecting the comment on the issue, the behavior of signers and token verifiers are unchanged.~~

Now the signer is replaced to emulatedSigner, and token verifiers panic when the environment variable is set. #414 (comment) #414 (comment)

RELEASE NOTE: The Admin SDK now supports the Firebase emulator. Developers can configure the SDK to run against the emulator by setting the FIREBASE_AUTH_EMULATOR_HOST environment variable.

* Change endpoint urls according to the environment variable

maku693 · 2020-12-18T17:25:31Z

auth/auth_test.go

+			option.WithoutAuthentication(),
+		},
+	}
+	client, err := NewClient(context.Background(), conf)


I'm not sure using no-auth config is appropriate for this test.

maku693 · 2020-12-18T17:28:50Z

auth/auth_test.go

 	}
-	if umc.providerConfigEndpoint != providerConfigEndpoint {
-		return fmt.Errorf("providerConfigEndpoint = %q; want = %q", umc.providerConfigEndpoint, providerConfigEndpoint)
+	if baseClient.tenantMgtEndpoint != defaultIDToolkitV2Beta1Endpoint {


Added the check for tenantMgtEndpoint.

samtstern · 2020-12-21T12:13:10Z

@maky693 thank you for the contribution! General approach LGTM but assigning to @hiranya911 for Go / Admin SDK review.

hiranya911

LGTM. Only question is should we release this without support for emulating token verification?

auth/auth.go

dgpc · 2021-01-05T20:29:16Z

@hiranya911 - as a user waiting for this feature, my 2c worth is that although token verification emulation is necessary for complete end-to-end testing, making it possible to talk to the emulator at all in this manner is still useful to release as-is, since it unblocks testing of a variety of workflows

Michaelhobo · 2021-01-05T20:35:10Z

@hiranya911 - as a user waiting for this feature, my 2c worth is that although token verification emulation is necessary for complete end-to-end testing, making it possible to talk to the emulator at all in this manner is still useful to release as-is, since it unblocks testing of a variety of workflows

Agreed, this would be a huge win for me.

yuchenshi · 2021-01-05T22:07:28Z

I'd propose a middle ground where we release a version first, where everything works but token verification panics with "not implemented" for now when the env var is set. This should ensure that SDK don't call production APIs in emulator mode and also minimize any confusion caused by the SDK verifying signatures using production public keys. (This idea can also apply to the Python SDK, using thrown exceptions instead of panics.)

samtstern · 2021-01-06T11:02:03Z

@yuchenshi I like that idea! SGTM

hiranya911 · 2021-01-06T20:50:56Z

Yeah, I like that too. Any chance we can get this PR updated to incorporate that change?

maku693 · 2021-01-07T01:17:25Z

Thank you for review! I'll update this PR this weekend.

maku693 · 2021-01-10T14:26:23Z

auth/token_verifier.go

@@ -100,9 +100,10 @@ type tokenVerifier struct {
 	expiredTokenCode  string
 	keySource         keySource
 	clock             internal.Clock
+	isEmulator        bool


This might be too simple. It's better to implement custom keySource for emulator mode.

But I don't sure custom keySource is necessary because we didn't decide how to verify tokens in the emulator mode yet.

maku693 · 2021-01-10T14:39:09Z

@yuchenshi Is the point of the change to prevent calling production APIs in emulator mode?
If so, not just the token verifier but also the signer and the tenant manager should panic at API calls, correct?

yuchenshi · 2021-01-11T19:18:58Z

For createCustomToken etc., when FIREBASE_AUTH_EMULATOR_HOST is set, the SDK should create unsigned tokens (i.e. the signature part being an empty string), which are in turn accepted by the Auth Emulator. In other words, signer should be short-circuited and there should not be any outgoing network call at all (no signBlob etc.).

Auth Emulator doesn't support multi-tenancy (at least for now) and I'm indifferent whether the SDK should panic or forward them to the Auth Emulator which rejects such requests. I'm fine as long as they won't reach production.

maku693 · 2021-01-12T15:38:24Z

Ah, I understand. I'll update not to sign tokens.

hiranya911

Looks reasonable to me.

@yuchenshi wdyt?

Modeled on firebase/firebase-admin-go#414

…HOST environment variable. (#531) * Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST Modeled on firebase/firebase-admin-go#414 * Tests for emulator support in auth, user mgmt and token gen To minimize modification of tests, the app fixture and instrumentation have been modified to use a global dict of URLs, which are then monkey-patched based on fixture parameters. Essentially, all tests using the app fixture are run twice, once with the emulated endpoint and once without. * fallback for monkeypatch in python 3.5 * Token verification for the auth emulator * Accommodate auth emulator behaviour in tests. Where possible, tests are modified to account for the current behaviour in emulator mode (e.g., invalid or expired tokens or cookies still work). Fixtures were changed to function scope to avoid problems caused by overlap when some fixtures being in emulator mode and some in normal mode concurrently.

maku693 added 4 commits December 18, 2020 17:10

feat(auth): Recognize FIREBASE_AUTH_EMULATOR_HOST environment variable

6d98ad1

* Change endpoint urls according to the environment variable

Fix incorrect test error message

1f52542

Fix lint error

d792ace

Avoid using environment variable for expected values of tests

68a6dce

maku693 commented Dec 18, 2020

View reviewed changes

maku693 marked this pull request as ready for review December 18, 2020 17:39

maku693 mentioned this pull request Dec 18, 2020

FR: Support Authentication Emulator #409

Closed

samtstern requested a review from hiranya911 December 21, 2020 12:12

hiranya911 approved these changes Jan 5, 2021

View reviewed changes

auth/auth.go Outdated Show resolved Hide resolved

hiranya911 assigned samtstern Jan 5, 2021

yuchenshi assigned maku693 and unassigned samtstern Jan 6, 2021

Define constant for the environment variable

11d9970

maku693 commented Jan 10, 2021

View reviewed changes

Make token verifier panics in emulator mode

c599191

maku693 added 2 commits January 12, 2021 16:09

Use emulated signer when FIREBASE_AUTH_EMULATOR_HOST is set

14cc3a0

Fix incorrect test error message

16de7ec

maku693 requested a review from hiranya911 January 12, 2021 16:22

hiranya911 approved these changes Jan 12, 2021

View reviewed changes

hiranya911 requested a review from yuchenshi January 12, 2021 21:57

hiranya911 assigned yuchenshi Jan 12, 2021

hiranya911 added the release-note label Jan 12, 2021

yuchenshi approved these changes Jan 12, 2021

View reviewed changes

hiranya911 merged commit 8cd5093 into firebase:dev Jan 15, 2021

hiranya911 mentioned this pull request Jan 22, 2021

Allow package consumers to simulate errors in test #416

Open

hiranya911 mentioned this pull request Feb 1, 2021

FR: Support for authentication emulator firebase/firebase-admin-python#503

Closed

muru added a commit to muru/firebase-admin-python that referenced this pull request Feb 4, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

5657a80

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Feb 5, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

7dd4d89

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Feb 5, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

d53bb41

Modeled on firebase/firebase-admin-go#414

maku693 mentioned this pull request Feb 20, 2021

feat(auth): Add token verification logic for emulator mode #419

Merged

muru added a commit to muru/firebase-admin-python that referenced this pull request Feb 24, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

37b431a

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Feb 24, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

80e4d07

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Feb 28, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

9d899e2

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Mar 5, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

ed36364

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Mar 16, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

d01ec61

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Mar 16, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

b358916

Modeled on firebase/firebase-admin-go#414

muru added a commit to muru/firebase-admin-python that referenced this pull request Mar 20, 2021

Support auth emulator via FIREBASE_AUTH_EMULATOR_HOST

65ad7c5

Modeled on firebase/firebase-admin-go#414

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(auth): Recognize `FIREBASE_AUTH_EMULATOR_HOST` environment variable #414

feat(auth): Recognize `FIREBASE_AUTH_EMULATOR_HOST` environment variable #414

maku693 commented Dec 18, 2020 •

edited by hiranya911

Loading

maku693 Dec 18, 2020

maku693 Dec 18, 2020

samtstern commented Dec 21, 2020 •

edited

Loading

hiranya911 left a comment

dgpc commented Jan 5, 2021

Michaelhobo commented Jan 5, 2021

yuchenshi commented Jan 5, 2021 •

edited

Loading

samtstern commented Jan 6, 2021

hiranya911 commented Jan 6, 2021

maku693 commented Jan 7, 2021

maku693 Jan 10, 2021 •

edited

Loading

maku693 commented Jan 10, 2021 •

edited

Loading

yuchenshi commented Jan 11, 2021

maku693 commented Jan 12, 2021

hiranya911 left a comment

feat(auth): Recognize FIREBASE_AUTH_EMULATOR_HOST environment variable #414

feat(auth): Recognize FIREBASE_AUTH_EMULATOR_HOST environment variable #414

Conversation

maku693 commented Dec 18, 2020 • edited by hiranya911 Loading

Discussion

maku693 Dec 18, 2020

Choose a reason for hiding this comment

maku693 Dec 18, 2020

Choose a reason for hiding this comment

samtstern commented Dec 21, 2020 • edited Loading

hiranya911 left a comment

Choose a reason for hiding this comment

dgpc commented Jan 5, 2021

Michaelhobo commented Jan 5, 2021

yuchenshi commented Jan 5, 2021 • edited Loading

samtstern commented Jan 6, 2021

hiranya911 commented Jan 6, 2021

maku693 commented Jan 7, 2021

maku693 Jan 10, 2021 • edited Loading

Choose a reason for hiding this comment

maku693 commented Jan 10, 2021 • edited Loading

yuchenshi commented Jan 11, 2021

maku693 commented Jan 12, 2021

hiranya911 left a comment

Choose a reason for hiding this comment

feat(auth): Recognize `FIREBASE_AUTH_EMULATOR_HOST` environment variable #414

feat(auth): Recognize `FIREBASE_AUTH_EMULATOR_HOST` environment variable #414

maku693 commented Dec 18, 2020 •

edited by hiranya911

Loading

samtstern commented Dec 21, 2020 •

edited

Loading

yuchenshi commented Jan 5, 2021 •

edited

Loading

maku693 Jan 10, 2021 •

edited

Loading

maku693 commented Jan 10, 2021 •

edited

Loading