applications/native/src/main/java/org/onap/policy/xacml/pdp/application/nativ/NativePdpApplicationTranslator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2020 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.xacml.pdp.application.nativ;
  25
  26 import com.att.research.xacml.api.Request;
  27 import com.att.research.xacml.api.Response;
  28 import com.att.research.xacml.util.XACMLPolicyScanner;
  29 import java.io.ByteArrayInputStream;
  30 import java.io.IOException;
  31 import java.nio.charset.StandardCharsets;
  32 import java.util.Base64;
  33 import lombok.Getter;
  34 import lombok.NoArgsConstructor;
  35 import org.onap.policy.common.parameters.annotations.NotBlank;
  36 import org.onap.policy.common.parameters.annotations.NotNull;
  37 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  38 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  39 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  40 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConversionException;
  41 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
  42 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslatorUtils;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45
  46 /**
  47  * This class implements one translator that interprets TOSCA policy and decision API request/response payload.
  48  *
  49  * @author Chenfei Gao (cgao@research.att.com)
  50  *
  51  */
  52 @NoArgsConstructor
  53 public class NativePdpApplicationTranslator implements ToscaPolicyTranslator {
  54
  55     private static final Logger LOGGER = LoggerFactory.getLogger(NativePdpApplicationTranslator.class);
  56
  57     @Override
  58     public Object convertPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException {
  59         //
  60         // Extract the Base64 encoded policy xml string and decode it
  61         //
  62         String encodedXacmlPolicy = getNativeXacmlPolicy(toscaPolicy);
  63         String decodedXacmlPolicy;
  64         try {
  65             decodedXacmlPolicy = new String(Base64.getDecoder().decode(encodedXacmlPolicy), StandardCharsets.UTF_8);
  66         } catch (IllegalArgumentException exc) {
  67             throw new ToscaPolicyConversionException("error on Base64 decoding the native policy", exc);
  68         }
  69         LOGGER.debug("Decoded xacml policy {}", decodedXacmlPolicy);
  70         //
  71         // Scan the string and convert to xacml PolicyType
  72         //
  73         try (var is = new ByteArrayInputStream(decodedXacmlPolicy.getBytes(StandardCharsets.UTF_8))) {
  74             //
  75             // Read the Policy In
  76             //
  77             Object policy = XACMLPolicyScanner.readPolicy(is);
  78             if (policy == null) {
  79                 throw new ToscaPolicyConversionException("Invalid XACML Policy");
  80             }
  81             return policy;
  82         } catch (IOException exc) {
  83             throw new ToscaPolicyConversionException("Failed to read policy", exc);
  84         }
  85     }
  86
  87     protected String getNativeXacmlPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException {
  88
  89         var nativeDefinition = ToscaPolicyTranslatorUtils.decodeProperties(toscaPolicy.getProperties(),
  90                         NativeDefinition.class);
  91
  92         LOGGER.debug("Base64 encoded native xacml policy {}", nativeDefinition.getPolicy());
  93         return nativeDefinition.getPolicy();
  94     }
  95
  96     @Override
  97     public Request convertRequest(DecisionRequest request) throws ToscaPolicyConversionException {
  98         throw new ToscaPolicyConversionException("Do not call native convertRequest");
  99     }
 100
 101     @Override
 102     public DecisionResponse convertResponse(Response xacmlResponse) {
 103         //
 104         // We do nothing to DecisionResponse for native xacml application
 105         //
 106         return null;
 107     }
 108
 109     @Getter
 110     public static class NativeDefinition {
 111         @NotNull
 112         @NotBlank
 113         private String policy;
 114     }
 115 }