Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Extract http headers utils (#8471)
- Loading branch information
Showing
6 changed files
with
317 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
95 changes: 95 additions & 0 deletions
95
http/src/main/java/io/micronaut/http/util/HttpHeadersUtil.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| /* | ||
| * Copyright 2017-2022 original authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.micronaut.http.util; | ||
|
|
||
| import io.micronaut.core.annotation.NonNull; | ||
| import io.micronaut.core.annotation.Nullable; | ||
| import io.micronaut.core.util.SupplierUtil; | ||
| import io.micronaut.http.HttpHeaders; | ||
| import org.slf4j.Logger; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.function.Function; | ||
| import java.util.function.Supplier; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| /** | ||
| * Utility class to work with {@link io.micronaut.http.HttpHeaders} or HTTP Headers. | ||
| * @author Sergio del Amo | ||
| * @since 3.8.0 | ||
| */ | ||
| public final class HttpHeadersUtil { | ||
| private static final Supplier<Pattern> HEADER_MASK_PATTERNS = SupplierUtil.memoized(() -> | ||
| Pattern.compile(".*(password|cred|cert|key|secret|token|auth|signat).*", Pattern.CASE_INSENSITIVE) | ||
| ); | ||
|
|
||
| private HttpHeadersUtil() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Trace HTTP Headers. | ||
| * @param log Logger | ||
| * @param httpHeaders HTTP Headers | ||
| */ | ||
| public static void trace(@NonNull Logger log, | ||
| @NonNull HttpHeaders httpHeaders) { | ||
| trace(log, httpHeaders.names(), httpHeaders::getAll); | ||
| } | ||
|
|
||
| /** | ||
| * Trace HTTP Headers. | ||
| * @param log Logger | ||
| * @param names HTTP Header names | ||
| * @param getAllHeaders Function to get all the header values for a particular header name | ||
| */ | ||
| public static void trace(@NonNull Logger log, | ||
| @NonNull Set<String> names, | ||
| @NonNull Function<String, List<String>> getAllHeaders) { | ||
| names.forEach(name -> trace(log, name, getAllHeaders)); | ||
| } | ||
|
|
||
| /** | ||
| * Trace HTTP Headers. | ||
| * @param log Logger | ||
| * @param name HTTP Header name | ||
| * @param getAllHeaders Function to get all the header values for a particular header name | ||
| */ | ||
| public static void trace(@NonNull Logger log, | ||
| @NonNull String name, | ||
| @NonNull Function<String, List<String>> getAllHeaders) { | ||
| boolean isMasked = HEADER_MASK_PATTERNS.get().matcher(name).matches(); | ||
| List<String> all = getAllHeaders.apply(name); | ||
| if (all.size() > 1) { | ||
| for (String value : all) { | ||
| String maskedValue = isMasked ? mask(value) : value; | ||
| log.trace("{}: {}", name, maskedValue); | ||
| } | ||
| } else if (!all.isEmpty()) { | ||
| String maskedValue = isMasked ? mask(all.get(0)) : all.get(0); | ||
| log.trace("{}: {}", name, maskedValue); | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| private static String mask(@Nullable String value) { | ||
| if (value == null) { | ||
| return null; | ||
| } | ||
| return "*MASKED*"; | ||
| } | ||
| } |
78 changes: 78 additions & 0 deletions
78
http/src/test/groovy/io/micronaut/http/util/HttpHeadersUtilSpec.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| package io.micronaut.http.util | ||
|
|
||
| import ch.qos.logback.classic.Level | ||
| import ch.qos.logback.classic.spi.ILoggingEvent | ||
| import ch.qos.logback.core.AppenderBase | ||
| import io.micronaut.http.HttpHeaders | ||
| import org.slf4j.Logger | ||
| import org.slf4j.LoggerFactory | ||
| import spock.lang.Specification | ||
|
|
||
| import java.util.concurrent.BlockingQueue | ||
| import java.util.concurrent.LinkedBlockingQueue | ||
|
|
||
| class HttpHeadersUtilSpec extends Specification { | ||
| def "check masking works for #value"() { | ||
| expect: | ||
| expected == HttpHeadersUtil.mask(value) | ||
|
|
||
| where: | ||
| value | expected | ||
| null | null | ||
| "foo" | "*MASKED*" | ||
| "Tim Yates" | "*MASKED*" | ||
| } | ||
|
|
||
| def "check mask detects common security headers"() { | ||
| given: | ||
| MemoryAppender appender = new MemoryAppender() | ||
| Logger log = LoggerFactory.getLogger(HttpHeadersUtilSpec.class) | ||
|
|
||
| expect: | ||
| log instanceof ch.qos.logback.classic.Logger | ||
|
|
||
| when: | ||
| ch.qos.logback.classic.Logger logger = (ch.qos.logback.classic.Logger) log | ||
| logger.addAppender(appender) | ||
| logger.setLevel(Level.TRACE) | ||
| appender.start() | ||
|
|
||
| HttpHeaders headers = new MockHttpHeaders([ | ||
| "Authorization": ["Bearer foo"], | ||
| "Proxy-Authorization": ["AWS4-HMAC-SHA256 bar"], | ||
| "Cookie": ["baz"], | ||
| "Set-Cookie": ["qux"], | ||
| "X-Forwarded-For": ["quux", "fred"], | ||
| "X-Forwarded-Host": ["quuz"], | ||
| "X-Real-IP": ["waldo"], | ||
| "Credential": ["foo"], | ||
| "Signature": ["bar probably secret"]]) | ||
|
|
||
| HttpHeadersUtil.trace(log, headers) | ||
|
|
||
| then: | ||
| appender.events.size() == headers.values().collect { it -> it.size() }.sum() | ||
| appender.events.contains("Authorization: *MASKED*") | ||
| appender.events.contains("Cookie: baz") | ||
| appender.events.contains("Credential: *MASKED*") | ||
| appender.events.contains("Set-Cookie: qux") | ||
| appender.events.contains("Proxy-Authorization: *MASKED*") | ||
| appender.events.contains("Signature: *MASKED*") | ||
| appender.events.contains("X-Forwarded-For: quux") | ||
| appender.events.contains("X-Forwarded-For: fred") | ||
| appender.events.contains("X-Forwarded-Host: quuz") | ||
| appender.events.contains("X-Real-IP: waldo") | ||
|
|
||
| cleanup: | ||
| appender.stop() | ||
| } | ||
|
|
||
| static class MemoryAppender extends AppenderBase<ILoggingEvent> { | ||
| final BlockingQueue<String> events = new LinkedBlockingQueue<>() | ||
|
|
||
| @Override | ||
| protected void append(ILoggingEvent e) { | ||
| events.add(e.formattedMessage) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.