2 * Copyright (c) 2015 Huawei Technologies and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.groupbasedpolicy.renderer.faas;
11 import com.google.common.annotations.VisibleForTesting;
12 import com.google.common.base.Optional;
13 import java.util.ArrayList;
14 import java.util.Collection;
15 import java.util.List;
16 import java.util.UUID;
17 import java.util.concurrent.ConcurrentHashMap;
18 import java.util.concurrent.Executor;
19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
20 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
21 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
22 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
23 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
24 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.faas.uln.datastore.api.UlnDatastoreUtil;
28 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.common.rev151013.Name;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.common.rev151013.Text;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.common.rev151013.Uuid;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.parameter.values.grouping.ParameterValue;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.parameter.values.grouping.ParameterValueBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.parameter.values.grouping.parameter.value.RangeValueBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.SecurityRuleGroupsBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.SecurityRuleGroup;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.SecurityRuleGroupBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.security.rule.group.SecurityRule;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.security.rule.group.SecurityRuleBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.security.rule.group.security.rule.RuleAction;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.security.rule.group.security.rule.RuleActionBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.security.rule.group.security.rule.RuleClassifier;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.security.rule.group.security.rule.RuleClassifier.Direction;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.faas.logical.faas.security.rules.rev151013.security.rule.groups.attributes.security.rule.groups.container.security.rule.groups.security.rule.group.security.rule.RuleClassifierBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionName;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierName;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContractId;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubjectName;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.faas.rev151009.mapped.tenants.entities.mapped.entity.MappedContract;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.faas.rev151009.mapped.tenants.entities.mapped.entity.MappedContractBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.Tenants;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.action.refs.ActionRef;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRef;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.Tenant;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.TenantKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.Policy;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.Contract;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.SubjectFeatureInstances;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.Clause;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.Subject;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.subject.Rule;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ActionInstance;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ActionInstanceKey;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ClassifierInstance;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ClassifierInstanceKey;
67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
68 import org.slf4j.Logger;
69 import org.slf4j.LoggerFactory;
71 public class FaasContractManagerListener implements DataTreeChangeListener<Contract> {
73 private static final Logger LOG = LoggerFactory.getLogger(FaasContractManagerListener.class);
74 private final ConcurrentHashMap<ContractId, Uuid> mappedContracts = new ConcurrentHashMap<>();
75 private final Executor executor;
76 private final DataBroker dataProvider;
77 private final TenantId gbpTenantId;
78 private final Uuid faasTenantId;
79 private final UlnDatastoreUtil ulnDatastoreUtil;
81 public FaasContractManagerListener(DataBroker dataProvider, TenantId gbpTenantId, Uuid faasTenantId,
82 Executor executor, UlnDatastoreUtil ulnDatastoreUtil) {
83 this.executor = executor;
84 this.gbpTenantId = gbpTenantId;
85 this.faasTenantId = faasTenantId;
86 this.dataProvider = dataProvider;
87 this.ulnDatastoreUtil = ulnDatastoreUtil;
91 public void onDataTreeChanged(Collection<DataTreeModification<Contract>> changes) {
92 executor.execute(() -> executeEvent(changes));
95 private void executeEvent(final Collection<DataTreeModification<Contract>> changes) {
96 for (DataTreeModification<Contract> change: changes) {
97 DataObjectModification<Contract> rootNode = change.getRootNode();
98 switch (rootNode.getModificationType()) {
99 case SUBTREE_MODIFIED:
101 Contract updatedContract = rootNode.getDataAfter();
102 LOG.debug("Contract {} is Updated.", updatedContract.getId().getValue());
103 ulnDatastoreUtil.submitSecurityGroupsToDs(initSecurityGroupBuilder(updatedContract).build());
106 Contract deletedContract = rootNode.getDataBefore();
107 LOG.debug("Contract {} is removed.", deletedContract.getId().getValue());
108 ReadWriteTransaction rwTx = dataProvider.newReadWriteTransaction();
109 Optional<MappedContract> op = DataStoreHelper.removeIfExists(LogicalDatastoreType.OPERATIONAL,
110 FaasIidFactory.mappedContractIid(gbpTenantId, deletedContract.getId()), rwTx);
111 if (op.isPresent()) {
112 DataStoreHelper.submitToDs(rwTx);
114 Uuid val = mappedContracts.remove(deletedContract.getId());
116 ulnDatastoreUtil.removeSecurityGroupsFromDsIfExists(faasTenantId, val);
125 public void loadAll(List<Contract> contracts, List<MappedContract> mpContracts) {
126 if (mpContracts != null) {
127 for (MappedContract mpContract : mpContracts) {
128 mappedContracts.putIfAbsent(mpContract.getGbpContractId(), mpContract.getFaasSecurityRulesId());
131 if (contracts != null) {
132 for (Contract contract : contracts) {
133 LOG.debug("Loading Contract {}", contract.getId().getValue());
134 ulnDatastoreUtil.submitSecurityGroupsToDs(initSecurityGroupBuilder(contract).build());
139 protected SecurityRuleGroupsBuilder initSecurityGroupBuilder(Contract contract) {
140 LOG.trace("Start initSecurityGroupBuilder");
141 SecurityRuleGroupsBuilder builder = new SecurityRuleGroupsBuilder();
142 builder.setUuid(getFaasSecurityRulesId(contract.getId()));
143 builder.setName(new Text(contract.getId().getValue()));
144 if (contract.getDescription() != null) {
145 builder.setDescription(new Text("gbp-contract: " + contract.getDescription().getValue()));
147 builder.setDescription(new Text("gbp-contract"));
149 builder.setTenantId(faasTenantId);
150 builder.setSecurityRuleGroup(buildSecurityRuleGroup(contract));
151 LOG.trace("Contract {} is mapped to Faas Security Rules {} ", contract.getId().getValue(), builder.getUuid()
156 private Uuid getFaasSecurityRulesId(ContractId contractId) {
157 Uuid val = mappedContracts.get(contractId);
161 Uuid faasContractId = null;
162 if (FaasPolicyManager.isUUid(contractId.getValue())) {
163 faasContractId = new Uuid(contractId.getValue());
165 faasContractId = new Uuid(UUID.randomUUID().toString());
167 mappedContracts.putIfAbsent(contractId, faasContractId);
168 val = mappedContracts.get(contractId);
169 MappedContractBuilder builder = new MappedContractBuilder();
170 builder.setFaasSecurityRulesId(val);
171 builder.setGbpContractId(contractId);
172 WriteTransaction wTx = dataProvider.newWriteOnlyTransaction();
173 MappedContract result = builder.build();
174 wTx.put(LogicalDatastoreType.OPERATIONAL,
175 FaasIidFactory.mappedContractIid(gbpTenantId, contractId), result);
176 if (DataStoreHelper.submitToDs(wTx)) {
177 LOG.debug("Cached in Datastore Mapped Contract {}", result);
179 LOG.error("Couldn't Cache in Datastore Mapped Contract {}", result);
185 List<SecurityRuleGroup> buildSecurityRuleGroup(Contract contract) {
186 LOG.trace("Start buildSecurityRuleGroup for contract {}", contract.getId().getValue());
187 List<SecurityRuleGroup> securityRuleGroups = new ArrayList<>();
188 if (contract.getClause() == null) {
189 LOG.debug("contract {} has no Clause", contract.getId().getValue());
192 for (Clause clause : contract.getClause()) {
193 if (clause.getSubjectRefs() == null) {
194 LOG.debug("Clause {} in contract {} has no Subject Ref", clause.getName().getValue(), contract.getId()
198 if (contract.getSubject() == null) {
199 LOG.warn("Couldn't find in Contract {} the expected subject references", contract.getId().getValue());
202 for (SubjectName subjectRef : clause.getSubjectRefs()) {
203 LOG.trace("Start Parsing Subject Ref {} in Contract {}", subjectRef, contract.getId().getValue());
204 for (Subject sub : contract.getSubject()) {
205 if (subjectRef.equals(sub.getName())) {
206 SecurityRuleGroupBuilder securityRuleGroupBuilder = new SecurityRuleGroupBuilder();
207 securityRuleGroupBuilder.setName(new Name(subjectRef.getValue()));
208 List<Rule> subRules = sub.getRule();
209 if (subRules == null) {
210 LOG.warn("Subject {} in Contract {} doesn't have rules", subjectRef.getValue(),
211 contract.getId().getValue());
213 List<SecurityRule> securityRules = getSecurityRules(contract, subjectRef, subRules);
214 LOG.debug("Subject {} in Contract {} has {} rules", subjectRef.getValue(), contract.getId()
215 .getValue(), securityRules.size());
216 securityRuleGroupBuilder.setSecurityRule(securityRules);
218 LOG.debug("Added Rule {} to Subject {} in Contract {}", securityRuleGroupBuilder.getName()
219 .getValue(), subjectRef.getValue(), contract.getId().getValue());
220 securityRuleGroups.add(securityRuleGroupBuilder.build());
225 LOG.trace("Done with buildSecurityRuleGroup for contract {}", contract.getId().getValue());
226 return securityRuleGroups;
230 List<SecurityRule> getSecurityRules(Contract contract, SubjectName subjectRef, List<Rule> subRules) {
231 List<SecurityRule> securityRules = new ArrayList<>();
232 for (Rule rule : subRules) {
233 List<ClassifierRef> classifierRefs = rule.getClassifierRef();
234 List<RuleClassifier> pClassifiers = null;
235 if (classifierRefs == null || classifierRefs.isEmpty()) {
236 LOG.warn("Rule {} in Subject {} in Contract {} doesn't have classifiers", rule.getName(), subjectRef,
239 pClassifiers = getClassifiers(gbpTenantId, contract, classifierRefs, dataProvider);
240 if (pClassifiers == null || pClassifiers.isEmpty()) {
241 LOG.warn("Rule {} in Subject {} in Contract {} doesn't have classifiers -- Will ignore this rule",
242 rule.getName(), subjectRef, contract.getId());
245 List<ActionRef> actionRefs = rule.getActionRef();
246 List<RuleAction> pActions = null;
247 if (actionRefs == null || actionRefs.isEmpty()) {
248 LOG.warn("Rule {} in Subject {} in Contract {} doesn't have actions", rule.getName(), subjectRef,
251 pActions = getActions(contract, actionRefs);
252 if (pActions == null || pActions.isEmpty()) {
253 LOG.warn("Rule {} in Subject {} in Contract {} doesn't have actions", rule.getName(), subjectRef,
258 securityRules.add(new SecurityRuleBuilder().setName(new Name(rule.getName().getValue()))
259 .setOrder(rule.getOrder())
260 .setRuleClassifier(pClassifiers)
261 .setRuleAction(pActions)
264 return securityRules;
267 private List<RuleAction> getActions(Contract contract, List<ActionRef> actionRefs) {
268 LOG.trace("Start Parsing Actions for actionRefs count {} in Contract {}", actionRefs.size(), contract.getId()
270 List<RuleAction> pActions = new ArrayList<>();
271 for (ActionRef actionRef : actionRefs) {
272 if (actionRef.getName() == null) {
273 LOG.warn("Couldn't find an Action in Contract {} -- ignored Action", contract.getId().getValue());
276 RuleActionBuilder ruleActionBuilder = new RuleActionBuilder();
277 ruleActionBuilder.setName(new Name(actionRef.getName().getValue()));
278 ruleActionBuilder.setOrder(actionRef.getOrder());
279 ActionInstance actionInstance = getActionInstance(actionRef.getName());
280 if (actionInstance == null) {
281 LOG.warn("Action instance {} is not found -- will only use the Action ref info", actionRef.getName());
283 if (actionInstance.getActionDefinitionId() != null) {
284 ruleActionBuilder.setAdditionalInfo(new Text(actionInstance.getActionDefinitionId().getValue()));
286 List<ParameterValue> parms = null;
287 if (actionInstance.getParameterValue() != null) {
288 LOG.trace("Action Instance {} has {} parameters", actionInstance.getName().getValue(),
289 actionInstance.getParameterValue().size());
290 parms = new ArrayList<>();
291 for (org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue instance : actionInstance.getParameterValue()) {
292 ParameterValueBuilder pBuilder = new ParameterValueBuilder();
293 pBuilder.setIntValue(instance.getIntValue());
294 if (instance.getName() != null) {
295 pBuilder.setName(new Name(instance.getName().getValue()));
297 pBuilder.setStringValue(instance.getStringValue());
298 if (instance.getRangeValue() != null) {
299 RangeValueBuilder rBuilder = new RangeValueBuilder().setMax(
300 instance.getRangeValue().getMax()).setMin(instance.getRangeValue().getMin());
301 pBuilder.setRangeValue(rBuilder.build());
303 ParameterValue parm = pBuilder.build();
304 LOG.trace("Added Parm {} from Action Instance {}", parm, actionInstance.getName().getValue());
308 LOG.trace("Action Instance {} has no parameters", actionInstance.getName().getValue());
310 ruleActionBuilder.setParameterValue(parms);
312 pActions.add(ruleActionBuilder.build());
318 private ActionInstance getActionInstance(ActionName name) {
319 ReadOnlyTransaction trans = dataProvider.newReadOnlyTransaction();
320 InstanceIdentifier<ActionInstance> ciId = InstanceIdentifier.builder(Tenants.class)
321 .child(Tenant.class, new TenantKey(gbpTenantId))
323 .child(SubjectFeatureInstances.class)
324 .child(ActionInstance.class, new ActionInstanceKey(name))
327 Optional<ActionInstance> data = trans.read(LogicalDatastoreType.CONFIGURATION, ciId).get();
328 if (data.isPresent()) {
331 } catch (Exception e) {
332 LOG.error("Couldn't read Action instance from datastore. Exception: ", e);
337 private List<RuleClassifier> getClassifiers(TenantId tenantId, Contract contract,
338 List<ClassifierRef> classifierRefs, DataBroker dataProvider) {
339 List<RuleClassifier> fClassifiers = new ArrayList<>();
340 for (ClassifierRef classifierRef : classifierRefs) {
341 if (classifierRef.getName() == null) {
342 LOG.warn("Found a Classifer without name in Contract {} ", contract.getId().getValue());
345 RuleClassifierBuilder ruleClassifierBuilder = new RuleClassifierBuilder();
346 ruleClassifierBuilder.setName(new Name(classifierRef.getName().getValue()));
347 ClassifierInstance classifierInstance = getClassifierInstance(tenantId, classifierRef.getName(),
349 if (classifierInstance == null) {
350 LOG.warn("Classifer instance {} is not found -- will only use the classifier Ref info",
351 classifierRef.getName());
353 if (classifierInstance.getClassifierDefinitionId() != null) {
354 ruleClassifierBuilder.setAdditionalInfo(new Text(classifierInstance.getClassifierDefinitionId()
357 List<ParameterValue> parms = null;
358 if (classifierInstance.getParameterValue() != null) {
359 LOG.trace("Calssifier Instance {} has {} parameters", classifierInstance.getName().getValue(),
360 classifierInstance.getParameterValue().size());
361 parms = new ArrayList<>();
362 for (org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue instance : classifierInstance.getParameterValue()) {
363 ParameterValueBuilder pBuilder = new ParameterValueBuilder();
364 pBuilder.setIntValue(instance.getIntValue());
365 pBuilder.setName(new Name(instance.getName().getValue()));
366 pBuilder.setStringValue(instance.getStringValue());
367 if (instance.getRangeValue() != null) {
368 RangeValueBuilder rBuilder = new RangeValueBuilder().setMax(
369 instance.getRangeValue().getMax()).setMin(instance.getRangeValue().getMin());
370 pBuilder.setRangeValue(rBuilder.build());
372 ParameterValue parm = pBuilder.build();
373 LOG.trace("Added parm {} from Classifier Instance {}", parm, classifierInstance.getName()
378 LOG.trace("Classifier Instance {} has no parameters", classifierInstance.getName().getValue());
380 ruleClassifierBuilder.setParameterValue(parms);
382 if (classifierRef.getDirection() != null) {
383 ruleClassifierBuilder.setDirection(Direction.forValue(classifierRef.getDirection().getIntValue()));
385 ruleClassifierBuilder.setDirection(Direction.Bidirectional);
387 fClassifiers.add(ruleClassifierBuilder.build());
392 private ClassifierInstance getClassifierInstance(TenantId tenantId, ClassifierName name, DataBroker dataProvider) {
393 ReadOnlyTransaction trans = dataProvider.newReadOnlyTransaction();
394 InstanceIdentifier<ClassifierInstance> ciId = InstanceIdentifier.builder(Tenants.class)
395 .child(Tenant.class, new TenantKey(tenantId))
397 .child(SubjectFeatureInstances.class)
398 .child(ClassifierInstance.class, new ClassifierInstanceKey(name))
401 Optional<ClassifierInstance> data = trans.read(LogicalDatastoreType.CONFIGURATION, ciId).get();
402 if (data.isPresent()) {
405 } catch (Exception e) {
406 LOG.error("Couldn't read Classifier instance from datastore. Exception: ", e);