16e01c06a53f65ffb42fe2fb788a831017c29704
[aai/sparky-be.git] / src / main / java / org / onap / aai / sparky / security / EcompSso.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6  * Copyright © 2017 Amdocs
7  * ================================================================================
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  *       http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  * ============LICENSE_END=========================================================
20  *
21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22  */
23 package org.onap.aai.sparky.security;
24
25 import javax.servlet.http.Cookie;
26 import javax.servlet.http.HttpServletRequest;
27
28 import org.onap.aai.sparky.logging.AaiUiMsgs;
29 import org.onap.aai.sparky.security.portal.config.PortalAuthenticationConfig;
30 import org.onap.aai.cl.api.Logger;
31 import org.onap.aai.cl.eelf.LoggerFactory;
32 import org.openecomp.portalsdk.core.onboarding.util.PortalApiProperties;
33 import org.openecomp.portalsdk.core.onboarding.util.CipherUtil;
34
35
36 /**
37  * Provides authentication services for onboarded ECOMP applications.
38  */
39 public class EcompSso {
40
41   public static final String EP_SERVICE = "EPService";
42   public static final String CSP_COOKIE_NAME = "csp_cookie_name";
43   public static final String CSP_GATE_KEEPER_PROD_KEY = "csp_gate_keeper_prod_key";
44   public static final String ONAP_ENABLED = "ONAP_ENABLED";
45   private static final Logger LOG = LoggerFactory.getInstance().getLogger(EcompSso.class);
46
47   /**
48    * Searches the request for a cookie with the specified name.
49    *
50    * @param request
51    * @param cookieName
52    * @return Cookie, or null if not found.
53    */
54   public static Cookie getCookie(HttpServletRequest request, String cookieName) {
55     Cookie[] cookies = request.getCookies();
56     if (cookies != null)
57       for (Cookie cookie : cookies) {
58         if (cookie.getName().equals(cookieName)) {
59           return cookie;
60         }
61       }
62
63     return null;
64   }
65
66   /**
67    * Answers whether the ECOMP Portal service cookie is present in the specified request.
68    *
69    * @param request
70    * @return true if the cookie is found, else false.
71    */
72   private static boolean isEPServiceCookiePresent(HttpServletRequest request) {
73     Cookie ep = getCookie(request, EP_SERVICE);
74     return (ep != null);
75   }
76
77   /**
78    * Validates whether the ECOMP Portal sign-on process has completed, which relies the AT&T Global
79    * Log On single-sign on process. Checks for the ECOMP cookie (see {@link #EP_SERVICE}). If found,
80    * then searches for a CSP cookie; if not found, for a WebJunction header.
81    *
82    * @param request
83    * @return User ID if the ECOMP cookie is present and the sign-on process established an User ID;
84    *         else null.
85    */
86   public static String validateEcompSso(HttpServletRequest request) {
87     boolean isOnapEnabled = PortalAuthenticationConfig.getInstance().getIsOnapEnabled();
88     if (isOnapEnabled) {
89       if (isEPServiceCookiePresent(request)) {
90         /*
91          * This is a "temporary" fix until proper separation between closed source and open source
92          * code is reached
93          */
94         return ONAP_ENABLED;
95       }
96       return null;
97     } else {
98       return getLoginIdFromCookie(request);
99     }
100   }
101
102   /**
103    * Searches the specified request for the CSP cookie, decodes it and gets the User ID.
104    *
105    * @param request
106    * @return User ID if the cookie is present in the request and can be decoded successfully
107    *         (expired cookies do not decode); else null.
108    */
109   private static String getLoginIdFromCookie(HttpServletRequest request) {
110     String userid = null;
111     try {
112       String[] cspFields = getCspData(request);
113       if (cspFields != null && cspFields.length > 5)
114         userid = cspFields[5];
115     } catch (Throwable t) {
116       LOG.info(AaiUiMsgs.LOGIN_FILTER_INFO,
117           "getLoginIdFromCookie failed " + t.getLocalizedMessage());
118     }
119     return userid;
120   }
121
122   /**
123    * Searches the specified request for the CSP cookie, decodes it and parses it to a String array.
124    *
125    * @param request
126    * @return Array of String as parsed from the cookie; null if the cookie is not present; empty
127    *         array if the cookie could not be decoded.
128    */
129   private static String[] getCspData(HttpServletRequest request) {
130     final String cookieName = PortalApiProperties.getProperty(CSP_COOKIE_NAME);
131     if (cookieName == null) {
132       LOG.debug(AaiUiMsgs.LOGIN_FILTER_DEBUG,
133           "getCspData: Failed to get property " + CSP_COOKIE_NAME);
134       return null;
135     }
136     Cookie csp = getCookie(request, cookieName);
137     if (csp == null) {
138       LOG.debug(AaiUiMsgs.LOGIN_FILTER_DEBUG, "getCspData failed to get cookie " + cookieName);
139       return null;
140     }
141     final String cspCookieEncrypted = csp.getValue();
142
143     String gateKeeperProdKey = PortalApiProperties.getProperty(CSP_GATE_KEEPER_PROD_KEY);
144     if (gateKeeperProdKey == null) {
145       LOG.debug(AaiUiMsgs.LOGIN_FILTER_DEBUG,
146           "getCspData: failed to get property " + CSP_GATE_KEEPER_PROD_KEY);
147     }
148
149     String cspCookieDecrypted = "";
150     try {
151       cspCookieDecrypted = CipherUtil.decrypt(cspCookieEncrypted, "");
152     } catch (Exception e) {
153       LOG.info(AaiUiMsgs.LOGIN_FILTER_INFO, "decrypting cookie failed " + e.getLocalizedMessage());
154     }
155
156     String[] cspData = cspCookieDecrypted.split("\\|");
157     return cspData;
158   }
159 }