global: send notification from event-listener

Author: edivalentinitu

api-service/README.md

@@ -85,3 +85,8 @@ The authentication can be enabled/disabled through this API's config file. Simpl
 Additionally, when the authentication is enabled, it requires **AUTH_SECRET** environment variable, which should be a generated long hash.
 
 **Example**: Generate a hash secret using: ```openssl rand -base64 32```.
+
+## Notifications
+New users that register through this API will have their LDAP/iRODS password generated by this service. The password has to be the same to respect
+CyVerse requirements. There is also the possibility to notify the user by sending this newly generated password per email, by configuring ``mailServiceConfig``.
+The service will work normally without configuring this, just that it will perform a no-op at the **notifications** endpoint.

api-service/src/main/java/com/cyverse/api/controllers/MailController.java

@@ -1,5 +1,6 @@
 package com.cyverse.api.controllers;
 
+import com.cyverse.api.exceptions.ResourceAlreadyExistsException;
 import com.cyverse.api.exceptions.UserException;
 import com.cyverse.api.models.UserModel;
 import com.cyverse.api.services.MailService;
@@ -30,7 +31,7 @@ public MailController(MailService mailService, PasswordService passwordService)
         responses = {@OpenApiResponse(status = "200")}
     )
     public void sendPasswordNotification(Context ctx)
-            throws UserException, MessagingException {
+            throws UserException, MessagingException, ResourceAlreadyExistsException {
         UserModel user = ctx.bodyAsClass(UserModel.class);
         validateUser(user);
         String password = passwordService.getPassword(user.getUsername());

api-service/src/main/java/com/cyverse/api/services/MailService.java

@@ -1,7 +1,8 @@
 package com.cyverse.api.services;
 
+import com.cyverse.api.exceptions.ResourceAlreadyExistsException;
 import jakarta.mail.MessagingException;
 
 public interface MailService {
-    void sendEmail(String email, String password) throws MessagingException;
+    void sendEmail(String email, String password) throws MessagingException, ResourceAlreadyExistsException;
 }

api-service/src/main/java/com/cyverse/api/services/MailServiceImpl.java

@@ -1,6 +1,7 @@
 package com.cyverse.api.services;
 
 import com.cyverse.api.config.MailServiceConfig;
+import com.cyverse.api.exceptions.ResourceAlreadyExistsException;
 import jakarta.mail.Message;
 import jakarta.mail.MessagingException;
 import jakarta.mail.Session;
@@ -10,25 +11,34 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.HashSet;
 import java.util.Properties;
+import java.util.Set;
 
 /**
  * Mail service based on jakarta.mail.
  */
 public class MailServiceImpl implements MailService {
     private static final Logger logger = LoggerFactory.getLogger(MailServiceImpl.class);
     private MailServiceConfig config;
+    private Set<String> mailsAlreadySent;
 
     public MailServiceImpl(MailServiceConfig config) {
         this.config = config;
+        this.mailsAlreadySent = new HashSet<>();
     }
 
     /**
      *  Send the password in an email to the user creating the account, using jakarta.mail
      *  library functionalities.
      */
     @Override
-    public void sendEmail(String emailTo, String password) throws MessagingException {
+    public void sendEmail(String emailTo, String password)
+            throws MessagingException, ResourceAlreadyExistsException {
+        if (mailsAlreadySent.contains(emailTo)) {
+            throw new ResourceAlreadyExistsException("Notification was already sent to this email");
+        }
+
         logger.debug("Sending mail to {} with LDAP/iRODS", emailTo);
 
         String from = config.getFromSender();
@@ -54,6 +64,7 @@ public void sendEmail(String emailTo, String password) throws MessagingException
 
         Transport.send(message);
 
+        this.mailsAlreadySent.add(emailTo);
         logger.debug("Mail sent successfully to {}", emailTo);
     }
 }

api-service/src/main/resources/api-service-config.yml

@@ -9,13 +9,13 @@ ldapServiceConfig:
   password: "notreal"
   baseDN: "dc=example,dc=org"
   everyoneGroup: "everyone"
-#authConfig:
-#  apiKey: "<api_key>"
-#  tokenIssuer: "http://api-service.cyverse.at"
-#  users:
-#    test_user:
-#      mail: "test.user@example.com"
-#      password: "testpass"
+authConfig:
+  apiKey: "<api_key>"
+  tokenIssuer: "http://api-service.cyverse.at"
+  users:
+    test_user:
+      mail: "test.user@example.com"
+      password: "testpass"
 userPortalServiceConfig:
   host: http://192.168.31.115:3000
   hmacKey: <SECRET> # portal equivalent in ENV config: HMAC_KEY

event-listener/src/main/java/com/cyverse/keycloak/KeycloakLoginListener.java

@@ -2,6 +2,7 @@
 
 import com.cyverse.keycloak.irods.service.IrodsService;
 import com.cyverse.keycloak.ldap.service.LdapService;
+import com.cyverse.keycloak.notification.service.NotificationService;
 import com.cyverse.keycloak.portal.service.UserPortalService;
 import org.jboss.logging.Logger;
 import org.keycloak.events.Event;
@@ -23,15 +24,18 @@ public class KeycloakLoginListener implements EventListenerProvider {
     private final LdapService ldapService;
     private final IrodsService irodsService;
     private final UserPortalService userPortalService;
+    private final NotificationService notificationService;
 
     public KeycloakLoginListener(KeycloakSession session,
                                  LdapService ldapService,
                                  IrodsService irodsService,
-                                 UserPortalService userPortalService) {
+                                 UserPortalService userPortalService,
+                                 NotificationService notificationService) {
         this.session = session;
         this.ldapService = ldapService;
         this.irodsService = irodsService;
         this.userPortalService = userPortalService;
+        this.notificationService = notificationService;
     }
 
     private void performLdapActions(UserModel user) {
@@ -54,6 +58,10 @@ private void performUserPortalActions(UserModel user) {
         userPortalService.addUserToPortal(user);
     }
 
+    private void performNotificationActions(UserModel user) {
+        notificationService.notifyUser(user);
+    }
+
     /**
      * Perform actions based on keycloak events.
      * Actions supported in this implementation: LDAP User update, iRODS account
@@ -75,6 +83,7 @@ public void onEvent(Event event) {
             performLdapActions(user);
             performIrodsActions(user);
             performUserPortalActions(user);
+            performNotificationActions(user);
         }
     }
 

event-listener/src/main/java/com/cyverse/keycloak/KeycloakLoginListenerFactory.java

@@ -7,6 +7,9 @@
 import com.cyverse.keycloak.irods.service.IrodsServiceImpl;
 import com.cyverse.keycloak.irods.service.NoOpIrodsServiceImpl;
 import com.cyverse.keycloak.ldap.service.LdapService;
+import com.cyverse.keycloak.notification.service.NoOpNotificationServiceImpl;
+import com.cyverse.keycloak.notification.service.NotificationService;
+import com.cyverse.keycloak.notification.service.NotificationServiceImpl;
 import com.cyverse.keycloak.portal.service.NoOpUserPortalServiceImpl;
 import com.cyverse.keycloak.portal.service.UserPortalService;
 import com.cyverse.keycloak.portal.service.UserPortalServiceImpl;
@@ -30,10 +33,11 @@ public class KeycloakLoginListenerFactory implements EventListenerProviderFactor
     private LdapService ldapService;
     private IrodsService irodsService;
     private UserPortalService userPortalService;
+    private NotificationService notificationService;
 
     @Override
     public EventListenerProvider create(KeycloakSession session) {
-        return new KeycloakLoginListener(session, ldapService, irodsService, userPortalService);
+        return new KeycloakLoginListener(session, ldapService, irodsService, userPortalService, notificationService);
     }
 
     private boolean testConnection(ListenerHttpClientBase httpClient) {
@@ -77,10 +81,12 @@ public void init(Config.Scope config) {
             irodsService = new IrodsServiceImpl(httpClient);
             ldapService = new LdapServiceImpl(httpClient);
             userPortalService = new UserPortalServiceImpl(httpClient);
+            notificationService = new NotificationServiceImpl(httpClient);
         } else {
             irodsService = new NoOpIrodsServiceImpl();
             ldapService = new NoOpLdapServiceImpl();
             userPortalService = new NoOpUserPortalServiceImpl();
+            notificationService = new NoOpNotificationServiceImpl();
         }
     }
 

event-listener/src/main/java/com/cyverse/keycloak/notification/service/NoOpNotificationServiceImpl.java

@@ -0,0 +1,13 @@
+package com.cyverse.keycloak.notification.service;
+
+import org.jboss.logging.Logger;
+import org.keycloak.models.UserModel;
+
+public class NoOpNotificationServiceImpl implements NotificationService {
+    private static final Logger logger = Logger.getLogger(NoOpNotificationServiceImpl.class);
+
+    @Override
+    public void notifyUser(UserModel user) {
+        logger.error("No operation possible. Check other dependencies for failures.");
+    }
+}

event-listener/src/main/java/com/cyverse/keycloak/notification/service/NotificationService.java

@@ -0,0 +1,7 @@
+package com.cyverse.keycloak.notification.service;
+
+import org.keycloak.models.UserModel;
+
+public interface NotificationService {
+    void notifyUser(UserModel user);
+}

event-listener/src/main/java/com/cyverse/keycloak/notification/service/NotificationServiceImpl.java

@@ -0,0 +1,54 @@
+package com.cyverse.keycloak.notification.service;
+
+import com.cyverse.keycloak.http.ListenerHttpClientBase;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.http.HttpStatus;
+import org.jboss.logging.Logger;
+import org.keycloak.models.UserModel;
+
+import java.io.IOException;
+import java.net.http.HttpResponse;
+import java.util.Map;
+
+public class NotificationServiceImpl implements NotificationService {
+    private static final Logger logger = Logger.getLogger(NoOpNotificationServiceImpl.class);
+    private final ListenerHttpClientBase httpClient;
+
+    private static final String NOTIFICATION_USERS_ENDPOINT = "/api/users/notification";
+
+    public NotificationServiceImpl(ListenerHttpClientBase httpClient) {
+        this.httpClient = httpClient;
+    }
+
+    @Override
+    public void notifyUser(UserModel user) {
+        logger.debug("Try notifying user: " + user.getUsername());
+
+        ObjectMapper mapper = new ObjectMapper();
+        Map<String, Object> data = Map.of(
+                "username", user.getUsername(),
+                "email", user.getEmail()
+        );
+
+        try {
+            String jsonBody = mapper.writeValueAsString(data);
+
+            HttpResponse<String> response =
+                    httpClient.getHttpClient()
+                            .send(httpClient
+                                            .getRequestPUT(NOTIFICATION_USERS_ENDPOINT, jsonBody),
+                                    HttpResponse.BodyHandlers.ofString());
+
+            logger.debug("API RESPONSE STATUS CODE: " + response.statusCode());
+
+            if (response.statusCode() == HttpStatus.SC_OK) {
+                logger.info("Successfully notified user " + user.getUsername());
+            }
+        } catch (JsonProcessingException jsonExc) {
+            logger.error("Got exception trying to build API client body data: " + user.getUsername() + "\n" + jsonExc.getMessage());
+        } catch (IOException | InterruptedException httpExc) {
+            logger.error("Got exception from HTTP request to API client: " + httpExc.getMessage());
+        }
+    }
+}