Test Custom JWT Authentication to Credentials #715

desistefanova · 2022-07-06T08:31:58Z

Update Changelog.
Add tests for login with JWT credentials.
Enable custom-token auth provider for the cloud apps using baas_client.dart.
Fixes: #398
This supersedes #709

…-dart into desistefanova-ds/jwt_tests

…to ds/jwt_tests

nirinchev

My comments roughly reflect what we discussed at the roundtable yesterday - the code seems fine to me, but I believe we should simplify our tests.

.github/workflows/ci.yml

.github/workflows/flutter-desktop-tests.yml

.github/workflows/dart-desktop-tests.yml

flutter/realm_flutter/tests/test_driver/app_test.dart

test/credentials_test.dart

nirinchev · 2022-08-10T13:20:09Z

test/credentials_test.dart

+  ///   "aud": "mongodb.com",
+  ///   "iss": "https://realm.io"
+  /// }
+  baasTest('JWT - login with existing user and edit profile', (configuration) async {


This test can't work like this. Users are distinguished by provider+providerId, so an email password user cannot authenticate with JWT, even if their identities are the same. What you can do is generate two tokens for the same user identity and different profile information. Then validate that both authenticate the same user and that after the second auth, the profile has been updated.

I'm just rewriting this test with having one user with two identities for different providers.

Does it make sense now?

Co-authored-by: Nikola Irinchev <irinchev@me.com>

…to ds/jwt_tests

nirinchev

Looks good, let's just clean up/simplify that profile test.

test/test.dart

nirinchev · 2022-08-10T22:42:10Z

test/credentials_test.dart

+    final username = "jwt_user@#r@D@realm.io";
+    final authProvider = EmailPasswordAuthProvider(app);
+    // Always register jwt_user@#r@D@realm.io as a new user.
+    try {
+      await authProvider.registerUser(username, strongPassword);
+    } on RealmException catch (e) {
+      {
+        if (e.message.contains("name already in use")) {
+          // If the user exists, delete it and register a new one with the same name and empty profile
+          final user1 = await loginWithRetry(app, Credentials.emailPassword(username, strongPassword));
+          await app.deleteUser(user1);
+          await authProvider.registerUser(username, strongPassword);
+        }
+      }


Why hardcode the username here? We should be able to use a random email and avoid that extra logic.

Because the token is already generated and it must contain the same username inside.

The logic gets complicated but it will allow us to run the same test many times.

I tried to generate a new username for email/password credentials and then to link to JWT credentials. The email and username of the user are updated with "jwt_user@#r@D@realm.io" that is coming from the token. If I run the test again it creates a new user, but when I try to link it to the credentials with the same token it fails, because "jwt_user@#r@D@realm.io" already exists and it can not rename the new user to the same name. I still have to delete "jwt_user@#r@D@realm.io" before to run the test again.

Yeah, the issue is that the token is already consumed to create a user. The next time the test runs, it tries to link the new user to an existing user which is forbidden.

blagoev

Its all good, but I have some small suggestions before merging this

.github/workflows/ci.yml

blagoev · 2022-08-11T19:51:53Z

test/data/jwt_keys/README.md

@@ -0,0 +1,57 @@
+Custom JWT Authentication
+
+The keys in this folder "test/data/jwt_keys" are used only for the purpose of the automatic tests.


Lets add these files to the .pubignore file. We will never need to publish them right?
Lets ignore the whole directory jwt_keys

Same for the flutter package

While here we should do this for the data/realm_files dir as well.

I deleted the whole folder jwt_keys and moved the REAMDME.md content into test\README.md.
About the realm file into data/realm_files we already have in .pubignore an exclude for the file **/*.realm but I will also add an exclude for the whole data folder.

blagoev · 2022-08-11T19:54:49Z

test/data/jwt_keys/private_key.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----


If these are not needed lets remove them. Right now they have not polluted the main branch so if we delete them they will not get into the master history

Co-authored-by: Nikola Irinchev <irinchev@me.com>

…to ds/jwt_tests

.github/workflows/flutter-desktop-tests.yml

Co-authored-by: blagoev <lubo@blagoev.com>

derinwalters and others added 4 commits July 3, 2022 04:23

Add Custom JWT Authentication to Credentials

44e0daf

Add generated public and private keys

7de483d

Merge branch 'ds/jwt_tests' of https://github.com/desistefanova/realm…

c26a032

…-dart into desistefanova-ds/jwt_tests

Merge branch 'desistefanova-ds/jwt_tests' into ds/jwt_tests

3263e1e

cla-bot bot added the cla: yes label Jul 6, 2022

blagoev assigned desistefanova Jul 6, 2022

desistefanova added 24 commits July 6, 2022 16:13

Generate RSA signing key, JWT and then login

5d70020

Enable custom token provider in BaasClient

da9b04a

Enable jwt token credentials test

8b90c23

Merge branch 'master' into ds/jwt_tests

a0c90c1

Fix file path

a12e469

Try to fix local paths

067c297

jwks.json path added to env.variable

f6147f7

Set variable BAAS_JWKS_URL

122fe2e

Fix BAAS_JWKS_URL

db22437

Merge branch 'ds/jwt_tests' of https://github.com/realm/realm-dart in…

ba46a16

…to ds/jwt_tests

Merge branch 'ds/jwt_tests' of https://github.com/realm/realm-dart in…

70d1743

…to ds/jwt_tests

Merge branch 'ds/jwt_tests' of https://github.com/realm/realm-dart in…

ff1b9fa

…to ds/jwt_tests

Get branch name for BAAS_JWKS_URL

29333eb

Get branch name

5a367bc

Provide jwks.json

5d22979

Test comment

285b693

Fix jwks.json location + readme.md

78d771b

Fix jwks.json url in CI

70f6f1e

jwk kid required

9dc4145

Add kid header to JWT

ed39679

Try to create cluster renamed

04494dd

Skip JWT test for Flutter IOS, Android and MacOS

e5d10ff

Make simple test paths

bc39293

Make simple test paths

46327e3

desistefanova added 3 commits August 5, 2022 18:30

Fix merge

6ee0689

Test with already generated JWT

3eec573

Merge branch 'master' into ds/jwt_tests

f3c1766

nirinchev requested changes Aug 10, 2022

View reviewed changes

desistefanova and others added 7 commits August 10, 2022 16:35

login with existing user and edit profile

c527ebc

Update .github/workflows/ci.yml

90b7cc2

Co-authored-by: Nikola Irinchev <irinchev@me.com>

Update .github/workflows/dart-desktop-tests.yml

0b12dad

Co-authored-by: Nikola Irinchev <irinchev@me.com>

Update flutter/realm_flutter/tests/test_driver/app_test.dart

107e306

Co-authored-by: Nikola Irinchev <irinchev@me.com>

Edit token expiration to be 100yars

6c500bf

Merge branch 'ds/jwt_tests' of https://github.com/realm/realm-dart in…

cfb4514

…to ds/jwt_tests

remove test for jwt validation with JWK JSON URL

1323a30

desistefanova requested review from nirinchev and nielsenko August 10, 2022 15:56

nirinchev reviewed Aug 10, 2022

View reviewed changes

Link TODO

9216201

blagoev suggested changes Aug 11, 2022

View reviewed changes

desistefanova and others added 3 commits August 12, 2022 09:58

Update .github/workflows/ci.yml

56910d1

Co-authored-by: Nikola Irinchev <irinchev@me.com>

Remove jwt test resources

9e9ce31

Merge branch 'ds/jwt_tests' of https://github.com/realm/realm-dart in…

5a2c062

…to ds/jwt_tests

blagoev reviewed Aug 12, 2022

View reviewed changes

.github/workflows/flutter-desktop-tests.yml Outdated Show resolved Hide resolved

blagoev approved these changes Aug 12, 2022

View reviewed changes

blagoev mentioned this pull request Aug 12, 2022

Add Custom JWT Authentication to Credentials #709

Closed

desistefanova and others added 3 commits August 12, 2022 12:45

Move readme.md to contributing.md

d94356f

Update .github/workflows/flutter-desktop-tests.yml

81105a5

Co-authored-by: blagoev <lubo@blagoev.com>

Merge branch 'master' into ds/jwt_tests

d068399

desistefanova mentioned this pull request Aug 12, 2022

Test external auth providers credentials #745

Merged

Merge branch 'master' into ds/jwt_tests

88cdfb8

desistefanova merged commit 0c99911 into master Aug 12, 2022

desistefanova deleted the ds/jwt_tests branch August 12, 2022 13:48

github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Test Custom JWT Authentication to Credentials #715

Test Custom JWT Authentication to Credentials #715

desistefanova commented Jul 6, 2022 •

edited by blagoev

Loading

nirinchev left a comment

nirinchev Aug 10, 2022

desistefanova Aug 10, 2022

desistefanova Aug 10, 2022

nirinchev left a comment

nirinchev Aug 10, 2022

desistefanova Aug 11, 2022

desistefanova Aug 11, 2022

desistefanova Aug 11, 2022

nirinchev Aug 11, 2022

blagoev left a comment

blagoev Aug 11, 2022

blagoev Aug 11, 2022

blagoev Aug 11, 2022

desistefanova Aug 12, 2022 •

edited

Loading

blagoev Aug 11, 2022

		@@ -0,0 +1,57 @@
		Custom JWT Authentication

		The keys in this folder "test/data/jwt_keys" are used only for the purpose of the automatic tests.

Test Custom JWT Authentication to Credentials #715

Test Custom JWT Authentication to Credentials #715

Conversation

desistefanova commented Jul 6, 2022 • edited by blagoev Loading

nirinchev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nirinchev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blagoev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

desistefanova Aug 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

desistefanova commented Jul 6, 2022 •

edited by blagoev

Loading

desistefanova Aug 12, 2022 •

edited

Loading