Print the User Information in catalina files while the log level is INFO (#276)

* Print the User Information in catalina files while the log level is INFO
---------

Co-authored-by: Vishnu Alapati <zalavis@seliiuts03320.seli.gic.ericsson.se>

Author: vishnu-alapati

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 2.1.1
 - Implemented the changes to log the eventId and HTTPStatus while the level is INFO.
+- Implemented the changes to print the user information while the log level is INFO.
 
 ## 2.1.0
 - Implemented new routing key template for Sepia.

publish-service/src/main/java/com/ericsson/eiffel/remrem/publish/config/CustomAuthenticationEntryPoint.java

@@ -0,0 +1,31 @@
+package com.ericsson.eiffel.remrem.publish.config;
+
+import java.io.IOException;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.security.authentication.BadCredentialsException;
+import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.web.AuthenticationEntryPoint;
+import org.springframework.stereotype.Component;
+
+@Component
+public class CustomAuthenticationEntryPoint implements AuthenticationEntryPoint {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(
+            CustomAuthenticationEntryPoint.class);
+
+    @Override
+    public void commence(HttpServletRequest request, HttpServletResponse response,
+            AuthenticationException authException) throws IOException, ServletException {
+        if (authException instanceof BadCredentialsException) {
+            LOGGER.warn("Bad Credentials {}", HttpStatus.UNAUTHORIZED);
+            response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Invalid credentials");
+        }
+    }
+}

publish-service/src/main/java/com/ericsson/eiffel/remrem/publish/config/SecurityConfig.java

@@ -21,7 +21,6 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Profile;
 import org.springframework.ldap.core.support.BaseLdapPathContextSource;
@@ -72,14 +71,20 @@ public Integer getTimeOut() {
         return ldapTimeOut;
     }
 
+    @Autowired
+    private CustomAuthenticationEntryPoint customAuthenticationEntryPoint;
+
     @Autowired
     protected void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
         final String jasyptKey = RabbitMqPropertiesConfig.readJasyptKeyFile(jasyptKeyFilePath);
         if (managerPassword.startsWith("{ENC(") && managerPassword.endsWith("}")) {
-            managerPassword = DecryptionUtils.decryptString(managerPassword.substring(1, managerPassword.length() - 1), jasyptKey);
+            managerPassword = DecryptionUtils.decryptString(
+                    managerPassword.substring(1, managerPassword.length() - 1), jasyptKey);
         }
         LOGGER.debug("LDAP server url: " + ldapUrl);
-        auth.ldapAuthentication().userSearchFilter(userSearchFilter).contextSource(ldapContextSource());
+        auth.ldapAuthentication()
+            .userSearchFilter(userSearchFilter)
+            .contextSource(ldapContextSource());
     }
 
     public BaseLdapPathContextSource ldapContextSource() {
@@ -98,6 +103,14 @@ public BaseLdapPathContextSource ldapContextSource() {
     @Override
     protected void configure(HttpSecurity http) throws Exception {
         LOGGER.debug("LDAP authentication enabled");
-        http.authorizeRequests().anyRequest().authenticated().and().httpBasic().and().csrf().disable();
+        http.authorizeRequests()
+            .anyRequest()
+            .authenticated()
+            .and()
+            .httpBasic()
+            .authenticationEntryPoint(customAuthenticationEntryPoint)
+            .and()
+            .csrf()
+            .disable();
     }
 }

publish-service/src/main/java/com/ericsson/eiffel/remrem/publish/controller/ProducerController.java

@@ -16,15 +16,20 @@
 
 import java.util.EnumSet;
 import java.util.Map;
+
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.userdetails.UserDetails;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
@@ -35,13 +40,13 @@
 import org.springframework.web.client.RestTemplate;
 
 import com.ericsson.eiffel.remrem.protocol.MsgService;
+import com.ericsson.eiffel.remrem.publish.exception.RemRemPublishException;
 import com.ericsson.eiffel.remrem.publish.helper.PublishUtils;
 import com.ericsson.eiffel.remrem.publish.helper.RMQHelper;
 import com.ericsson.eiffel.remrem.publish.service.EventTemplateHandler;
+import com.ericsson.eiffel.remrem.publish.service.GenerateURLTemplate;
 import com.ericsson.eiffel.remrem.publish.service.MessageService;
 import com.ericsson.eiffel.remrem.publish.service.SendResult;
-import com.ericsson.eiffel.remrem.publish.service.GenerateURLTemplate;
-import com.ericsson.eiffel.remrem.publish.exception.RemRemPublishException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
@@ -73,6 +78,9 @@ public class ProducerController {
     @Autowired
     private GenerateURLTemplate generateURLTemplate;
 
+    @Value("${activedirectory.publish.enabled}")
+    private boolean isAuthenticationEnabled;
+
     private RestTemplate restTemplate = new RestTemplate();
 
     private JsonParser parser = new JsonParser();
@@ -87,6 +95,18 @@ public void setRestTemplate(RestTemplate restTemplate) {
         this.restTemplate = restTemplate;
     }
 
+    public void logUserName() {
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        // Check if the user is authenticated
+        if (authentication != null && authentication.isAuthenticated()) {
+            // Get the UserDetails object, which contains user information
+            UserDetails userDetails = (UserDetails) authentication.getPrincipal();
+            // Get the username of the authenticated user
+            String username = userDetails.getUsername();
+            log.info("User name: {} ", username);
+        }
+    }
+
     @SuppressWarnings({ "rawtypes", "unchecked" })
     @ApiOperation(value = "To publish eiffel event to message bus", response = String.class)
     @ApiResponses(value = { @ApiResponse(code = 200, message = "Event sent successfully"),
@@ -96,22 +116,30 @@ public void setRestTemplate(RestTemplate restTemplate) {
             @ApiResponse(code = 503, message = "Service Unavailable") })
     @RequestMapping(value = "/producer/msg", method = RequestMethod.POST)
     @ResponseBody
-    public ResponseEntity send(@ApiParam(value = "message protocol", required = true) @RequestParam(value = "mp") final String msgProtocol,
-                               @ApiParam(value = "user domain") @RequestParam(value = "ud", required = false) final String userDomain,
-                               @ApiParam(value = "tag") @RequestParam(value = "tag", required = false) final String tag,
-                               @ApiParam(value = "routing key") @RequestParam(value = "rk", required = false) final String routingKey,
-                               @ApiParam(value = "eiffel event", required = true) @RequestBody final JsonElement body) {
+    public ResponseEntity send(
+            @ApiParam(value = "message protocol", required = true) @RequestParam(value = "mp") final String msgProtocol,
+            @ApiParam(value = "user domain") @RequestParam(value = "ud", required = false) final String userDomain,
+            @ApiParam(value = "tag") @RequestParam(value = "tag", required = false) final String tag,
+            @ApiParam(value = "routing key") @RequestParam(value = "rk", required = false) final String routingKey,
+            @ApiParam(value = "eiffel event", required = true) @RequestBody final JsonElement body) {
+        if(isAuthenticationEnabled) {
+            logUserName();
+        }
+
         MsgService msgService = PublishUtils.getMessageService(msgProtocol, msgServices);
         log.debug("mp: " + msgProtocol);
         log.debug("body: " + body);
-        log.debug("user domain suffix: " + userDomain + " tag: " + tag + " Routing Key: " + routingKey);
+        log.debug("user domain suffix: " + userDomain + " tag: " + tag + " Routing Key: "
+                + routingKey);
+
         if (msgService != null && msgProtocol != null) {
             try {
                 rmqHelper.rabbitMqPropertiesInit(msgProtocol);
             } catch (RemRemPublishException e) {
                 return new ResponseEntity(e.getMessage(), HttpStatus.NOT_FOUND);
             }
-        } synchronized(this) {
+        }
+        synchronized (this) {
             SendResult result = messageService.send(body, msgService, userDomain, tag, routingKey);
             log.info("HTTP Status: {}",  messageService.getHttpStatus().value());
             return new ResponseEntity(result, messageService.getHttpStatus());
@@ -166,6 +194,9 @@ public ResponseEntity generateAndPublish(@ApiParam(value = "message protocol", r
                                                      + "event fields from the input event data that does not validate successfully, "
                                                      + "and add those removed field information into customData/remremGenerateFailures") @RequestParam(value = "okToLeaveOutInvalidOptionalFields", required = false, defaultValue = "false")  final Boolean okToLeaveOutInvalidOptionalFields,
                                              @ApiParam(value = "JSON message", required = true) @RequestBody final JsonObject bodyJson) {
+        if (isAuthenticationEnabled) {
+            logUserName();
+        }
 
         String bodyJsonOut = null;
         if(parseData) {