src/main/java/org/onap/clamp/clds/service/CldsService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights
   6  *                             reserved.
   7  * ================================================================================
   8  * Modifications Copyright (c) 2019 Samsung
   9  * ================================================================================
  10  * Licensed under the Apache License, Version 2.0 (the "License");
  11  * you may not use this file except in compliance with the License.
  12  * You may obtain a copy of the License at
  13  *
  14  * http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  * ============LICENSE_END============================================
  22  * Modifications copyright (c) 2018 Nokia
  23  * ===================================================================
  24  *
  25  */
  26
  27 package org.onap.clamp.clds.service;
  28
  29 import com.att.eelf.configuration.EELFLogger;
  30 import com.att.eelf.configuration.EELFManager;
  31
  32 import java.util.Date;
  33
  34 import javax.servlet.http.HttpServletRequest;
  35
  36 import org.onap.clamp.clds.model.CldsInfo;
  37 import org.onap.clamp.clds.util.LoggingUtils;
  38 import org.onap.clamp.clds.util.ONAPLogConstants;
  39 import org.slf4j.event.Level;
  40 import org.springframework.beans.factory.annotation.Autowired;
  41 import org.springframework.beans.factory.annotation.Value;
  42 import org.springframework.stereotype.Component;
  43
  44 /**
  45  * Service to save and retrieve the CLDS model attributes.
  46  */
  47 @Component
  48 public class CldsService extends SecureServiceBase {
  49     /**
  50      * The constant securityLogger.
  51      */
  52     protected static final EELFLogger securityLogger = EELFManager.getInstance().getSecurityLogger();
  53     /**
  54      * The constant logger.
  55      */
  56     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsService.class);
  57
  58     private final String cldsPermissionTypeFilterVf;
  59     private final String cldsPermissionInstance;
  60     /**
  61      * The Permission read cl.
  62      */
  63     final SecureServicePermission permissionReadCl;
  64     /**
  65      * The Permission update cl.
  66      */
  67     final SecureServicePermission permissionUpdateCl;
  68     /**
  69      * The Permission read template.
  70      */
  71     final SecureServicePermission permissionReadTemplate;
  72     /**
  73      * The Permission update template.
  74      */
  75     final SecureServicePermission permissionUpdateTemplate;
  76     /**
  77      * The Permission read tosca.
  78      */
  79     final SecureServicePermission permissionReadTosca;
  80     /**
  81      * The Permission update tosca.
  82      */
  83     final SecureServicePermission permissionUpdateTosca;
  84
  85     private LoggingUtils util = new LoggingUtils(logger);
  86
  87     @Autowired
  88     private HttpServletRequest request;
  89
  90     /**
  91      * Instantiates a new Clds service.
  92      *
  93      * @param cldsPersmissionTypeCl      the clds persmission type cl
  94      * @param cldsPermissionTypeClManage the clds permission type cl manage
  95      * @param cldsPermissionTypeClEvent  the clds permission type cl event
  96      * @param cldsPermissionTypeFilterVf the clds permission type filter vf
  97      * @param cldsPermissionTypeTemplate the clds permission type template
  98      * @param cldsPermissionTypeTosca    the clds permission type tosca
  99      * @param cldsPermissionInstance     the clds permission instance
 100      */
 101     @Autowired
 102     public CldsService(
 103             @Value("${clamp.config.security.permission.type.cl:permission-type-cl}") String cldsPersmissionTypeCl,
 104             @Value("${clamp.config.security.permission.type.cl.manage:permission-type-cl-manage}") String cldsPermissionTypeClManage,
 105             @Value("${clamp.config.security.permission.type.cl.event:permission-type-cl-event}") String cldsPermissionTypeClEvent,
 106             @Value("${clamp.config.security.permission.type.filter.vf:permission-type-filter-vf}") String cldsPermissionTypeFilterVf,
 107             @Value("${clamp.config.security.permission.type.template:permission-type-template}") String cldsPermissionTypeTemplate,
 108             @Value("${clamp.config.security.permission.type.tosca:permission-type-tosca}") String cldsPermissionTypeTosca,
 109             @Value("${clamp.config.security.permission.instance:dev}") String cldsPermissionInstance) {
 110         this.cldsPermissionTypeFilterVf = cldsPermissionTypeFilterVf;
 111         this.cldsPermissionInstance = cldsPermissionInstance;
 112         permissionReadCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "read");
 113         permissionUpdateCl = SecureServicePermission.create(cldsPersmissionTypeCl, cldsPermissionInstance, "update");
 114         permissionReadTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 115                 "read");
 116         permissionUpdateTemplate = SecureServicePermission.create(cldsPermissionTypeTemplate, cldsPermissionInstance,
 117                 "update");
 118         permissionReadTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance, "read");
 119         permissionUpdateTosca = SecureServicePermission.create(cldsPermissionTypeTosca, cldsPermissionInstance,
 120                 "update");
 121     }
 122
 123     /**
 124      * Gets clds info. CLDS IFO service will return 3 things 1. User Name 2. CLDS
 125      * code version that is currently installed from pom.xml file 3. User
 126      * permissions
 127      *
 128      * @return the clds info
 129      */
 130     public CldsInfo getCldsInfo() {
 131         util.entering(request, "CldsService: GET cldsInfo");
 132         final Date startTime = new Date();
 133         LoggingUtils.setTimeContext(startTime, new Date());
 134
 135         CldsInfoProvider cldsInfoProvider = new CldsInfoProvider(this);
 136         final CldsInfo cldsInfo = cldsInfoProvider.getCldsInfo();
 137
 138         // audit log
 139         LoggingUtils.setTimeContext(startTime, new Date());
 140         securityLogger.info("GET cldsInfo completed");
 141         util.exiting("200", "Get cldsInfo success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
 142         return cldsInfo;
 143     }
 144
 145     /**
 146      * Determine if the user is authorized for a particular VF by its invariant
 147      * UUID.
 148      *
 149      * @param vfInvariantUuid the vf invariant uuid
 150      * @return boolean or throws NotAuthorizedException
 151      */
 152     public boolean isAuthorizedForVf(String vfInvariantUuid) {
 153         if (cldsPermissionTypeFilterVf != null && !cldsPermissionTypeFilterVf.isEmpty()) {
 154             SecureServicePermission permission = SecureServicePermission.create(cldsPermissionTypeFilterVf,
 155                     cldsPermissionInstance, vfInvariantUuid);
 156             return isAuthorized(permission);
 157         } else {
 158             // if CLDS_PERMISSION_TYPE_FILTER_VF property is not provided, then
 159             // VF filtering is turned off
 160             logger.warn("VF filtering turned off");
 161             return true;
 162         }
 163     }
 164
 165     /**
 166      * Sets logging util.
 167      *
 168      * @param utilP the util p
 169      */
 170     // Created for the integration test
 171     public void setLoggingUtil(LoggingUtils utilP) {
 172         util = utilP;
 173     }
 174 }