1 files changed, 70 insertions, 29 deletions

diff --git a/ecomp-sdk/epsdk-app-os/src/main/java/org/openecomp/portalapp/login/LoginStrategyImpl.java b/ecomp-sdk/epsdk-app-os/src/main/java/org/openecomp/portalapp/login/LoginStrategyImpl.java
index 9f742ce9..270e69ff 100644
--- a/ecomp-sdk/epsdk-app-os/src/main/java/org/openecomp/portalapp/login/LoginStrategyImpl.java
+++ b/ecomp-sdk/epsdk-app-os/src/main/java/org/openecomp/portalapp/login/LoginStrategyImpl.java
@@ -1,3 +1,23 @@
+/*-
+ * ================================================================================
+ * ECOMP Portal SDK
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property
+ * ================================================================================
+ * 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.
+ * ================================================================================
+ */
+
 package org.openecomp.portalapp.login;
 
 import javax.servlet.http.Cookie;
@@ -5,66 +25,87 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.openecomp.portalsdk.core.auth.LoginStrategy;
+import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;
 import org.openecomp.portalsdk.core.onboarding.exception.PortalAPIException;
 import org.openecomp.portalsdk.core.onboarding.util.CipherUtil;
-import org.openecomp.portalsdk.core.onboarding.util.PortalApiConstants;
-import org.openecomp.portalsdk.core.onboarding.util.PortalApiProperties;
+import org.openecomp.portalsdk.core.util.SystemProperties;
 import org.springframework.web.servlet.ModelAndView;
 
+/**
+ * Implements basic single-signon login strategy for open-source applications
+ * when users start at Portal. Extracts an encrypted user ID sent by Portal.
+ */
 public class LoginStrategyImpl extends LoginStrategy {
-	
+
+	private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(LoginStrategyImpl.class);
+
+	/**
+	 * login for open source is same as external login in the non-open-source
+	 * version.
+	 */
 	@Override
 	public ModelAndView doLogin(HttpServletRequest request, HttpServletResponse response) throws Exception {
-		//'login' for opensource is same as 'external' login.
 		return doExternalLogin(request, response);
 	}
-	
+
 	@Override
 	public String getUserId(HttpServletRequest request) throws PortalAPIException {
 		// Check ECOMP Portal cookie
-		if (!isLoginCookieExist(request))
+		Cookie ep = getCookie(request, EP_SERVICE);
+		if (ep == null) {
+			logger.debug(EELFLoggerDelegate.debugLogger, "getUserId: no EP_SERVICE cookie, returning null");
 			return null;
+		}
 
 		String userid = null;
 		try {
 			userid = getUserIdFromCookie(request);
 		} catch (Exception e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
+			logger.error(EELFLoggerDelegate.errorLogger, "getUserId failed", e);
 		}
-		return userid;	
+		return userid;
 	}
 
-	private static String getUserIdFromCookie(HttpServletRequest request) throws Exception {
+	/**
+	 * Searches the request for the user-ID cookie and decrypts the value using a
+	 * key configured in properties
+	 * 
+	 * @param request
+	 *            HttpServletRequest
+	 * @return User ID
+	 * @throws Exception
+	 *             On any failure
+	 */
+	private String getUserIdFromCookie(HttpServletRequest request) throws Exception {
 		String userId = "";
-		Cookie[] cookies = request.getCookies();
-		Cookie userIdcookie = null;
-		if (cookies != null)
-			for (Cookie cookie : cookies)
-				if (cookie.getName().equals(USER_ID))
-					userIdcookie = cookie;
-		if(userIdcookie!=null){
-			userId = CipherUtil.decrypt(userIdcookie.getValue(),
-					PortalApiProperties.getProperty(PortalApiConstants.Decryption_Key));
+		Cookie userIdCookie = getCookie(request, USER_ID);
+		if (userIdCookie != null) {
+			final String cookieValue = userIdCookie.getValue();
+			if (!SystemProperties.containsProperty(SystemProperties.Decryption_Key))
+				throw new Exception("Failed to find property " + SystemProperties.Decryption_Key);
+			final String decryptionKey = SystemProperties.getProperty(SystemProperties.Decryption_Key);
+			userId = CipherUtil.decrypt(cookieValue, decryptionKey);
+			logger.debug(EELFLoggerDelegate.debugLogger, "getUserIdFromCookie: decrypted as {}", userId);
 		}
 		return userId;
-	
-	}
-	
-	private static boolean isLoginCookieExist(HttpServletRequest request) {
-		Cookie ep = getCookie(request, EP_SERVICE);
-		return (ep != null);
 	}
-	
-	private static Cookie getCookie(HttpServletRequest request, String cookieName) {
+
+	/**
+	 * Searches the request for the named cookie.
+	 * 
+	 * @param request
+	 *            HttpServletRequest
+	 * @param cookieName
+	 *            Name of desired cookie
+	 * @return Cookie if found; otherwise null.
+	 */
+	private Cookie getCookie(HttpServletRequest request, String cookieName) {
 		Cookie[] cookies = request.getCookies();
 		if (cookies != null)
 			for (Cookie cookie : cookies)
 				if (cookie.getName().equals(cookieName))
 					return cookie;
-
 		return null;
 	}
 
-	
 }