applications/guard/src/main/java/org/onap/policy/xacml/pdp/application/guard/CoordinationGuardTranslator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 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  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.xacml.pdp.application.guard;
  24
  25 import com.att.research.xacml.api.Request;
  26 import com.att.research.xacml.api.Response;
  27 import com.att.research.xacml.util.XACMLPolicyScanner;
  28
  29 import java.io.ByteArrayInputStream;
  30 import java.io.File;
  31 import java.io.FileInputStream;
  32 import java.io.IOException;
  33 import java.io.InputStream;
  34 import java.nio.charset.StandardCharsets;
  35 import java.nio.file.Files;
  36 import java.nio.file.Paths;
  37 import java.util.List;
  38 import java.util.Map;
  39 import java.util.UUID;
  40 import java.util.stream.Collectors;
  41 import java.util.stream.Stream;
  42 import org.apache.commons.io.IOUtils;
  43 import org.onap.policy.common.utils.coder.CoderException;
  44 import org.onap.policy.common.utils.coder.StandardYamlCoder;
  45 import org.onap.policy.common.utils.resources.ResourceUtils;
  46 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  47 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  49 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConversionException;
  50 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
  51 import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 public class CoordinationGuardTranslator implements ToscaPolicyTranslator {
  56
  57     private static final Logger LOGGER = LoggerFactory.getLogger(CoordinationGuardTranslator.class);
  58
  59     public CoordinationGuardTranslator() {
  60         super();
  61     }
  62
  63     @Override
  64     public Object convertPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException {
  65         LOGGER.debug("Using CoordinationGuardTranslator.convertPolicy");
  66         //
  67         // Policy name should be at the root
  68         //
  69         String type = toscaPolicy.getType();
  70         String coordinationFunctionPath = "src/main/resources/coordination/function";
  71         Map<String, Object> policyProps = toscaPolicy.getProperties();
  72         LOGGER.debug("path = {}", coordinationFunctionPath);
  73         LOGGER.debug("props = {}", policyProps);
  74         @SuppressWarnings("unchecked")
  75         List<String> controlLoop = (List<String>) policyProps.get("controlLoop");
  76         CoordinationDirective cd = new CoordinationDirective();
  77         cd.setCoordinationFunction(type);
  78         cd.setControlLoop(controlLoop);
  79         LOGGER.debug("CoordinationDirective = {}", cd);
  80         //
  81         // Generate the xacml policy as a string
  82         //
  83         String xacmlStr = generateXacmlFromCoordinationDirective(cd, coordinationFunctionPath);
  84         LOGGER.debug("xacmlStr\n{}", xacmlStr);
  85         //
  86         // Scan the string and convert to PoilcyType
  87         //
  88         try (InputStream is = new ByteArrayInputStream(xacmlStr.getBytes(StandardCharsets.UTF_8))) {
  89             return XACMLPolicyScanner.readPolicy(is);
  90         } catch (IOException e) {
  91             throw new ToscaPolicyConversionException("Failed to read policy", e);
  92         }
  93     }
  94
  95     /**
  96      * This function is not used for CLC instead
  97      * the one in LegacyGuardTranslator is used.
  98      */
  99     @Override
 100     public Request convertRequest(DecisionRequest request) throws ToscaPolicyConversionException {
 101         throw new ToscaPolicyConversionException("this convertRequest shouldn't be used");
 102     }
 103
 104     /**
 105      * This function is not used for CLC instead
 106      * the one in LegacyGuardTranslator is used.
 107      */
 108     @Override
 109     public DecisionResponse convertResponse(Response xacmlResponse) {
 110         LOGGER.info("this convertResponse shouldn't be used");
 111         return null;
 112     }
 113
 114     /**
 115      * Load YAML coordination directive.
 116      *
 117      * @param directiveFilename yaml directive file to load
 118      * @return the CoordinationDirective
 119      */
 120     public static CoordinationDirective loadCoordinationDirectiveFromFile(
 121         String directiveFilename) {
 122         try (InputStream is = new FileInputStream(new File(directiveFilename))) {
 123             String contents = IOUtils.toString(is, StandardCharsets.UTF_8);
 124             //
 125             // Read the yaml into our Java Object
 126             //
 127             CoordinationDirective obj =
 128                 new StandardYamlCoder().decode(contents, CoordinationDirective.class);
 129             LOGGER.debug(contents);
 130             return obj;
 131         } catch (IOException | CoderException e) {
 132             LOGGER.error("Error while loading YAML coordination directive", e);
 133         }
 134         return null;
 135     }
 136
 137     /**
 138      * Generate Xacml rule implementing specified CoordinationDirective.
 139      *
 140      * @param cd the CoordinationDirective
 141      * @param protoDir the directory containing Xacml implementation prototypes
 142      * @return the generated Xacml policy
 143      */
 144     public static String generateXacmlFromCoordinationDirective(CoordinationDirective cd,
 145         String protoDir) throws ToscaPolicyConversionException {
 146         /*
 147          * Determine file names
 148          */
 149         String xacmlProtoFilename =
 150             protoDir + File.separator + cd.getCoordinationFunction() + ".xml";
 151         LOGGER.debug("xacmlProtoFilename={}", xacmlProtoFilename);
 152         /*
 153          * Values to be used for placeholders
 154          */
 155         final String uniqueId = UUID.randomUUID().toString();
 156         final String cLOne = cd.getControlLoop(0);
 157         final String cLTwo = cd.getControlLoop(1);
 158         /*
 159          * Replace function placeholders with appropriate values
 160          */
 161         String policyXml = ResourceUtils.getResourceAsString(xacmlProtoFilename);
 162         if (policyXml == null) {
 163             throw new ToscaPolicyConversionException("Error while generating XACML policy for coordination directive");
 164         }
 165         policyXml = policyXml.replace("UNIQUE_ID", uniqueId);
 166         policyXml = policyXml.replace("CONTROL_LOOP_ONE", cLOne);
 167         policyXml = policyXml.replace("CONTROL_LOOP_TWO", cLTwo);
 168
 169         return policyXml;
 170
 171     }
 172
 173 }