upgrade project dependencies (including keycloak to 23.0.3) and refractor

api-key-module/pom.xml

@@ -10,7 +10,7 @@
 
     <properties>
         <java.version>11</java.version>
-        <keycloak.version>21.0.1</keycloak.version>
+        <keycloak.version>23.0.3</keycloak.version>
     </properties>
 
     <dependencies>
@@ -32,16 +32,10 @@
             <version>${keycloak.version}</version>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.jboss.spec.javax.ws.rs</groupId>
-            <artifactId>jboss-jaxrs-api_2.0_spec</artifactId>
-            <version>1.0.0.Final</version>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>com.amazonaws</groupId>
             <artifactId>aws-java-sdk-ses</artifactId>
-            <version>1.11.538</version>
+            <version>1.12.472</version>
         </dependency>
     </dependencies>
 

api-key-module/src/main/java/com/gwidgets/providers/ApiKeyResourceProvider.java

@@ -6,8 +6,7 @@ import org.keycloak.services.resource.RealmResourceProvider;
 
 public class ApiKeyResourceProvider implements RealmResourceProvider {
 
-
+    private final KeycloakSession session;
-    private KeycloakSession session;
 
     public ApiKeyResourceProvider(KeycloakSession session) {
         this.session = session;
@@ -17,7 +16,5 @@ public class ApiKeyResourceProvider implements RealmResourceProvider {
         return new ApiKeyResource(session);
     }
 
-    public void close() {
+    public void close() {}
-
-    }
 }

api-key-module/src/main/java/com/gwidgets/providers/ApiKeyResourceProviderFactory.java

@@ -8,23 +8,15 @@ import org.keycloak.services.resource.RealmResourceProviderFactory;
 
 public class ApiKeyResourceProviderFactory implements RealmResourceProviderFactory {
 
-
     public RealmResourceProvider create(KeycloakSession session) {
         return new ApiKeyResourceProvider(session);
     }
 
-    public void init(Config.Scope config) {
+    public void init(Config.Scope config) {}
 
+    public void postInit(KeycloakSessionFactory factory) {}
 
-    }
+    public void close() {}
-
-    public void postInit(KeycloakSessionFactory factory) {
-
-    }
-
-    public void close() {
-
-    }
 
     public String getId() {
         return "check";

api-key-module/src/main/java/com/gwidgets/providers/RegisterEventListenerProvider.java

@@ -1,9 +1,7 @@
 package com.gwidgets.providers;
 
 
-import java.util.Objects;
+import jakarta.persistence.EntityManager;
-import java.util.UUID;
-import javax.persistence.EntityManager;
 import org.keycloak.common.util.SecretGenerator;
 import org.keycloak.connections.jpa.JpaConnectionProvider;
 import org.keycloak.events.Event;
@@ -13,22 +11,18 @@ import org.keycloak.events.admin.AdminEvent;
 import org.keycloak.events.admin.OperationType;
 import org.keycloak.events.admin.ResourceType;
 import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.RealmModel;
-import org.keycloak.models.RealmProvider;
 import org.keycloak.models.jpa.entities.UserAttributeEntity;
 import org.keycloak.models.jpa.entities.UserEntity;
 
-public class RegisterEventListenerProvider implements EventListenerProvider  {
+import java.util.Objects;
+import java.util.UUID;
 
-    private KeycloakSession session;
+public class RegisterEventListenerProvider implements EventListenerProvider  {
-    private RealmProvider model;
+    //keycloak utility to generate random strings, anything can be used e.g. UUID,...
-    //keycloak utility to generate random strings, anything can be used e.g UUID,..
+    private final SecretGenerator secretGenerator;
-    private SecretGenerator secretGenerator;
+    private final EntityManager entityManager;
-    private EntityManager entityManager;
 
     public RegisterEventListenerProvider(KeycloakSession session) {
-        this.session = session;
-        this.model = session.realms();
         this.entityManager = session.getProvider(JpaConnectionProvider.class).getEntityManager();
         this.secretGenerator = SecretGenerator.getInstance();
     }
@@ -36,7 +30,6 @@ public class RegisterEventListenerProvider implements EventListenerProvider  {
     public void onEvent(Event event) {
         //we are only interested in the register event
         if (event.getType().equals(EventType.REGISTER)) {
-            RealmModel realm = model.getRealm(event.getRealmId());
             String userId = event.getUserId();
             addApiKeyAttribute(userId);
         }
@@ -66,7 +59,5 @@ public class RegisterEventListenerProvider implements EventListenerProvider  {
     }
 
     @Override
-    public void close() {
+    public void close() {}
-
-    }
 }

api-key-module/src/main/java/com/gwidgets/providers/RegisterEventListenerProviderFactory.java

@@ -12,15 +12,11 @@ public class RegisterEventListenerProviderFactory implements EventListenerProvid
         return new RegisterEventListenerProvider(keycloakSession);
     }
 
-    public void init(Config.Scope scope) {
+    public void init(Config.Scope scope) {}
-    }
 
-    public void postInit(KeycloakSessionFactory keycloakSessionFactory) {
+    public void postInit(KeycloakSessionFactory keycloakSessionFactory) {}
 
-    }
+    public void close() {}
-
-    public void close() {
-    }
 
     public String getId() {
         return "api-key-registration-generation";

api-key-module/src/main/java/com/gwidgets/providers/SESEmailSenderProvider.java

@@ -31,7 +31,6 @@ public class SESEmailSenderProvider implements EmailSenderProvider {
 
   @Override
   public void send(Map<String, String> config, String address, String subject, String textBody, String htmlBody) throws EmailException {
-
     log.info("attempting to send email using aws ses for " + address);
 
     Message message = new Message().withSubject(new Content().withData(subject))
@@ -47,7 +46,5 @@ public class SESEmailSenderProvider implements EmailSenderProvider {
   }
 
   @Override
-  public void close() {
+  public void close() {}
-
-  }
 }

api-key-module/src/main/java/com/gwidgets/providers/SESEmailSenderProviderFactory.java

@@ -16,7 +16,6 @@ public class SESEmailSenderProviderFactory implements EmailSenderProviderFactory
 
   @Override
   public EmailSenderProvider create(KeycloakSession session) {
-
     //using singleton pattern to avoid creating the client each time create is called
     if (sesClientInstance == null) {
       String awsRegion = Objects.requireNonNull(System.getenv("AWS_REGION"));
@@ -32,16 +31,13 @@ public class SESEmailSenderProviderFactory implements EmailSenderProviderFactory
   }
 
   @Override
-  public void init(Scope config) {
+  public void init(Scope config) {}
-
-  }
 
   @Override
-  public void postInit(KeycloakSessionFactory factory) { }
+  public void postInit(KeycloakSessionFactory factory) {}
 
   @Override
-  public void close() {
+  public void close() {}
-  }
 
   @Override
   public String getId() {

api-key-module/src/main/java/com/gwidgets/resources/ApiKeyResource.java

@@ -1,32 +1,27 @@
 package com.gwidgets.resources;
 
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import jakarta.ws.rs.ext.Provider;
 import org.keycloak.models.KeycloakSession;
-import org.keycloak.models.UserModel;
-
-import javax.ws.rs.GET;
-import javax.ws.rs.Produces;
-import javax.ws.rs.QueryParam;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-import java.util.Objects;
-import java.util.stream.Stream;
 
+@Provider
 public class ApiKeyResource {
 
-    private KeycloakSession session;
+    private final KeycloakSession session;
-
-    private final String realmName;
 
     public ApiKeyResource(KeycloakSession session) {
         this.session = session;
-        String envRealmName = System.getenv("REALM_NAME");
-        this.realmName = Objects.isNull(envRealmName) || Objects.equals(System.getenv(envRealmName), "")? "example": envRealmName;
     }
 
     @GET
     @Produces("application/json")
     public Response checkApiKey(@QueryParam("apiKey") String apiKey) {
-        Stream<UserModel> result = session.users().searchForUserByUserAttributeStream(session.realms().getRealm(realmName), "api-key", apiKey);
+        return session.users().searchForUserByUserAttributeStream(session.getContext().getRealm(), "api-key", apiKey)
-        return result.count() > 0 ? Response.ok().type(MediaType.APPLICATION_JSON).build(): Response.status(401).type(MediaType.APPLICATION_JSON).build();
+                .findFirst().isPresent() ? Response.ok().type(MediaType.APPLICATION_JSON).build():
+                Response.status(401).type(MediaType.APPLICATION_JSON).build();
     }
 }

dashboard-service/Dockerfile

@@ -9,7 +9,7 @@
 
 #RUN mvn clean package
 
-FROM openjdk:11-jre-slim
+FROM openjdk:17-alpine
 
 ARG VERSION=0.1
 

dashboard-service/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>2.1.0.RELEASE</version>
+		<version>2.7.18</version>
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
 	<groupId>com.gwidgets</groupId>
@@ -15,8 +15,8 @@
 	<description>Demo project for Spring Boot</description>
 
 	<properties>
-		<java.version>11</java.version>
+		<java.version>17</java.version>
-		<keycloak.version>21.0.1</keycloak.version>
+		<keycloak.version>23.0.3</keycloak.version>
 	</properties>
 
 	<dependencies>
@@ -56,6 +56,7 @@
 			<plugin>
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
+				<version>2.7.18</version>
 			</plugin>
 		</plugins>
 	</build>

dashboard-service/src/main/java/com/gwidgets/DashboardServiceApplication.java

@@ -1,11 +1,19 @@
 package com.gwidgets;
 
+import org.keycloak.adapters.KeycloakConfigResolver;
+import org.keycloak.adapters.springboot.KeycloakSpringBootConfigResolver;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
 
 @SpringBootApplication
 public class DashboardServiceApplication {
 	public static void main(String[] args) {
 		SpringApplication.run(DashboardServiceApplication.class, args);
 	}
+
+	@Bean
+	public KeycloakConfigResolver keycloakConfigResolver() {
+		return new KeycloakSpringBootConfigResolver();
+	}
 }

dashboard-service/src/main/java/com/gwidgets/SecurityConfiguration.java

@@ -1,9 +1,8 @@
 package com.gwidgets;
 
-import java.security.Principal;
 import org.keycloak.KeycloakPrincipal;
 import org.keycloak.KeycloakSecurityContext;
-import org.keycloak.adapters.KeycloakConfigResolver;
+import org.keycloak.adapters.springboot.KeycloakSpringBootProperties;
 import org.keycloak.adapters.springsecurity.KeycloakConfiguration;
 import org.keycloak.adapters.springsecurity.authentication.KeycloakAuthenticationProvider;
 import org.keycloak.adapters.springsecurity.config.KeycloakWebSecurityConfigurerAdapter;
@@ -22,20 +21,14 @@ import org.springframework.security.web.authentication.session.SessionAuthentica
 import org.springframework.web.context.WebApplicationContext;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
-import org.keycloak.adapters.springboot.KeycloakSpringBootConfigResolver;
+
-import org.keycloak.adapters.springboot.KeycloakSpringBootProperties;
+import java.security.Principal;
 
 
 @EnableConfigurationProperties(KeycloakSpringBootProperties.class)
 @KeycloakConfiguration
 public class SecurityConfiguration extends KeycloakWebSecurityConfigurerAdapter {
 
-
-  @Bean
-  public KeycloakConfigResolver keycloakConfigResolver() {
-    return new KeycloakSpringBootConfigResolver();
-  }
-
   @Override
   protected void configure(HttpSecurity http) throws Exception {
     super.configure(http);
@@ -45,7 +38,6 @@ public class SecurityConfiguration extends KeycloakWebSecurityConfigurerAdapter
 
   @Autowired
   public void configureGlobal(AuthenticationManagerBuilder auth) {
-
     KeycloakAuthenticationProvider keycloakAuthenticationProvider = keycloakAuthenticationProvider();
 
     SimpleAuthorityMapper grantedAuthorityMapper = new SimpleAuthorityMapper();
@@ -65,7 +57,6 @@ public class SecurityConfiguration extends KeycloakWebSecurityConfigurerAdapter
   @Bean
   @Scope(scopeName = WebApplicationContext.SCOPE_REQUEST, proxyMode = ScopedProxyMode.TARGET_CLASS)
   public KeycloakSecurityContext getKeycloakSecurityContext() {
-
     ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
     Principal principal = attributes.getRequest().getUserPrincipal();
     if (principal == null) {

docker-compose.yaml

@@ -1,7 +1,7 @@
 version: '3.8'
 services:
   auth-server:
-    image: quay.io/keycloak/keycloak:21.0.1
+    image: quay.io/keycloak/keycloak:23.0.3
     environment:
       KEYCLOAK_ADMIN: admin
       KEYCLOAK_ADMIN_PASSWORD: admin

rest-api-service/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:11-alpine
+FROM node:14-alpine
 
 COPY index.js .
 COPY package.json .

rest-api-service/index.js

@@ -13,6 +13,7 @@ app.use(function (req, res, next) {
     console.log(`checking api key ${apiKey}, auth server ${authServer}`)
 
     http.get("http://"+authServer+"/auth/realms/"+realmName+"/check?apiKey="+apiKey, (authResponse) => {
+        console.log(`received ${authResponse.statusCode} status from Keycloak`)
        if (authResponse.statusCode == 200) {
            next()
        } else {

rest-api-service/package.json

@@ -9,7 +9,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "express": "^4.17.1",
+    "express": "^4.17.3",
     "http": "0.0.0"
   },
   "devDependencies": {}