Merge pull request #110 from networknt/issue109

stevehu · web-flow · commit f19ea798f579 · 2024-07-08T16:21:50.000-04:00
fixes #109 All header access by key should be case insensitive
diff --git a/pom.xml b/pom.xml
@@ -112,6 +112,16 @@
             <artifactId>status</artifactId>
             <version>${version.light-4j}</version>
         </dependency>
+        <dependency>
+            <groupId>com.networknt</groupId>
+            <artifactId>cluster</artifactId>
+            <version>${version.light-4j}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.networknt</groupId>
+            <artifactId>monad-result</artifactId>
+            <version>${version.light-4j}</version>
+        </dependency>
         <dependency>
             <groupId>com.networknt</groupId>
             <artifactId>env-config</artifactId>
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/audit/AuditMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/audit/AuditMiddleware.java
@@ -9,6 +9,7 @@
 import com.networknt.config.JsonMapper;
 import com.networknt.mask.Mask;
 import com.networknt.status.Status;
+import com.networknt.utility.MapUtil;
 import com.networknt.utility.ModuleRegistry;
 import com.networknt.utility.StringUtils;
 import org.slf4j.Logger;
@@ -159,9 +160,13 @@ private void auditRequest(LightLambdaExchange exchange, Map<String, Object> audi
 
     private void auditHeader(LightLambdaExchange exchange, Map<String, Object> auditMap) {
         for (String name : CONFIG.getHeaderList()) {
-            String value = exchange.getRequest().getHeaders().get(name);
-            if(LOG.isTraceEnabled()) LOG.trace("header name = " + name + " header value = " + value);
-            auditMap.put(name, CONFIG.isMask() ? Mask.maskRegex(value, "requestHeader", name) : value);
+            Optional<String> optionalValue = MapUtil.getValueIgnoreCase(exchange.getRequest().getHeaders(), name);
+            if(optionalValue.isEmpty()) {
+                if(LOG.isTraceEnabled()) LOG.trace("header name = {} header value is null", name);
+                continue;
+            }
+            if(LOG.isTraceEnabled()) LOG.trace("header name = {} header value = {}", name, optionalValue.get());
+            auditMap.put(name, CONFIG.isMask() ? Mask.maskRegex(optionalValue.get(), "requestHeader", name) : optionalValue.get());
         }
     }
 
@@ -170,8 +175,9 @@ private void auditRequestBody(LightLambdaExchange exchange, Map<String, Object>
         String requestBodyString = exchange.getRequest().getBody();
         // Mask requestBody json string if mask enabled
         if (requestBodyString != null && !requestBodyString.isEmpty()) {
-            String contentType = exchange.getRequest().getHeaders().get(HeaderKey.CONTENT_TYPE);
-            if(contentType != null) {
+            Optional<String> optionalContentType = MapUtil.getValueIgnoreCase(exchange.getRequest().getHeaders(), HeaderKey.CONTENT_TYPE);
+            if(optionalContentType.isPresent()) {
+                String contentType = optionalContentType.get();
                 if(contentType.startsWith("application/json")) {
                     if(CONFIG.isMask()) requestBodyString = Mask.maskJson(requestBodyString, REQUEST_BODY_KEY);
                 } else if(contentType.startsWith("text") || contentType.startsWith("application/xml")) {
@@ -192,8 +198,9 @@ private void auditResponseBody(LightLambdaExchange exchange, Map<String, Object>
         String responseBodyString = exchange.getResponse().getBody();
         // mask the response body json string if mask is enabled.
         if(responseBodyString != null && !responseBodyString.isEmpty()) {
-            String contentType = exchange.getResponse().getHeaders().get(HeaderKey.CONTENT_TYPE);
-            if(contentType != null) {
+            Optional<String> optionalContentType = MapUtil.getValueIgnoreCase(exchange.getResponse().getHeaders(), HeaderKey.CONTENT_TYPE);
+            if(optionalContentType.isPresent()) {
+                String contentType = optionalContentType.orElse(null);
                 if(contentType.startsWith("application/json")) {
                     if(CONFIG.isMask()) responseBodyString =Mask.maskJson(responseBodyString, RESPONSE_BODY_KEY);
                 } else if(contentType.startsWith("text") || contentType.startsWith("application/xml")) {
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/correlation/CorrelationMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/correlation/CorrelationMiddleware.java
@@ -6,6 +6,7 @@
 import com.networknt.config.Config;
 import com.networknt.correlation.CorrelationConfig;
 import com.networknt.status.Status;
+import com.networknt.utility.MapUtil;
 import com.networknt.utility.ModuleRegistry;
 import org.apache.commons.codec.binary.Base64;
 import org.slf4j.Logger;
@@ -14,6 +15,7 @@
 
 import java.nio.ByteBuffer;
 import java.util.HashMap;
+import java.util.Optional;
 import java.util.UUID;
 
 
@@ -34,15 +36,17 @@ public Status execute(final LightLambdaExchange exchange) {
         // check if the cid is in the request header
         String cid = null;
         if(exchange.getRequest().getHeaders() != null) {
-            cid = exchange.getRequest().getHeaders().get(HeaderKey.CORRELATION);
+            Optional<String> optionalCid = MapUtil.getValueIgnoreCase(exchange.getRequest().getHeaders(), HeaderKey.CORRELATION);
+            cid = optionalCid.orElse(null);
         } else {
             exchange.getRequest().setHeaders(new HashMap<>());
         }
         if (cid == null && CONFIG.isAutogenCorrelationID()) {
             cid = this.getUUID();
             exchange.getRequest().getHeaders().put(HeaderKey.CORRELATION, cid);
             exchange.addAttachment(CORRELATION_ATTACHMENT_KEY, cid);
-            String tid = exchange.getRequest().getHeaders().get(HeaderKey.TRACEABILITY);
+            Optional<String> optionalTid = MapUtil.getValueIgnoreCase(exchange.getRequest().getHeaders(), HeaderKey.TRACEABILITY);
+            String tid = optionalTid.orElse(null);
             if (tid != null && LOG.isInfoEnabled())
                 LOG.info("Associate traceability Id {} with correlation Id {}", tid, cid);
         }
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/limit/key/AkamaiAddressKeyResolver.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/limit/key/AkamaiAddressKeyResolver.java
@@ -1,8 +1,10 @@
 package com.networknt.aws.lambda.handler.middleware.limit.key;
 
 import com.networknt.aws.lambda.LightLambdaExchange;
+import com.networknt.utility.MapUtil;
 
 import java.util.Map;
+import java.util.Optional;
 
 /**
  * When native-lambda is used for external clients and all external requests go through the
@@ -16,8 +18,8 @@ public class AkamaiAddressKeyResolver implements KeyResolver {
     public String resolve(LightLambdaExchange exchange) {
         String key = "127.0.0.1";
         Map<String, String> headerMap = exchange.getResponse().getHeaders();
-        String value = headerMap.get("True-Client-IP");
-        if(value != null) key = value;
+        Optional<String> valueString = MapUtil.getValueIgnoreCase(headerMap, "True-Client-IP");
+        if(valueString.isPresent()) key = valueString.get();
         return key;
     }
 }
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/limit/key/JwtHeaderClientIdKeyResolver.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/limit/key/JwtHeaderClientIdKeyResolver.java
@@ -3,8 +3,10 @@
 import com.networknt.aws.lambda.LightLambdaExchange;
 import com.networknt.aws.lambda.handler.middleware.audit.AuditMiddleware;
 import com.networknt.utility.Constants;
+import com.networknt.utility.MapUtil;
 
 import java.util.Map;
+import java.util.Optional;
 
 /**
  * This is a customized KeyResolver for one of our customers on the external gateway in the DMZ.
@@ -27,8 +29,8 @@ public String resolve(LightLambdaExchange exchange) {
         if(key == null) {
             // try to get the key from the header
             Map<String, String> headerMap = exchange.getRequest().getHeaders();
-            String value = headerMap.get("Client-Id");
-            if(value != null) key = value;
+            Optional<String> optionalValue = MapUtil.getValueIgnoreCase(headerMap, "Client-Id");
+            if(optionalValue.isPresent()) key = optionalValue.get();
         }
         return key;
     }
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/sanitizer/SanitizerMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/sanitizer/SanitizerMiddleware.java
@@ -49,18 +49,21 @@ public Status execute(LightLambdaExchange exchange) {
                 for (Map.Entry<String, String> entry: headerMap.entrySet()) {
                     // if ignore list exists, it will take the precedence.
                     if(CONFIG.getHeaderAttributesToIgnore() != null && CONFIG.getHeaderAttributesToIgnore().stream().anyMatch(entry.getKey()::equalsIgnoreCase)) {
-                        if(LOG.isTraceEnabled()) LOG.trace("Ignore header " + entry.getKey() + " as it is in the ignore list.");
+                        if(LOG.isTraceEnabled())
+                            LOG.trace("Ignore header {} as it is in the ignore list.", entry.getKey());
                         continue;
                     }
 
                     if(CONFIG.getHeaderAttributesToEncode() != null) {
                         if(CONFIG.getHeaderAttributesToEncode().stream().anyMatch(entry.getKey()::equalsIgnoreCase)) {
-                            if(LOG.isTraceEnabled()) LOG.trace("Encode header " + entry.getKey() + " as it is not in the ignore list and it is in the encode list.");
+                            if(LOG.isTraceEnabled())
+                                LOG.trace("Encode header {} as it is not in the ignore list and it is in the encode list.", entry.getKey());
                             entry.setValue(headerEncoder.applyEncoding(entry.getValue()));
                         }
                     } else {
                         // no attributes to encode, encode everything except the ignore list.
-                        if(LOG.isTraceEnabled()) LOG.trace("Encode header " + entry.getKey() + " as it is not in the ignore list and the encode list is null.");
+                        if(LOG.isTraceEnabled())
+                            LOG.trace("Encode header {} as it is not in the ignore list and the encode list is null.", entry.getKey());
                         entry.setValue(headerEncoder.applyEncoding(entry.getValue()));
                     }
                 }
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/security/JwtVerifyMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/security/JwtVerifyMiddleware.java
@@ -120,10 +120,9 @@ public Status handleJwt(LightLambdaExchange exchange, String pathPrefix, String
                         auditInfo.put(Constants.CLIENT_ID_STRING, clientId);
                         auditInfo.put(Constants.ISSUER_CLAIMS, issuer);
                         Map<String, String> headers = exchange.getRequest().getHeaders();
-                        String callerId = headers.get(Constants.CALLER_ID_STRING);
-
-                        if (callerId != null)
-                            auditInfo.put(Constants.CALLER_ID_STRING, callerId);
+                        Optional<String> optionalCallerId = MapUtil.getValueIgnoreCase(headers, Constants.CALLER_ID_STRING);
+                        if (optionalCallerId.isPresent())
+                            auditInfo.put(Constants.CALLER_ID_STRING, optionalCallerId.get());
 
                         exchange.addAttachment(AUDIT_ATTACHMENT_KEY, auditInfo);
 
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/security/SwtVerifyMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/security/SwtVerifyMiddleware.java
@@ -106,9 +106,9 @@ public Status handleSwt(LightLambdaExchange exchange, String reqPath, List<Strin
                     String issuer = tokenInfo.getIss();
                     auditInfo.put(Constants.ISSUER_CLAIMS, issuer);
                     Map<String, String> headers = exchange.getRequest().getHeaders();
-                    String callerId = headers.get(Constants.CALLER_ID_STRING);
-                    if (callerId != null)
-                        auditInfo.put(Constants.CALLER_ID_STRING, callerId);
+                    Optional<String> optionalCallerId = MapUtil.getValueIgnoreCase(headers, Constants.CALLER_ID_STRING);
+                    if (optionalCallerId.isPresent())
+                        auditInfo.put(Constants.CALLER_ID_STRING, optionalCallerId.get());
                     exchange.addAttachment(AUDIT_ATTACHMENT_KEY, auditInfo);
 
                     if (CONFIG != null && CONFIG.isEnableVerifyScope()) {
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/traceability/TraceabilityMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/traceability/TraceabilityMiddleware.java
@@ -7,12 +7,14 @@
 import com.networknt.config.Config;
 import com.networknt.status.Status;
 import com.networknt.traceability.TraceabilityConfig;
+import com.networknt.utility.MapUtil;
 import com.networknt.utility.ModuleRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
 
 import java.util.HashMap;
+import java.util.Optional;
 
 public class TraceabilityMiddleware implements MiddlewareHandler {
     private static final Logger LOG = LoggerFactory.getLogger(TraceabilityMiddleware.class);
@@ -34,7 +36,8 @@ public Status execute(final LightLambdaExchange exchange) {
 
         String tid = null;
         if(exchange.getRequest().getHeaders() != null) {
-            tid = exchange.getRequest().getHeaders().get(HeaderKey.TRACEABILITY);
+            Optional<String> tidOptional = MapUtil.getValueIgnoreCase(exchange.getRequest().getHeaders(), HeaderKey.TRACEABILITY);
+            tid = tidOptional.orElse(null);
         }
 
         if (tid != null) {
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/transformer/RequestTransformerMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/transformer/RequestTransformerMiddleware.java
@@ -11,6 +11,7 @@
 import com.networknt.status.Status;
 import com.networknt.utility.ConfigUtils;
 import com.networknt.utility.Constants;
+import com.networknt.utility.MapUtil;
 import com.networknt.utility.ModuleRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -140,7 +141,7 @@ public Status execute(LightLambdaExchange exchange) {
                                         if(removeList != null) {
                                             removeList.forEach(s -> {
                                                 if(LOG.isTraceEnabled()) LOG.trace("removing request header: " + s);
-                                                exchange.getRequest().getHeaders().remove(s);
+                                                MapUtil.delValueIgnoreCase(exchange.getRequest().getHeaders(), s);
                                             });
                                         }
                                         Map<String, Object> updateMap = (Map)requestHeaders.get("update");
diff --git a/src/main/java/com/networknt/aws/lambda/handler/middleware/transformer/ResponseTransformerMiddleware.java b/src/main/java/com/networknt/aws/lambda/handler/middleware/transformer/ResponseTransformerMiddleware.java
@@ -8,6 +8,7 @@
 import com.networknt.status.Status;
 import com.networknt.utility.ConfigUtils;
 import com.networknt.utility.Constants;
+import com.networknt.utility.MapUtil;
 import com.networknt.utility.ModuleRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -154,7 +155,7 @@ public Status execute(LightLambdaExchange exchange) {
                                 // manipulate the response headers.
                                 List<String> removeList = (List) responseHeaders.get(REMOVE);
                                 if (removeList != null) {
-                                    removeList.forEach(s -> exchange.getResponse().getHeaders().remove(s));
+                                    removeList.forEach(s -> MapUtil.delValueIgnoreCase(exchange.getResponse().getHeaders(), s));
                                 }
                                 Map<String, Object> updateMap = (Map) responseHeaders.get(UPDATE);
                                 if (updateMap != null) {
diff --git a/src/test/java/com/networknt/aws/lambda/middleware/sanitizer/SanitizerMiddlewareTest.java b/src/test/java/com/networknt/aws/lambda/middleware/sanitizer/SanitizerMiddlewareTest.java
@@ -11,13 +11,15 @@
 import com.networknt.config.JsonMapper;
 import com.networknt.sanitizer.SanitizerConfig;
 
+import com.networknt.utility.MapUtil;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Optional;
 
 public class SanitizerMiddlewareTest {
     private static final Logger LOG = LoggerFactory.getLogger(SanitizerMiddlewareTest.class);
@@ -53,9 +55,9 @@ public void testSanitizerMiddlewareHeader() {
         this.exchange.executeChain();
         requestEvent = exchange.getFinalizedRequest(false);
         Map<String, String> headerMapResult = requestEvent.getHeaders();
-        String param = headerMapResult.get("param");
+        Optional<String> optionalParam = MapUtil.getValueIgnoreCase(headerMapResult, "param");
         // works on both linux and Windows due to EncodeWrapper
-        Assertions.assertTrue(param.contains("<script>alert(\\'header test\\')</script>"));
+        optionalParam.ifPresent(s -> Assertions.assertTrue(s.contains("<script>alert(\\'header test\\')</script>")));
     }
 
     @Test
diff --git a/src/test/java/com/networknt/aws/lambda/middleware/security/BasicAuthMiddlewareTest.java b/src/test/java/com/networknt/aws/lambda/middleware/security/BasicAuthMiddlewareTest.java
@@ -13,6 +13,7 @@
 import com.networknt.basicauth.BasicAuthConfig;
 import com.networknt.status.Status;
 import com.networknt.utility.Constants;
+import com.networknt.utility.MapUtil;
 import org.apache.commons.codec.binary.Base64;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
@@ -96,7 +97,7 @@ public void testMissingToken() {
         var requestEvent = TestUtils.createTestRequestEvent();
         requestEvent.setPath("/v2/pet");
         // add the X-Traceability-Id to the header
-        requestEvent.getHeaders().remove(HeaderKey.AUTHORIZATION);
+        MapUtil.delValueIgnoreCase(requestEvent.getHeaders(), HeaderKey.AUTHORIZATION);
         InvocationResponse invocation = InvocationResponse.builder()
                 .requestId("12345")
                 .event(requestEvent)
diff --git a/src/test/java/com/networknt/aws/lambda/middleware/token/TokenMiddlewareTest.java b/src/test/java/com/networknt/aws/lambda/middleware/token/TokenMiddlewareTest.java
@@ -8,6 +8,7 @@
 import com.networknt.aws.lambda.handler.middleware.token.TokenMiddleware;
 import com.networknt.aws.lambda.utility.HeaderKey;
 import com.networknt.router.middleware.TokenConfig;
+import com.networknt.utility.MapUtil;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
@@ -25,7 +26,7 @@ public void testTokenMiddlewareWithoutServiceId() {
         // add a request header so that it can be removed by the middleware
         // requestEvent.getHeaders().put("service_id", "com.networknt.petstore-1.0.0");
         requestEvent.getHeaders().put(HeaderKey.TRACEABILITY, "12345");
-        requestEvent.getHeaders().remove(HeaderKey.AUTHORIZATION);
+        MapUtil.delValueIgnoreCase(requestEvent.getHeaders(), HeaderKey.AUTHORIZATION);
 
         requestEvent.setPath("/v1/pets");
         requestEvent.setBody("{\"id\": 1, \"name\": \"dog\"}");

Original file line number	Diff line number	Diff line change
`@@ -49,18 +49,21 @@ public Status execute(LightLambdaExchange exchange) {`
`49`	`49`	`for (Map.Entry<String, String> entry: headerMap.entrySet()) {`
`50`	`50`	`// if ignore list exists, it will take the precedence.`
`51`	`51`	`if(CONFIG.getHeaderAttributesToIgnore() != null && CONFIG.getHeaderAttributesToIgnore().stream().anyMatch(entry.getKey()::equalsIgnoreCase)) {`
`52`		`- if(LOG.isTraceEnabled()) LOG.trace("Ignore header " + entry.getKey() + " as it is in the ignore list.");`
	`52`	`+ if(LOG.isTraceEnabled())`
	`53`	`+ LOG.trace("Ignore header {} as it is in the ignore list.", entry.getKey());`
`53`	`54`	`continue;`
`54`	`55`	`}`
`55`	`56`
`56`	`57`	`if(CONFIG.getHeaderAttributesToEncode() != null) {`
`57`	`58`	`if(CONFIG.getHeaderAttributesToEncode().stream().anyMatch(entry.getKey()::equalsIgnoreCase)) {`
`58`		`- if(LOG.isTraceEnabled()) LOG.trace("Encode header " + entry.getKey() + " as it is not in the ignore list and it is in the encode list.");`
	`59`	`+ if(LOG.isTraceEnabled())`
	`60`	`+ LOG.trace("Encode header {} as it is not in the ignore list and it is in the encode list.", entry.getKey());`
`59`	`61`	`entry.setValue(headerEncoder.applyEncoding(entry.getValue()));`
`60`	`62`	`}`
`61`	`63`	`} else {`
`62`	`64`	`// no attributes to encode, encode everything except the ignore list.`
`63`		`- if(LOG.isTraceEnabled()) LOG.trace("Encode header " + entry.getKey() + " as it is not in the ignore list and the encode list is null.");`
	`65`	`+ if(LOG.isTraceEnabled())`
	`66`	`+ LOG.trace("Encode header {} as it is not in the ignore list and the encode list is null.", entry.getKey());`
`64`	`67`	`entry.setValue(headerEncoder.applyEncoding(entry.getValue()));`
`65`	`68`	`}`
`66`	`69`	`}`