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