-
Notifications
You must be signed in to change notification settings - Fork 1k
/
HttpHeadersUtil.java
95 lines (86 loc) · 3.16 KB
/
HttpHeadersUtil.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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*";
}
}