diff options
author | Pamela Dragosh <pdragosh@research.att.com> | 2019-03-15 14:30:00 -0400 |
---|---|---|
committer | Pamela Dragosh <pdragosh@research.att.com> | 2019-03-18 12:25:32 -0400 |
commit | 59c38b6b3dfbd43c876f85ffb1e4b484951ced44 (patch) | |
tree | 99120b17e967d8497c03fb038c664fa0063b3871 /applications/monitoring/src/main | |
parent | 934c39bcdb5ff9a095331f60ef1b279ec91875a9 (diff) |
Started with test decision JSON objects.
Added new Policy Finder Factory that ONAP will use and
got the code working with new policy/models (see other
review which will have to be merged first).
Added some new conversion methods to convert from a
Xacml request to an Onap request.
Added some property methods for XACML Properties objects
and JUnit tests.
Started filling in some Guard application details and
combining code.
Issue-ID: POLICY-1602
Change-Id: I5235b74f3b036dcf05779b655a03ac290d594354
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'applications/monitoring/src/main')
-rw-r--r-- | applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java (renamed from applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/engine/OnapXacmlPdpEngine.java) | 292 | ||||
-rw-r--r-- | applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java | 78 | ||||
-rw-r--r-- | applications/monitoring/src/main/resources/META-INF/services/org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider | 2 | ||||
-rw-r--r-- | applications/monitoring/src/main/resources/RootMonitoringPolicy.xml | 4 |
4 files changed, 262 insertions, 114 deletions
diff --git a/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/engine/OnapXacmlPdpEngine.java b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java index 6c53566a..ab48d134 100644 --- a/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/engine/OnapXacmlPdpEngine.java +++ b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringPdpApplication.java @@ -20,24 +20,29 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.xacml.pdp.engine; +package org.onap.policy.xacml.pdp.application.monitoring; +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.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.api.pdp.PDPEngine; -import com.att.research.xacml.api.pdp.PDPEngineFactory; import com.att.research.xacml.api.pdp.PDPException; -import com.att.research.xacml.util.FactoryException; +import com.att.research.xacml.std.annotations.RequestParser; import com.att.research.xacml.util.XACMLPolicyScanner; +import com.att.research.xacml.util.XACMLPolicyWriter; import com.att.research.xacml.util.XACMLProperties; import com.google.common.collect.Lists; +import com.google.gson.Gson; +import java.io.ByteArrayOutputStream; import java.io.FileInputStream; -import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; -import java.io.OutputStream; import java.nio.file.Path; import java.nio.file.Paths; import java.util.ArrayList; @@ -63,12 +68,14 @@ 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.ToscaPolicyConverter; import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConverterUtils; import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider; -import org.onap.policy.pdp.xacml.application.common.XacmlUpdatePolicyUtils; +import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.yaml.snakeyaml.Yaml; @@ -82,13 +89,12 @@ import org.yaml.snakeyaml.Yaml; * @author pameladragosh * */ -public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicationServiceProvider { +public class MonitoringPdpApplication implements ToscaPolicyConverter, XacmlApplicationServiceProvider { - private static final Logger LOGGER = LoggerFactory.getLogger(OnapXacmlPdpEngine.class); + private static final Logger LOGGER = LoggerFactory.getLogger(MonitoringPdpApplication.class); private static final String ONAP_MONITORING_BASE_POLICY_TYPE = "onap.Monitoring"; private static final String ONAP_MONITORING_DERIVED_POLICY_TYPE = "onap.policies.monitoring"; - private Path pathForData = null; private Properties pdpProperties = null; private PDPEngine pdpEngine = null; @@ -97,67 +103,13 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio /** * Constructor. */ - public OnapXacmlPdpEngine() { + public MonitoringPdpApplication() { // // By default this supports just Monitoring policy types // supportedPolicyTypes.put(ONAP_MONITORING_BASE_POLICY_TYPE, "1.0.0"); } - /** - * Load properties from given file. - * - * @param location Path and filename - * @throws IOException If unable to read file - */ - public synchronized void loadXacmlProperties(String location) throws IOException { - try (InputStream is = new FileInputStream(location)) { - pdpProperties.load(is); - } - } - - /** - * Stores the XACML Properties to the given file location. - * - * @param location File location including name - * @throws IOException If unable to store the file. - */ - public synchronized void storeXacmlProperties(String location) throws IOException { - try (OutputStream os = new FileOutputStream(location)) { - String strComments = "#"; - pdpProperties.store(os, strComments); - } - } - - /** - * Make a decision call. - * - * @param request Incoming request object - * @return Response object - */ - public synchronized Response decision(Request request) { - // - // This is what we need to return - // - Response response = null; - // - // Track some timing - // - long timeStart = System.currentTimeMillis(); - try { - response = this.pdpEngine.decide(request); - } catch (PDPException e) { - LOGGER.error("{}", e); - } finally { - // - // Track the end of timing - // - long timeEnd = System.currentTimeMillis(); - LOGGER.info("Elapsed Time: {}ms", (timeEnd - timeStart)); - } - return response; - } - @Override public String applicationName() { return "Monitoring Application"; @@ -178,29 +130,18 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio // // Look for and load the properties object // - Path propertyPath = Paths.get(this.pathForData.toAbsolutePath().toString(), "xacml.properties"); - LOGGER.debug("Looking for {}", propertyPath.toAbsolutePath()); - try (InputStream is = new FileInputStream(propertyPath.toAbsolutePath().toString()) ) { - // - // Create a new properties object - // - pdpProperties = new Properties(); - // - // Load it with our values - // - pdpProperties.load(is); + try { + pdpProperties = XacmlPolicyUtils.loadXacmlProperties(XacmlPolicyUtils.getPropertiesPath(pathForData)); LOGGER.debug("{}", pdpProperties); } catch (IOException e) { LOGGER.error("{}", e); } // - // Now initialize the XACML PDP Engine + // Create an engine // - try { - PDPEngineFactory factory = PDPEngineFactory.newInstance(); - this.pdpEngine = factory.newEngine(pdpProperties); - } catch (FactoryException e) { - LOGGER.error("{}", e); + PDPEngine newEngine = XacmlPolicyUtils.createEngine(pdpProperties); + if (newEngine != null) { + pdpEngine = newEngine; } } @@ -222,9 +163,6 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio @Override public synchronized void loadPolicies(Map<String, Object> toscaPolicies) { - // - // - // try { // // Convert the policies first @@ -245,45 +183,84 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio // String rootFile = pdpProperties.getProperty(roots.iterator().next() + ".file"); try (InputStream is = new FileInputStream(rootFile)) { + // + // Read the Root Policy into memory + // Object policyData = XACMLPolicyScanner.readPolicy(is); // // Should be a PolicySet // if (policyData instanceof PolicySetType) { + // + // Add the referenced policies into a new Root Policy + // PolicyType[] newPolicies = listPolicies.toArray(new PolicyType[listPolicies.size()]); - PolicySetType newRootPolicy = - XacmlUpdatePolicyUtils.updateXacmlRootPolicy((PolicySetType) policyData, newPolicies); + PolicySetType newRootPolicy = XacmlPolicyUtils.addPoliciesToXacmlRootPolicy( + (PolicySetType) policyData, newPolicies); + LOGGER.debug("New ROOT Policy"); + try (ByteArrayOutputStream os = new ByteArrayOutputStream()) { + XACMLPolicyWriter.writePolicyFile(os, newRootPolicy); + LOGGER.debug("{}", os); + } catch (IOException e) { + LOGGER.error("Failed to convert {}", e); + } // // Save the new Policies to disk // - + for (PolicyType policy : newPolicies) { + // + // Construct the filename + // + Path refPath = XacmlPolicyUtils.constructUniquePolicyFilename(policy, pathForData); + // + // Write the policy to disk + // Maybe check for an error + // + XACMLPolicyWriter.writePolicyFile(refPath, policy); + // + // Save it off + // + XacmlPolicyUtils.addReferencedPolicy(pdpProperties, refPath); + } // // Save the root policy to disk // - + XACMLPolicyWriter.writePolicyFile(Paths.get(rootFile), newRootPolicy); // - // Update properties to declare the referenced policies + // Write the policies to disk // - + XacmlPolicyUtils.storeXacmlProperties(pdpProperties, + XacmlPolicyUtils.getPropertiesPath(pathForData)); // - // Write the policies to disk + // Reload the engine // - + PDPEngine newEngine = XacmlPolicyUtils.createEngine(pdpProperties); + if (newEngine != null) { + pdpEngine = newEngine; + } } else { throw new ToscaPolicyConversionException("Root policy isn't a PolicySet"); } } - // - // Add to the root policy - // } catch (IOException | ToscaPolicyConversionException e) { LOGGER.error("Failed to loadPolicies {}", e); } } @Override - public synchronized JSONObject makeDecision(JSONObject jsonSchema) { - return null; + public synchronized DecisionResponse makeDecision(DecisionRequest request) { + // + // Convert to a XacmlRequest + // + Request xacmlRequest = this.convertRequest(request); + // + // Now get a decision + // + Response xacmlResponse = this.xacmlDecision(xacmlRequest); + // + // Convert to a DecisionResponse + // + return this.convertResponse(xacmlResponse); } @Override @@ -325,11 +302,17 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio LOGGER.debug("Found policy {}", policyObject.getClass()); Map<String, Object> policyContents = (Map<String, Object>) policyObject; for (Entry<String, Object> entrySet : policyContents.entrySet()) { - LOGGER.info("Entry set {}", 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 // @@ -397,14 +380,11 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio rule.setEffect(EffectType.PERMIT); rule.setTarget(new TargetType()); // - // There should be properties section - this data ends up as a - // JSON BLOB that is returned back to calling application. + // Now represent the policy as Json // - if (! policyDefinition.containsKey("properties")) { - throw new ToscaPolicyConversionException(policyName + " missing properties section"); - } - addObligation(rule, - (Map<String, Object>) policyDefinition.get("properties")); + JSONObject jsonObligation = new JSONObject(); + jsonObligation.put(policyName, policyDefinition); + addObligation(rule, jsonObligation); // // Add the rule to the policy // @@ -498,20 +478,19 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio return target; } - private RuleType addObligation(RuleType rule, Map<String, Object> properties) { + private RuleType addObligation(RuleType rule, JSONObject jsonPolicy) { // // Convert the YAML Policy to JSON Object // - JSONObject jsonObject = new JSONObject(properties); if (LOGGER.isDebugEnabled()) { - LOGGER.debug("JSON conversion {}{}", System.lineSeparator(), jsonObject); + LOGGER.debug("JSON DCAE 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(jsonObject.toString()); + value.getContent().add(jsonPolicy.toString()); // // Create our AttributeAssignmentExpression where we will // store the contents of the policy in JSON format. @@ -536,4 +515,99 @@ public class OnapXacmlPdpEngine implements ToscaPolicyConverter, XacmlApplicatio return rule; } + @Override + public Request convertRequest(DecisionRequest request) { + LOGGER.debug("Converting Request {}", request); + try { + return RequestParser.parseRequest(MonitoringRequest.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 + // + for (Obligation obligation : xacmlResult.getObligations()) { + 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); + } + } + } + } else { + decisionResponse.setErrorMessage("A better error message"); + } + } + + return decisionResponse; + } + + /** + * Make a decision call. + * + * @param request Incoming request object + * @return Response object + */ + private synchronized Response xacmlDecision(Request request) { + // + // This is what we need to return + // + Response response = null; + // + // Track some timing + // + long timeStart = System.currentTimeMillis(); + try { + response = this.pdpEngine.decide(request); + } catch (PDPException e) { + LOGGER.error("Xacml PDP Engine failed {}", e); + } finally { + // + // Track the end of timing + // + long timeEnd = System.currentTimeMillis(); + LOGGER.info("Elapsed Time: {}ms", (timeEnd - timeStart)); + } + return response; + } } diff --git a/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java new file mode 100644 index 00000000..b2e5ff9a --- /dev/null +++ b/applications/monitoring/src/main/java/org/onap/policy/xacml/pdp/application/monitoring/MonitoringRequest.java @@ -0,0 +1,78 @@ +/* + * ============LICENSE_START======================================================= + * ONAP Policy Decision Models + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.xacml.pdp.application.monitoring; + +import com.att.research.xacml.std.annotations.XACMLAction; +import com.att.research.xacml.std.annotations.XACMLRequest; +import com.att.research.xacml.std.annotations.XACMLResource; +import com.att.research.xacml.std.annotations.XACMLSubject; + +import java.util.Map; +import java.util.Map.Entry; + +import org.onap.policy.models.decisions.concepts.DecisionRequest; + +@XACMLRequest(ReturnPolicyIdList = true) +public class MonitoringRequest { + + @XACMLSubject(includeInResults = true) + String onapName = "DCAE"; + + @XACMLResource(includeInResults = true) + String resource = "onap.policies.Monitoring"; + + @XACMLAction() + String action = "configure"; + + + /** + * Parses the DecisionRequest into a MonitoringRequest. + * + * @param decisionRequest Input DecisionRequest + * @return MonitoringRequest + */ + public static MonitoringRequest createInstance(DecisionRequest decisionRequest) { + MonitoringRequest request = new MonitoringRequest(); + request.onapName = decisionRequest.getOnapName(); + request.action = decisionRequest.getAction(); + + Map<String, Object> resources = decisionRequest.getResource(); + for (Entry<String, Object> entry : resources.entrySet()) { + if (entry.getKey().equals("policy-id")) { + // + // TODO handle lists of policies + // + request.resource = entry.getValue().toString(); + continue; + } + if (entry.getKey().equals("policy-type")) { + // + // TODO handle lists of policies + // + request.resource = entry.getValue().toString(); + } + } + // + // TODO handle a bad incoming request. Do that here? + // + return request; + } +} diff --git a/applications/monitoring/src/main/resources/META-INF/services/org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider b/applications/monitoring/src/main/resources/META-INF/services/org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider index 5c8dd5e6..29c6b87f 100644 --- a/applications/monitoring/src/main/resources/META-INF/services/org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider +++ b/applications/monitoring/src/main/resources/META-INF/services/org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider @@ -1 +1 @@ -org.onap.policy.xacml.pdp.engine.OnapXacmlPdpEngine
\ No newline at end of file +org.onap.policy.xacml.pdp.application.monitoring.MonitoringPdpApplication
\ No newline at end of file diff --git a/applications/monitoring/src/main/resources/RootMonitoringPolicy.xml b/applications/monitoring/src/main/resources/RootMonitoringPolicy.xml index 33b28815..5578fda9 100644 --- a/applications/monitoring/src/main/resources/RootMonitoringPolicy.xml +++ b/applications/monitoring/src/main/resources/RootMonitoringPolicy.xml @@ -5,10 +5,6 @@ <AnyOf> <AllOf> <Match MatchId="urn:oasis:names:tc:xacml:1.0:function:string-equal"> - <AttributeValue DataType="http://www.w3.org/2001/XMLSchema#string">onap.policies.Monitoring</AttributeValue> - <AttributeDesignator Category="urn:oasis:names:tc:xacml:3.0:attribute-category:resource" AttributeId="urn:oasis:names:tc:xacml:1.0:resource:resource-id" DataType="http://www.w3.org/2001/XMLSchema#string" MustBePresent="false"/> - </Match> - <Match MatchId="urn:oasis:names:tc:xacml:1.0:function:string-equal"> <AttributeValue DataType="http://www.w3.org/2001/XMLSchema#string">DCAE</AttributeValue> <AttributeDesignator Category="urn:oasis:names:tc:xacml:1.0:subject-category:access-subject" AttributeId="urn:oasis:names:tc:xacml:1.0:subject:subject-id" DataType="http://www.w3.org/2001/XMLSchema#string" MustBePresent="false"/> </Match> |