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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2019 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.pdp.xacml.application.common.std;
import com.att.research.xacml.api.AttributeAssignment;
import com.att.research.xacml.api.DataTypeException;
import com.att.research.xacml.api.Decision;
import com.att.research.xacml.api.Identifier;
import com.att.research.xacml.api.Obligation;
import com.att.research.xacml.api.Request;
import com.att.research.xacml.api.Response;
import com.att.research.xacml.api.Result;
import com.att.research.xacml.api.XACML3;
import com.att.research.xacml.std.annotations.RequestParser;
import com.att.research.xacml.util.XACMLPolicyWriter;
import com.google.gson.Gson;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AnyOfType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AttributeAssignmentExpressionType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AttributeValueType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.EffectType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.MatchType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObjectFactory;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObligationExpressionType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.ObligationExpressionsType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.RuleType;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.TargetType;
import org.json.JSONObject;
import org.onap.policy.models.decisions.concepts.DecisionRequest;
import org.onap.policy.models.decisions.concepts.DecisionResponse;
import org.onap.policy.pdp.xacml.application.common.ToscaDictionary;
import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConversionException;
import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslatorUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class StdMatchableTranslator implements ToscaPolicyTranslator {
private static final Logger LOGGER = LoggerFactory.getLogger(StdMatchableTranslator.class);
public StdMatchableTranslator() {
super();
}
@SuppressWarnings("unchecked")
@Override
public List<PolicyType> scanAndConvertPolicies(Map<String, Object> toscaObject)
throws ToscaPolicyConversionException {
//
// Our return object
//
List<PolicyType> scannedPolicies = new ArrayList<>();
//
// Iterate each of the Policies
//
List<Object> policies = (List<Object>) toscaObject.get("policies");
for (Object policyObject : policies) {
//
// Get the contents
//
LOGGER.debug("Found policy {}", policyObject.getClass());
Map<String, Object> policyContents = (Map<String, Object>) policyObject;
for (Entry<String, Object> entrySet : policyContents.entrySet()) {
LOGGER.debug("Entry set {}", entrySet);
//
// Convert this policy
//
PolicyType policy = this.convertPolicy(entrySet);
try (ByteArrayOutputStream os = new ByteArrayOutputStream()) {
XACMLPolicyWriter.writePolicyFile(os, policy);
LOGGER.debug("{}", os);
} catch (IOException e) {
LOGGER.error("Failed to convert {}", e);
}
//
// Convert and add in the new policy
//
scannedPolicies.add(policy);
}
}
return scannedPolicies;
}
@Override
public Request convertRequest(DecisionRequest request) {
LOGGER.debug("Converting Request {}", request);
try {
return RequestParser.parseRequest(StdMatchablePolicyRequest.createInstance(request));
} catch (IllegalArgumentException | IllegalAccessException | DataTypeException e) {
LOGGER.error("Failed to convert DecisionRequest: {}", e);
}
//
// TODO throw exception
//
return null;
}
@Override
public DecisionResponse convertResponse(Response xacmlResponse) {
LOGGER.debug("Converting Response {}", xacmlResponse);
DecisionResponse decisionResponse = new DecisionResponse();
//
// Iterate through all the results
//
for (Result xacmlResult : xacmlResponse.getResults()) {
//
// Check the result
//
if (xacmlResult.getDecision() == Decision.PERMIT) {
//
// Setup policies
//
decisionResponse.setPolicies(new ArrayList<>());
//
// Go through obligations
//
scanObligations(xacmlResult.getObligations(), decisionResponse);
}
if (xacmlResult.getDecision() == Decision.NOTAPPLICABLE) {
//
// There is no policy
//
decisionResponse.setPolicies(new ArrayList<>());
}
if (xacmlResult.getDecision() == Decision.DENY
|| xacmlResult.getDecision() == Decision.INDETERMINATE) {
//
// TODO we have to return an ErrorResponse object instead
//
decisionResponse.setStatus("A better error message");
}
}
return decisionResponse;
}
protected void scanObligations(Collection<Obligation> obligations, DecisionResponse decisionResponse) {
for (Obligation obligation : obligations) {
LOGGER.debug("Obligation: {}", obligation);
for (AttributeAssignment assignment : obligation.getAttributeAssignments()) {
LOGGER.debug("Attribute Assignment: {}", assignment);
//
// We care about the content attribute
//
if (ToscaDictionary.ID_OBLIGATION_POLICY_MONITORING_CONTENTS
.equals(assignment.getAttributeId())) {
//
// The contents are in Json form
//
Object stringContents = assignment.getAttributeValue().getValue();
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("DCAE contents: {}{}", System.lineSeparator(), stringContents);
}
//
// Let's parse it into a map using Gson
//
Gson gson = new Gson();
@SuppressWarnings("unchecked")
Map<String, Object> result = gson.fromJson(stringContents.toString() ,Map.class);
decisionResponse.getPolicies().add(result);
}
}
}
}
@SuppressWarnings("unchecked")
protected PolicyType convertPolicy(Entry<String, Object> entrySet) throws ToscaPolicyConversionException {
//
// Policy name should be at the root
//
String policyName = entrySet.getKey();
Map<String, Object> policyDefinition = (Map<String, Object>) entrySet.getValue();
//
// Set it as the policy ID
//
PolicyType newPolicyType = new PolicyType();
newPolicyType.setPolicyId(policyName);
//
// Optional description
//
if (policyDefinition.containsKey("description")) {
newPolicyType.setDescription(policyDefinition.get("description").toString());
}
//
// There should be a metadata section
//
if (! policyDefinition.containsKey("metadata")) {
throw new ToscaPolicyConversionException(policyName + " missing metadata section");
}
this.fillMetadataSection(newPolicyType,
(Map<String, Object>) policyDefinition.get("metadata"));
//
// Set the combining rule
//
newPolicyType.setRuleCombiningAlgId(XACML3.ID_RULE_FIRST_APPLICABLE.stringValue());
//
// Generate the TargetType
//
if (! policyDefinition.containsKey("properties")) {
throw new ToscaPolicyConversionException(policyName + " missing properties section");
}
policyDefinition.get("properties");
newPolicyType.setTarget(generateTargetType((Map<String, Object>) policyDefinition.get("properties")));
//
// Now create the Permit Rule
// No target since the policy has a target
// With obligations.
//
RuleType rule = new RuleType();
rule.setDescription("Default is to PERMIT if the policy matches.");
rule.setRuleId(policyName + ":rule");
rule.setEffect(EffectType.PERMIT);
rule.setTarget(new TargetType());
//
// Now represent the policy as Json
//
JSONObject jsonObligation = new JSONObject();
jsonObligation.put(policyName, policyDefinition);
addObligation(rule, jsonObligation);
//
// Add the rule to the policy
//
newPolicyType.getCombinerParametersOrRuleCombinerParametersOrVariableDefinition().add(rule);
//
// Return our new policy
//
return newPolicyType;
}
/**
* From the TOSCA metadata section, pull in values that are needed into the XACML policy.
*
* @param policy Policy Object to store the metadata
* @param metadata The Metadata TOSCA Map
* @return Same Policy Object
* @throws ToscaPolicyConversionException If there is something missing from the metadata
*/
protected PolicyType fillMetadataSection(PolicyType policy,
Map<String, Object> metadata) throws ToscaPolicyConversionException {
if (! metadata.containsKey("policy-id")) {
throw new ToscaPolicyConversionException(policy.getPolicyId() + " missing metadata policy-id");
} else {
//
// Do nothing here - the XACML PolicyId is used from TOSCA Policy Name field
//
}
if (! metadata.containsKey("policy-version")) {
throw new ToscaPolicyConversionException(policy.getPolicyId() + " missing metadata policy-version");
} else {
//
// Add in the Policy Version
//
policy.setVersion(metadata.get("policy-version").toString());
}
return policy;
}
/**
* For generating target type, we are making an assumption that the
* policyScope and policyType are the fields that OOF wants to match on.
*
* <P>In the future, we would need to receive the Policy Type specification
* from the PAP so we can dynamically see which fields are matchable.
*
* <P>Note: I am making an assumption that the matchable fields are what
* the OOF wants to query a policy on.
*
* @param properties Properties section of policy
* @return TargetType object
*/
@SuppressWarnings("unchecked")
protected TargetType generateTargetType(Map<String, Object> properties) {
TargetType targetType = new TargetType();
//
// Iterate the properties
//
for (Entry<String, Object> entrySet : properties.entrySet()) {
//
// Find policyScope and policyType
//
if (entrySet.getKey().equals("policyScope")) {
LOGGER.debug("Found policyScope: {}", entrySet.getValue());
if (entrySet.getValue() instanceof Collection) {
targetType.getAnyOf().add(generateMatches((Collection<Object>) entrySet.getValue(),
ToscaDictionary.ID_RESOURCE_POLICY_SCOPE_PROPERTY));
} else if (entrySet.getValue() instanceof String) {
targetType.getAnyOf().add(generateMatches(Arrays.asList(entrySet.getValue()),
ToscaDictionary.ID_RESOURCE_POLICY_SCOPE_PROPERTY));
}
}
if (entrySet.getKey().equals("policyType")) {
LOGGER.debug("Found policyType: {}", entrySet.getValue());
if (entrySet.getValue() instanceof Collection) {
targetType.getAnyOf().add(generateMatches((Collection<Object>) entrySet.getValue(),
ToscaDictionary.ID_RESOURCE_POLICY_TYPE_PROPERTY));
} else if (entrySet.getValue() instanceof String) {
targetType.getAnyOf().add(generateMatches(Arrays.asList(entrySet.getValue()),
ToscaDictionary.ID_RESOURCE_POLICY_TYPE_PROPERTY));
}
}
}
return targetType;
}
protected AnyOfType generateMatches(Collection<Object> matchables, Identifier attributeId) {
//
// This is our outer AnyOf - which is an OR
//
AnyOfType anyOf = new AnyOfType();
for (Object matchable : matchables) {
//
// Create a match for this
//
MatchType match = ToscaPolicyTranslatorUtils.buildMatchTypeDesignator(
XACML3.ID_FUNCTION_STRING_EQUAL,
matchable.toString(),
XACML3.ID_DATATYPE_STRING,
attributeId,
XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
//
// Now create an anyOf (OR)
//
anyOf.getAllOf().add(ToscaPolicyTranslatorUtils.buildAllOf(match));
}
return anyOf;
}
protected RuleType addObligation(RuleType rule, JSONObject jsonPolicy) {
//
// Convert the YAML Policy to JSON Object
//
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("JSON Optimization Policy {}{}", System.lineSeparator(), jsonPolicy);
}
//
// Create an AttributeValue for it
//
AttributeValueType value = new AttributeValueType();
value.setDataType(ToscaDictionary.ID_OBLIGATION_POLICY_MONITORING_DATATYPE.stringValue());
value.getContent().add(jsonPolicy.toString());
//
// Create our AttributeAssignmentExpression where we will
// store the contents of the policy in JSON format.
//
AttributeAssignmentExpressionType expressionType = new AttributeAssignmentExpressionType();
expressionType.setAttributeId(ToscaDictionary.ID_OBLIGATION_POLICY_MONITORING_CONTENTS.stringValue());
ObjectFactory factory = new ObjectFactory();
expressionType.setExpression(factory.createAttributeValue(value));
//
// Create an ObligationExpression for it
//
ObligationExpressionType obligation = new ObligationExpressionType();
obligation.setFulfillOn(EffectType.PERMIT);
obligation.setObligationId(ToscaDictionary.ID_OBLIGATION_REST_BODY.stringValue());
obligation.getAttributeAssignmentExpression().add(expressionType);
//
// Now we can add it into the rule
//
ObligationExpressionsType obligations = new ObligationExpressionsType();
obligations.getObligationExpression().add(obligation);
rule.setObligationExpressions(obligations);
return rule;
}
}
|