From 1e61754c29fc99636de692a0fb9d2ef1a4ba9e61 Mon Sep 17 00:00:00 2001 From: "Ben David, Elad (eb7504)" Date: Sun, 3 Nov 2019 17:22:48 +0200 Subject: Align logging to Onap-ELS 2019.11 Change-Id: I1750493d5c9f2eab8c1395f0fbc9ae66cf74b0a6 Issue-ID: SDC-2639 Signed-off-by: Ben David, Elad (eb7504) --- .../backend/openecomp-sdc-security-util/pom.xml | 6 ++ .../filters/SessionValidationFilter.java | 88 +++++++++++++++++----- 2 files changed, 74 insertions(+), 20 deletions(-) (limited to 'openecomp-be/backend/openecomp-sdc-security-util') diff --git a/openecomp-be/backend/openecomp-sdc-security-util/pom.xml b/openecomp-be/backend/openecomp-sdc-security-util/pom.xml index 3b2fd1da53..78fa00a17b 100644 --- a/openecomp-be/backend/openecomp-sdc-security-util/pom.xml +++ b/openecomp-be/backend/openecomp-sdc-security-util/pom.xml @@ -88,6 +88,12 @@ 1.7.4 test + + + org.onap.logging-analytics + logging-slf4j + 1.4.0 + \ No newline at end of file diff --git a/openecomp-be/backend/openecomp-sdc-security-util/src/main/java/org/openecomp/sdc/securityutil/filters/SessionValidationFilter.java b/openecomp-be/backend/openecomp-sdc-security-util/src/main/java/org/openecomp/sdc/securityutil/filters/SessionValidationFilter.java index 1684df4017..de235bff89 100644 --- a/openecomp-be/backend/openecomp-sdc-security-util/src/main/java/org/openecomp/sdc/securityutil/filters/SessionValidationFilter.java +++ b/openecomp-be/backend/openecomp-sdc-security-util/src/main/java/org/openecomp/sdc/securityutil/filters/SessionValidationFilter.java @@ -20,11 +20,14 @@ package org.openecomp.sdc.securityutil.filters; +import org.onap.logging.ref.slf4j.ONAPLogConstants; import org.openecomp.sdc.securityutil.AuthenticationCookieUtils; import org.openecomp.sdc.securityutil.CipherUtilException; import org.openecomp.sdc.securityutil.ISessionValidationFilterConfiguration; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.slf4j.MDC; +import org.apache.commons.lang.StringUtils; import javax.servlet.Filter; import javax.servlet.FilterChain; @@ -38,6 +41,7 @@ import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.Arrays; import java.util.List; +import java.util.UUID; import java.util.concurrent.TimeUnit; import java.util.stream.Collectors; @@ -46,6 +50,19 @@ public abstract class SessionValidationFilter implements Filter { private ISessionValidationFilterConfiguration filterConfiguration; private List excludedUrls; + private static final String REQUEST_ID = ONAPLogConstants.MDCs.REQUEST_ID; + private static final String ONAP_REQUEST_ID_HEADER = ONAPLogConstants.Headers.REQUEST_ID; + private static final String REQUEST_ID_HEADER = "X-RequestID"; + private static final String TRANSACTION_ID_HEADER = "X-TransactionId"; + private static final String ECOMP_REQUEST_ID_HEADER = "X-ECOMP-RequestID"; + + private static final String PARTNER_NAME = ONAPLogConstants.MDCs.PARTNER_NAME; + private static final String USER_ID_HEADER = "USER_ID"; + private static final String ONAP_PARTNER_NAME_HEADER = ONAPLogConstants.Headers.PARTNER_NAME; + private static final String USER_AGENT_HEADER = "User-Agent"; + private static final String UNKNOWN = "UNKNOWN"; + + public abstract ISessionValidationFilterConfiguration getFilterConfiguration(); protected abstract Cookie addRoleToCookie(Cookie updatedCookie); protected abstract boolean isRoleValid(Cookie cookie); @@ -61,51 +78,45 @@ public abstract class SessionValidationFilter implements Filter { final HttpServletRequest httpRequest = (HttpServletRequest) servletRequest; final HttpServletResponse httpResponse = (HttpServletResponse) servletResponse; - long starTime = System.nanoTime(); + long startTime = System.nanoTime(); + fillMDCFromHeaders(httpRequest); log.debug("SessionValidationFilter: Validation started, received request with URL {}", httpRequest.getRequestURL()); // request preprocessing - boolean isContinueProcessing = preProcessingRequest(servletRequest, servletResponse, filterChain, httpRequest, httpResponse); + boolean isContinueProcessing = preProcessingRequest(servletRequest, servletResponse, filterChain, httpRequest, httpResponse, startTime); List cookies = null; + Cookie extractedCookie = null; // request processing if (isContinueProcessing) { cookies = extractAuthenticationCookies(httpRequest.getCookies()); - isContinueProcessing = processRequest(httpRequest, httpResponse, cookies.get(0)); + extractedCookie = cookies.get(0); + isContinueProcessing = processRequest(httpRequest, httpResponse, extractedCookie); } // response processing if(isContinueProcessing){ log.debug("SessionValidationFilter: Cookie from request {} is valid, passing request to session extension ...", httpRequest.getRequestURL()); - Cookie updatedCookie = processResponse(cookies.get(cookies.size()-1)); - + Cookie updatedCookie = processResponse(extractedCookie); cleanResponceFromLeftoverCookies(httpResponse, cookies); - - // Use responce wrapper if servlet remove Cookie header from responce -// OutputStream out = httpResponse.getOutputStream(); -// ResponceWrapper responceWrapper = new ResponceWrapper(httpResponse); - log.debug("SessionValidationFilter: request {} passed all validations, passing request to endpoint ...", httpRequest.getRequestURL()); httpResponse.addCookie(updatedCookie); + long durationSec = TimeUnit.NANOSECONDS.toSeconds(System.nanoTime() - startTime); + long durationMil = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime); + log.debug("SessionValidationFilter: Validation ended, running time for URL {} is: {} seconds {} miliseconds", httpRequest.getPathInfo(), durationSec, durationMil); filterChain.doFilter(servletRequest, httpResponse); - - // Use responce wrapper if servlet remove Cookie header from responce -// responceWrapper.addCookie(updatedCookie); -// httpResponse.setContentLength(responceWrapper.getData().length); -// out.write(responceWrapper.getData()); -// out.close(); } - long durationSec = TimeUnit.NANOSECONDS.toSeconds(System.nanoTime() - starTime); - long durationMil = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - starTime); - log.debug("SessionValidationFilter: Validation ended, running time for URL {} is: {} seconds {} miliseconds", httpRequest.getPathInfo(), durationSec, durationMil); } - private boolean preProcessingRequest(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + private boolean preProcessingRequest(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain, HttpServletRequest httpRequest, HttpServletResponse httpResponse, long startTime) throws IOException, ServletException { boolean isPreProcessingSucceeded = true; if (isUrlFromWhiteList(httpRequest)) { log.debug("SessionValidationFilter: URL {} excluded from access validation , passing request to endpoint ... ", httpRequest.getRequestURL()); + long durationSec = TimeUnit.NANOSECONDS.toSeconds(System.nanoTime() - startTime); + long durationMil = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime); + log.debug("SessionValidationFilter: Validation ended, running time for URL {} is: {} seconds {} miliseconds", httpRequest.getPathInfo(), durationSec, durationMil); filterChain.doFilter(servletRequest, servletResponse); isPreProcessingSucceeded = false; @@ -207,6 +218,43 @@ public abstract class SessionValidationFilter implements Filter { } } + public static void fillMDCFromHeaders(HttpServletRequest httpServletRequest) { + fillRequestIdFromHeader(httpServletRequest); + fillPartnerNameFromHeader(httpServletRequest); + + } + + private static void fillRequestIdFromHeader(HttpServletRequest httpServletRequest){ + if (MDC.get(REQUEST_ID) == null) { + if (StringUtils.isNotEmpty(httpServletRequest.getHeader(ONAP_REQUEST_ID_HEADER))) { + MDC.put(REQUEST_ID, httpServletRequest.getHeader(ONAP_REQUEST_ID_HEADER)); + } else if (StringUtils.isNotEmpty(httpServletRequest.getHeader(REQUEST_ID_HEADER))) { + MDC.put(REQUEST_ID, httpServletRequest.getHeader(REQUEST_ID_HEADER)); + } else if (StringUtils.isNotEmpty(httpServletRequest.getHeader(TRANSACTION_ID_HEADER))) { + MDC.put(REQUEST_ID, httpServletRequest.getHeader(TRANSACTION_ID_HEADER)); + } else if (StringUtils.isNotEmpty(httpServletRequest.getHeader(ECOMP_REQUEST_ID_HEADER))) { + MDC.put(REQUEST_ID, httpServletRequest.getHeader(ECOMP_REQUEST_ID_HEADER)); + } else { + MDC.put(REQUEST_ID, UUID.randomUUID().toString()); + } + } + } + + private static void fillPartnerNameFromHeader(HttpServletRequest httpServletRequest){ + if (MDC.get(PARTNER_NAME) == null) { + if (StringUtils.isNotEmpty(httpServletRequest.getHeader(USER_ID_HEADER))) { + MDC.put(PARTNER_NAME, httpServletRequest.getHeader(USER_ID_HEADER)); + } else if (StringUtils.isNotEmpty(httpServletRequest.getHeader(ONAP_PARTNER_NAME_HEADER))) { + MDC.put(PARTNER_NAME, httpServletRequest.getHeader(ONAP_PARTNER_NAME_HEADER)); + } else if (StringUtils.isNotEmpty(httpServletRequest.getHeader(USER_AGENT_HEADER))) { + MDC.put(PARTNER_NAME, httpServletRequest.getHeader(USER_AGENT_HEADER)); + } else { + MDC.put(PARTNER_NAME, UNKNOWN); + } + } + } + + @Override public void destroy() { -- cgit 1.2.3-korg