POLICY-SDK-APP/src/main/java/org/onap/policy/admin/CheckPDP.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy Engine
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.admin;
  22
  23
  24 import java.io.FileInputStream;
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.nio.charset.StandardCharsets;
  28 import java.nio.file.Path;
  29 import java.nio.file.Paths;
  30 import java.util.ArrayList;
  31 import java.util.Arrays;
  32 import java.util.Base64;
  33 import java.util.Collection;
  34 import java.util.Collections;
  35 import java.util.HashMap;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.Properties;
  39
  40 import org.onap.policy.common.logging.flexlogger.FlexLogger;
  41 import org.onap.policy.common.logging.flexlogger.Logger;
  42 import org.onap.policy.rest.XACMLRestProperties;
  43 import org.onap.policy.xacml.api.XACMLErrorConstants;
  44
  45 import com.att.research.xacml.util.XACMLProperties;
  46
  47 /**
  48  * What is not good about this class is that once a value has been set for pdpProperties path
  49  * you cannot change it. That may be ok for a highly controlled production environment in which
  50  * nothing changes, but not a very good implementation.
  51  *
  52  * The reset() method has been added to assist with the above problem in order to
  53  * acquire >80% JUnit code coverage.
  54  *
  55  * This static class doesn't really check a PDP, it simply loads a properties file and tried
  56  * to ensure that a valid URL exists for a PDP along with user/password.
  57  *
  58  */
  59 public class CheckPDP {
  60     private static Path pdpPath = null;
  61     private static Long oldModified = null;
  62     private static HashMap<String, String> pdpMap = null;
  63     private static final Logger LOGGER = FlexLogger.getLogger(CheckPDP.class);
  64
  65     private CheckPDP(){
  66         //default constructor
  67     }
  68
  69     public static Map<String, String> getPdpMap() {
  70         return pdpMap;
  71     }
  72
  73     private static void reset() {
  74         pdpPath = null;
  75         oldModified = null;
  76         pdpMap = null;
  77     }
  78
  79     public static boolean validateID(String id) {
  80         // ReadFile
  81         try {
  82             readFile();
  83         } catch (Exception e) {
  84             LOGGER.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + e);
  85             return false;
  86         }
  87         if (pdpMap == null) {
  88             return false;
  89         }
  90         // Check ID
  91         return pdpMap.containsKey(id);
  92     }
  93
  94     private static void readFile(){
  95         String pdpFile = null;
  96         try{
  97             pdpFile = XACMLProperties.getProperty(XACMLRestProperties.PROP_PDP_IDFILE);
  98         }catch (Exception e){
  99             LOGGER.error(XACMLErrorConstants.ERROR_DATA_ISSUE + "Cannot read the PDP ID File" + e);
 100             return;
 101         }
 102         if (pdpFile == null) {
 103             LOGGER.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "PDP File name not Valid : " + pdpFile);
 104         }
 105         if (pdpPath == null) {
 106             pdpPath = Paths.get(pdpFile);
 107             if (!pdpPath.toString().endsWith(".properties") || !pdpPath.toFile().exists()) {
 108                 LOGGER.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "File doesn't exist in the specified Path : "     + pdpPath.toString());
 109                 CheckPDP.reset();
 110                 return;
 111             }
 112             readProps();
 113         }
 114         // Check if File is updated recently
 115         else {
 116             Long newModified = pdpPath.toFile().lastModified();
 117             if (!newModified.equals(oldModified)) {
 118                 // File has been updated.
 119                 readProps();
 120             }
 121         }
 122     }
 123
 124     @SuppressWarnings({ "unchecked", "rawtypes" })
 125     private static void readProps() {
 126         Properties pdpProp;
 127         pdpProp = new Properties();
 128         try(InputStream in = new FileInputStream(pdpPath.toFile())) {
 129             oldModified = pdpPath.toFile().lastModified();
 130             pdpProp.load(in);
 131             // Read the Properties and Load the PDPs and encoding.
 132             pdpMap = new HashMap<>();
 133             // Check the Keys for PDP_URLs
 134             Collection<Object> unsorted = pdpProp.keySet();
 135             List<String> sorted = new ArrayList(unsorted);
 136             Collections.sort(sorted);
 137             for (String propKey : sorted) {
 138                 loadPDPProperties(propKey, pdpProp);
 139             }
 140         } catch (IOException e) {
 141             LOGGER.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + e);
 142         }
 143         if (pdpMap == null || pdpMap.isEmpty()) {
 144             LOGGER.debug(XACMLErrorConstants.ERROR_SYSTEM_ERROR + "Cannot Proceed without PDP_URLs");
 145             CheckPDP.reset();
 146         }
 147     }
 148
 149     private static void loadPDPProperties(String propKey, Properties pdpProp){
 150         if (propKey.startsWith("PDP_URL")) {
 151             String checkVal = pdpProp.getProperty(propKey);
 152             if (checkVal == null) {
 153                 LOGGER.error("Properties file doesn't have the PDP_URL parameter");
 154             }
 155             if (checkVal != null && checkVal.contains(";")) {
 156                 List<String> pdpDefault = new ArrayList<>(Arrays.asList(checkVal.split("\\s*;\\s*")));
 157                 int pdpCount = 0;
 158                 while (pdpCount < pdpDefault.size()) {
 159                     String pdpVal = pdpDefault.get(pdpCount);
 160                     readPDPParam(pdpVal);
 161                     pdpCount++;
 162                 }
 163             }
 164         }
 165     }
 166
 167     private static void readPDPParam(String pdpVal){
 168         if(pdpVal.contains(",")){
 169             List<String> pdpValues = new ArrayList<>(Arrays.asList(pdpVal.split("\\s*,\\s*")));
 170             if(pdpValues.size()==3){
 171                 // 1:2 will be UserID:Password
 172                 String userID = pdpValues.get(1);
 173                 String pass = pdpValues.get(2);
 174                 Base64.Encoder encoder = Base64.getEncoder();
 175                 // 0 - PDPURL
 176                 pdpMap.put(pdpValues.get(0), encoder.encodeToString((userID+":"+pass).getBytes(StandardCharsets.UTF_8)));
 177             }else{
 178                 LOGGER.error(XACMLErrorConstants.ERROR_PERMISSIONS + "No Credentials to send Request: " + pdpValues);
 179             }
 180         }else{
 181             LOGGER.error(XACMLErrorConstants.ERROR_PERMISSIONS + "No Credentials to send Request: " + pdpVal);
 182         }
 183     }
 184
 185     public static String getEncoding(String pdpID){
 186         try {
 187             readFile();
 188         } catch (Exception e) {
 189             LOGGER.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + e);
 190         }
 191         String encoding = null;
 192         if(pdpMap!=null && (!pdpMap.isEmpty())){
 193             try{
 194                 encoding = pdpMap.get(pdpID);
 195             } catch(Exception e){
 196                 LOGGER.error(XACMLErrorConstants.ERROR_SYSTEM_ERROR + e);
 197             }
 198             return encoding;
 199         }else{
 200             return null;
 201         }
 202     }
 203 }