aboutsummaryrefslogtreecommitdiffstats
path: root/PolicyEngineUtils/src/main/java/org/onap/policy/utils/AAFPolicyClientImpl.java
blob: 732183d4797165f0423d5079d268d9132cfd015d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/*-
 * ============LICENSE_START=======================================================
 * PolicyEngineUtils
 * ================================================================================
 * Copyright (C) 2017-2018 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.utils;

import java.security.Principal;
import java.util.Properties;

import org.apache.log4j.Logger;
import org.onap.aaf.cadi.Access.Level;
import org.onap.aaf.cadi.CadiException;
import org.onap.aaf.cadi.PropAccess;
import org.onap.aaf.cadi.aaf.AAFPermission;
import org.onap.aaf.cadi.aaf.v2_0.AAFAuthn;
import org.onap.aaf.cadi.aaf.v2_0.AAFCon;
import org.onap.aaf.cadi.aaf.v2_0.AAFConHttp;
import org.onap.aaf.cadi.aaf.v2_0.AAFLurPerm;
import org.onap.aaf.cadi.config.Config;
import org.onap.aaf.cadi.locator.PropertyLocator;
import org.onap.aaf.cadi.principal.UnAuthPrincipal;



/**
 * AAF Client: Generic AAF Client implementation to connect to AAF Resources to validate permissions and authorization. 
 * 
 */
public class AAFPolicyClientImpl implements AAFPolicyClient{
	private static Logger logger = Logger.getLogger(AAFPolicyClientImpl.class.getName());

	private static final String ENVIRONMENT = "ENVIRONMENT";
	
	// Warning Please don't Change these Values. Confirm with AAF team.  
	private static final String DEVL_AAF_URL = "";
	private static final String TEST_AAF_URL = "";
	private static final String PROD_AAF_URL = "";
	private static final String DEFAULT_AFT_LATITUDE = "32.780140";
	private static final String DEFAULT_AFT_LONGITUDE = "-96.800451";
	private static final String TEST_AFT_ENVIRONMENT = "AFTUAT";
	private static final String PROD_AFT_ENVIRONMENT = "AFTPRD";
	private static final String DEFAULT_AAF_USER_EXPIRES = Integer.toString(5*60000); 	// 5 minutes for found items to live in cache
	private static final String DEFAULT_AAF_HIGH_COUNT = Integer.toString(400); 		// Maximum number of items in Cache

	private static AAFPolicyClientImpl instance = null;

	private static Properties props = new Properties();
	private static AAFCon<?> aafCon = null;
	private static AAFLurPerm aafLurPerm = null;
	private static AAFAuthn<?> aafAuthn = null;
	private static PropAccess access = null;

	private AAFPolicyClientImpl(Properties properties) throws AAFPolicyException{
		setup(properties);
	}

	/**
	 * Gets the instance of the AAFClient instance. Needs Proper properties with CLIENT_ID, CLIENT_KEY and ENVIRONMENT
	 * 
	 * @param properties Properties with CLIENT_ID, CLIENT_KEY and ENVIRONMENT
	 * @return AAFClient instance. 
	 * @throws AAFPolicyException Exceptions. 
	 */
	public static synchronized AAFPolicyClientImpl getInstance(Properties properties) throws AAFPolicyException{
		if(instance == null) {
			logger.info("Creating AAFClient Instance ");
			instance = new AAFPolicyClientImpl(properties);
		}
		return instance;
	}

	// To set Property values && Connections. 
	private static void setup(Properties properties) throws AAFPolicyException {
		if(properties!=null && !properties.isEmpty()){
			props = System.getProperties();
			props.setProperty("AFT_LATITUDE", properties.getProperty("AFT_LATITUDE", DEFAULT_AFT_LATITUDE));
			props.setProperty("AFT_LONGITUDE", properties.getProperty("AFT_LONGITUDE", DEFAULT_AFT_LONGITUDE));
			String aftEnv = TEST_AFT_ENVIRONMENT;
			props.setProperty("aaf_id",properties.getProperty("aaf_id", "aafID"));
			props.setProperty("aaf_password", properties.getProperty("aaf_password", "aafPass"));
			if(properties.containsKey(Config.AAF_URL)){
				// if given a value in properties file. 
				props.setProperty(Config.AAF_URL, properties.getProperty(Config.AAF_URL));
			}else{
				// Set Default values. 
				if(properties.getProperty(ENVIRONMENT, "DEVL").equalsIgnoreCase(AAFEnvironment.TEST.toString())){
					props.setProperty(Config.AAF_URL, TEST_AAF_URL);
				}else if(properties.getProperty(ENVIRONMENT, "DEVL").equalsIgnoreCase(AAFEnvironment.PROD.toString())){
					props.setProperty(Config.AAF_URL, PROD_AAF_URL);
					aftEnv = PROD_AFT_ENVIRONMENT;
				}else{
					props.setProperty(Config.AAF_URL, DEVL_AAF_URL);
				}
			}
			props.setProperty("AFT_ENVIRONMENT", properties.getProperty("AFT_ENVIRONMENT", aftEnv));
			props.setProperty(Config.AAF_USER_EXPIRES, properties.getProperty(Config.AAF_USER_EXPIRES, DEFAULT_AAF_USER_EXPIRES));	
			props.setProperty(Config.AAF_HIGH_COUNT, properties.getProperty(Config.AAF_HIGH_COUNT, DEFAULT_AAF_HIGH_COUNT));
		}else{
			logger.error("Required Property value is missing : " + ENVIRONMENT);
			throw new AAFPolicyException("Required Property value is missing : " + ENVIRONMENT);
		}
		access = new PolicyAccess(props, Level.valueOf(properties.getProperty("AAF_LOG_LEVEL", Level.ERROR.toString())));
		setUpAAF();
	}

	/**
	 * Updates the Properties file in case if required. 
	 * 
	 * @param properties  Properties with CLIENT_ID, CLIENT_KEY and ENVIRONMENT
	 * @throws AAFPolicyException exceptions if any.
	 */
	@Override
	public void updateProperties(Properties properties) throws AAFPolicyException{
		setup(properties);
	}

	/**
	 * Checks the Authentication and Permissions for the given values. 
	 * 
	 * @param mechID MechID or ATT ID must be registered under the Name space. 
	 * @param pass Password pertaining to the MechID or ATTID. 
	 * @param type Permissions Type.
	 * @param instance Permissions Instance. 
	 * @param action Permissions Action. 
	 * @return
	 */
	@Override
	public boolean checkAuthPerm(String mechID, String pass, String type, String instance, String action){
		return checkAuth(mechID, pass) && checkPerm(mechID, pass, type, instance, action);
	}

	/**
	 * Checks the Authentication of the UserName and Password Given. 
	 * 
	 * @param userName UserName or MechID
	 * @param pass Password.
	 * @return True or False. 
	 */
	@Override
	public boolean checkAuth(String userName, String pass){
		if(aafAuthn!=null){
			try {
				int i=0;
				do{
					if(aafAuthn.validate(userName, pass)==null){ 
						return true; 
					}
					i++;
				}while(i<2);
			} catch (Exception e) {
				logger.error(e.getMessage() + e);
			}
		}
		return false;
	}

	/**
	 * Checks Permissions for the given UserName, Password and Type, Instance Action. 
	 * 
	 * @param userName UserName or MechID
	 * @param pass Password.
	 * @param type Permissions Type. 
	 * @param instance Permissions Instance. 
	 * @param action Permissions Action. 
	 * @return True or False. 
	 */
	@Override
	public boolean checkPerm(String userName, String pass, String type, String instance, String action){
		int i =0;
		Boolean result= false;
		do{
			if(aafCon!=null && aafLurPerm !=null){
				try {
					aafCon.basicAuth(userName, pass);
					AAFPermission perm = new AAFPermission(type, instance, action);
					final Principal p = new UnAuthPrincipal(userName); 
					result = aafLurPerm.fish(p, perm);
				} catch (CadiException e) {
					logger.error(e.getMessage() + e);
					aafLurPerm.destroy();
				}
			}
			i++;
		}while(i<2 && !result); // Try once more to check if this can be passed. AAF has some issues. 
		return result;
	}

	private static boolean setUpAAF(){
		try {
			aafCon = new AAFConHttp(access,new PropertyLocator("https://aaf-onap-beijing-test.osaaf.org:8100"));
			aafLurPerm = aafCon.newLur();
			aafAuthn = aafCon.newAuthn(aafLurPerm);
			return true;
		} catch (Exception e) {
			logger.error("Error while setting up AAF Connection " + e.getMessage() + e);
			return false;
		}
	}
}