Adds feature to configure keycloak server with Scopes #128

mdanish98 · 2022-09-16T17:50:40Z

This library is indeed really useful.
I was using this library to mock keycloak authorization token behavior. But one use case it was missing like when there is an implementation for getting authorization token with normal OAuth2 request using custom getAccessToken method. The scenario is like I have a project which has a method to provide authorization and it just takes clientId, clientSecret and tokenUrl and it has its own implementation to request JWT token. Here I have to check whether it is able to successfully get the access token and then able to provide access to the secured registry, and the secured registry checks for the required scopes needed to perform certain action (Read/Write etc).
So for this there is a need to configure the realm with clientScopes while configuring the server and by not using TokenConfig.
I have added this feature to initialize and start KeyCloakMock server with clientScopes. I have also added the required test cases to cover this implementation.

Please let me know incase you need further information.

Thanks
Signed-off-by: Mohammad Ghazanfar Ali Danish [email protected]

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

mdanish98 · 2022-09-20T12:19:25Z

Dear @ostrya

Did you had some time to check this PR ?
Actually I have another PR on my other project which is dependent on this. If this change is merged that would be easy to update the dependent PR.

Please let me know incase of any further information.

Thanks and Regards

ostrya

Sorry for the late reply. I like your change, but I have a suggestion so we can avoid manipulating static variables.

example-backend/bin/.gitignore

mock/src/main/java/com/tngtech/keycloakmock/api/ServerConfig.java

Description: - Removes withClientScopes method in ServerConfig - Moves the openid scope from the TokenConfig to ServerConfig - Now the defaultScope (openid) is added when Keycloakmock Server is instantiated - Removes the default value scope check from TokenConfigTest (default_values_are_used) as now default value of scope is configured via ServerConfig - Modifies the TokenGeneratorTest (config_is_correctly_applied) in such a way that it only checks the scope configured and not the defaultScope - Adds additional test case in KeycloakMockTest to check if server is started without using withDefaultScopes then by default it should contain 'openid' scope Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Description: - Removes .gitignore from bin folders Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

mdanish98 · 2022-11-16T11:59:06Z

Dear @ostrya

Did you had a chance to check these changes?

mdanish98 · 2023-01-17T15:31:11Z

Dear @ostrya @mrmarbury @Achimh3011 @aaschmid ,

Actually we are dependent on this change and our project which is Eclipse Basyx an Industry 4.0 project is pending due to this pull request.

I request you to please look into this pull request and merge it so that we can use it in our project.

ostrya · 2023-01-17T19:24:59Z

Hi, sorry for the long delay. I had a really busy November and must then have lost track of this PR. I will have a look now.

mock/src/main/java/com/tngtech/keycloakmock/api/ServerConfig.java

mock/src/main/java/com/tngtech/keycloakmock/api/TokenConfig.java

mock/src/main/java/com/tngtech/keycloakmock/impl/UrlConfiguration.java

mock/src/test/java/com/tngtech/keycloakmock/api/KeycloakMockTest.java

- Inject this named singleton scopes inside TokenHelper - Resets the UrlConfiguration - Adapts to assertJ style assertions - Updates Javadoc Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

mdanish98 · 2023-01-18T20:37:35Z

Dear @ostrya

Many thanks for your suggestion I updated all the changes you requested.
One remark regarding the "please use a solution similar to the "resourcesToMapRolesTo" parameter:" comment:
As per your remarks I created a named singleton inside ServerModule. I tried to inject the named parameter into TokenGenerator's constructor but it was not working because the TokenGenerator is being used in SignatureComponent and due to this it was throwing error as [[Dagger/MissingBinding]](error: [Dagger/MissingBinding] @javax.inject.Named). So I thought that would be a major change because I might have to include the ServerModule.class in SignatureComponent like @component(modules = {KeyModule.class, ServerModule.class}) . And thatswhy I did the same thing you suggested in TokenHelper class instead, i.e. how "resourcesToMapRolesTo" is also implemented.

Please let me know if this is fine otherwise I will do it in TokenGenerator.

Please review it and let me know for further changes.

Thanks and Regards

ostrya

Yes, the approach to inject the scopes is much better. And it's fine to inject the scopes in the token helper instead.

I have just two minor remarks on the tests, otherwise it looks good now.

ostrya · 2023-01-19T07:19:37Z

mock/src/test/java/com/tngtech/keycloakmock/api/KeycloakMockTest.java

+
+    Set<String> scope = extractScopeFromToken(token);
+
+    assertThat(scope.size()).isEqualTo(3);


Cosmetic change:

Suggested change

assertThat(scope.size()).isEqualTo(3);

assertThat(scope).hasSize(3);

ostrya · 2023-01-19T07:24:44Z

mock/src/test/java/com/tngtech/keycloakmock/api/TokenConfigTest.java

@@ -47,7 +47,6 @@ void default_values_are_used() {
    assertThat(config.getPreferredUsername()).isNull();
    assertThat(config.getRealmAccess().getRoles()).isEmpty();
    assertThat(config.getResourceAccess()).isEmpty();
-    assertThat(config.getScope()).isEqualTo("openid");


To document the new behavior, maybe assert the scope is empty by default? I.e.

assertThat(config.getScope()).isEmpty();

ostrya · 2023-01-19T07:34:18Z

I'll just merge and adapt the tests on the main branch.

Adds feature to configure keycloak server with Scopes

6318bc9

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

ostrya requested changes Oct 14, 2022

View reviewed changes

example-backend/bin/.gitignore Outdated Show resolved Hide resolved

mock/src/main/java/com/tngtech/keycloakmock/api/ServerConfig.java Outdated Show resolved Hide resolved

mdanish98 added 2 commits October 16, 2022 21:54

Excludes bin in global .gitignore

2935a6f

Description: - Removes .gitignore from bin folders Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

mdanish98 requested a review from ostrya October 17, 2022 06:46

ostrya requested changes Jan 17, 2023

View reviewed changes

Adds a named singleton to ServerModule

4c9307f

- Inject this named singleton scopes inside TokenHelper - Resets the UrlConfiguration - Adapts to assertJ style assertions - Updates Javadoc Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

mdanish98 requested a review from ostrya January 18, 2023 20:38

ostrya reviewed Jan 19, 2023

View reviewed changes

ostrya approved these changes Jan 19, 2023

View reviewed changes

ostrya merged commit 6ade05e into TNG:main Jan 19, 2023

mdanish98 mentioned this pull request Jan 20, 2023

Includes the ignored secured registry test with keycloak eclipse-basyx/basyx-java-components#233

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds feature to configure keycloak server with Scopes #128

Adds feature to configure keycloak server with Scopes #128

mdanish98 commented Sep 16, 2022

mdanish98 commented Sep 20, 2022

ostrya left a comment

mdanish98 commented Nov 16, 2022

mdanish98 commented Jan 17, 2023 •

edited

Loading

ostrya commented Jan 17, 2023

mdanish98 commented Jan 18, 2023

ostrya left a comment

ostrya Jan 19, 2023

ostrya Jan 19, 2023

ostrya commented Jan 19, 2023


		Set<String> scope = extractScopeFromToken(token);

		assertThat(scope.size()).isEqualTo(3);

	assertThat(scope.size()).isEqualTo(3);
	assertThat(scope).hasSize(3);

Adds feature to configure keycloak server with Scopes #128

Adds feature to configure keycloak server with Scopes #128

Conversation

mdanish98 commented Sep 16, 2022

mdanish98 commented Sep 20, 2022

ostrya left a comment

Choose a reason for hiding this comment

mdanish98 commented Nov 16, 2022

mdanish98 commented Jan 17, 2023 • edited Loading

ostrya commented Jan 17, 2023

mdanish98 commented Jan 18, 2023

ostrya left a comment

Choose a reason for hiding this comment

ostrya Jan 19, 2023

Choose a reason for hiding this comment

ostrya Jan 19, 2023

Choose a reason for hiding this comment

ostrya commented Jan 19, 2023

mdanish98 commented Jan 17, 2023 •

edited

Loading