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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
/*-
* ============LICENSE_START=======================================================
* ECOMP-XACML
* ================================================================================
* Copyright (C) 2017 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.openecomp.policy.xacml.std.pip.engines.aaf;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openecomp.policy.utils.AAFPolicyClient;
import org.openecomp.policy.utils.AAFPolicyException;
import com.att.research.xacml.api.Attribute;
import com.att.research.xacml.api.AttributeValue;
import com.att.research.xacml.api.Identifier;
import com.att.research.xacml.api.XACML3;
import com.att.research.xacml.api.pip.PIPException;
import com.att.research.xacml.api.pip.PIPFinder;
import com.att.research.xacml.api.pip.PIPRequest;
import com.att.research.xacml.api.pip.PIPResponse;
import com.att.research.xacml.std.IdentifierImpl;
import com.att.research.xacml.std.StdMutableAttribute;
import com.att.research.xacml.std.datatypes.DataTypes;
import com.att.research.xacml.std.pip.StdMutablePIPResponse;
import com.att.research.xacml.std.pip.StdPIPRequest;
import com.att.research.xacml.std.pip.StdPIPResponse;
import com.att.research.xacml.std.pip.engines.StdConfigurableEngine;
/**
* PIP Engine for Implementing {@link com.att.research.xacml.std.pip.engines.ConfigurableEngine} interface to provide
* attribute retrieval from AT&T AAF interface.
*
* @version $Revision$
*/
public class AAFEngine extends StdConfigurableEngine {
public static final String DEFAULT_DESCRIPTION = "PIP for authenticating aaf attributes using the AT&T AAF REST interface";
public static final String DEFAULT_ISSUER = "att-aaf";
private static final String SUCCESS = "Success";
public static final String AAF_RESULT= "AAF_RESULT";
public static final String AAF_RESPONSE= "AAF_RESPONSE";
//
public static final Identifier AAF_RESPONSE_ID = new IdentifierImpl(AAF_RESPONSE);
public static final Identifier AAF_RESULT_ID = new IdentifierImpl(AAF_RESULT);
//
private static final PIPRequest PIP_REQUEST_UID = new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, new IdentifierImpl("AAF_ID"), XACML3.ID_DATATYPE_STRING);
private static final PIPRequest PIP_REQUEST_PASS = new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, new IdentifierImpl("AAF_PASS"), XACML3.ID_DATATYPE_STRING);
private static final PIPRequest PIP_REQUEST_TYPE = new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, new IdentifierImpl("AAF_TYPE"), XACML3.ID_DATATYPE_STRING);
private static final PIPRequest PIP_REQUEST_INSTANCE = new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, new IdentifierImpl("AAF_INSTANCE"), XACML3.ID_DATATYPE_STRING);
private static final PIPRequest PIP_REQUEST_ACTION = new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, new IdentifierImpl("AAF_ACTION"), XACML3.ID_DATATYPE_STRING);
private static final PIPRequest PIP_REQUEST_ENV = new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, new IdentifierImpl("AAF_ENVIRONMENT"), XACML3.ID_DATATYPE_STRING);
private static final List<PIPRequest> mapRequiredAttributes = new ArrayList<PIPRequest>();
static{
mapRequiredAttributes.add(new StdPIPRequest(PIP_REQUEST_UID));
mapRequiredAttributes.add(new StdPIPRequest(PIP_REQUEST_PASS));
mapRequiredAttributes.add(new StdPIPRequest(PIP_REQUEST_TYPE));
mapRequiredAttributes.add(new StdPIPRequest(PIP_REQUEST_INSTANCE));
mapRequiredAttributes.add(new StdPIPRequest(PIP_REQUEST_ACTION));
mapRequiredAttributes.add(new StdPIPRequest(PIP_REQUEST_ENV));
}
private static final Map<PIPRequest, String> mapSupportedAttributes = new HashMap<PIPRequest, String>();
static{
mapSupportedAttributes.put(new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, AAF_RESPONSE_ID, XACML3.ID_DATATYPE_STRING), "response");
mapSupportedAttributes.put(new StdPIPRequest(XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, AAF_RESULT_ID, XACML3.ID_DATATYPE_BOOLEAN), "result");
}
protected Log logger = LogFactory.getLog(this.getClass());
public AAFEngine(){
}
private PIPResponse getAttribute(PIPRequest pipRequest, PIPFinder pipFinder) {
PIPResponse pipResponse = null;
try {
pipResponse = pipFinder.getMatchingAttributes(pipRequest, this);
if (pipResponse.getStatus() != null && !pipResponse.getStatus().isOk()) {
this.logger.warn("Error retrieving " + pipRequest.getAttributeId().stringValue() + ": " + pipResponse.getStatus().toString());
pipResponse = null;
}
if (pipResponse.getAttributes().size() == 0) {
this.logger.warn("No value for " + pipRequest.getAttributeId().stringValue());
pipResponse = null;
}
} catch (PIPException ex) {
this.logger.error("PIPException getting subject-id attribute: " + ex.getMessage(), ex);
}
return pipResponse;
}
private String getValue(PIPResponse pipResponse){
String result = null;
Collection<Attribute> listAttributes = pipResponse.getAttributes();
for(Attribute attribute: listAttributes){
Iterator<AttributeValue<String>> iterAttributeValues = attribute.findValues(DataTypes.DT_STRING);
if(iterAttributeValues!=null) {
while(iterAttributeValues.hasNext()){
result = iterAttributeValues.next().getValue();
break;
}
}
}
return result;
}
private synchronized String getResult(PIPFinder pipFinder) {
PIPResponse pipResponseUID = this.getAttribute(PIP_REQUEST_UID, pipFinder);
PIPResponse pipResponsePass = this.getAttribute(PIP_REQUEST_PASS, pipFinder);
PIPResponse pipResponseType = this.getAttribute(PIP_REQUEST_TYPE, pipFinder);
PIPResponse pipResponseAction = this.getAttribute(PIP_REQUEST_ACTION, pipFinder);
PIPResponse pipResponseInstance = this.getAttribute(PIP_REQUEST_INSTANCE, pipFinder);
PIPResponse pipResponseEnv = this.getAttribute(PIP_REQUEST_ENV, pipFinder);
String response = null;
// Evaluate AAF if we have all the required values.
if(pipResponseUID!=null && pipResponsePass!=null && pipResponseType != null && pipResponseAction!= null && pipResponseInstance!=null && pipResponseEnv!=null){
// Check the Environment.
String environment = getValue(pipResponseEnv);
if(environment == null){
response = "Environment Value is not set. ";
}
String userName = getValue(pipResponseUID);
String pass = getValue(pipResponsePass);
AAFPolicyClient aafClient = null;
Properties properties = new Properties();
if(environment.equalsIgnoreCase("PROD")){
properties.setProperty("ENVIRONMENT", "PROD");
}else if(environment.equalsIgnoreCase("TEST")){
properties.setProperty("ENVIRONMENT", "TEST");
}else{
properties.setProperty("ENVIRONMENT", "DEVL");
}
logger.debug("environment : " + environment);
if(userName!=null && pass!=null){
try {
aafClient = AAFPolicyClient.getInstance(properties);
} catch (AAFPolicyException e) {
logger.error("AAF configuration failed. " + e.getMessage());
}
if(aafClient!=null){
if(aafClient.checkAuth(userName, pass)){
String type = getValue(pipResponseType);
String instance = getValue(pipResponseInstance);
String action = getValue(pipResponseAction);
if(aafClient.checkPerm(userName, pass, type, instance, action)){
response = SUCCESS + "Permissions Validated";
}else{
response = "No Permissions for "+userName+" to: "+type+", "+instance+", "+action;
}
}else{
response = "Authentication Failed for the given Values";
}
}
}else{
response = "ID and Password are not given";
}
}else{
response = "Insufficient Values to Evaluate AAF";
}
return response;
}
private void addStringAttribute(StdMutablePIPResponse stdPIPResponse, Identifier category, Identifier attributeId, String value) {
if (value != null) {
AttributeValue<String> attributeValue = null;
try {
attributeValue = DataTypes.DT_STRING.createAttributeValue(value);
} catch (Exception ex) {
this.logger.error("Failed to convert " + value + " to an AttributeValue<String>", ex);
}
if (attributeValue != null) {
stdPIPResponse.addAttribute(new StdMutableAttribute(category, attributeId, attributeValue, this.getIssuer(), false));
}
}
}
private void addBooleanAttribute(StdMutablePIPResponse stdPIPResponse, Identifier category, Identifier attributeId, boolean value) {
AttributeValue<Boolean> attributeValue = null;
try {
attributeValue = DataTypes.DT_BOOLEAN.createAttributeValue(value);
} catch (Exception ex) {
this.logger.error("Failed to convert " + value + " to an AttributeValue<Boolean>", ex);
}
if (attributeValue != null) {
stdPIPResponse.addAttribute(new StdMutableAttribute(category, attributeId, attributeValue, this.getIssuer(), false));
}
}
@Override
public PIPResponse getAttributes(PIPRequest pipRequest, PIPFinder pipFinder) throws PIPException {
/*
* First check to see if the issuer is set and then match it
*/
String string;
if ((string = pipRequest.getIssuer()) != null) {
if (!string.equals(this.getIssuer())) {
this.logger.debug("Requested issuer '" + string + "' does not match " + (this.getIssuer() == null ? "null" : "'" + this.getIssuer() + "'"));
return StdPIPResponse.PIP_RESPONSE_EMPTY;
}
}
/*
* Drop the issuer and see if the request matches any of our supported queries
*/
PIPRequest pipRequestSupported = (pipRequest.getIssuer() == null ? pipRequest : new StdPIPRequest(pipRequest.getCategory(), pipRequest.getAttributeId(), pipRequest.getDataTypeId()));
if (!mapSupportedAttributes.containsKey(pipRequestSupported)) {
this.logger.debug("Requested attribute '" + pipRequest.toString() + "' is not supported");
return StdPIPResponse.PIP_RESPONSE_EMPTY;
}
StdMutablePIPResponse stdPIPResponse = new StdMutablePIPResponse();
String response = this.getResult(pipFinder);
boolean result = false;
if(response.contains(SUCCESS)){
result = true;
}
this.addBooleanAttribute(stdPIPResponse, XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, AAF_RESULT_ID, result);
this.addStringAttribute(stdPIPResponse, XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE, AAF_RESPONSE_ID, response);
return new StdPIPResponse(stdPIPResponse);
}
@Override
public void configure(String id, Properties properties) throws PIPException {
super.configure(id, properties);
if (this.getDescription() == null) {
this.setDescription(DEFAULT_DESCRIPTION);
}
if (this.getIssuer() == null) {
this.setIssuer(DEFAULT_ISSUER);
}
}
@Override
public Collection<PIPRequest> attributesRequired() {
List<PIPRequest> attributes = new ArrayList<PIPRequest>();
for (PIPRequest attribute: mapRequiredAttributes) {
attributes.add(new StdPIPRequest(attribute));
}
return attributes;
}
@Override
public Collection<PIPRequest> attributesProvided() {
List<PIPRequest> attributes = new ArrayList<PIPRequest>();
for (PIPRequest attribute : mapSupportedAttributes.keySet()) {
attributes.add(new StdPIPRequest(attribute));
}
return attributes;
}
}
|
