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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2019 Nordix Foundation
* Modifications Copyright (C) 2021 Nordix Foundation.
* ================================================================================
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.openecomp.sdc.common.zip;
import java.io.BufferedOutputStream;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import java.util.zip.ZipOutputStream;
import org.apache.commons.io.IOUtils;
import org.openecomp.sdc.common.zip.exception.ZipException;
import org.openecomp.sdc.common.zip.exception.ZipSlipException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Handles zip operations.
*/
public class ZipUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(ZipUtils.class);
private static final String COULD_NOT_OBTAIN_CANONICAL_PATH = "Could not obtain canonical path of: '%s'";
private ZipUtils() {
}
/**
* Checks if the path is a zip slip attempt calling the {@link #checkForZipSlipInRead(Path)} method.
*
* @param zipEntry the zip entry
* @throws ZipSlipException when a zip slip attempt is detected
*/
public static void checkForZipSlipInRead(final ZipEntry zipEntry) throws ZipSlipException {
checkForZipSlipInRead(Paths.get(zipEntry.getName()));
}
/**
* Checks if the path is a zip slip attempt when you don't have a destination folder eg in memory reading or zip creation.
*
* @param filePath the file path
* @throws ZipSlipException when a zip slip attempt is detected
*/
public static void checkForZipSlipInRead(final Path filePath) throws ZipSlipException {
validateAndReturnPath(filePath);
if (filePath.toString().contains("../") || filePath.toString().contains("..\\")) {
throw new ZipSlipException(filePath.toString());
}
}
private static Path validateAndReturnPath(final Path filePath) throws ZipSlipException {
final File file = filePath.toFile();
String canonicalPath;
try {
canonicalPath = file.getCanonicalPath();
} catch (final IOException ex) {
throw new ZipSlipException(String.format(COULD_NOT_OBTAIN_CANONICAL_PATH, file.getPath()), ex);
}
if (canonicalPath != null && !canonicalPath.equals(file.getAbsolutePath())) {
throw new ZipSlipException(filePath.toString());
}
return Path.of(canonicalPath);
}
/**
* Checks if the zip entry is a zip slip attempt based on the destination directory.
*
* @param zipEntry the zip entry
* @param targetDirectoryPath the target extraction folder
* @throws ZipException when the zip slip was detected as a {@link ZipSlipException}. Also when there was a problem getting the canonical paths
* from the zip entry or target directory.
*/
public static void checkForZipSlipInExtraction(final ZipEntry zipEntry, final Path targetDirectoryPath) throws ZipException {
final File targetDirectoryAsFile = targetDirectoryPath.toFile();
final File targetFile = new File(targetDirectoryAsFile, zipEntry.getName());
final String targetDirectoryCanonicalPath;
try {
targetDirectoryCanonicalPath = targetDirectoryAsFile.getCanonicalPath();
} catch (final IOException e) {
throw new ZipException(String.format(COULD_NOT_OBTAIN_CANONICAL_PATH, targetDirectoryAsFile.getAbsolutePath()), e);
}
final String targetFileCanonicalPath;
try {
targetFileCanonicalPath = targetFile.getCanonicalPath();
} catch (final IOException e) {
throw new ZipException(String.format(COULD_NOT_OBTAIN_CANONICAL_PATH, targetFile.getAbsolutePath()), e);
}
if (!targetFileCanonicalPath.startsWith(targetDirectoryCanonicalPath + File.separator)) {
throw new ZipSlipException(zipEntry.getName());
}
}
/**
* Creates a ZipInputStream from a byte array.
*
* @param zipFileBytes the zip byte array
* @return the created ZipInputStream.
*/
private static ZipInputStream getInputStreamFromBytes(final byte[] zipFileBytes) {
return new ZipInputStream(new ByteArrayInputStream(zipFileBytes));
}
/**
* Reads a zip file into memory. Parses the zipFile in byte array and calls {@link #readZip(byte[], boolean)}.
*
* @param zipFile the zip file to read
* @param hasToIncludeDirectories includes or not the directories found during the zip reading
* @return a Map representing a pair of file path and file byte array
* @throws ZipException when there was a problem during the reading process
*/
public static Map<String, byte[]> readZip(final File zipFile, final boolean hasToIncludeDirectories) throws ZipException {
try {
return readZip(Files.readAllBytes(zipFile.toPath()), hasToIncludeDirectories);
} catch (final IOException e) {
throw new ZipException(String.format("Could not read the zip file '%s'", zipFile.getName()), e);
}
}
/**
* Reads a zip file to a in memory structure formed by the file path and its bytes. The structure can contains only files or files and
* directories. If configured to include directories, only empty directories and directories that contains files will be included. The full
* directory tree will not be generated, eg:
* <pre>
* \
* \..\Directory
* \..\..\ChildDirectory
* \..\..\..\aFile.txt
* \..\..\EmptyChildDirectory
* </pre>
* The return will include "Directory\ChildDirectory\aFile.txt" and "Directory\EmptyChildDirectory" but not "Directory" or the root.
*
* @param zipFileBytes the zip file byte array to read
* @param hasToIncludeDirectories includes or not the directories found during the zip reading.
* @return a Map representing a pair of file path and file byte array
* @throws ZipException when there was a problem during the reading process
*/
public static Map<String, byte[]> readZip(final byte[] zipFileBytes, final boolean hasToIncludeDirectories) throws ZipException {
final Map<String, byte[]> filePathAndByteMap = new HashMap<>();
try (final ZipInputStream inputZipStream = ZipUtils.getInputStreamFromBytes(zipFileBytes)) {
ZipEntry zipEntry;
while ((zipEntry = inputZipStream.getNextEntry()) != null) {
filePathAndByteMap.putAll(processZipEntryInRead(zipEntry, getBytes(inputZipStream), hasToIncludeDirectories));
}
} catch (final IOException e) {
LOGGER.warn("Could not close the zip input stream", e);
}
return filePathAndByteMap;
}
private static Map<String, byte[]> processZipEntryInRead(final ZipEntry zipEntry, final byte[] inputStreamBytes,
final boolean hasToIncludeDirectories) throws ZipException {
final Map<String, byte[]> filePathAndByteMap = new HashMap<>();
checkForZipSlipInRead(zipEntry);
if (zipEntry.isDirectory()) {
if (hasToIncludeDirectories) {
filePathAndByteMap.put(normalizeFolder(zipEntry.getName()), null);
}
return filePathAndByteMap;
}
if (hasToIncludeDirectories) {
final Path parentFolderPath = Paths.get(zipEntry.getName()).getParent();
if (parentFolderPath != null) {
filePathAndByteMap.putIfAbsent(normalizeFolder(parentFolderPath.toString()), null);
}
}
filePathAndByteMap.put(zipEntry.getName(), inputStreamBytes);
return filePathAndByteMap;
}
/**
* Adds a {@link File#separator} at the end of the folder path if not present.
*
* @param folderPath the folder to normalize
* @return the normalized folder
*/
private static String normalizeFolder(final String folderPath) {
final StringBuilder normalizedFolderBuilder = new StringBuilder(folderPath);
if (!folderPath.endsWith(File.separator)) {
normalizedFolderBuilder.append(File.separator);
}
return normalizedFolderBuilder.toString();
}
/**
* Converts a ZipInputStream in byte array.
*
* @param inputZipStream the zip input stream
* @return the byte array representing the input stream
* @throws ZipException when there was a problem parsing the input zip stream
*/
private static byte[] getBytes(final ZipInputStream inputZipStream) throws ZipException {
final byte[] fileByteContent;
try {
fileByteContent = IOUtils.toByteArray(inputZipStream);
} catch (final IOException e) {
throw new ZipException("Could not read bytes from file", e);
}
return fileByteContent;
}
/**
* Unzips a zip file into an output folder.
*
* @param zipFilePath the zip file path
* @param outputFolder the output folder path
* @throws ZipException when there was a problem during the unzip process
*/
public static void unzip(final Path zipFilePath, final Path outputFolder) throws ZipException {
if (zipFilePath == null || outputFolder == null) {
return;
}
createDirectoryIfNotExists(outputFolder);
final File zipFile = zipFilePath.toFile();
try (final FileInputStream fileInputStream = new FileInputStream(zipFile); final ZipInputStream stream = new ZipInputStream(
fileInputStream)) {
ZipEntry zipEntry;
while ((zipEntry = stream.getNextEntry()) != null) {
checkForZipSlipInExtraction(zipEntry, outputFolder);
final String fileName = zipEntry.getName();
final Path fileToWritePath = validateAndReturnPath(Paths.get(outputFolder.toString(), fileName));
if (zipEntry.isDirectory()) {
createDirectoryIfNotExists(fileToWritePath);
} else {
writeFile(stream, fileToWritePath);
}
}
} catch (final FileNotFoundException e) {
throw new ZipException(String.format("Could not find file: '%s'", zipFile.getAbsolutePath()), e);
} catch (final IOException e) {
throw new ZipException(String.format("An unexpected error occurred trying to unzip '%s'", zipFile.getAbsolutePath()), e);
}
}
/**
* Writes a file from a zipInputStream to a path. Creates the file parent directories if they don't exist.
*
* @param zipInputStream the zip input stream
* @param fileToWritePath the file path to write
* @throws ZipException when there was a problem during the file creation
*/
private static void writeFile(final ZipInputStream zipInputStream, final Path fileToWritePath) throws ZipException {
final Path parentFolderPath = fileToWritePath.getParent();
if (parentFolderPath != null) {
try {
Files.createDirectories(validateAndReturnPath(parentFolderPath));
} catch (final IOException e) {
throw new ZipException(String.format("Could not create parent directories of '%s'", fileToWritePath), e);
}
}
try (final FileOutputStream outputStream = new FileOutputStream(fileToWritePath.toFile())) {
IOUtils.copy(zipInputStream, outputStream);
} catch (final FileNotFoundException e) {
throw new ZipException(String.format("Could not find file '%s'", fileToWritePath), e);
} catch (final IOException e) {
throw new ZipException(String.format("An unexpected error has occurred while writing file '%s'", fileToWritePath), e);
}
}
/**
* Creates the path directories if the provided path does not exists.
*
* @param path the path to create directories
* @throws ZipException when there was a problem to create the directories
*/
private static void createDirectoryIfNotExists(final Path path) throws ZipException {
if (path.toFile().exists()) {
return;
}
try {
Files.createDirectories(path);
} catch (final IOException e) {
throw new ZipException(String.format("Could not create directories for path '%s'", path), e);
}
}
/**
* Zips a directory and its children content.
*
* @param fromPath the directory path to zip
* @param toZipFilePath the path to the zip file that will be created
* @throws ZipException when there was a problem during the zip process
*/
public static void createZipFromPath(final Path fromPath, final Path toZipFilePath) throws ZipException {
final Path createdZipFilePath;
try {
createdZipFilePath = Files.createFile(toZipFilePath);
} catch (final IOException e) {
throw new ZipException(String.format("Could not create file '%s'", toZipFilePath), e);
}
try (final FileOutputStream fileOutputStream = new FileOutputStream(
createdZipFilePath.toFile()); final BufferedOutputStream bos = new BufferedOutputStream(
fileOutputStream); final ZipOutputStream zipOut = new ZipOutputStream(bos); final Stream<Path> walkStream = Files.walk(fromPath)) {
final Set<Path> allFilesSet = walkStream.collect(Collectors.toSet());
for (final Path path : allFilesSet) {
checkForZipSlipInRead(path);
if (path.equals(fromPath)) {
continue;
}
final Path relativePath = fromPath.relativize(path);
final File file = path.toFile();
if (file.isDirectory()) {
zipOut.putNextEntry(new ZipEntry(relativePath + File.separator));
} else {
zipOut.putNextEntry(new ZipEntry(relativePath.toString()));
zipOut.write(Files.readAllBytes(path));
}
zipOut.closeEntry();
}
} catch (final FileNotFoundException e) {
throw new ZipException(String.format("Could not create file '%s'", toZipFilePath), e);
} catch (final IOException e) {
throw new ZipException("An error has occurred while creating the zip package", e);
}
}
}
|