SecurityManagerUtil.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.security.lang;

import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.util.ServiceLoader;
import com.liferay.portal.module.framework.ModuleFrameworkAdapterHelper;
import com.liferay.portal.util.PropsValues;

import java.util.List;

/**
 * @author Brian Wing Shun Chan
 * @author Raymond Augé
 * @author Zsolt Berentey
 */
public class SecurityManagerUtil {

	public static final boolean ENABLED = System.getSecurityManager() != null;

	public static void destroy() {
		if (_portalSecurityManager == null) {
			return;
		}

		_portalSecurityManager.destroy();

		_portalSecurityManager = null;
	}

	public static PortalSecurityManager getPortalSecurityManager() {
		return _portalSecurityManager;
	}

	public static void init() {
		if (_portalSecurityManagerStrategy != null) {
			return;
		}

		_portalSecurityManagerStrategy = PortalSecurityManagerStrategy.parse(
			PropsValues.PORTAL_SECURITY_MANAGER_STRATEGY);

		if (_portalSecurityManagerStrategy ==
				PortalSecurityManagerStrategy.LIFERAY) {

			if (!ENABLED) {
				_log.error(
					"Plugin security management is not enabled. Enable a " +
						"security manager, then restart.");

				_portalSecurityManagerStrategy =
					PortalSecurityManagerStrategy.DEFAULT;

				return;
			}

			_loadPortalSecurityManager();

			if (_portalSecurityManager == null) {
				_portalSecurityManagerStrategy =
					PortalSecurityManagerStrategy.DEFAULT;

				if (_log.isInfoEnabled()) {
					_log.info(
						"No portal security manager implementation was " +
							"located. Continuing with the default security " +
								"strategy.");
				}

				return;
			}
		}

		if (_portalSecurityManagerStrategy ==
				PortalSecurityManagerStrategy.LIFERAY) {

			System.setSecurityManager((SecurityManager)_portalSecurityManager);
		}
	}

	public static boolean isDefault() {
		init();

		if (_portalSecurityManagerStrategy ==
				PortalSecurityManagerStrategy.DEFAULT) {

			return true;
		}

		return false;
	}

	public static boolean isLiferay() {
		init();

		if (_portalSecurityManagerStrategy ==
				PortalSecurityManagerStrategy.LIFERAY) {

			return true;
		}

		return false;
	}

	private static void _loadPortalSecurityManager() {
		try {
			List<PortalSecurityManager> portalSecurityManagers =
				ServiceLoader.load(
					ModuleFrameworkAdapterHelper.getClassLoader(),
					PortalSecurityManager.class);

			if (portalSecurityManagers.isEmpty()) {
				return;
			}

			_portalSecurityManager = portalSecurityManagers.get(0);
		}
		catch (Exception e) {
			_log.error(e, e);
		}
	}

	private static final Log _log = LogFactoryUtil.getLog(
		SecurityManagerUtil.class);

	private static PortalSecurityManager _portalSecurityManager;
	private static PortalSecurityManagerStrategy _portalSecurityManagerStrategy;

	private enum PortalSecurityManagerStrategy {

		DEFAULT, LIFERAY;

		public static PortalSecurityManagerStrategy parse(String value) {
			if (value.equals("liferay")) {
				return LIFERAY;
			}

			return DEFAULT;
		}

	}

}