2 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
7 * Modification Copyright (C) 2018 IBM.
8 * ===================================================================
10 * Unless otherwise specified, all software contained herein is licensed
11 * under the Apache License, Version 2.0 (the "License");
12 * you may not use this software except in compliance with the License.
13 * You may obtain a copy of the License at
15 * http://www.apache.org/licenses/LICENSE-2.0
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS,
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
23 * Unless otherwise specified, all documentation contained herein is licensed
24 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
25 * you may not use this documentation except in compliance with the License.
26 * You may obtain a copy of the License at
28 * https://creativecommons.org/licenses/by/4.0/
30 * Unless required by applicable law or agreed to in writing, documentation
31 * distributed under the License is distributed on an "AS IS" BASIS,
32 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33 * See the License for the specific language governing permissions and
34 * limitations under the License.
36 * ============LICENSE_END============================================
40 package org.onap.portalapp.portal.interceptor;
42 import java.util.ArrayList;
43 import java.util.List;
45 import java.util.regex.Matcher;
46 import java.util.regex.Pattern;
47 import java.util.stream.Collectors;
49 import javax.servlet.http.HttpServletRequest;
50 import javax.servlet.http.HttpServletResponse;
52 import org.mockito.internal.stubbing.answers.ThrowsException;
53 import org.onap.aaf.cadi.CadiWrap;
54 import org.onap.portalapp.controller.sessionmgt.SessionCommunicationController;
55 import org.onap.portalapp.portal.controller.BasicAuthenticationController;
56 import org.onap.portalapp.portal.controller.ExternalAppsRestfulController;
57 import org.onap.portalapp.portal.controller.SharedContextRestController;
58 import org.onap.portalapp.portal.controller.WebAnalyticsExtAppController;
59 import org.onap.portalapp.portal.domain.BasicAuthCredentials;
60 import org.onap.portalapp.portal.domain.EPApp;
61 import org.onap.portalapp.portal.domain.EPEndpoint;
62 import org.onap.portalapp.portal.domain.EPUser;
63 import org.onap.portalapp.portal.logging.aop.EPEELFLoggerAdvice;
64 import org.onap.portalapp.portal.logging.format.EPAppMessagesEnum;
65 import org.onap.portalapp.portal.logging.logic.EPLogUtil;
66 import org.onap.portalapp.portal.service.AdminRolesService;
67 import org.onap.portalapp.portal.service.AppsCacheService;
68 import org.onap.portalapp.portal.service.BasicAuthenticationCredentialService;
69 import org.onap.portalapp.portal.service.ExternalAccessRolesService;
70 import org.onap.portalapp.portal.utils.EPCommonSystemProperties;
71 import org.onap.portalapp.portal.utils.EcompPortalUtils;
72 import org.onap.portalapp.service.RemoteWebServiceCallService;
73 import org.onap.portalapp.service.sessionmgt.ManageService;
74 import org.onap.portalapp.util.EPUserUtils;
75 import org.onap.portalsdk.core.controller.FusionBaseController;
76 import org.onap.portalsdk.core.exception.UrlAccessRestrictedException;
77 import org.onap.portalsdk.core.interceptor.ResourceInterceptor;
78 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
79 import org.onap.portalsdk.core.onboarding.listener.PortalTimeoutHandler;
80 import org.onap.portalsdk.core.onboarding.util.AuthUtil;
81 import org.onap.portalsdk.core.onboarding.util.CipherUtil;
82 import org.onap.portalsdk.core.onboarding.util.PortalApiConstants;
83 import org.onap.portalsdk.core.onboarding.util.PortalApiProperties;
84 import org.onap.portalsdk.core.util.SystemProperties;
85 import org.onap.portalsdk.core.util.SystemProperties.SecurityEventTypeEnum;
86 import org.springframework.beans.factory.annotation.Autowired;
87 import org.springframework.web.method.HandlerMethod;
89 public class PortalResourceInterceptor extends ResourceInterceptor {
91 private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(PortalResourceInterceptor.class);
94 private RemoteWebServiceCallService remoteWebServiceCallService;
97 private ManageService manageService;
100 AppsCacheService appCacheService;
103 private EPEELFLoggerAdvice epAdvice;
106 private AdminRolesService adminRolesService;
109 private BasicAuthenticationCredentialService basicAuthService;
111 @SuppressWarnings("unchecked")
113 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
116 if (handler instanceof HandlerMethod) {
117 HandlerMethod method = (HandlerMethod) handler;
120 * These classes provide REST endpoints used by other application
121 * servers, NOT by an end user's browser.
123 if (method.getBean() instanceof FusionBaseController) {
124 FusionBaseController controller = (FusionBaseController) method.getBean();
125 if (!controller.isAccessible()) {
127 // authorize portalApi requests by user role
128 String requestURI = request.getRequestURI();
129 if (requestURI != null) {
130 String[] uriArray = requestURI.split("/portalApi/");
131 if (uriArray.length > 1) {
132 String portalApiPath = uriArray[1];
134 Set<? extends String> roleFunctions = (Set<? extends String>) request.getSession()
135 .getAttribute(SystemProperties
136 .getProperty(SystemProperties.ROLE_FUNCTIONS_ATTRIBUTE_NAME));
137 Set<? extends String> allRoleFunctions = (Set<? extends String>) request.getSession()
138 .getAttribute(EPUserUtils.ALL_ROLE_FUNCTIONS);
139 // Defend against code error to avoid throwing NPE
140 if (roleFunctions == null || allRoleFunctions == null) {
141 logger.error(EELFLoggerDelegate.errorLogger,
142 "preHandle: failed to get role functions attribute(s) from session!!");
143 EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeInitializationError);
146 // check to see if roleFunctions of the user is in
148 // list of all role functions
149 // if not, ignore to prevent restricting every
151 // call; otherwise, if it is, then check for the
153 EPUser user = (EPUser) request.getSession().getAttribute(
154 SystemProperties.getProperty(SystemProperties.USER_ATTRIBUTE_NAME));
155 //RoleAdmin check is being added because the role belongs to partner application
156 //inorder to access portal api's, bypassing this with isRoleAdmin Check
157 if ((EPUserUtils.matchRoleFunctions(portalApiPath, allRoleFunctions)
158 && !EPUserUtils.matchRoleFunctions(portalApiPath, roleFunctions)) && !adminRolesService.isRoleAdmin(user)) {
159 logger.error(EELFLoggerDelegate.errorLogger,
160 "preHandle: User {} not authorized for path {} ", user.getOrgUserId(),
162 EcompPortalUtils.setBadPermissions(user, response, portalApiPath);
163 EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeRestApiAuthenticationError);
172 else if (method.getBean() instanceof BasicAuthenticationController) {
173 return checkBasicAuth(request, response);
175 Object controllerObj = method.getBean();
176 if (controllerObj instanceof SessionCommunicationController
177 || controllerObj instanceof SharedContextRestController
178 || controllerObj instanceof ExternalAppsRestfulController) {
179 // check user authentication for RESTful calls
180 String secretKey = null;
182 epAdvice.loadServletRequestBasedDefaults(request, SecurityEventTypeEnum.INCOMING_REST_MESSAGE);
183 if (!remoteWebServiceCallService.verifyRESTCredential(secretKey, request.getHeader(EPCommonSystemProperties.UEB_KEY),
184 request.getHeader("username"), request.getHeader("password"))) {
185 throw new UrlAccessRestrictedException();
187 } catch (Exception e) {
188 logger.error(EELFLoggerDelegate.errorLogger, "preHandle: failed to authenticate RESTful service",
190 EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeRestApiAuthenticationError, e);
191 throw new UrlAccessRestrictedException();
195 if (controllerObj instanceof WebAnalyticsExtAppController) {
196 if (!remoteWebServiceCallService.verifyAppKeyCredential(request.getHeader(EPCommonSystemProperties.UEB_KEY))) {
197 logger.error(EELFLoggerDelegate.errorLogger,
198 "preHandle: failed to verify app key for web analytics call");
199 throw new UrlAccessRestrictedException();
204 handleSessionUpdates(request);
209 * Sets the status code and sends a response. Factors code out of many
213 * HttpServletResponse
215 * HTTP status code like 404
217 * Message to send in a JSON error object
219 private void sendErrorResponse(HttpServletResponse response, final int statusCode, final String message)
221 response.setStatus(statusCode);
222 response.setContentType("application/json");
223 response.getWriter().write("{\"error\":\"" + message + "\"}");
224 response.getWriter().flush();
228 * Gets HTTP basic authentication information from the request and checks
229 * whether those credentials are authorized for the request path.
234 * HttpServletResponse
235 * @return True if the request is authorized, else false
238 private boolean checkBasicAuth(HttpServletRequest request, HttpServletResponse response) throws Exception {
239 String uri = request.getRequestURI().toString();
240 uri = uri.substring(uri.indexOf("/", 1));
242 final String authHeader = request.getHeader(EPCommonSystemProperties.AUTHORIZATION);
243 final String uebkey = request.getHeader(EPCommonSystemProperties.UEB_KEY);
245 CadiWrap wrapReq = (CadiWrap) request;
246 logger.debug(EELFLoggerDelegate.debugLogger, "Entering in the loop as the uri contains auxapi : {}");
247 String nameSpace=PortalApiProperties.getProperty(PortalApiConstants.AUTH_NAMESPACE);
248 logger.debug(EELFLoggerDelegate.debugLogger, "namespace form the portal properties : {}",nameSpace);
249 Boolean accessallowed=AuthUtil.isAccessAllowed(request, nameSpace);
250 logger.debug(EELFLoggerDelegate.debugLogger, "AccessAllowed for the request and namespace : {}",accessallowed);
252 logger.debug(EELFLoggerDelegate.debugLogger, "AccessAllowed is allowed: {}",accessallowed);
254 //String[] accountNamePassword = EcompPortalUtils.getUserNamePassword(authHeader);
255 //check ueb condition
256 if(uebkey !=null && !uebkey.isEmpty())
258 EPApp application = appCacheService.getAppFromUeb(uebkey,1);
259 if (application == null) {
260 throw new Exception("Invalid credentials!");
263 final String appUsername = application.getUsername();
264 logger.debug(EELFLoggerDelegate.debugLogger, "appUsername : {}",appUsername);
266 String[] accountNamePassword = EcompPortalUtils.getUserNamePassword(authHeader);
267 logger.debug(EELFLoggerDelegate.debugLogger, "accountNamePassword : {}",accountNamePassword);
269 if (accountNamePassword == null || accountNamePassword.length != 2) {
270 final String msg = "failed to get username and password from Atuhorization header";
271 logger.debug(EELFLoggerDelegate.debugLogger, "checkBasicAuth Username and password failed to get: {}", msg);
272 sendErrorResponse(response, HttpServletResponse.SC_UNAUTHORIZED, msg);
275 if (appUsername.equals(accountNamePassword[0])) {
278 final String msg = "failed to match the UserName from the application ";
279 logger.debug(EELFLoggerDelegate.debugLogger, "failed to match the UserName from the application checkBasicAuth Username and password failed to get: {}", msg);
280 sendErrorResponse(response, HttpServletResponse.SC_UNAUTHORIZED, msg);
289 final String msg = "no authorization found";
290 logger.debug(EELFLoggerDelegate.debugLogger, "checkBasicAuth when no accessallowed: {}", msg);
291 sendErrorResponse(response, HttpServletResponse.SC_UNAUTHORIZED, msg);
296 }catch(ClassCastException e){
297 logger.debug(EELFLoggerDelegate.debugLogger, "Entering in the classcastexception block if the UN is not the mechid : {}");
299 String secretKey = null;
300 // Unauthorized access due to missing HTTP Authorization request header
301 if (authHeader == null) {
302 if (remoteWebServiceCallService.verifyRESTCredential(secretKey, request.getHeader(EPCommonSystemProperties.UEB_KEY),
303 request.getHeader("username"), request.getHeader("password"))) {
306 final String msg = "no authorization found";
307 logger.debug(EELFLoggerDelegate.debugLogger, "checkBasicAuth: {}", msg);
308 sendErrorResponse(response, HttpServletResponse.SC_UNAUTHORIZED, msg);
312 String[] accountNamePassword = EcompPortalUtils.getUserNamePassword(authHeader);
313 if (accountNamePassword == null || accountNamePassword.length != 2) {
314 final String msg = "failed to get username and password from Atuhorization header";
315 logger.debug(EELFLoggerDelegate.debugLogger, "checkBasicAuth: {}", msg);
316 sendErrorResponse(response, HttpServletResponse.SC_UNAUTHORIZED, msg);
320 if(uebkey !=null && !uebkey.isEmpty())
322 EPApp application = appCacheService.getAppFromUeb(uebkey,1);
323 if (application == null) {
324 throw new Exception("Invalid credentials!");
327 final String appUsername = application.getUsername();
328 final String dbDecryptedPwd = CipherUtil.decryptPKC(application.getAppPassword());
329 if (appUsername.equals(accountNamePassword[0]) && dbDecryptedPwd.equals(accountNamePassword[1])) {
336 BasicAuthCredentials creds;
338 creds = basicAuthService.getBasicAuthCredentialByUsernameAndPassword(accountNamePassword[0],
339 accountNamePassword[1]);
340 } catch (Exception e1) {
341 logger.error(EELFLoggerDelegate.errorLogger, "checkBasicAuth failed to get credentials", e1);
342 final String msg = "Failed while getting basic authentication credential: ";
343 sendErrorResponse(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, msg);
347 // Unauthorized access due to invalid credentials (username and
349 if (creds == null || !creds.getUsername().equals(accountNamePassword[0])) {
350 final String msg = "Unauthorized: Access denied";
351 logger.debug(EELFLoggerDelegate.debugLogger, "checkBasicAuth: {}", msg);
352 sendErrorResponse(response, HttpServletResponse.SC_UNAUTHORIZED, msg);
356 // Unauthorized access due to inactive account
357 if (creds.getIsActive().equals("N")) {
358 final String msg = "Unauthorized: The account is inactive";
359 logger.debug(EELFLoggerDelegate.debugLogger, "checkBasicAuth: {}", msg);
360 sendErrorResponse(response, HttpServletResponse.SC_UNAUTHORIZED, msg);
364 }catch (Exception e2) {
365 logger.error(EELFLoggerDelegate.errorLogger, "checkBasicAuth failed to get credentials for some other exception", e2);
366 final String msg = "Failed while getting basic authentication credential for some other exception: ";
367 sendErrorResponse(response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, msg);
375 @SuppressWarnings("unused")
376 private String decrypted(String encrypted) throws Exception {
378 if (encrypted != null && encrypted.length() > 0) {
380 result = CipherUtil.decryptPKC(encrypted, SystemProperties.getProperty(SystemProperties.Decryption_Key));
381 } catch (Exception e) {
382 logger.error(EELFLoggerDelegate.errorLogger, "decryptedPassword failed", e);
389 private String encrypted(String decryptedPwd) throws Exception {
391 if (decryptedPwd != null && decryptedPwd.length() > 0) {
393 result = CipherUtil.encryptPKC(decryptedPwd,
394 SystemProperties.getProperty(SystemProperties.Decryption_Key));
395 } catch (Exception e) {
396 logger.error(EELFLoggerDelegate.errorLogger, "encryptedPassword() failed", e);
403 protected void handleSessionUpdates(HttpServletRequest request) {
404 PortalTimeoutHandler.handleSessionUpdatesNative(request, null, null, null, null, manageService);