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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
/*-
* ============LICENSE_START==========================================
* ONAP Portal
* ===================================================================
* Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
* ===================================================================
*
* Unless otherwise specified, all software contained herein is licensed
* under the Apache License, Version 2.0 (the "License");
* you may not use this software 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.
*
* Unless otherwise specified, all documentation contained herein is licensed
* under the Creative Commons License, Attribution 4.0 Intl. (the "License");
* you may not use this documentation except in compliance with the License.
* You may obtain a copy of the License at
*
* https://creativecommons.org/licenses/by/4.0/
*
* Unless required by applicable law or agreed to in writing, documentation
* 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.portalapp.util;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.binary.Hex;
import org.onap.portalapp.portal.domain.EPRole;
import org.onap.portalapp.portal.domain.EPUser;
import org.onap.portalapp.portal.domain.EPUserApp;
import org.onap.portalapp.portal.exceptions.RoleFunctionException;
import org.onap.portalapp.portal.service.EPRoleFunctionService;
import org.onap.portalsdk.core.domain.RoleFunction;
import org.onap.portalsdk.core.exception.SessionExpiredException;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.onap.portalsdk.core.menu.MenuBuilder;
import org.onap.portalsdk.core.service.DataAccessService;
import org.onap.portalsdk.core.util.SystemProperties;
import org.onap.portalsdk.core.web.support.AppUtils;
import org.springframework.beans.factory.annotation.Autowired;
public class EPUserUtils {
public static final String ALL_ROLE_FUNCTIONS = "allRoleFunctions";
private static final String decodeValueOfForwardSlash = "2f";
private static final String decodeValueOfHyphen = "2d";
private static final String decodeValueOfAsterisk = "2a";
private static final Long ACCOUNT_ADMIN_ROLE_ID = 999L;
private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(EPUserUtils.class);
private static DataAccessService dataAccessService;
/**
* Gets the EPUser object from the session.
*
* @param request
* HttpServletRequest
* @return EPUser object that was created upon login
* @throws SessionExpiredException
* if no session exists.
*/
public static EPUser getUserSession(HttpServletRequest request) {
HttpSession session = AppUtils.getSession(request);
if (session == null)
throw new SessionExpiredException();
return (EPUser) session.getAttribute(SystemProperties.getProperty(SystemProperties.USER_ATTRIBUTE_NAME));
}
/**
* Establishes the user's portal session
*
* @param request
* HttpServletRequest
* @param user
* EPUser
* @param applicationMenuData
* Menu data
* @param businessDirectMenuData
* Menu data
* @param ePRoleFunctionService
* role function service
* @throws DecoderException
*/
@SuppressWarnings("rawtypes")
public static void setUserSession(HttpServletRequest request, EPUser user, Set applicationMenuData,
Set businessDirectMenuData, EPRoleFunctionService ePRoleFunctionService) throws RoleFunctionException {
HttpSession session = request.getSession(true);
// clear the current user session to avoid any conflicts
EPUserUtils.clearUserSession(request);
session.setAttribute(SystemProperties.getProperty(SystemProperties.USER_ATTRIBUTE_NAME), user);
setAllRoleFunctions(ePRoleFunctionService.getRoleFunctions(), session);
ePRoleFunctionService.getRoleFunctions(request, user);
// truncate the role (and therefore the role function) data to save
// memory in the session
user.setEPRoles(null);
session.setAttribute(SystemProperties.getProperty(SystemProperties.USER_NAME), user.getFullName());
ServletContext context = session.getServletContext();
try {
context.getAttribute("licenseVerification");
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "setUserSession failed to get licenseVerification attribute",
e);
}
session.setAttribute(SystemProperties.getProperty(SystemProperties.APP_DISPLAY_NAME), "My Portal");
session.setAttribute(SystemProperties.getProperty(SystemProperties.APPLICATION_MENU_ATTRIBUTE_NAME),
MenuBuilder.filterMenu(applicationMenuData, request));
session.setAttribute(SystemProperties.getProperty(SystemProperties.BUSINESS_DIRECT_MENU_ATTRIBUTE_NAME),
MenuBuilder.filterMenu(businessDirectMenuData, request));
}
/**
* Creates a set of role function names and stores the set as a session
* attribute.
*
* @param allRoleFunctions
* List of role functions.
* @param session
* HttpSession
* @throws DecoderException
*/
private static void setAllRoleFunctions(List<RoleFunction> allRoleFunctions, HttpSession session) throws RoleFunctionException {
if (allRoleFunctions == null)
return;
Set<String> roleFnSet = new HashSet<>();
for (RoleFunction roleFn : allRoleFunctions){
roleFnSet.add(decodeFunctionCode(roleFn.getCode()));
}
session.setAttribute(ALL_ROLE_FUNCTIONS, roleFnSet);
}
public static String decodeFunctionCode(String str) throws RoleFunctionException{
String decodedString = str;
List<Pattern> decodingList = new ArrayList<>();
decodingList.add(Pattern.compile(decodeValueOfForwardSlash));
decodingList.add(Pattern.compile(decodeValueOfHyphen));
decodingList.add(Pattern.compile(decodeValueOfAsterisk));
for (Pattern xssInputPattern : decodingList) {
try {
decodedString = decodedString.replaceAll("%" + xssInputPattern,
new String(Hex.decodeHex(xssInputPattern.toString().toCharArray())));
} catch (DecoderException e) {
logger.error(EELFLoggerDelegate.errorLogger, "Failed to decode the Rolefunction: "+ str,
e);
throw new RoleFunctionException("decode failed", e);
}
}
return decodedString;
}
/**
* Removes all stored attributes from the user's session
*
* @param request
* HttpServletRequest
* @throws SessionExpiredException
* if no session exists
*/
private static void clearUserSession(HttpServletRequest request) {
HttpSession session = AppUtils.getSession(request);
if (session == null)
throw new SessionExpiredException();
// removes all stored attributes from the current user's session
session.removeAttribute(SystemProperties.getProperty(SystemProperties.USER_ATTRIBUTE_NAME));
session.removeAttribute(SystemProperties.getProperty(SystemProperties.APPLICATION_MENU_ATTRIBUTE_NAME));
session.removeAttribute(SystemProperties.getProperty(SystemProperties.BUSINESS_DIRECT_MENU_ATTRIBUTE_NAME));
session.removeAttribute(SystemProperties.getProperty(SystemProperties.ROLES_ATTRIBUTE_NAME));
session.removeAttribute(SystemProperties.getProperty(SystemProperties.ROLE_FUNCTIONS_ATTRIBUTE_NAME));
}
/**
* Gets role information from the user session, in the cached user object. As a
* side effect sets a session variable with the roles.
*
* @param request
* HttpServletRequest
* @return Map of role ID to role object
*/
@SuppressWarnings("rawtypes")
public static Map getRoles(HttpServletRequest request) {
HashMap roles;
HttpSession session = AppUtils.getSession(request);
roles = (HashMap) session.getAttribute(SystemProperties.getProperty(SystemProperties.ROLES_ATTRIBUTE_NAME));
// if roles are not already cached, let's grab them from the user
// session
if (roles == null) {
EPUser user = getUserSession(request);
// get all user roles (including the tree of child roles)
roles = getAllUserRoles(user);
session.setAttribute(SystemProperties.getProperty(SystemProperties.ROLES_ATTRIBUTE_NAME), roles);
}
return roles;
}
/**
* Builds a map of role ID to role object.
*
* @param user
* EPUser
* @return Map of role ID to role object
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
private static HashMap getAllUserRoles(EPUser user) {
HashMap roles = new HashMap();
for (EPRole role : user.getEPRoles()) {
if (role.getActive()) {
roles.put(role.getId(), role);
// let's take a recursive trip down the tree to add all child
// roles
addChildRoles(role, roles);
}
}
// Additionally; the account admin role is overloaded between onap
// portal and partners; lets also include that
for (EPUserApp epUserApp : user.getEPUserApps()) {
EPRole role = epUserApp.getRole();
if (role.getActive() && role.getId().equals(ACCOUNT_ADMIN_ROLE_ID)) {
roles.put(role.getId(), role);
// let's take a recursive trip down the tree to add all child
// roles
addChildRoles(role, roles);
}
}
return roles;
}
/**
* Adds all child roles of the specified role to the map of roles.
*
* @param role
* EPRole
* @param roles
* Maps role id to role object
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
private static void addChildRoles(EPRole role, HashMap roles) {
Set childRoles = role.getChildRoles();
if (childRoles != null && !childRoles.isEmpty()) {
for (Object o : childRoles) {
EPRole childRole = (EPRole) o;
if (childRole.getActive()) {
roles.put(childRole.getId(), childRole);
addChildRoles(childRole, roles);
}
}
}
}
public static boolean hasRole(EPUser user, String roleKey) {
return getAllUserRoles(user).keySet().contains(new Long(roleKey));
}
public static DataAccessService getDataAccessService() {
return dataAccessService;
}
@Autowired
public static void setDataAccessService(DataAccessService dataAccessService) {
EPUserUtils.dataAccessService = dataAccessService;
}
/**
* Gets the user's ID from the user object in the session
*
* @param request
* HttpServletRequest
* @return Integer ID of current user
*/
public static int getUserId(HttpServletRequest request) {
return getUserIdAsLong(request).intValue();
}
/**
* Gets the user's ID from the user object in the session
*
* @param request
* HttpServletREquest
* @return Long ID of current user
*/
static Long getUserIdAsLong(HttpServletRequest request) {
Long userId = new Long(SystemProperties.getProperty(SystemProperties.APPLICATION_USER_ID));
if (request != null && getUserSession(request) != null) {
userId = getUserSession(request).getId();
}
return userId;
}
/**
* Gets the request ID from the request.
*
* @param request
* HttpServletRequest
* @return Request ID
*/
public static String getRequestId(HttpServletRequest request) {
Enumeration<String> headerNames = request.getHeaderNames();
String requestId = "";
try {
while (headerNames.hasMoreElements()) {
String headerName = headerNames.nextElement();
logger.debug(EELFLoggerDelegate.debugLogger,
"One header is " + headerName + " : " + request.getHeader(headerName));
if (headerName.equalsIgnoreCase(SystemProperties.ECOMP_REQUEST_ID)) {
requestId = request.getHeader(headerName);
break;
}
}
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "getRequestId failed", e);
}
return (requestId.isEmpty() ? UUID.randomUUID().toString() : requestId);
}
/**
* Gets the full URL from the request.
*
* @param request
* HttpServletRequest
* @return Full URL
*/
static String getFullURL(HttpServletRequest request) {
if (request != null) {
StringBuffer requestURL = request.getRequestURL();
String queryString = request.getQueryString();
if (queryString == null) {
return requestURL.toString();
} else {
return requestURL.append('?').append(queryString).toString();
}
}
return "";
}
public static Boolean matchRoleFunctions(String portalApiPath, Set<? extends String> roleFunctions) {
String[] path = portalApiPath.split("/");
List<String> roleFunList;
if (path.length > 1) {
roleFunList = roleFunctions.stream().filter(item -> item.startsWith(path[0])).collect(Collectors.toList());
if (roleFunList.size() >= 1) {
for (String roleFunction : roleFunList) {
String[] roleFunctionArray = roleFunction.split("/");
boolean b = true;
if (roleFunctionArray.length == path.length) {
for (int i = 0; i < roleFunctionArray.length; i++) {
if (!roleFunctionArray[i].equals("*")) {
Pattern p = Pattern.compile(Pattern.quote(path[i]), Pattern.CASE_INSENSITIVE);
Matcher m = p.matcher(roleFunctionArray[i]);
b = m.matches();
}
}
if (b) return true;
}
}
}
} else {
for (String roleFunction : roleFunctions) {
if (roleFunction.equals(("*"))) {
return true;
} else if (portalApiPath.matches(roleFunction)) {
return true;
}
}
}
return false;
}
}
|