adapters/mso-vnfm-adapter/mso-vnfm-etsi-adapter/src/main/java/org/onap/so/adapters/vnfmadapter/extclients/vnfm/VnfmHelper.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.adapters.vnfmadapter.extclients.vnfm;
  22
  23 import static org.onap.so.adapters.vnfmadapter.Constants.BASE_URL;
  24 import static org.onap.so.adapters.vnfmadapter.Constants.OPERATION_NOTIFICATION_ENDPOINT;
  25 import com.google.common.reflect.TypeToken;
  26 import com.google.gson.Gson;
  27 import com.google.gson.JsonElement;
  28 import com.google.gson.JsonObject;
  29 import java.security.GeneralSecurityException;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.Map;
  33 import org.onap.aai.domain.yang.EsrSystemInfo;
  34 import org.onap.so.adapters.vnfmadapter.extclients.aai.AaiServiceProvider;
  35 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.AccessInfo;
  36 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.InterfaceInfo;
  37 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.VimCredentials;
  38 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.grant.model.InlineResponse201VimConnections;
  39 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InstantiateVnfRequest;
  40 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.LccnSubscriptionRequest;
  41 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthentication;
  42 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthentication.AuthTypeEnum;
  43 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthenticationParamsBasic;
  44 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthenticationParamsOauth2ClientCredentials;
  45 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilter;
  46 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilter.NotificationTypesEnum;
  47 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilterVnfInstanceSubscriptionFilter;
  48 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.VnfInstancesvnfInstanceIdinstantiateExtVirtualLinks;
  49 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo;
  50 import org.onap.so.utils.CryptoUtils;
  51 import org.onap.vnfmadapter.v1.model.CreateVnfRequest;
  52 import org.onap.vnfmadapter.v1.model.ExternalVirtualLink;
  53 import org.onap.vnfmadapter.v1.model.Tenant;
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56 import org.springframework.beans.factory.annotation.Autowired;
  57 import org.springframework.beans.factory.annotation.Value;
  58 import org.springframework.stereotype.Service;
  59
  60 /**
  61  * Provides helper methods for interactions with VNFM.
  62  */
  63 @Service
  64 public class VnfmHelper {
  65
  66     private static final Logger logger = LoggerFactory.getLogger(VnfmHelper.class);
  67     private static final String SEPARATOR = "_";
  68     private final AaiServiceProvider aaiServiceProvider;
  69
  70     @Value("${vnfmadapter.endpoint}")
  71     private String vnfmAdapterEndoint;
  72
  73     @Value("${vnfmadapter.auth:E39823AAB2739CC654C4E92B52C05BC34149342D0A46451B00CA508C8EDC62242CE4E9DA9445D3C01A3F13}")
  74     private String vnfmAdapterAuth;
  75
  76     @Value("${mso.key}")
  77     private String msoEncryptionKey;
  78
  79     @Autowired
  80     public VnfmHelper(final AaiServiceProvider aaiServiceProvider) {
  81         this.aaiServiceProvider = aaiServiceProvider;
  82     }
  83
  84     /**
  85      * Create an {@link InstantiateVnfRequest} to send in an instantiation request to a VNFM.
  86      *
  87      * @param tenant the tenant the request is to be fulfilled on
  88      * @param createVnfRequest the request received by the VNFM adapter
  89      */
  90     public InstantiateVnfRequest createInstantiateRequest(final Tenant tenant, final CreateVnfRequest createVnfRequest,
  91             final String flavourId) {
  92         final InstantiateVnfRequest instantiateVnfRequest = new InstantiateVnfRequest();
  93         instantiateVnfRequest.setFlavourId(flavourId);
  94         instantiateVnfRequest.setVimConnectionInfo(getVimConnectionInfos(tenant));
  95         instantiateVnfRequest
  96                 .setAdditionalParams(getAdditionalParametersAsJsonObject(createVnfRequest.getAdditionalParams()));
  97         instantiateVnfRequest.setExtVirtualLinks(getExternalVirtualLinks(createVnfRequest.getExternalVirtualLinks()));
  98         createVnfRequest.getExternalVirtualLinks();
  99         return instantiateVnfRequest;
 100     }
 101
 102     private String getFlavourId() {
 103         // TODO read from csar
 104         return "default";
 105     }
 106
 107     private List<VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo> getVimConnectionInfos(final Tenant tenant) {
 108         final List<VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo> connectionInfos = new ArrayList<>();
 109         connectionInfos.add(getVimConnectionInfo(tenant));
 110         return connectionInfos;
 111     }
 112
 113     private VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo getVimConnectionInfo(final Tenant tenant) {
 114         final EsrSystemInfo esrSystemInfo =
 115                 aaiServiceProvider.invokeGetCloudRegionEsrSystemInfoList(tenant.getCloudOwner(), tenant.getRegionName())
 116                         .getEsrSystemInfo().iterator().next();
 117
 118         final VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo vnfInstancesVimConnectionInfo =
 119                 new VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo();
 120         final String vimId = createVimId(tenant.getCloudOwner(), tenant.getRegionName());
 121         vnfInstancesVimConnectionInfo.setId(vimId);
 122         vnfInstancesVimConnectionInfo.setVimId(vimId);
 123         vnfInstancesVimConnectionInfo.setVimType(esrSystemInfo.getType());
 124         vnfInstancesVimConnectionInfo.setInterfaceInfo(getInterfaceInfo(esrSystemInfo.getServiceUrl()));
 125         vnfInstancesVimConnectionInfo.setAccessInfo(getAccessInfo(esrSystemInfo, tenant.getTenantId()));
 126         return vnfInstancesVimConnectionInfo;
 127     }
 128
 129     private InterfaceInfo getInterfaceInfo(final String url) {
 130         final InterfaceInfo interfaceInfo = new InterfaceInfo();
 131         interfaceInfo.setIdentityEndPoint(url);
 132         return interfaceInfo;
 133     }
 134
 135     private AccessInfo getAccessInfo(final EsrSystemInfo esrSystemInfo, final String tenantId) {
 136         final AccessInfo accessInfo = new AccessInfo();
 137         accessInfo.setProjectId(tenantId);
 138         accessInfo.setDomainName(esrSystemInfo.getCloudDomain());
 139
 140         final VimCredentials vimCredentials = new VimCredentials();
 141         vimCredentials.setUsername(esrSystemInfo.getUserName());
 142         vimCredentials.setPassword(esrSystemInfo.getPassword());
 143         accessInfo.setCredentials(vimCredentials);
 144         return accessInfo;
 145     }
 146
 147     private String createVimId(final String cloudOwner, final String cloudRegion) {
 148         return cloudOwner + SEPARATOR + cloudRegion;
 149     }
 150
 151     private JsonObject getAdditionalParametersAsJsonObject(final Map<String, String> additionalParameters) {
 152         final JsonObject additionalParametersJsonObject = new JsonObject();
 153         if (additionalParameters != null) {
 154             for (final Map.Entry<String, JsonElement> item : new Gson().toJsonTree(additionalParameters)
 155                     .getAsJsonObject().entrySet()) {
 156                 additionalParametersJsonObject.add(item.getKey(), item.getValue());
 157             }
 158         } else {
 159             logger.warn("No additional parameters were specified for the operation");
 160         }
 161         return additionalParametersJsonObject;
 162     }
 163
 164     private List<VnfInstancesvnfInstanceIdinstantiateExtVirtualLinks> getExternalVirtualLinks(
 165             final List<ExternalVirtualLink> extVirtualLinks) {
 166         if (extVirtualLinks != null) {
 167             final String extVirtualLinksJsonObject =
 168                     new Gson().toJson(extVirtualLinks, new TypeToken<List<ExternalVirtualLink>>() {}.getType());
 169             return new Gson().fromJson(extVirtualLinksJsonObject,
 170                     new TypeToken<List<VnfInstancesvnfInstanceIdinstantiateExtVirtualLinks>>() {}.getType());
 171         }
 172         return null;
 173     }
 174
 175     /**
 176      * Create a {@link LccnSubscriptionRequest} to send in an notification subscription request to a VNFM.
 177      *
 178      * @param the ID of the VNF notifications are required for
 179      * @return the request
 180      * @throws GeneralSecurityException
 181      */
 182     public LccnSubscriptionRequest createNotificationSubscriptionRequest(final String vnfId)
 183             throws GeneralSecurityException {
 184         final LccnSubscriptionRequest lccnSubscriptionRequest = new LccnSubscriptionRequest();
 185         lccnSubscriptionRequest.setAuthentication(getSubscriptionsAuthentication());
 186         lccnSubscriptionRequest.setCallbackUri(vnfmAdapterEndoint + BASE_URL + OPERATION_NOTIFICATION_ENDPOINT);
 187         final SubscriptionsFilter filter = new SubscriptionsFilter();
 188         filter.addNotificationTypesItem(NotificationTypesEnum.VNFLCMOPERATIONOCCURRENCENOTIFICATION);
 189         final SubscriptionsFilterVnfInstanceSubscriptionFilter vnfInstanceSubscriptionFilter =
 190                 new SubscriptionsFilterVnfInstanceSubscriptionFilter();
 191         vnfInstanceSubscriptionFilter.addVnfInstanceIdsItem(vnfId);
 192         filter.setVnfInstanceSubscriptionFilter(vnfInstanceSubscriptionFilter);
 193         lccnSubscriptionRequest.setFilter(filter);
 194         return lccnSubscriptionRequest;
 195     }
 196
 197     private SubscriptionsAuthentication getSubscriptionsAuthentication() throws GeneralSecurityException {
 198         final SubscriptionsAuthentication authentication = new SubscriptionsAuthentication();
 199
 200         final String[] decrypedAuth = CryptoUtils.decrypt(vnfmAdapterAuth, msoEncryptionKey).split(":");
 201
 202         SubscriptionsAuthenticationParamsOauth2ClientCredentials oauthParams =
 203                 new SubscriptionsAuthenticationParamsOauth2ClientCredentials();
 204         oauthParams.setTokenEndpoint(vnfmAdapterEndoint + "/oauth/token");
 205         oauthParams.clientId(decrypedAuth[0]);
 206         oauthParams.setClientPassword(decrypedAuth[1]);
 207         authentication.addAuthTypeItem(AuthTypeEnum.OAUTH2_CLIENT_CREDENTIALS);
 208         authentication.paramsOauth2ClientCredentials(oauthParams);
 209
 210         final SubscriptionsAuthenticationParamsBasic basicAuthParams = new SubscriptionsAuthenticationParamsBasic();
 211         basicAuthParams.setUserName(decrypedAuth[0]);
 212         basicAuthParams.setPassword(decrypedAuth[1]);
 213         authentication.addAuthTypeItem(AuthTypeEnum.BASIC);
 214         authentication.paramsBasic(basicAuthParams);
 215
 216         authentication.addAuthTypeItem(AuthTypeEnum.TLS_CERT);
 217         return authentication;
 218     }
 219
 220     /**
 221      * Get the VIM connections for a tenant
 222      *
 223      * @param tenant the tenant
 224      * @return the VIM connections
 225      */
 226     public InlineResponse201VimConnections getVimConnections(final Tenant tenant) {
 227         final EsrSystemInfo esrSystemInfo =
 228                 aaiServiceProvider.invokeGetCloudRegionEsrSystemInfoList(tenant.getCloudOwner(), tenant.getRegionName())
 229                         .getEsrSystemInfo().iterator().next();
 230
 231         final InlineResponse201VimConnections vimConnection = new InlineResponse201VimConnections();
 232         vimConnection.setId(createVimId(tenant.getCloudOwner(), tenant.getRegionName()));
 233         vimConnection.setVimId(vimConnection.getId());
 234         vimConnection.setVimType(esrSystemInfo.getType());
 235         vimConnection.setInterfaceInfo(getInterfaceInfo(esrSystemInfo.getServiceUrl()));
 236         vimConnection.setAccessInfo(getAccessInfo(esrSystemInfo, tenant.getTenantId()));
 237         return vimConnection;
 238     }
 239
 240
 241 }