2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.policy.xacml.pdp.application.guard;
25 import com.att.research.xacml.api.Request;
26 import com.att.research.xacml.api.Response;
27 import com.att.research.xacml.util.XACMLPolicyScanner;
29 import java.io.ByteArrayInputStream;
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;
39 import java.util.UUID;
40 import java.util.stream.Collectors;
41 import java.util.stream.Stream;
43 import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
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;
56 public class CoordinationGuardTranslator implements ToscaPolicyTranslator {
58 private static final Logger LOGGER = LoggerFactory.getLogger(CoordinationGuardTranslator.class);
60 public CoordinationGuardTranslator() {
65 public PolicyType convertPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException {
66 LOGGER.debug("Using CoordinationGuardTranslator.convertPolicy");
68 // Policy name should be at the root
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 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);
81 // Generate the xacml policy as a string
83 String xacmlStr = generateXacmlFromCoordinationDirective(cd, coordinationFunctionPath);
84 LOGGER.debug("xacmlStr\n{}", xacmlStr);
86 // Scan the string and convert to PoilcyType
88 try (InputStream is = new ByteArrayInputStream(xacmlStr.getBytes(StandardCharsets.UTF_8))) {
89 return (PolicyType) XACMLPolicyScanner.readPolicy(is);
90 } catch (IOException e) {
91 throw new ToscaPolicyConversionException("Failed to read policy", e);
96 public Request convertRequest(DecisionRequest request) {
97 LOGGER.info("this convertRequest shouldn't be used");
102 public DecisionResponse convertResponse(Response xacmlResponse) {
103 LOGGER.info("this convertResponse shouldn't be used");
108 * Load YAML coordination directive.
110 * @param directiveFilename yaml directive file to load
111 * @return the CoordinationDirective
113 public static CoordinationDirective loadCoordinationDirectiveFromFile(String directiveFilename) {
114 try (InputStream is = new FileInputStream(new File(directiveFilename))) {
115 String contents = IOUtils.toString(is, StandardCharsets.UTF_8);
117 // Read the yaml into our Java Object
119 Yaml yaml = new Yaml(new Constructor(CoordinationDirective.class));
120 Object obj = yaml.load(contents);
121 LOGGER.debug(contents);
122 return (CoordinationDirective) obj;
123 } catch (IOException e) {
124 LOGGER.error("Error while loading YAML coordination directive", e);
130 * Generate Xacml rule implementing specified CoordinationDirective.
132 * @param cd the CoordinationDirective
133 * @param protoDir the directory containing Xacml implementation prototypes
134 * @return the generated Xacml policy
136 public static String generateXacmlFromCoordinationDirective(CoordinationDirective cd,
137 String protoDir) throws ToscaPolicyConversionException {
139 * Determine file names
141 String xacmlProtoFilename = protoDir + File.separator + cd.getCoordinationFunction() + ".xml";
142 LOGGER.debug("xacmlProtoFilename={}", xacmlProtoFilename);
144 * Values to be used for placeholders
146 final String uniqueId = UUID.randomUUID().toString();
147 final String cLOne = cd.getControlLoop(0);
148 final String cLTwo = cd.getControlLoop(1);
150 * Replace function placeholders with appropriate values
152 try (Stream<String> stream = Files.lines(Paths.get(xacmlProtoFilename))) {
153 return stream.map(s -> s.replaceAll("UNIQUE_ID", uniqueId))
154 .map(s -> s.replaceAll("CONTROL_LOOP_ONE", cLOne))
155 .map(s -> s.replaceAll("CONTROL_LOOP_TWO", cLTwo))
156 .collect(Collectors.joining(System.lineSeparator()));
157 } catch (IOException e) {
159 ToscaPolicyConversionException("Error while generating XACML policy for coordination directive", e);