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