com.sun.enterprise.security.provider.PolicyConfigurationFactoryImpl Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2018] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.security.provider;
import static com.sun.logging.LogDomains.SECURITY_LOGGER;
import static java.util.logging.Level.FINE;
import static java.util.logging.Level.SEVERE;
import static java.util.logging.Level.WARNING;
import java.io.File;
import java.io.IOException;
import java.security.Permission;
import java.security.Policy;
import java.security.SecurityPermission;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Logger;
import javax.security.jacc.PolicyConfiguration;
import javax.security.jacc.PolicyConfigurationFactory;
import javax.security.jacc.PolicyContextException;
import org.jvnet.hk2.annotations.ContractsProvided;
import org.jvnet.hk2.annotations.Service;
import com.sun.enterprise.util.LocalStringManagerImpl;
import fish.payara.jacc.ContextProvider;
import fish.payara.jacc.JaccConfigurationFactory;
/**
* Implementation of jacc PolicyConfigurationFactory class
*
* @author Harpreet Singh
* @author Ron Monzillo
* @version
*/
@Service
@ContractsProvided({ PolicyConfigurationFactoryImpl.class, PolicyConfigurationFactory.class })
public class PolicyConfigurationFactoryImpl extends PolicyConfigurationFactory implements JaccConfigurationFactory {
private static Logger logger = Logger.getLogger(SECURITY_LOGGER);
private static LocalStringManagerImpl localStrings = new LocalStringManagerImpl(PolicyConfigurationFactoryImpl.class);
// Set in PolicyLoader from domain.xml
private static final String REPOSITORY_HOME_PROP = "com.sun.enterprise.jaccprovider.property.repository";
private Map applicationToPolicyContextIdMap = new ConcurrentHashMap();
// Map of ContextId -> ContextProvider (per context PolicyConfigurationFactory and Policy)
private Map contextToContextProviderMap = new ConcurrentHashMap<>();
// Map of ContextId -> PolicyConfiguration
private Map contextToConfigurationMap = new ConcurrentHashMap<>();
// Used to represent configuration linkages
private /* TODO: static */ Map> linkTable = new HashMap<>();
private String repository;
private Permission setPolicyPermission;
private static PolicyConfigurationFactoryImpl singleton;
public PolicyConfigurationFactoryImpl() {
repository = initializeRepository();
singleton = this;
}
@Override
public void registerContextProvider(String applicationContextId, PolicyConfigurationFactory factory, Policy policy) {
checkSetPolicyPermission();
try {
String policyContextId = applicationToPolicyContextIdMap.get(applicationContextId);
if (policyContextId == null) {
throw new IllegalStateException(
"No policyContextId available for applicationContextId " + applicationContextId +
" Is this JaccConfigurationFactory instance used by the container?");
}
if (inService(policyContextId)) {
throw new IllegalStateException("Context :" + policyContextId + " already has an active global provider");
}
ContextProvider contextProvider = contextToContextProviderMap.get(policyContextId);
if (contextProvider != null && contextProvider.getPolicyConfigurationFactory().inService(policyContextId)) {
throw new IllegalStateException("Context :" + policyContextId + " already has an active context (per app) provider");
}
contextToContextProviderMap.put(policyContextId, new ContextProviderImpl(factory, policy));
} catch (PolicyContextException e) {
throw new IllegalStateException(e);
}
}
@Override
public void addContextIdMapping(String applicationContextId, String policyContextId) {
applicationToPolicyContextIdMap.put(applicationContextId, policyContextId);
}
@Override
public boolean removeContextIdMappingByPolicyContextId(String policyContextId) {
return applicationToPolicyContextIdMap.entrySet().removeIf(e -> e.getValue().equals(policyContextId));
}
@Override
public ContextProvider getContextProviderByPolicyContextId(String contextId) {
return contextToContextProviderMap.get(contextId);
}
@Override
public ContextProvider removeContextProviderByPolicyContextId(String policyContextId) {
return contextToContextProviderMap.remove(policyContextId);
}
/**
* This method is used to obtain an instance of the provider specific class that implements the PolicyConfiguration
* interface that corresponds to the identified policy context within the provider. The methods of the
* PolicyConfiguration interface are used to define the policy statements of the identified policy context.
*
* If at the time of the call, the identified policy context does not exist in the provider, then the policy context
* will be created in the provider and the Object that implements the context's PolicyConfiguration Interface will be
* returned. If the state of the identified context is "deleted" or "inService" it will be transitioned to the "open"
* state as a result of the call. The states in the lifecycle of a policy context are defined by the PolicyConfiguration
* interface.
*
* For a given value of policy context identifier, this method must always return the same instance of
* PolicyConfiguration and there must be at most one actual instance of a PolicyConfiguration with a given policy
* context identifier (during a process context).
*
* To preserve the invariant that there be at most one PolicyConfiguration object for a given policy context, it may be
* necessary for this method to be thread safe.
*
*
* @param contextID A String identifying the policy context whose PolicyConfiguration interface is to be returned. The
* value passed to this parameter must not be null.
*
* @param remove A boolean value that establishes whether or not the policy statements of an existing policy context are
* to be removed before its PolicyConfiguration object is returned. If the value passed to this parameter is true, the
* policy statements of an existing policy context will be removed. If the value is false, they will not be removed.
*
* @return an Object that implements the PolicyConfiguration Interface matched to the Policy provider and corresponding
* to the identified policy context.
*
* @throws java.lang.SecurityException when called by an AccessControlContext that has not been granted the "setPolicy"
* SecurityPermission.
*
* @throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been
* accounted for by the getPolicyConfiguration method signature. The exception thrown by the implementation class will
* be encapsulated (during construction) in the thrown PolicyContextException.
*/
@Override
public PolicyConfiguration getPolicyConfiguration(String contextId, boolean remove) throws PolicyContextException {
checkSetPolicyPermission();
if (logger.isLoggable(FINE)) {
logger.fine("JACC Policy Provider: Getting PolicyConfiguration object with id = " + contextId);
}
ContextProvider contextProvider = contextToContextProviderMap.get(contextId);
if (contextProvider != null) {
return contextProvider.getPolicyConfigurationFactory().getPolicyConfiguration(contextId, remove);
}
return getPolicyConfigurationImpl(contextId, true, remove);
}
/**
* This method determines if the identified policy context exists with state "inService" in the Policy provider
* associated with the factory.
*
*
* @param contextID A string identifying a policy context
*
* @return true if the identified policy context exists within the provider and its state is "inService", false
* otherwise.
*
* @throws java.lang.SecurityException when called by an AccessControlContext that has not been granted the "setPolicy"
* SecurityPermission.
*
* @throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been
* accounted for by the inService method signature. The exception thrown by the implementation class will be
* encapsulated (during construction) in the thrown PolicyContextException.
*/
@Override
public boolean inService(String contextId) throws PolicyContextException {
checkSetPolicyPermission();
ContextProvider contextProvider = contextToContextProviderMap.get(contextId);
if (contextProvider != null) {
return contextProvider.getPolicyConfigurationFactory().inService(contextId);
}
PolicyConfiguration policyConfiguration = getPolicyConfigurationImpl(contextId);
return policyConfiguration == null ? false : policyConfiguration.inService();
}
// ### Private / Protected methods
static PolicyConfigurationFactoryImpl getInstance() {
return singleton;
}
/**
* Read the repository directory name, create the directory, and save the name in 'repository'
*/
private String initializeRepository() {
try {
// TODO: remove the use of system property here
repository = System.getProperty(REPOSITORY_HOME_PROP);
if (repository == null) {
logger.log(SEVERE, localStrings.getLocalString("pc.no_repository", "no repository"));
} else {
if (logger.isLoggable(FINE)) {
logger.fine("JACC policy provider: repository set to: " + repository);
}
File repositoryDirectory = new File(repository);
if (repositoryDirectory.exists()) {
if (!repositoryDirectory.isDirectory()) {
logger.log(SEVERE,
localStrings.getLocalString(
"pc.unable_to_create_repository",
"unable to create repository" + repository, new Object[] { repository }));
} else {
// Read deployed policy contexts
File[] appsInService = repositoryDirectory.listFiles();
if (appsInService != null) {
for (int i = 0; i < appsInService.length; i++) {
File[] contextsInService = appsInService[i].listFiles(pathName -> pathName.isDirectory());
if (contextsInService != null) {
for (int j = 0; j < contextsInService.length; j++) {
try {
PolicyConfigurationImpl pc = new PolicyConfigurationImpl(contextsInService[j], false, false,
this);
contextToConfigurationMap.put(pc.CONTEXT_ID, pc);
} catch (Exception ex) {
logger.log(WARNING,
localStrings.getLocalString(
"pc.unable_to_read_repostory",
"unable to read repository", new Object[] { contextsInService[i].toString() }), ex);
}
}
}
}
}
}
} else {
if (logger.isLoggable(FINE)) {
logger.fine("JACC Policy Provider: creating new policy repository");
}
if (!repositoryDirectory.mkdirs()) {
throw new IOException();
}
}
}
} catch (Exception e) {
logger.log(SEVERE,
localStrings.getLocalString(
"pc.unable_to_init_repository",
"unable to init repository", new Object[] { e }));
repository = null;
}
return repository;
}
String getRepository() {
return repository;
}
String getContextDirectoryName(String contextId) {
if (repository == null) {
throw new RuntimeException("JACC Policy provider: repository not initialized");
}
return repository + File.separator + contextId;
}
protected PolicyConfigurationImpl getPolicyConfigurationImpl(String contextId) {
// Do not create new policy, nor open configuration or remove policy statements
return getPolicyConfigurationImpl(contextId, false, false);
}
protected PolicyConfigurationImpl getPolicyConfigurationImpl(String contextId, boolean open, boolean remove) {
PolicyConfigurationImpl policyConfiguration = contextToConfigurationMap.get(contextId);
if (policyConfiguration != null) {
if (open) {
// Return the policy configuration to the open state, value of
// remove will determine if statements are removed
policyConfiguration.initialize(true, remove, false);
}
} else {
// Check if the policy configuration was copied into the filesystem after the repository
// was initialized.
// Note that both a policy obtained from a directory and a new instance are correctly
// initialized, so we don't need to call policyConfiguration.initialize as we do above
policyConfiguration = getPolicyConfigurationImplFromDirectory(contextId, open, remove);
if (policyConfiguration == null) {
if (open) {
policyConfiguration = new PolicyConfigurationImpl(contextId, this);
contextToConfigurationMap.put(contextId, policyConfiguration);
}
}
}
return policyConfiguration;
}
/**
* This method tries to find the Policy Configuration copied into the file system (by the DAS) after the
* repository was initialized.
*
* This will only open the Policy Configuration if remove is true (otherwise the Policy Configuration will
* remain in service);
*/
private PolicyConfigurationImpl getPolicyConfigurationImplFromDirectory(String contextId, boolean open, boolean remove) {
PolicyConfigurationImpl policyConfigurationImpl = null;
File contextDirectory = new File(getContextDirectoryName(contextId));
if (contextDirectory.exists()) {
policyConfigurationImpl = new PolicyConfigurationImpl(contextDirectory, open, remove, this);
contextToConfigurationMap.put(contextId, policyConfigurationImpl);
}
return policyConfigurationImpl;
}
protected List getPolicyConfigurationImpls() {
return new ArrayList<>(contextToConfigurationMap.values());
}
protected PolicyConfigurationImpl removePolicyConfigurationImpl(String contextID) {
return contextToConfigurationMap.remove(contextID);
}
protected void checkSetPolicyPermission() {
SecurityManager securityManager = System.getSecurityManager();
if (securityManager != null) {
if (setPolicyPermission == null) {
setPolicyPermission = new SecurityPermission("setPolicy");
}
securityManager.checkPermission(setPolicyPermission);
}
}
Map> getLinkTable() {
return linkTable;
}
}