PolicyEngineUtils/src/main/java/org/onap/policy/utils/AAFPolicyClientImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineUtils
   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
  22 package org.onap.policy.utils;
  23
  24 import java.util.Properties;
  25
  26 import org.apache.log4j.Logger;
  27
  28 import com.att.cadi.Access;
  29 import com.att.cadi.Access.Level;
  30 import com.att.cadi.CadiException;
  31 import com.att.cadi.aaf.AAFPermission;
  32 import com.att.cadi.aaf.v2_0.AAFAuthn;
  33 import com.att.cadi.aaf.v2_0.AAFCon;
  34 import com.att.cadi.aaf.v2_0.AAFConDME2;
  35 import com.att.cadi.aaf.v2_0.AAFLurPerm;
  36 import com.att.cadi.config.Config;
  37
  38
  39 /**
  40  * AAF Client: Generic AAF Client implementation to connect to AAF Resources to validate permissions and authorization.
  41  *
  42  */
  43 public class AAFPolicyClientImpl implements AAFPolicyClient{
  44         private static Logger logger = Logger.getLogger(AAFPolicyClientImpl.class.getName());
  45
  46         private static final String ENVIRONMENT = "ENVIRONMENT";
  47
  48         // Warning Please don't Change these Values. Confirm with AAF team.
  49         private static final String DEVL_AAF_URL = "";
  50         private static final String TEST_AAF_URL = "";
  51         private static final String PROD_AAF_URL = "";
  52         private static final String DEFAULT_AFT_LATITUDE = "32.780140";
  53         private static final String DEFAULT_AFT_LONGITUDE = "-96.800451";
  54         private static final String TEST_AFT_ENVIRONMENT = "AFTUAT";
  55         private static final String PROD_AFT_ENVIRONMENT = "AFTPRD";
  56         private static final String DEFAULT_AAF_USER_EXPIRES = Integer.toString(5*60000);       // 5 minutes for found items to live in cache
  57         private static final String DEFAULT_AAF_HIGH_COUNT = Integer.toString(400);             // Maximum number of items in Cache
  58
  59         private static AAFPolicyClientImpl instance = null;
  60
  61         private static Properties props = new Properties();
  62         private static AAFCon<?> aafCon = null;
  63         private static AAFLurPerm aafLurPerm = null;
  64         private static AAFAuthn<?> aafAuthn = null;
  65         private static Access access = null;
  66
  67         private AAFPolicyClientImpl(Properties properties) throws AAFPolicyException{
  68                 setup(properties);
  69         }
  70
  71         /**
  72          * Gets the instance of the AAFClient instance. Needs Proper properties with CLIENT_ID, CLIENT_KEY and ENVIRONMENT
  73          *
  74          * @param properties Properties with CLIENT_ID, CLIENT_KEY and ENVIRONMENT
  75          * @return AAFClient instance.
  76          * @throws AAFPolicyException Exceptions.
  77          */
  78         public static synchronized AAFPolicyClientImpl getInstance(Properties properties) throws AAFPolicyException{
  79                 if(instance == null) {
  80                         logger.info("Creating AAFClient Instance ");
  81                         instance = new AAFPolicyClientImpl(properties);
  82                 }
  83                 return instance;
  84         }
  85
  86         // To set Property values && Connections.
  87         private static void setup(Properties properties) throws AAFPolicyException {
  88                 if(properties!=null && !properties.isEmpty()){
  89                         props = System.getProperties();
  90                         props.setProperty("AFT_LATITUDE", properties.getProperty("AFT_LATITUDE", DEFAULT_AFT_LATITUDE));
  91                         props.setProperty("AFT_LONGITUDE", properties.getProperty("AFT_LONGITUDE", DEFAULT_AFT_LONGITUDE));
  92                         String aftEnv = TEST_AFT_ENVIRONMENT;
  93                         props.setProperty("aaf_id",properties.getProperty("aaf_id", "aafID"));
  94                         props.setProperty("aaf_password", properties.getProperty("aaf_password", "aafPass"));
  95                         if(properties.containsKey(Config.AAF_URL)){
  96                                 // if given a value in properties file.
  97                                 props.setProperty(Config.AAF_URL, properties.getProperty(Config.AAF_URL));
  98                         }else{
  99                                 // Set Default values.
 100                                 if(properties.getProperty(ENVIRONMENT, "DEVL").equalsIgnoreCase(AAFEnvironment.TEST.toString())){
 101                                         props.setProperty(Config.AAF_URL, TEST_AAF_URL);
 102                                 }else if(properties.getProperty(ENVIRONMENT, "DEVL").equalsIgnoreCase(AAFEnvironment.PROD.toString())){
 103                                         props.setProperty(Config.AAF_URL, PROD_AAF_URL);
 104                                         aftEnv = PROD_AFT_ENVIRONMENT;
 105                                 }else{
 106                                         props.setProperty(Config.AAF_URL, DEVL_AAF_URL);
 107                                 }
 108                         }
 109                         props.setProperty("AFT_ENVIRONMENT", properties.getProperty("AFT_ENVIRONMENT", aftEnv));
 110                         props.setProperty(Config.AAF_USER_EXPIRES, properties.getProperty(Config.AAF_USER_EXPIRES, DEFAULT_AAF_USER_EXPIRES));
 111                         props.setProperty(Config.AAF_HIGH_COUNT, properties.getProperty(Config.AAF_HIGH_COUNT, DEFAULT_AAF_HIGH_COUNT));
 112                 }else{
 113                         logger.error("Required Property value is missing : " + ENVIRONMENT);
 114                         throw new AAFPolicyException("Required Property value is missing : " + ENVIRONMENT);
 115                 }
 116                 access = new PolicyAccess(props, Level.valueOf(properties.getProperty("AAF_LOG_LEVEL", Level.ERROR.toString())));
 117                 setUpAAF();
 118         }
 119
 120         /**
 121          * Updates the Properties file in case if required.
 122          *
 123          * @param properties  Properties with CLIENT_ID, CLIENT_KEY and ENVIRONMENT
 124          * @throws AAFPolicyException exceptions if any.
 125          */
 126         @Override
 127         public void updateProperties(Properties properties) throws AAFPolicyException{
 128                 setup(properties);
 129         }
 130
 131         /**
 132          * Checks the Authentication and Permissions for the given values.
 133          *
 134          * @param mechID MechID or ATT ID must be registered under the Name space.
 135          * @param pass Password pertaining to the MechID or ATTID.
 136          * @param type Permissions Type.
 137          * @param instance Permissions Instance.
 138          * @param action Permissions Action.
 139          * @return
 140          */
 141         @Override
 142         public boolean checkAuthPerm(String mechID, String pass, String type, String instance, String action){
 143                 return checkAuth(mechID, pass) && checkPerm(mechID, pass, type, instance, action);
 144         }
 145
 146         /**
 147          * Checks the Authentication of the UserName and Password Given.
 148          *
 149          * @param userName UserName or MechID
 150          * @param pass Password.
 151          * @return True or False.
 152          */
 153         @Override
 154         public boolean checkAuth(String userName, String pass){
 155                 if(aafAuthn!=null){
 156                         try {
 157                                 int i=0;
 158                                 do{
 159                                         if(aafAuthn.validate(userName, pass)==null){
 160                                                 return true;
 161                                         }
 162                                         i++;
 163                                 }while(i<2);
 164                         } catch (Exception e) {
 165                                 logger.error(e.getMessage() + e);
 166                         }
 167                 }
 168                 logger.info("Authentication failed for : " + userName + " in " + props.getProperty(Config.AAF_URL));
 169                 return false;
 170         }
 171
 172         /**
 173          * Checks Permissions for the given UserName, Password and Type, Instance Action.
 174          *
 175          * @param userName UserName or MechID
 176          * @param pass Password.
 177          * @param type Permissions Type.
 178          * @param instance Permissions Instance.
 179          * @param action Permissions Action.
 180          * @return True or False.
 181          */
 182         @Override
 183         public boolean checkPerm(String userName, String pass, String type, String instance, String action){
 184                 int i =0;
 185                 Boolean result= false;
 186                 do{
 187                         if(aafCon!=null && aafLurPerm !=null){
 188                                 try {
 189                                         aafCon.basicAuth(userName, pass);
 190                                         AAFPermission perm = new AAFPermission(type, instance, action);
 191                                         result = aafLurPerm.fish(userName, perm);
 192                                 } catch (CadiException e) {
 193                                         logger.error(e.getMessage() + e);
 194                                         aafLurPerm.destroy();
 195                                 }
 196                         }
 197                         logger.info("Permissions for : " + userName + " in " + props.getProperty(Config.AAF_URL) + " for " + type  + "," + instance + "," + action + "\n Result is: " + result);
 198                         i++;
 199                 }while(i<2 && !result); // Try once more to check if this can be passed. AAF has some issues.
 200                 return result;
 201         }
 202
 203         private static boolean setUpAAF(){
 204                 try {
 205                         aafCon = new AAFConDME2(access);
 206                         aafLurPerm = aafCon.newLur();
 207                         aafAuthn = aafCon.newAuthn(aafLurPerm);
 208                         return true;
 209                 } catch (Exception e) {
 210                         logger.error("Error while setting up AAF Connection " + e.getMessage() + e);
 211                         return false;
 212                 }
 213         }
 214 }