Add support for TOSCA 1.3
[sdc.git] / catalog-be / src / main / java / org / openecomp / sdc / be / servlets / AbstractValidationsServlet.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * SDC
4  * ================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END=========================================================
19  * Modifications copyright (c) 2019 Nokia
20  * ================================================================================
21  */
22
23 package org.openecomp.sdc.be.servlets;
24
25 import com.fasterxml.jackson.databind.ObjectMapper;
26 import com.google.gson.Gson;
27 import com.google.gson.JsonSyntaxException;
28 import fj.data.Either;
29 import java.io.File;
30 import java.io.FileInputStream;
31 import java.io.IOException;
32 import java.io.InputStream;
33 import java.lang.reflect.Type;
34 import java.nio.charset.StandardCharsets;
35 import java.util.Arrays;
36 import java.util.HashMap;
37 import java.util.List;
38 import java.util.Map;
39 import java.util.Optional;
40 import java.util.function.Supplier;
41 import javax.servlet.ServletContext;
42 import javax.servlet.http.HttpServletRequest;
43 import javax.ws.rs.core.Response;
44 import org.apache.commons.codec.binary.Base64;
45 import org.apache.commons.collections4.MapUtils;
46 import org.apache.commons.io.IOUtils;
47 import org.apache.commons.lang3.StringUtils;
48 import org.apache.commons.lang3.tuple.ImmutablePair;
49 import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;
50 import org.openecomp.sdc.be.components.impl.CsarValidationUtils;
51 import org.openecomp.sdc.be.components.impl.ImportUtils;
52 import org.openecomp.sdc.be.components.impl.ImportUtils.ResultStatusEnum;
53 import org.openecomp.sdc.be.components.impl.ImportUtils.ToscaElementTypeEnum;
54 import org.openecomp.sdc.be.components.impl.ResourceImportManager;
55 import org.openecomp.sdc.be.components.impl.exceptions.ByActionStatusComponentException;
56 import org.openecomp.sdc.be.components.impl.exceptions.ByResponseFormatComponentException;
57 import org.openecomp.sdc.be.components.impl.exceptions.ComponentException;
58 import org.openecomp.sdc.be.config.BeEcompErrorManager;
59 import org.openecomp.sdc.be.config.ConfigurationManager;
60 import org.openecomp.sdc.be.dao.api.ActionStatus;
61 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
62 import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
63 import org.openecomp.sdc.be.impl.ComponentsUtils;
64 import org.openecomp.sdc.be.impl.ServletUtils;
65 import org.openecomp.sdc.be.model.ArtifactDefinition;
66 import org.openecomp.sdc.be.model.Resource;
67 import org.openecomp.sdc.be.model.UploadResourceInfo;
68 import org.openecomp.sdc.be.model.User;
69 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
70 import org.openecomp.sdc.be.servlets.ResourceUploadServlet.ResourceAuthorityTypeEnum;
71 import org.openecomp.sdc.be.user.Role;
72 import org.openecomp.sdc.be.user.UserBusinessLogic;
73 import org.openecomp.sdc.be.utils.TypeUtils;
74 import org.openecomp.sdc.common.api.Constants;
75 import org.openecomp.sdc.common.api.UploadArtifactInfo;
76 import org.openecomp.sdc.common.datastructure.Wrapper;
77 import org.openecomp.sdc.common.log.wrappers.Logger;
78 import org.openecomp.sdc.common.util.GeneralUtility;
79 import org.openecomp.sdc.common.util.YamlToObjectConverter;
80 import org.openecomp.sdc.common.zip.ZipUtils;
81 import org.openecomp.sdc.common.zip.exception.ZipException;
82 import org.openecomp.sdc.exception.ResponseFormat;
83 import org.yaml.snakeyaml.Yaml;
84
85 public abstract class AbstractValidationsServlet extends BeGenericServlet {
86
87     private static final Logger log = Logger.getLogger(AbstractValidationsServlet.class);
88     private static final String TOSCA_SIMPLE_YAML_PREFIX = "tosca_simple_yaml_";
89     private static final List<String> TOSCA_DEFINITION_VERSIONS = Arrays.asList(
90         TOSCA_SIMPLE_YAML_PREFIX + "1_0_0",
91         TOSCA_SIMPLE_YAML_PREFIX + "1_1_0",
92         "tosca_simple_profile_for_nfv_1_0_0",
93         TOSCA_SIMPLE_YAML_PREFIX + "1_0",
94         TOSCA_SIMPLE_YAML_PREFIX + "1_1",
95         TOSCA_SIMPLE_YAML_PREFIX + "1_2",
96         TOSCA_SIMPLE_YAML_PREFIX + "1_3");
97     private static final List<String> TOSCA_YML_CSAR_VALID_SUFFIX = Arrays.asList(".yml", ".yaml", ".csar");
98
99     protected ServletUtils servletUtils;
100     protected ResourceImportManager resourceImportManager;
101     protected final ComponentInstanceBusinessLogic componentInstanceBusinessLogic;
102
103
104     public AbstractValidationsServlet(UserBusinessLogic userBusinessLogic,
105         ComponentInstanceBusinessLogic componentInstanceBL, ComponentsUtils componentsUtils,
106         ServletUtils servletUtils, ResourceImportManager resourceImportManager) {
107         super(userBusinessLogic, componentsUtils);
108         this.servletUtils = servletUtils;
109         this.resourceImportManager = resourceImportManager;
110         this.componentInstanceBusinessLogic = componentInstanceBL;
111     }
112
113     protected void init() {
114     }
115
116     protected void validateResourceDoesNotExist(Wrapper<Response> responseWrapper, User user, String resourceName) {
117         if (resourceImportManager.isResourceExist(resourceName)) {
118             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.RESOURCE_ALREADY_EXISTS);
119             Response errorResponse = buildErrorResponse(responseFormat);
120             getComponentsUtils().auditResource(responseFormat, user, resourceName, AuditingActionEnum.IMPORT_RESOURCE);
121             responseWrapper.setInnerElement(errorResponse);
122         }
123     }
124
125     protected void validateUserExist(Wrapper<Response> responseWrapper, Wrapper<User> userWrapper, String userUserId) {
126         log.debug("get user {} from DB", userUserId);
127         // get user details
128         if (userUserId == null) {
129             log.info("user userId is null");
130             Response response = returnMissingInformation(new User());
131             responseWrapper.setInnerElement(response);
132         }
133
134         else {
135             UserBusinessLogic userAdmin = getServletUtils().getUserAdmin();
136             try {
137                 User user = userAdmin.getUser(userUserId);
138                 userWrapper.setInnerElement(user);
139             } catch (ComponentException ce) {
140                 log.info("user is not listed. userId={}", userUserId);
141                 User user = new User();
142                 user.setUserId(userUserId);
143                 Response response = returnMissingInformation(user);
144                 responseWrapper.setInnerElement(response);
145             }
146         }
147     }
148
149     protected Response returnMissingInformation(User user) {
150         ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_INFORMATION);
151         getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
152         return buildErrorResponse(responseFormat);
153     }
154
155     protected void validateDataNotNull(Wrapper<Response> responseWrapper, Object... dataParams) {
156         for (Object dataElement : dataParams) {
157             if (dataElement == null) {
158                 log.info("Invalid body was received.");
159                 Response response = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
160                 responseWrapper.setInnerElement(response);
161                 break;
162             }
163         }
164
165     }
166
167     protected void validateUserRole(Wrapper<Response> errorResponseWrapper, User user) {
168         log.debug("validate user role");
169         if (!user.getRole().equals(Role.ADMIN.name()) && !user.getRole().equals(Role.DESIGNER.name())) {
170             log.info("user is not in appropriate role to perform action");
171             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.RESTRICTED_OPERATION);
172             log.debug("audit before sending response");
173             getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
174
175             Response response = buildErrorResponse(responseFormat);
176             errorResponseWrapper.setInnerElement(response);
177         }
178
179     }
180
181     protected void validateZip(final Wrapper<Response> responseWrapper, final File zipFile, final String payloadName) {
182         if (StringUtils.isEmpty(payloadName)) {
183             log.info("Invalid JSON was received. Payload name is empty");
184             final Response errorResponse =
185                 buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
186             responseWrapper.setInnerElement(errorResponse);
187             return;
188         }
189         final Map<String, byte[]> unzippedFolder;
190         try {
191             unzippedFolder = ZipUtils.readZip(zipFile, false);
192         } catch (final ZipException e) {
193             log.error("Could not read ZIP file '{}' for validation", zipFile.getName(), e);
194             final Response errorResponse =
195                 buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
196             responseWrapper.setInnerElement(errorResponse);
197             return;
198         }
199         if (!unzippedFolder.containsKey(payloadName)) {
200             log.info("Could no find payload '{}' in ZIP file '{}'", payloadName, zipFile.getName());
201             final Response errorResponse =
202                 buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
203             responseWrapper.setInnerElement(errorResponse);
204         }
205
206
207     }
208
209     protected void validateCsar(final Wrapper<Response> responseWrapper, final File csarFile, final String payloadName) {
210         if (StringUtils.isEmpty(payloadName)) {
211             log.info("Invalid JSON was received. Payload name is empty");
212             Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
213             responseWrapper.setInnerElement(errorResponse);
214             return;
215         }
216         final Map<String, byte[]> unzippedFolder;
217         try {
218             unzippedFolder = ZipUtils.readZip(csarFile, false);
219         } catch (final ZipException e) {
220             log.error("Could not read CSAR file '{}' for validation", csarFile.getName(), e);
221             final Response errorResponse =
222                 buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
223             responseWrapper.setInnerElement(errorResponse);
224             return;
225         }
226         if (unzippedFolder.isEmpty()) {
227             log.info("The CSAR file is empty");
228             Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
229             responseWrapper.setInnerElement(errorResponse);
230         }
231
232     }
233
234     protected void fillZipContents(Wrapper<String> yamlStringWrapper, File file) throws ZipException {
235         extractZipContents(yamlStringWrapper, file);
236     }
237
238     public static void extractZipContents(Wrapper<String> yamlStringWrapper, File file) throws ZipException {
239         final Map<String, byte[]> unzippedFolder = ZipUtils.readZip(file, false);
240         String ymlName = unzippedFolder.keySet().iterator().next();
241         fillToscaTemplateFromZip(yamlStringWrapper, ymlName, file);
242     }
243
244     private static void fillToscaTemplateFromZip(final Wrapper<String> yamlStringWrapper, final String payloadName,
245                                                  final File file) throws ZipException {
246         final Map<String, byte[]> unzippedFolder = ZipUtils.readZip(file, false);
247         final byte[] yamlFileInBytes = unzippedFolder.get(payloadName);
248         final String yamlAsString = new String(yamlFileInBytes, StandardCharsets.UTF_8);
249         log.debug("received yaml: {}", yamlAsString);
250         yamlStringWrapper.setInnerElement(yamlAsString);
251     }
252
253     protected void fillPayloadDataFromFile(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfoWrapper, File file)  {
254         try(InputStream fileInputStream = new FileInputStream(file)){
255
256             byte [] data = new byte[(int)file.length()];
257             if( fileInputStream.read(data) == -1){
258                 log.info("Invalid json was received.");
259                 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
260
261                 Response errorResp = buildErrorResponse(responseFormat);
262                 responseWrapper.setInnerElement(errorResp);
263             }
264             String payloadData =  Base64.encodeBase64String(data);
265             uploadResourceInfoWrapper.setPayloadData(payloadData);
266
267
268
269         } catch (IOException e) {
270             log.info("Invalid json was received or Error while closing input Stream.");
271             log.debug("Invalid json was received or Error while closing input Stream. {}", e.getMessage(), e);
272             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
273
274             Response errorResp = buildErrorResponse(responseFormat);
275             responseWrapper.setInnerElement(errorResp);
276
277         }
278     }
279
280     protected void validateUserRole(Wrapper<Response> errorResponseWrapper, User user, ResourceAuthorityTypeEnum resourceAuthority) {
281         log.debug("validate user role");
282         if (resourceAuthority == ResourceAuthorityTypeEnum.NORMATIVE_TYPE_BE) {
283             if (!user.getRole().equals(Role.ADMIN.name())) {
284                 log.info("user is not in appropriate role to perform action");
285                 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.RESTRICTED_OPERATION);
286                 log.debug("audit before sending response");
287                 getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
288
289                 Response response = buildErrorResponse(responseFormat);
290                 errorResponseWrapper.setInnerElement(response);
291             }
292         } else {
293             validateUserRole(errorResponseWrapper, user);
294         }
295
296     }
297
298     protected void validateAndFillResourceJson(Wrapper<Response> responseWrapper, Wrapper<UploadResourceInfo> uploadResourceInfoWrapper, User user, ResourceAuthorityTypeEnum resourceAuthorityEnum, String resourceInfo) {
299         boolean isValid;
300         try {
301             log.debug("The received json is {}", resourceInfo);
302             UploadResourceInfo resourceInfoObject = gson.fromJson(resourceInfo, UploadResourceInfo.class);
303             if (resourceInfoObject == null) {
304                 isValid = false;
305             } else {
306                 if (!resourceAuthorityEnum.isBackEndImport()) {
307                     isValid = resourceInfoObject.getPayloadName() != null && !resourceInfoObject.getPayloadName().isEmpty();
308                     //only resource name is checked
309                 } else {
310                     isValid = true;
311                 }
312                 uploadResourceInfoWrapper.setInnerElement(resourceInfoObject);
313             }
314
315         } catch (JsonSyntaxException e) {
316             log.debug("Invalid json was received. {}", e.getMessage(), e);
317             isValid = false;
318
319         }
320         if (!isValid) {
321             log.info("Invalid json was received.");
322             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
323             getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
324             Response errorResp = buildErrorResponse(responseFormat);
325             responseWrapper.setInnerElement(errorResp);
326         }
327     }
328
329     protected void validateAuthorityType(Wrapper<Response> responseWrapper, String authorityType) {
330         log.debug("The received authority type is {}", authorityType);
331         ResourceAuthorityTypeEnum authorityTypeEnum = ResourceAuthorityTypeEnum.findByUrlPath(authorityType);
332         if (authorityTypeEnum == null) {
333             log.info("Invalid authority type was received.");
334             Response errorResp = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
335             responseWrapper.setInnerElement(errorResp);
336         }
337     }
338
339     public ServletUtils getServletUtils() {
340         return servletUtils;
341     }
342
343     public Gson getGson() {
344         return getServletUtils().getGson();
345     }
346
347     public ComponentsUtils getComponentsUtils() {
348         return getServletUtils().getComponentsUtils();
349     }
350
351     protected void validatePayloadIsTosca(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user, String toscaPayload) {
352         log.debug("checking payload is valid tosca");
353         boolean isValid;
354         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
355         Either<String, ResultStatusEnum> findFirstToscaStringElement = ImportUtils.findFirstToscaStringElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.TOSCA_VERSION);
356
357         if (findFirstToscaStringElement.isRight()) {
358             isValid = false;
359         } else {
360             String defenitionVersionFound = findFirstToscaStringElement.left().value();
361             if (defenitionVersionFound == null || defenitionVersionFound.isEmpty()) {
362                 isValid = false;
363             } else {
364                 isValid = TOSCA_DEFINITION_VERSIONS.contains(defenitionVersionFound);
365             }
366         }
367
368         if (!isValid) {
369             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_TOSCA_TEMPLATE);
370             Response errorResponse = buildErrorResponse(responseFormat);
371             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
372             responseWrapper.setInnerElement(errorResponse);
373         }
374
375     }
376
377     protected void validatePayloadIsYml(Wrapper<Response> responseWrapper, User user, UploadResourceInfo uploadResourceInfo, String toscaTamplatePayload) {
378         log.debug("checking tosca template is valid yml");
379         YamlToObjectConverter yamlConvertor = new YamlToObjectConverter();
380         boolean isYamlValid = yamlConvertor.isValidYaml(toscaTamplatePayload.getBytes());
381         if (!isYamlValid) {
382             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_YAML_FILE);
383             Response errorResponse = buildErrorResponse(responseFormat);
384             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
385             responseWrapper.setInnerElement(errorResponse);
386         }
387     }
388
389     /**
390      * Gets the Resource type from the given node type name.
391      *
392      * @param nodeTypeFullName - Node type Name
393      * @return Resource Type name
394      */
395     private String getResourceType(final String nodeTypeFullName) {
396
397         final Optional<String> nodeTypeNamePrefix = getNodeTypeNamePrefix(nodeTypeFullName);
398         if (nodeTypeNamePrefix.isPresent()) {
399             final String nameWithouNamespacePrefix = nodeTypeFullName.substring(nodeTypeNamePrefix.get().length());
400             final String[] findTypes = nameWithouNamespacePrefix.split("\\.");
401             if (findTypes.length > 0) {
402                 final ResourceTypeEnum resourceType = ResourceTypeEnum.getType(findTypes[0].toUpperCase());
403                 if (resourceType != null) {
404                     return resourceType.name();
405                 }
406             }
407         }
408         return ResourceTypeEnum.VFC.name();
409     }
410
411     /**
412      * Extracts the Node Type Name prefix from the given Node Type Name.
413      * @param nodeName - Node Type Name
414      * @return Node Type Name prefix
415      */
416     private Optional<String> getNodeTypeNamePrefix(final String nodeName) {
417         final List<String> definedNodeTypeNamespaceList = ConfigurationManager.getConfigurationManager()
418             .getConfiguration().getDefinedResourceNamespace();
419         for (final String validNamespace : definedNodeTypeNamespaceList) {
420             if (nodeName.startsWith(validNamespace)) {
421                 return Optional.of(validNamespace);
422             }
423         }
424         return Optional.empty();
425     }
426
427     protected void validatePayloadNameSpace(final Wrapper<Response> responseWrapper,
428                                             final UploadResourceInfo resourceInfo,
429                                             final User user, final String toscaPayload) {
430         boolean isValid;
431         String namespace = "";
432         final Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
433         final Either<Map<String, Object>, ResultStatusEnum> toscaElement = ImportUtils.findFirstToscaMapElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.NODE_TYPES);
434         if (toscaElement.isRight() || toscaElement.left().value().size() != 1) {
435             isValid = false;
436         } else {
437             namespace = toscaElement.left().value().keySet().iterator().next();
438             isValid = getNodeTypeNamePrefix(namespace).isPresent();
439         }
440         if (!isValid) {
441             final ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_RESOURCE_NAMESPACE);
442             final Response errorResponse = buildErrorResponse(responseFormat);
443             getComponentsUtils().auditResource(responseFormat, user, resourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
444             responseWrapper.setInnerElement(errorResponse);
445         } else {
446             resourceInfo.setResourceType(getResourceType(namespace));
447         }
448     }
449
450     private void validatePayloadIsSingleResource(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user, String toscaPayload) {
451         log.debug("checking payload contains single resource");
452         boolean isValid;
453         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
454         Either<Map<String, Object>, ResultStatusEnum> toscaElement = ImportUtils.findFirstToscaMapElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.NODE_TYPES);
455         if (toscaElement.isRight()) {
456             isValid = false;
457         } else {
458             isValid = toscaElement.left().value().size() == 1;
459         }
460
461         if (!isValid) {
462             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.NOT_SINGLE_RESOURCE);
463             Response errorResponse = buildErrorResponse(responseFormat);
464             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
465             responseWrapper.setInnerElement(errorResponse);
466         }
467
468     }
469
470     private void validatePayloadIsNotService(Wrapper<Response> responseWrapper, User user, UploadResourceInfo uploadResourceInfo, String toscaPayload) {
471         log.debug("checking payload is not a tosca service");
472         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
473         Either<Object, ResultStatusEnum> toscaElement = ImportUtils.findToscaElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.TOPOLOGY_TEMPLATE, ToscaElementTypeEnum.ALL);
474
475         if (toscaElement.isLeft()) {
476             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.NOT_RESOURCE_TOSCA_TEMPLATE);
477             Response errorResponse = buildErrorResponse(responseFormat);
478             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
479             responseWrapper.setInnerElement(errorResponse);
480         }
481
482     }
483
484     private void validateToscaTemplatePayloadName(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user) {
485         String toscaTemplatePayloadName = uploadResourceInfo.getPayloadName();
486         boolean isValidSuffix = false;
487         if (toscaTemplatePayloadName != null && !toscaTemplatePayloadName.isEmpty()) {
488             for (String validSuffix : TOSCA_YML_CSAR_VALID_SUFFIX) {
489                 isValidSuffix = isValidSuffix || toscaTemplatePayloadName.toLowerCase().endsWith(validSuffix);
490             }
491         }
492         if (!isValidSuffix) {
493             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_TOSCA_FILE_EXTENSION);
494             Response errorResponse = buildErrorResponse(responseFormat);
495             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
496             responseWrapper.setInnerElement(errorResponse);
497         }
498
499     }
500
501     private void validateMD5(Wrapper<Response> responseWrapper, User user, UploadResourceInfo resourceInfo, HttpServletRequest request, String resourceInfoJsonString) {
502         boolean isValid;
503         String recievedMD5 = request.getHeader(Constants.MD5_HEADER);
504         if (recievedMD5 == null) {
505             isValid = false;
506         } else {
507             String calculateMD5 = GeneralUtility.calculateMD5Base64EncodedByString(resourceInfoJsonString);
508             isValid = calculateMD5.equals(recievedMD5);
509         }
510         if (!isValid) {
511             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_RESOURCE_CHECKSUM);
512             Response errorResponse = buildErrorResponse(responseFormat);
513             getComponentsUtils().auditResource(responseFormat, user, resourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
514             responseWrapper.setInnerElement(errorResponse);
515         }
516     }
517
518     ComponentTypeEnum validateComponentType(String componentType) {
519         if (componentType == null) {
520             throw new ByActionStatusComponentException(ActionStatus.UNSUPPORTED_ERROR);
521         }
522         if (ComponentTypeEnum.RESOURCE_PARAM_NAME.equalsIgnoreCase(componentType)) {
523             return ComponentTypeEnum.RESOURCE;
524         }
525         if (ComponentTypeEnum.SERVICE_PARAM_NAME.equalsIgnoreCase(componentType)) {
526             return ComponentTypeEnum.SERVICE;
527         }
528         log.debug("Invalid componentType:{}", componentType);
529         throw new ByActionStatusComponentException(ActionStatus.UNSUPPORTED_ERROR, componentType);
530     }
531
532
533     ComponentTypeEnum convertToComponentType(String componentType) {
534         return validateComponentType(componentType);
535     }
536
537     private void fillToscaTemplateFromJson(Wrapper<Response> responseWrapper, Wrapper<String> yamlStringWrapper, User user, UploadResourceInfo resourceInfo) {
538         if (resourceInfo.getPayloadData() == null || resourceInfo.getPayloadData().isEmpty()) {
539             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_RESOURCE_PAYLOAD);
540             Response errorResponse = buildErrorResponse(responseFormat);
541             getComponentsUtils().auditResource(responseFormat, user, resourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
542             responseWrapper.setInnerElement(errorResponse);
543         } else {
544             String toscaPayload = resourceInfo.getPayloadData();
545             String decodedPayload = new String(Base64.decodeBase64(toscaPayload));
546             yamlStringWrapper.setInnerElement(decodedPayload);
547         }
548
549     }
550
551     void fillPayload(Wrapper<Response> responseWrapper, Wrapper<UploadResourceInfo> uploadResourceInfoWrapper, Wrapper<String> yamlStringWrapper, User user, String resourceInfoJsonString, ResourceAuthorityTypeEnum resourceAuthorityEnum,
552             File file) throws ZipException {
553
554         if (responseWrapper.isEmpty()) {
555             if (resourceAuthorityEnum.isBackEndImport()) {
556                 // PrePayload Validations
557                 if (responseWrapper.isEmpty()) {
558                     validateDataNotNull(responseWrapper, file, resourceInfoJsonString);
559                 }
560                 if(!resourceAuthorityEnum.equals(ResourceAuthorityTypeEnum.CSAR_TYPE_BE)){
561                     if (responseWrapper.isEmpty()) {
562                         validateZip(responseWrapper, file, uploadResourceInfoWrapper.getInnerElement().getPayloadName());
563                     }
564
565                     // Fill PayLoad From File
566                     if (responseWrapper.isEmpty()) {
567                         fillToscaTemplateFromZip(yamlStringWrapper, uploadResourceInfoWrapper.getInnerElement().getPayloadName(), file);
568                     }
569                 }else{
570
571                     if (responseWrapper.isEmpty()) {
572                         validateCsar(responseWrapper, file, uploadResourceInfoWrapper.getInnerElement().getPayloadName());
573                     }
574
575                     // Fill PayLoad From File
576                     if (responseWrapper.isEmpty()) {
577                         fillPayloadDataFromFile(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), file);
578                     }
579
580                 }
581
582             } else {
583                 // Fill PayLoad From JSON
584                 if (responseWrapper.isEmpty()) {
585                     fillToscaTemplateFromJson(responseWrapper, yamlStringWrapper, user, uploadResourceInfoWrapper.getInnerElement());
586                 }
587             }
588
589         }
590
591     }
592
593     protected void specificResourceAuthorityValidations(final Wrapper<Response> responseWrapper,
594                                                         final Wrapper<UploadResourceInfo> uploadResourceInfoWrapper,
595                                                         final Wrapper<String> yamlStringWrapper, final User user,
596                                                         final HttpServletRequest request, final String resourceInfoJsonString,
597                                                         final ResourceAuthorityTypeEnum resourceAuthorityEnum) {
598
599         if (responseWrapper.isEmpty()) {
600             // UI Only Validation
601             if (!resourceAuthorityEnum.isBackEndImport()) {
602                 importUIValidations(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), user, request, resourceInfoJsonString);
603             }
604
605             // User Defined Type Resources
606             if (resourceAuthorityEnum.isUserTypeResource()
607                     && !CsarValidationUtils.isCsarPayloadName(uploadResourceInfoWrapper.getInnerElement().getPayloadName())
608                     && responseWrapper.isEmpty()) {
609                             validatePayloadNameSpace(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), user, yamlStringWrapper.getInnerElement());
610             }
611         }
612     }
613
614     void commonGeneralValidations(Wrapper<Response> responseWrapper, Wrapper<User> userWrapper, Wrapper<UploadResourceInfo> uploadResourceInfoWrapper, ResourceAuthorityTypeEnum resourceAuthorityEnum, String userId,
615                                   String resourceInfoJsonString) {
616
617         if (responseWrapper.isEmpty()) {
618             validateUserExist(responseWrapper, userWrapper, userId);
619         }
620
621         if (responseWrapper.isEmpty()) {
622             validateUserRole(responseWrapper, userWrapper.getInnerElement(), resourceAuthorityEnum);
623         }
624
625         if (responseWrapper.isEmpty()) {
626             validateAndFillResourceJson(responseWrapper, uploadResourceInfoWrapper, userWrapper.getInnerElement(), resourceAuthorityEnum, resourceInfoJsonString);
627         }
628
629         if (responseWrapper.isEmpty()) {
630             validateToscaTemplatePayloadName(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), userWrapper.getInnerElement());
631         }
632         if (responseWrapper.isEmpty()) {
633             validateResourceType(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), userWrapper.getInnerElement());
634         }
635
636     }
637
638     private void validateResourceType(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user) {
639         String resourceType = uploadResourceInfo.getResourceType();
640         if (resourceType == null || !ResourceTypeEnum.containsName(resourceType)) {
641             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
642             Response errorResponse = buildErrorResponse(responseFormat);
643             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
644             responseWrapper.setInnerElement(errorResponse);
645         }
646     }
647
648     private void importUIValidations(Wrapper<Response> responseWrapper, UploadResourceInfo resourceInfo, User user, HttpServletRequest request, String resourceInfoJsonString) {
649         if (responseWrapper.isEmpty()) {
650             validateMD5(responseWrapper, user, resourceInfo, request, resourceInfoJsonString);
651         }
652         if (responseWrapper.isEmpty() && request != null && request.getMethod() != null && request.getMethod().equals("POST")) {
653             validateResourceDoesNotExist(responseWrapper, user, resourceInfo.getName());
654         }
655     }
656
657     void commonPayloadValidations(Wrapper<Response> responseWrapper, Wrapper<String> yamlStringWrapper, User user, UploadResourceInfo uploadResourceInfo) {
658
659         if (responseWrapper.isEmpty()) {
660             validatePayloadIsYml(responseWrapper, user, uploadResourceInfo, yamlStringWrapper.getInnerElement());
661         }
662         if (responseWrapper.isEmpty()) {
663             validatePayloadIsTosca(responseWrapper, uploadResourceInfo, user, yamlStringWrapper.getInnerElement());
664         }
665         if (responseWrapper.isEmpty()) {
666             validatePayloadIsNotService(responseWrapper, user, uploadResourceInfo, yamlStringWrapper.getInnerElement());
667         }
668         if (responseWrapper.isEmpty()) {
669             validatePayloadIsSingleResource(responseWrapper, uploadResourceInfo, user, yamlStringWrapper.getInnerElement());
670         }
671     }
672
673
674     void handleImport(Wrapper<Response> responseWrapper, User user, UploadResourceInfo resourceInfoObject, String yamlAsString, ResourceAuthorityTypeEnum authority, boolean createNewVersion, String resourceUniqueId) {
675         ImmutablePair<Resource, ActionStatus> createOrUpdateResponse = null;
676         Response response = null;
677         Object representation = null;
678         ImmutablePair<Resource, ActionStatus> importedResourceStatus = null;
679         if (CsarValidationUtils.isCsarPayloadName(resourceInfoObject.getPayloadName())) {
680             log.debug("import resource from csar");
681             importedResourceStatus = importResourceFromUICsar(resourceInfoObject, user, resourceUniqueId);
682         } else if (!authority.isUserTypeResource()) {
683             log.debug("import normative type resource");
684             createOrUpdateResponse = resourceImportManager.importNormativeResource(yamlAsString, resourceInfoObject, user, createNewVersion, true);
685         } else {
686             log.debug("import user resource (not normative type)");
687             createOrUpdateResponse = resourceImportManager.importUserDefinedResource(yamlAsString, resourceInfoObject, user,  false);
688         }
689         if (createOrUpdateResponse!= null){
690             importedResourceStatus = createOrUpdateResponse;
691         }
692         if(importedResourceStatus != null){
693             try {
694                 representation = RepresentationUtils.toRepresentation(importedResourceStatus.left);
695             } catch (IOException e) {
696                 log.debug("Error while building resource representation : {}", e.getMessage(), e);
697             }
698             response = buildOkResponse(getComponentsUtils().getResponseFormat(importedResourceStatus.right), representation);
699         }
700         responseWrapper.setInnerElement(response);
701     }
702
703     private ImmutablePair<Resource, ActionStatus> importResourceFromUICsar(UploadResourceInfo resourceInfoObject, User user, String resourceUniqueId) {
704
705         Resource newResource;
706         ActionStatus actionStatus;
707         Resource resource = new Resource();
708         String payloadName = resourceInfoObject.getPayloadName();
709         fillResourceFromResourceInfoObject(resource, resourceInfoObject);
710
711         Map<String, byte[]> csarUIPayload = getCsarFromPayload(resourceInfoObject);
712         getAndValidateCsarYaml(csarUIPayload, resource, user, payloadName);
713
714         if (resourceUniqueId == null || resourceUniqueId.isEmpty()) {
715             newResource = resourceImportManager.getResourceBusinessLogic().createResource(resource, AuditingActionEnum.CREATE_RESOURCE, user, csarUIPayload, payloadName);
716             actionStatus = ActionStatus.CREATED;
717         } else {
718             newResource = resourceImportManager.getResourceBusinessLogic().validateAndUpdateResourceFromCsar(resource, user, csarUIPayload, payloadName, resourceUniqueId);
719             actionStatus = ActionStatus.OK;
720         }
721         return new ImmutablePair<>(newResource, actionStatus);
722     }
723
724     private Resource throwComponentException(ResponseFormat responseFormat) {
725         throw new ByResponseFormatComponentException(responseFormat);
726     }
727
728     private void getAndValidateCsarYaml(Map<String, byte[]> csarUIPayload, Resource resource, User user, String csarUUID) {
729
730         Either<ImmutablePair<String, String>, ResponseFormat> getToscaYamlRes = CsarValidationUtils.getToscaYaml(csarUIPayload, csarUUID, getComponentsUtils());
731
732         if (getToscaYamlRes.isRight()) {
733             ResponseFormat responseFormat = getToscaYamlRes.right().value();
734             log.debug("Error when try to get csar toscayamlFile with csar ID {}, error: {}", csarUUID, responseFormat);
735             BeEcompErrorManager.getInstance().logBeDaoSystemError("Creating resource from CSAR: fetching CSAR with id " + csarUUID + " failed");
736             getComponentsUtils().auditResource(responseFormat, user, resource, AuditingActionEnum.CREATE_RESOURCE);
737             throwComponentException(responseFormat);
738         }
739         String toscaYaml = getToscaYamlRes.left().value().getValue();
740
741         log.debug("checking tosca template is valid yml");
742         YamlToObjectConverter yamlConvertor = new YamlToObjectConverter();
743         boolean isValid = yamlConvertor.isValidYaml(toscaYaml.getBytes());
744         if (!isValid) {
745             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_YAML_FILE);
746             getComponentsUtils().auditResource(responseFormat, user, resource, AuditingActionEnum.IMPORT_RESOURCE);
747             throwComponentException(responseFormat);
748         }
749
750         log.debug("checking payload is valid tosca");
751         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaYaml);
752         Either<String, ResultStatusEnum> findFirstToscaStringElement = ImportUtils.findFirstToscaStringElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.TOSCA_VERSION);
753
754         if (findFirstToscaStringElement.isRight()) {
755             isValid = false;
756         } else {
757             String defenitionVersionFound = findFirstToscaStringElement.left().value();
758             if (defenitionVersionFound == null || defenitionVersionFound.isEmpty()) {
759                 isValid = false;
760             } else {
761                 isValid = TOSCA_DEFINITION_VERSIONS.contains(defenitionVersionFound);
762             }
763         }
764
765         if (!isValid) {
766             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_TOSCA_TEMPLATE);
767             getComponentsUtils().auditResource(responseFormat, user, resource, AuditingActionEnum.IMPORT_RESOURCE);
768             throwComponentException(responseFormat);
769         }
770     }
771
772     private void fillResourceFromResourceInfoObject(Resource resource, UploadResourceInfo resourceInfoObject) {
773         resourceImportManager.populateResourceMetadata(resourceInfoObject, resource);
774         fillArtifacts(resource, resourceInfoObject);
775
776     }
777
778     private void fillArtifacts(Resource resource, UploadResourceInfo resourceInfoObject) {
779         if (resource != null && resourceInfoObject != null) {
780             List<UploadArtifactInfo> artifactList = resourceInfoObject.getArtifactList();
781             if (artifactList != null) {
782                 Map<String, ArtifactDefinition> artifactsHM = new HashMap<>();
783                 for (UploadArtifactInfo artifact : artifactList) {
784                     ArtifactDefinition artifactDef = new ArtifactDefinition();
785                     artifactDef.setArtifactName(artifact.getArtifactName());
786                     artifactDef.setArtifactType(artifact.getArtifactType().getType());
787                     artifactDef.setDescription(artifact.getArtifactDescription());
788                     artifactDef.setPayloadData(artifact.getArtifactData());
789                     artifactDef.setArtifactRef(artifact.getArtifactPath());
790                     artifactsHM.put(artifactDef.getArtifactName(), artifactDef);
791                 }
792                 resource.setArtifacts(artifactsHM);
793             }
794         }
795     }
796
797     private Map<String, byte[]> getCsarFromPayload(UploadResourceInfo innerElement) {
798         String csarUUID = innerElement.getPayloadName();
799         String payloadData = innerElement.getPayloadData();
800         if (payloadData == null) {
801             log.info("Failed to decode received csar {}", csarUUID);
802             throw new ByActionStatusComponentException(ActionStatus.CSAR_NOT_FOUND, csarUUID);
803         }
804
805         byte[] decodedPayload = Base64.decodeBase64(payloadData.getBytes(StandardCharsets.UTF_8));
806         if (decodedPayload == null) {
807             log.info("Failed to decode received csar {}", csarUUID);
808             throw new ByActionStatusComponentException(ActionStatus.CSAR_NOT_FOUND, csarUUID);
809         }
810
811         Map<String, byte[]> csar = null;
812         try {
813             csar = ZipUtils.readZip(decodedPayload, false);
814         } catch (final ZipException e) {
815             log.info("Failed to unzip received csar {}", csarUUID, e);
816         }
817         return csar;
818     }
819
820     void validateInputStream(final HttpServletRequest request, Wrapper<String> dataWrapper, Wrapper<ResponseFormat> errorWrapper) throws IOException {
821         InputStream inputStream = request.getInputStream();
822         byte[] bytes = IOUtils.toByteArray(inputStream);
823         if (bytes == null || bytes.length == 0) {
824             log.info("Empty body was sent.");
825             errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
826         } else {
827             dataWrapper.setInnerElement(new String(bytes, StandardCharsets.UTF_8));
828         }
829
830     }
831
832     <T> void validateClassParse(String data, Wrapper<T> parsedClassWrapper, Supplier<Class<T>> classGen, Wrapper<ResponseFormat> errorWrapper) {
833         try {
834             T parsedClass = gson.fromJson(data, classGen.get());
835             if (parsedClass == null) {
836                 errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
837             } else {
838                 parsedClassWrapper.setInnerElement(parsedClass);
839             }
840         } catch (JsonSyntaxException e) {
841             log.debug("Failed to decode received {} {} to object.", classGen.get().getName(), data, e);
842             errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
843         }
844     }
845
846     void validateComponentInstanceBusinessLogic(HttpServletRequest request, String containerComponentType, Wrapper<ComponentInstanceBusinessLogic> blWrapper, Wrapper<ResponseFormat> errorWrapper) {
847         ServletContext context = request.getSession().getServletContext();
848         ComponentInstanceBusinessLogic componentInstanceLogic = getComponentInstanceBL(context);
849         if (componentInstanceLogic == null) {
850             log.debug("Unsupported component type {}", containerComponentType);
851             errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.UNSUPPORTED_ERROR, containerComponentType));
852         } else {
853             blWrapper.setInnerElement(componentInstanceLogic);
854         }
855     }
856
857     <T> Response buildResponseFromElement(Wrapper<ResponseFormat> errorWrapper, Wrapper<T> attributeWrapper) throws IOException {
858         Response response;
859         if (errorWrapper.isEmpty()) {
860             ObjectMapper mapper = new ObjectMapper();
861             String result = mapper.writeValueAsString(attributeWrapper.getInnerElement());
862             response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
863         } else {
864             response = buildErrorResponse(errorWrapper.getInnerElement());
865         }
866         return response;
867     }
868
869     protected void validateXECOMPInstanceIDHeader(String instanceIdHeader, Wrapper<ResponseFormat> responseWrapper) {
870         ResponseFormat responseFormat;
871         if(StringUtils.isEmpty(instanceIdHeader) ){
872             log.debug("Missing X-ECOMP-InstanceID header");
873             responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
874             responseWrapper.setInnerElement(responseFormat);
875         }
876     }
877
878     protected void validateHttpCspUserIdHeader(String header, Wrapper<ResponseFormat> responseWrapper) {
879         ResponseFormat responseFormat;
880         if( StringUtils.isEmpty(header)){
881             log.debug("MissingUSER_ID");
882             responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_USER_ID);
883             responseWrapper.setInnerElement(responseFormat);
884         }
885     }
886
887     <T> Either<T, ResponseFormat> parseToObject(String json, Supplier<Class<T>> classSupplier) {
888
889         try {
890             T object = RepresentationUtils.fromRepresentation(json, classSupplier.get());
891             return Either.left(object);
892         } catch (Exception e) {
893             log.debug("Failed to parse json to {} object", classSupplier.get().getName(), e);
894             ResponseFormat responseFormat = componentsUtils.getResponseFormat(ActionStatus.INVALID_CONTENT);
895             return Either.right(responseFormat);
896         }
897     }
898
899     public <T> Either<List<T>, ResponseFormat> parseListOfObjects(String json, Type type) {
900         try {
901             List<T> listOfObjects = gson.fromJson(json, type);
902             return Either.left(listOfObjects);
903         } catch (Exception e) {
904             log.debug("Failed to parse json to {} object", type.getClass().getName(), e);
905             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
906             return Either.right(responseFormat);
907         }
908     }
909     protected void validateNotEmptyBody(String data) {
910         if (StringUtils.isEmpty(data)) {
911             throw new ByActionStatusComponentException(ActionStatus.MISSING_BODY);
912         }
913     }
914 }