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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
|
/**
* Copyright 2017 Huawei Technologies Co., Ltd.
*
* 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 org.onap.validation.csar;
import org.apache.commons.io.FilenameUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.*;
import java.nio.file.Files;
import java.nio.file.Paths;
import static java.nio.charset.StandardCharsets.*;
import java.util.*;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.yaml.snakeyaml.Yaml;
public class CsarValidator {
private static final Logger LOG = LoggerFactory.getLogger(CsarValidator.class);
//Schema files
static private ValidatorSchemaLoader vsl;
// Map of CSAR file and un-zipped file indices
static private HashMap<String, String> csarFiles;
// Map of packageId and CSAR files
private static HashMap<String, HashMap<String, String>> csar = new HashMap<String, HashMap<String, String>>();
private static String MAINSERV_TEMPLATE;
private static String MAINSERV_MANIFEST;
/**
*
* @param packageId
* @param csarWithPath
* @throws IOException
*/
public CsarValidator(String packageId, String csarWithPath) throws IOException {
try(FileInputStream is = new FileInputStream(csarWithPath)) {
} catch (FileNotFoundException e2) {
LOG.error("CSAR %s is not found! " +ErrorCodes.RESOURCE_MISSING, e2);
throw new ValidationException(ErrorCodes.RESOURCE_MISSING);
}
try {
csarFiles = CsarUtil.csarExtract(csarWithPath);
if(!csarFiles.isEmpty()) {
csar.put(packageId, getCsarFiles());
LOG.debug("CSAR extracted sucessfully.");
}
} catch (Exception e1) {
//deleteDirectory();
LOG.error("CSAR %s is not a valid CSAR/ZIP file! ", e1);
}
try {
vsl = new ValidatorSchemaLoader();
} catch (Exception e) {
e.printStackTrace();
}
}
/**
*
* @return true if all validations are successful
*/
public static boolean validateCsar() {
boolean vsm = validateCsarMeta();
// boolean vtm = validateToscaMeta__();
boolean vtm = validateAndScanToscaMeta();
boolean vms = validateMainService();
if ((vsm || vms ) && vtm) {
return true;
}
return false;
}
/**
*
* @param csarWithPath
* @return true if csar integrity validation is successful
*/
public static boolean validateCsarIntegrity(String csarWithPath) {
try {
RandomAccessFile raf = new RandomAccessFile(csarWithPath, "r");
long n = raf.readInt();
raf.close();
// Check for the CSAR's integrity
if (n != 0x504B0304) {
LOG.error("CSAR %s is not a valid CSAR/ZIP file! ");
return false;
}
return true;
} catch (IOException e1) {
LOG.error("CSAR %s is not a valid CSAR/ZIP file! ", e1);
return false;
}
}
/**
*
* @return true if csar meta data validation is successful
*/
public static boolean validateCsarMeta() {
String cfile = csarFiles.get(CommonConstants.CSAR_META);
if (StringUtils.isEmpty(cfile)) {
return false;
}
if (!cfile.isEmpty()) {
File file = new File(cfile);
try(BufferedReader reader = new BufferedReader(new FileReader(file))) {
String tempString = null;
while ((tempString = reader.readLine()) != null) {
if (!tempString.equals("")) {
int count1 = tempString.indexOf(":");
String meta = tempString.substring(0, count1).trim();
if (meta.equalsIgnoreCase(CommonConstants.CSAR_TYPE_META)) {
int count = tempString.indexOf(":") + 1;
if (tempString.substring(count).trim().isEmpty()) {
return false;
}
}
if (meta.equalsIgnoreCase(CommonConstants.CSAR_PROVIDER_META)) {
int count = tempString.indexOf(":") + 1;
if (tempString.substring(count).trim().isEmpty()) {
return false;
}
}
if (meta.equalsIgnoreCase(CommonConstants.CSAR_VERSION_META)) {
int count = tempString.indexOf(":") + 1;
if (tempString.substring(count).trim().isEmpty()) {
return false;
}
}
}
reader.close();
return true;
}
} catch (IOException e2) {
LOG.error("CSAR_META_VALIDATION" + ":" + "Exception caught while validateCsarMeta ! " +ErrorCodes.FILE_IO, e2);
throw new ValidationException(ErrorCodes.FILE_IO);
}
}
return false;
}
/**
*
* @return true csar tosca meta validation is successful
*/
public static boolean validateAndScanToscaMeta() {
String cfile = csarFiles.get(CommonConstants.TOSCA_META);
if (!validateToscaMeta(cfile)) {
return false;
}
try {
if (cfile.contains(System.getProperty("file.separator") +
CommonConstants.TOSCA_METADATA + System.getProperty("file.separator") +
CommonConstants.TOSCA_META)) {
MAINSERV_MANIFEST = checkAndGetMRF(cfile,"Entry-Manifest");
if (MAINSERV_MANIFEST == null) {
MAINSERV_MANIFEST = CommonConstants.MAINSERV_MANIFEST;
}
MAINSERV_TEMPLATE = checkAndGetMRF(cfile,"Entry-Definitions");
if (MAINSERV_TEMPLATE == null) {
MAINSERV_TEMPLATE = CommonConstants.MAINSERV_TEMPLATE;
}
return true;
}
} catch (Exception e) {
LOG.error("Parsing error");
}
return false;
}
private static String checkAndGetMRF(String mrfFile, String attribute) {
try {
String value = CheckEntryFor(mrfFile, attribute);
String mrfCsarEntry = null;
//Rel-1 & SOL004 Entry-Definitions is optional
if (! StringUtils.isEmpty(value)) {
if(value.contains("Definitions/"))
{
String[] splitPath = value.split("/");
mrfCsarEntry = csarFiles.get(splitPath[splitPath.length - 1]);
// csarEntry = csarFiles.get(subValue);
}
else { //Hack to support non-compliant "Entry-Definitions:" format
mrfCsarEntry = csarFiles.get(value);
}
if (null != mrfCsarEntry) {
return mrfCsarEntry;
}
}
} catch (IOException | NullPointerException e) {
LOG.error("CSAR_TOSCA_VALIDATION" + ":" + "Could not read file %s ! " +ErrorCodes.FILE_IO+ " " +ErrorCodes.RESOURCE_MISSING);
throw new ValidationException(ErrorCodes.RESOURCE_MISSING);
}
return null;
}
/**
*
* @return true csar validation is successful
*/
public static boolean validateMainService() {
String key = "metadata";
// Infuture load from the respective file template/schema
List<String> mListMetadata = Arrays.asList("vnf_product_name", "vnf_provider_id",
"vnf_package_version", "vnf_release_data_time");
@SuppressWarnings("unused")
boolean mfResult = CheckEntryFor(CommonConstants.MAINSERV_MANIFEST, mListMetadata, key);
String mainServManifest = MAINSERV_MANIFEST;
if(!Paths.get(mainServManifest).isAbsolute()){
mainServManifest = csarFiles.get(FilenameUtils.getName(mainServManifest));
}
// Rel-2 SOL004 requirement
if(StringUtils.isEmpty(mainServManifest)){
//Do nothing for Rel-1
//return false;
}
String mainservTemplate = MAINSERV_TEMPLATE;
if(!Paths.get(MAINSERV_TEMPLATE).isAbsolute()){
mainservTemplate = csarFiles.get(FilenameUtils.getName(mainservTemplate));
}
if(StringUtils.isEmpty(mainservTemplate)){
return false;
}
return true;
}
private static String CheckEntryFor(String fileWithPath, String attribute) throws IOException {
List<String> lines = Files.readAllLines(Paths.get(fileWithPath), UTF_8);
for (String strLine : lines) {
if (!attribute.isEmpty() && strLine.contains(attribute)) {
String entry = strLine.substring(attribute.length(), strLine.length()).trim();
return entry.replaceFirst(":","").trim();
}
}
return null;
}
@SuppressWarnings("unchecked")
private static boolean CheckEntryFor(String cFile, List<String> attributes, String key) {
@SuppressWarnings("unused")
String tFileWithPath;
if (! Paths.get(cFile).isAbsolute()) {
cFile = csarFiles.get(FilenameUtils.getName(cFile));
}
if(StringUtils.isEmpty(cFile)) {
return false;
}
Yaml yaml = new Yaml();
Map<String, ?> values;
try {
values = (Map<String, ?>) yaml.load(new FileInputStream(new File(cFile)));
} catch (FileNotFoundException e) {
LOG.error("FILE_NOT_FOUND" + ":" + "Exception caught while trying to find the file ! " + e.getMessage(), e);
return false;
}
Map<? super String,? super String> subValues = (Map<? super String, ? super String>) values.get(key);
//1. Check for empty values in map and if number of mandatory attributes presence
List<? super String> lResultNonNull = subValues.values().stream()
.filter(Objects::nonNull)
.map(Object::toString)
.collect(Collectors.toList());
// If no attributes provided, take it easy
// there are no mandatory fields to be
// validated.
if (attributes == null) {
return true;
}
if (subValues.size() != attributes.size() &&
lResultNonNull.size() != attributes.size()) {
return false;
}
//Validate the exact mandatory(not defined in SOL004 yet)
// attributes with expected attributes list
List<? super String> lResult = subValues.keySet().stream()
.filter(attributes::contains)
.collect(Collectors.toList());
if (lResult.size() == 0) {
return false;
}
return true;
}
/**
*
* @return true if csar meta data validation is successful
*/
private static boolean validateToscaMeta(String cfile) {
if (StringUtils.isEmpty(cfile)) {
return false;
}
else {
File file = new File(cfile);
Yaml yaml = new Yaml();
Map<String, ?> toscaMeta = null;
try {
toscaMeta = (Map<String, ?>) yaml.load(new FileInputStream(file));
} catch (FileNotFoundException e) {
e.printStackTrace();
}
return toscaMeta.keySet().containsAll((vsl.getToscaMeta().keySet()));
}
}
public static HashMap<String, HashMap<String, String>> getCsar() {
return csar;
}
public static void setCsar(HashMap<String, HashMap<String, String>> csar) {
CsarValidator.csar = csar;
}
public static HashMap<String, String> getCsarFiles() {
return csarFiles;
}
public static void setCsarFiles(HashMap<String, String> csarFiles) {
CsarValidator.csarFiles = csarFiles;
}
}
|