001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.security.sso;
016    
017    import com.liferay.portal.kernel.security.sso.SSO;
018    import com.liferay.portal.kernel.util.PropsKeys;
019    import com.liferay.portal.util.PrefsPropsUtil;
020    import com.liferay.portal.util.PropsValues;
021    import com.liferay.registry.Registry;
022    import com.liferay.registry.RegistryUtil;
023    import com.liferay.registry.ServiceReference;
024    import com.liferay.registry.ServiceTracker;
025    import com.liferay.registry.ServiceTrackerCustomizer;
026    
027    import java.util.Collections;
028    import java.util.Map;
029    import java.util.concurrent.ConcurrentSkipListMap;
030    
031    /**
032     * @author Raymond Aug??
033     */
034    public class SSOUtil {
035    
036            public static String getSessionExpirationRedirectURL(
037                    long companyId, String sessionExpirationRedirectURL) {
038    
039                    if (_instance._ssoMap.isEmpty()) {
040                            return sessionExpirationRedirectURL;
041                    }
042    
043                    return _instance._getSessionExpirationRedirectUrl(companyId);
044            }
045    
046            public static String getSignInURL(long companyId, String signInURL) {
047                    if (_instance._ssoMap.isEmpty()) {
048                            return null;
049                    }
050    
051                    return _instance._getSignInUrl(companyId, signInURL);
052            }
053    
054            public static boolean isLoginRedirectRequired(long companyId) {
055                    if (PrefsPropsUtil.getBoolean(
056                                    companyId, PropsKeys.LOGIN_DIALOG_DISABLED,
057                                    PropsValues.LOGIN_DIALOG_DISABLED)) {
058    
059                            return true;
060                    }
061    
062                    if (_instance._ssoMap.isEmpty()) {
063                            return false;
064                    }
065    
066                    return _instance._isLoginRedirectRequired(companyId);
067            }
068    
069            public static boolean isRedirectRequired(long companyId) {
070                    if (_instance._ssoMap.isEmpty()) {
071                            return false;
072                    }
073    
074                    return _instance._isRedirectRequired(companyId);
075            }
076    
077            public static boolean isSessionRedirectOnExpire(long companyId) {
078                    boolean sessionRedirectOnExpire =
079                            PropsValues.SESSION_TIMEOUT_REDIRECT_ON_EXPIRE;
080    
081                    if (_instance._ssoMap.isEmpty()) {
082                            return sessionRedirectOnExpire;
083                    }
084    
085                    if (PrefsPropsUtil.getBoolean(
086                                    companyId, PropsKeys.OPEN_SSO_AUTH_ENABLED,
087                                    PropsValues.OPEN_SSO_AUTH_ENABLED) &&
088                            PropsValues.OPEN_SSO_LOGOUT_ON_SESSION_EXPIRATION) {
089    
090                            return true;
091                    }
092    
093                    return _instance._isSessionRedirectOnExpire(companyId);
094            }
095    
096            private SSOUtil() {
097                    Registry registry = RegistryUtil.getRegistry();
098    
099                    _serviceTracker = registry.trackServices(
100                            SSO.class, new SSOServiceTrackerCustomizer());
101    
102                    _serviceTracker.open();
103            }
104    
105            private String _getSessionExpirationRedirectUrl(long companyId) {
106                    for (SSO sso : _ssoMap.values()) {
107                            String sessionExpirationRedirectUrl =
108                                    sso.getSessionExpirationRedirectUrl(companyId);
109    
110                            if (sessionExpirationRedirectUrl != null) {
111                                    return sessionExpirationRedirectUrl;
112                            }
113                    }
114    
115                    return null;
116            }
117    
118            private String _getSignInUrl(long companyId, String defaultSignInURL) {
119                    for (SSO sso : _ssoMap.values()) {
120                            String signInURL = sso.getSignInURL(companyId, defaultSignInURL);
121    
122                            if (signInURL != null) {
123                                    return signInURL;
124                            }
125                    }
126    
127                    return null;
128            }
129    
130            private boolean _isLoginRedirectRequired(long companyId) {
131                    for (SSO sso : _ssoMap.values()) {
132                            if (sso.isLoginRedirectRequired(companyId)) {
133                                    return true;
134                            }
135                    }
136    
137                    return false;
138            }
139    
140            private boolean _isRedirectRequired(long companyId) {
141                    for (SSO sso : _ssoMap.values()) {
142                            if (sso.isRedirectRequired(companyId)) {
143                                    return true;
144                            }
145                    }
146    
147                    return false;
148            }
149    
150            private boolean _isSessionRedirectOnExpire(long companyId) {
151                    for (SSO sso : _ssoMap.values()) {
152                            if (sso.isSessionRedirectOnExpire(companyId)) {
153                                    return true;
154                            }
155                    }
156    
157                    return false;
158            }
159    
160            private static final SSOUtil _instance = new SSOUtil();
161    
162            private final ServiceTracker<SSO, SSO> _serviceTracker;
163            private final Map<ServiceReference<SSO>, SSO> _ssoMap =
164                    new ConcurrentSkipListMap<>(Collections.reverseOrder());
165    
166            private class SSOServiceTrackerCustomizer
167                    implements ServiceTrackerCustomizer<SSO, SSO> {
168    
169                    @Override
170                    public SSO addingService(ServiceReference<SSO> serviceReference) {
171                            Registry registry = RegistryUtil.getRegistry();
172    
173                            SSO sso = registry.getService(serviceReference);
174    
175                            _ssoMap.put(serviceReference, sso);
176    
177                            return sso;
178                    }
179    
180                    @Override
181                    public void modifiedService(
182                            ServiceReference<SSO> serviceReference, SSO sso) {
183                    }
184    
185                    @Override
186                    public void removedService(
187                            ServiceReference<SSO> serviceReference, SSO sso) {
188    
189                            Registry registry = RegistryUtil.getRegistry();
190    
191                            registry.ungetService(serviceReference);
192    
193                            _ssoMap.remove(serviceReference);
194                    }
195    
196            }
197    
198    }