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
|
/*-
* ============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.DataTypeException;
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.XACML3;
import com.att.research.xacml.std.annotations.RequestParser;
import com.google.common.base.Strings;
import java.util.Collection;
import java.util.Map;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.AnyOfType;
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.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.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
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.OnapObligation;
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.ToscaPolicyTranslatorUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class StdCombinedPolicyResultsTranslator extends StdBaseTranslator {
private static final Logger LOGGER = LoggerFactory.getLogger(StdCombinedPolicyResultsTranslator.class);
public StdCombinedPolicyResultsTranslator() {
super();
}
@Override
public PolicyType convertPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException {
//
// Sanity checks
//
if (toscaPolicy == null) {
throw new ToscaPolicyConversionException("Cannot convert a NULL policy");
}
if (toscaPolicy.getMetadata() == null) {
throw new ToscaPolicyConversionException("Cannot convert a policy with missing metadata section");
}
//
// Get the policy Id
//
String policyId = toscaPolicy.getMetadata().get(POLICY_ID);
//
// Set it as the policy ID
//
PolicyType newPolicyType = new PolicyType();
newPolicyType.setPolicyId(policyId);
//
// Optional description
//
newPolicyType.setDescription(toscaPolicy.getDescription());
//
// There should be a metadata section
//
this.fillMetadataSection(newPolicyType, toscaPolicy.getMetadata());
//
// Set the combining rule
//
newPolicyType.setRuleCombiningAlgId(XACML3.ID_RULE_FIRST_APPLICABLE.stringValue());
//
// Generate the TargetType
//
TargetType target = this.generateTargetType(policyId, toscaPolicy.getType(), toscaPolicy.getVersion());
newPolicyType.setTarget(target);
//
// 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(policyId + ":rule");
rule.setEffect(EffectType.PERMIT);
rule.setTarget(new TargetType());
//
// Now represent the policy as Json
//
StandardCoder coder = new StandardCoder();
String jsonPolicy;
try {
jsonPolicy = coder.encode(toscaPolicy);
} catch (CoderException e) {
throw new ToscaPolicyConversionException(e);
}
addObligation(rule, policyId, jsonPolicy, null, toscaPolicy.getType());
//
// Add the rule to the policy
//
newPolicyType.getCombinerParametersOrRuleCombinerParametersOrVariableDefinition().add(rule);
//
// Return our new policy
//
return newPolicyType;
}
@Override
public Request convertRequest(DecisionRequest request) {
LOGGER.info("Converting Request {}", request);
try {
return RequestParser.parseRequest(StdCombinedPolicyRequest.createInstance(request));
} catch (IllegalArgumentException | IllegalAccessException | DataTypeException e) {
LOGGER.error("Failed to convert DecisionRequest: {}", e);
}
//
// TODO throw exception
//
return null;
}
/**
* scanObligations - scans the list of obligations and make appropriate method calls to process
* obligations.
*
* @param obligations Collection of obligation objects
* @param decisionResponse DecisionResponse object used to store any results from obligations.
*/
@Override
protected void scanObligations(Collection<Obligation> obligations, DecisionResponse decisionResponse) {
for (Obligation obligation : obligations) {
Identifier obligationId = obligation.getId();
LOGGER.info("Obligation: {}", obligationId);
if (ToscaDictionary.ID_OBLIGATION_REST_BODY.equals(obligationId)) {
scanContentObligation(obligation, decisionResponse);
}
}
}
/**
* scanContentObligation - scans the specific obligation for policy-id and policy-content.
*
* @param obligation Obligation incoming obligation object
* @param decisionResponse DecisionResponse object
*/
protected void scanContentObligation(Obligation obligation, DecisionResponse decisionResponse) {
//
// Create our OnapObligation which will scan for attributes
//
OnapObligation onapObligation = new OnapObligation(obligation);
//
// Get the attributes we care about
//
String policyId = onapObligation.getPolicyId();
Map<String, Object> policyContent = onapObligation.getPolicyContentAsMap();
//
// Sanity check that we got the attributes we care about. NOTE: This translator
// ensures that these are set when convertPolicy is called.
//
if (! Strings.isNullOrEmpty(policyId) && policyContent != null) {
decisionResponse.getPolicies().put(policyId, policyContent);
} else {
LOGGER.error("Missing obligation policyId {} or policyContent {}", policyId,
policyContent == null ? "null" : policyContent.size());
}
}
/**
* generateTargetType - Generates a TargetType object for the policy-id and policy-type.
*
* @param policyId String policy-id
* @param policyType String policy type
* @param policyTypeVersion String policy type version
* @return TargetType object
*/
protected TargetType generateTargetType(String policyId, String policyType, String policyTypeVersion) {
//
// Create all the match's that are possible
//
// This is for the Policy Id
//
MatchType matchPolicyId = ToscaPolicyTranslatorUtils.buildMatchTypeDesignator(
XACML3.ID_FUNCTION_STRING_EQUAL,
policyId,
XACML3.ID_DATATYPE_STRING,
ToscaDictionary.ID_RESOURCE_POLICY_ID,
XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
//
// This is for the Policy Type
//
MatchType matchPolicyType = ToscaPolicyTranslatorUtils.buildMatchTypeDesignator(
XACML3.ID_FUNCTION_STRING_EQUAL,
policyType,
XACML3.ID_DATATYPE_STRING,
ToscaDictionary.ID_RESOURCE_POLICY_TYPE,
XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
//
// This is for the Policy Type version
//
MatchType matchPolicyTypeVersion = ToscaPolicyTranslatorUtils.buildMatchTypeDesignator(
XACML3.ID_FUNCTION_STRING_EQUAL,
policyTypeVersion,
XACML3.ID_DATATYPE_STRING,
ToscaDictionary.ID_RESOURCE_POLICY_TYPE_VERSION,
XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE);
//
// This is our outer AnyOf - which is an OR
//
AnyOfType anyOf = new AnyOfType();
//
// Create AllOf (AND) of just Policy Id
//
anyOf.getAllOf().add(ToscaPolicyTranslatorUtils.buildAllOf(matchPolicyId));
//
// Create AllOf (AND) of just Policy Type
//
anyOf.getAllOf().add(ToscaPolicyTranslatorUtils.buildAllOf(matchPolicyType));
//
// Create AllOf (AND) of Policy Type and Policy Type Version
//
anyOf.getAllOf().add(ToscaPolicyTranslatorUtils.buildAllOf(matchPolicyType, matchPolicyTypeVersion));
//
// Now we can create the TargetType, add the top-level anyOf (OR),
// and return the value.
//
TargetType target = new TargetType();
target.getAnyOf().add(anyOf);
return target;
}
}
|
