-
Notifications
You must be signed in to change notification settings - Fork 174
/
HeaderUtil.java
267 lines (243 loc) · 10.7 KB
/
HeaderUtil.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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/*
* Copyright 2017-2024 Adobe.
*
* 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
*
* http://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 com.adobe.testing.s3mock.util;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.AWS_CHUNKED;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_CHECKSUM_ALGORITHM;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_CHECKSUM_CRC32;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_CHECKSUM_CRC32C;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_CHECKSUM_SHA1;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_CHECKSUM_SHA256;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_CONTENT_SHA256;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_SDK_CHECKSUM_ALGORITHM;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_SERVER_SIDE_ENCRYPTION;
import static com.adobe.testing.s3mock.util.AwsHttpHeaders.X_AMZ_STORAGE_CLASS;
import static org.apache.commons.lang3.StringUtils.equalsIgnoreCase;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import static org.apache.commons.lang3.StringUtils.startsWithIgnoreCase;
import com.adobe.testing.s3mock.dto.ChecksumAlgorithm;
import com.adobe.testing.s3mock.dto.StorageClass;
import com.adobe.testing.s3mock.store.S3ObjectMetadata;
import java.util.AbstractMap.SimpleEntry;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import org.springframework.http.HttpHeaders;
import org.springframework.http.InvalidMediaTypeException;
import org.springframework.http.MediaType;
public final class HeaderUtil {
private static final String RESPONSE_HEADER_CONTENT_TYPE = "response-content-type";
private static final String RESPONSE_HEADER_CONTENT_LANGUAGE = "response-content-language";
private static final String RESPONSE_HEADER_EXPIRES = "response-expires";
private static final String RESPONSE_HEADER_CACHE_CONTROL = "response-cache-control";
private static final String RESPONSE_HEADER_CONTENT_DISPOSITION = "response-content-disposition";
private static final String RESPONSE_HEADER_CONTENT_ENCODING = "response-content-encoding";
private static final String HEADER_X_AMZ_META_PREFIX = "x-amz-meta-";
private static final String STREAMING_AWS_4_HMAC_SHA_256_PAYLOAD =
"STREAMING-AWS4-HMAC-SHA256-PAYLOAD";
private static final String STREAMING_AWS_4_HMAC_SHA_256_PAYLOAD_TRAILER =
"STREAMING-AWS4-HMAC-SHA256-PAYLOAD-TRAILER";
private static final MediaType FALLBACK_MEDIA_TYPE = MediaType.APPLICATION_OCTET_STREAM;
private HeaderUtil() {
// private constructor for utility classes
}
/**
* Creates response headers from S3ObjectMetadata user metadata.
* @param s3ObjectMetadata {@link S3ObjectMetadata} S3Object where user metadata will be extracted
*/
public static Map<String, String> userMetadataHeadersFrom(S3ObjectMetadata s3ObjectMetadata) {
Map<String, String> metadataHeaders = new HashMap<>();
if (s3ObjectMetadata.userMetadata() != null) {
s3ObjectMetadata.userMetadata()
.forEach((key, value) -> {
if (startsWithIgnoreCase(key, HEADER_X_AMZ_META_PREFIX)) {
metadataHeaders.put(key, value);
} else {
//support case where metadata was stored locally in legacy format
metadataHeaders.put(HEADER_X_AMZ_META_PREFIX + key, value);
}
});
}
return metadataHeaders;
}
/**
* Creates response headers from S3ObjectMetadata storageclass.
* @param s3ObjectMetadata {@link S3ObjectMetadata} S3Object where data will be extracted
*/
public static Map<String, String> storageClassHeadersFrom(S3ObjectMetadata s3ObjectMetadata) {
Map<String, String> headers = new HashMap<>();
StorageClass storageClass = s3ObjectMetadata.storageClass();
if (storageClass != null) {
headers.put(X_AMZ_STORAGE_CLASS, storageClass.toString());
}
return headers;
}
/**
* Retrieves user metadata from request.
* @param headers {@link HttpHeaders}
* @return map containing user meta-data
*/
public static Map<String, String> userMetadataFrom(HttpHeaders headers) {
return parseHeadersToMap(headers,
header -> startsWithIgnoreCase(header, HEADER_X_AMZ_META_PREFIX));
}
/**
* Retrieves headers to store from request.
* @param headers {@link HttpHeaders}
* @return map containing headers to store
*/
public static Map<String, String> storeHeadersFrom(HttpHeaders headers) {
return parseHeadersToMap(headers,
header -> (equalsIgnoreCase(header, HttpHeaders.EXPIRES)
|| equalsIgnoreCase(header, HttpHeaders.CONTENT_LANGUAGE)
|| equalsIgnoreCase(header, HttpHeaders.CONTENT_DISPOSITION)
|| equalsIgnoreCase(header, HttpHeaders.CONTENT_ENCODING)
|| equalsIgnoreCase(header, HttpHeaders.CACHE_CONTROL)
));
}
/**
* Retrieves headers encryption headers from request.
* @param headers {@link HttpHeaders}
* @return map containing encryption headers
*/
public static Map<String, String> encryptionHeadersFrom(HttpHeaders headers) {
return parseHeadersToMap(headers,
header -> startsWithIgnoreCase(header, X_AMZ_SERVER_SIDE_ENCRYPTION));
}
private static Map<String, String> parseHeadersToMap(HttpHeaders headers,
Predicate<String> matcher) {
return headers
.entrySet()
.stream()
.map(
entry -> {
if (matcher.test(entry.getKey())
&& entry.getValue() != null
&& !entry.getValue().isEmpty()
&& isNotBlank(entry.getValue().get(0))) {
return new SimpleEntry<>(entry.getKey(), entry.getValue().get(0));
} else {
return null;
}
}
)
.filter(Objects::nonNull)
.collect(Collectors.toMap(SimpleEntry::getKey, SimpleEntry::getValue));
}
public static boolean isChunkedAndV4Signed(HttpHeaders headers) {
var sha256Header = headers.getFirst(X_AMZ_CONTENT_SHA256);
return sha256Header != null
&& (sha256Header.equals(STREAMING_AWS_4_HMAC_SHA_256_PAYLOAD)
|| sha256Header.equals(STREAMING_AWS_4_HMAC_SHA_256_PAYLOAD_TRAILER));
}
public static boolean isChunked(HttpHeaders headers) {
var contentEncodingHeaders = headers.get(HttpHeaders.CONTENT_ENCODING);
return (contentEncodingHeaders != null
&& (contentEncodingHeaders.contains(AWS_CHUNKED)));
}
public static MediaType mediaTypeFrom(final String contentType) {
try {
return MediaType.parseMediaType(contentType);
} catch (final InvalidMediaTypeException e) {
return FALLBACK_MEDIA_TYPE;
}
}
public static Map<String, String> overrideHeadersFrom(Map<String,String> queryParams) {
return queryParams
.entrySet()
.stream()
.map(
entry -> {
if (isNotBlank(mapHeaderName(entry.getKey()))) {
return new SimpleEntry<>(mapHeaderName(entry.getKey()), entry.getValue());
} else {
return null;
}
}
)
.filter(Objects::nonNull)
.collect(Collectors.toMap(SimpleEntry::getKey, SimpleEntry::getValue));
}
public static Map<String, String> checksumHeaderFrom(S3ObjectMetadata s3ObjectMetadata) {
ChecksumAlgorithm checksumAlgorithm = s3ObjectMetadata.checksumAlgorithm();
String checksum = s3ObjectMetadata.checksum();
return checksumHeaderFrom(checksum, checksumAlgorithm);
}
public static Map<String, String> checksumHeaderFrom(String checksum,
ChecksumAlgorithm checksumAlgorithm) {
Map<String, String> headers = new HashMap<>();
if (checksumAlgorithm != null && checksum != null) {
headers.put(mapChecksumToHeader(checksumAlgorithm), checksum);
}
return headers;
}
public static ChecksumAlgorithm checksumAlgorithmFromHeader(HttpHeaders headers) {
if (headers.containsKey(X_AMZ_CHECKSUM_SHA256)) {
return ChecksumAlgorithm.SHA256;
} else if (headers.containsKey(X_AMZ_CHECKSUM_SHA1)) {
return ChecksumAlgorithm.SHA1;
} else if (headers.containsKey(X_AMZ_CHECKSUM_CRC32)) {
return ChecksumAlgorithm.CRC32;
} else if (headers.containsKey(X_AMZ_CHECKSUM_CRC32C)) {
return ChecksumAlgorithm.CRC32C;
} else if (headers.containsKey(X_AMZ_CHECKSUM_ALGORITHM)) {
var checksumAlgorithm = headers.getFirst(X_AMZ_CHECKSUM_ALGORITHM);
return ChecksumAlgorithm.fromString(checksumAlgorithm);
} else {
return null;
}
}
public static ChecksumAlgorithm checksumAlgorithmFromSdk(HttpHeaders headers) {
if (headers.containsKey(X_AMZ_SDK_CHECKSUM_ALGORITHM)) {
return ChecksumAlgorithm.fromString(headers.getFirst(X_AMZ_SDK_CHECKSUM_ALGORITHM));
} else {
return null;
}
}
public static String checksumFrom(HttpHeaders headers) {
if (headers.containsKey(X_AMZ_CHECKSUM_SHA256)) {
return headers.getFirst(X_AMZ_CHECKSUM_SHA256);
} else if (headers.containsKey(X_AMZ_CHECKSUM_SHA1)) {
return headers.getFirst(X_AMZ_CHECKSUM_SHA1);
} else if (headers.containsKey(X_AMZ_CHECKSUM_CRC32)) {
return headers.getFirst(X_AMZ_CHECKSUM_CRC32);
} else if (headers.containsKey(X_AMZ_CHECKSUM_CRC32C)) {
return headers.getFirst(X_AMZ_CHECKSUM_CRC32C);
}
return null;
}
public static String mapChecksumToHeader(ChecksumAlgorithm checksumAlgorithm) {
return switch (checksumAlgorithm) {
case SHA256 -> X_AMZ_CHECKSUM_SHA256;
case SHA1 -> X_AMZ_CHECKSUM_SHA1;
case CRC32 -> X_AMZ_CHECKSUM_CRC32;
case CRC32C -> X_AMZ_CHECKSUM_CRC32C;
};
}
private static String mapHeaderName(final String name) {
return switch (name) {
case RESPONSE_HEADER_CACHE_CONTROL -> HttpHeaders.CACHE_CONTROL;
case RESPONSE_HEADER_CONTENT_DISPOSITION -> HttpHeaders.CONTENT_DISPOSITION;
case RESPONSE_HEADER_CONTENT_ENCODING -> HttpHeaders.CONTENT_ENCODING;
case RESPONSE_HEADER_CONTENT_LANGUAGE -> HttpHeaders.CONTENT_LANGUAGE;
case RESPONSE_HEADER_CONTENT_TYPE -> HttpHeaders.CONTENT_TYPE;
case RESPONSE_HEADER_EXPIRES -> HttpHeaders.EXPIRES;
// Only the above header overrides are supported by S3
default -> "";
};
}
}