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 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
  43 import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
  44
  45 import org.apache.commons.io.IOUtils;
  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.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53 import org.yaml.snakeyaml.Yaml;
  54 import org.yaml.snakeyaml.constructor.Constructor;
  55
  56 public class CoordinationGuardTranslator implements ToscaPolicyTranslator {
  57
  58     private static final Logger LOGGER = LoggerFactory.getLogger(CoordinationGuardTranslator.class);
  59
  60     public CoordinationGuardTranslator() {
  61         super();
  62     }
  63
  64     @Override
  65     public PolicyType convertPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException {
  66         LOGGER.debug("Using CoordinationGuardTranslator.convertPolicy");
  67         //
  68         // Policy name should be at the root
  69         //
  70         String type = toscaPolicy.getType();
  71         String coordinationFunctionPath = "src/main/resources/coordination/function";
  72         Map<String, Object> policyProps = toscaPolicy.getProperties();
  73         LOGGER.debug("path = {}", coordinationFunctionPath);
  74         LOGGER.debug("props = {}", policyProps);
  75         @SuppressWarnings("unchecked")
  76         List<String> controlLoop = (List<String>) policyProps.get("controlLoop");
  77         CoordinationDirective cd = new CoordinationDirective();
  78         cd.setCoordinationFunction(type);
  79         cd.setControlLoop(controlLoop);
  80         LOGGER.debug("CoordinationDirective = {}", cd);
  81         //
  82         // Generate the xacml policy as a string
  83         //
  84         String xacmlStr = generateXacmlFromCoordinationDirective(cd, coordinationFunctionPath);
  85         LOGGER.debug("xacmlStr\n{}", xacmlStr);
  86         //
  87         // Scan the string and convert to PoilcyType
  88         //
  89         try (InputStream is = new ByteArrayInputStream(xacmlStr.getBytes(StandardCharsets.UTF_8))) {
  90             return (PolicyType) XACMLPolicyScanner.readPolicy(is);
  91         } catch (IOException e) {
  92             throw new ToscaPolicyConversionException("Failed to read policy", e);
  93         }
  94     }
  95
  96     @Override
  97     public Request convertRequest(DecisionRequest request) {
  98         LOGGER.info("this convertRequest shouldn't be used");
  99         return null;
 100     }
 101
 102     @Override
 103     public DecisionResponse convertResponse(Response xacmlResponse) {
 104         LOGGER.info("this convertResponse shouldn't be used");
 105         return null;
 106     }
 107
 108     /**
 109      * Load YAML coordination directive.
 110      *
 111      * @param directiveFilename yaml directive file to load
 112      * @return the CoordinationDirective
 113      */
 114     public static CoordinationDirective loadCoordinationDirectiveFromFile(String directiveFilename) {
 115         try (InputStream is = new FileInputStream(new File(directiveFilename))) {
 116             String contents = IOUtils.toString(is, StandardCharsets.UTF_8);
 117             //
 118             // Read the yaml into our Java Object
 119             //
 120             Yaml yaml = new Yaml(new Constructor(CoordinationDirective.class));
 121             Object obj = yaml.load(contents);
 122             LOGGER.debug(contents);
 123             return (CoordinationDirective) obj;
 124         } catch (IOException e) {
 125             LOGGER.error("Error while loading YAML coordination directive", e);
 126         }
 127         return null;
 128     }
 129
 130     /**
 131      * Generate Xacml rule implementing specified CoordinationDirective.
 132      *
 133      * @param cd the CoordinationDirective
 134      * @param protoDir the directory containing Xacml implementation prototypes
 135      * @return the generated Xacml policy
 136      */
 137     public static String generateXacmlFromCoordinationDirective(CoordinationDirective cd,
 138                                                                 String protoDir) throws ToscaPolicyConversionException {
 139         /*
 140          * Determine file names
 141          */
 142         String xacmlProtoFilename = protoDir + File.separator + cd.getCoordinationFunction() + ".xml";
 143         LOGGER.debug("xacmlProtoFilename={}", xacmlProtoFilename);
 144         /*
 145          * Values to be used for placeholders
 146          */
 147         final String uniqueId = UUID.randomUUID().toString();
 148         final String cLOne = cd.getControlLoop(0);
 149         final String cLTwo = cd.getControlLoop(1);
 150         /*
 151          * Replace function placeholders with appropriate values
 152          */
 153         try (Stream<String> stream = Files.lines(Paths.get(xacmlProtoFilename))) {
 154             return stream.map(s -> s.replaceAll("UNIQUE_ID", uniqueId))
 155                 .map(s -> s.replaceAll("CONTROL_LOOP_ONE", cLOne))
 156                 .map(s -> s.replaceAll("CONTROL_LOOP_TWO", cLTwo))
 157                 .collect(Collectors.joining(System.lineSeparator()));
 158         } catch (IOException e) {
 159             throw new
 160                 ToscaPolicyConversionException("Error while generating XACML policy for coordination directive", e);
 161         }
 162     }
 163
 164 }