/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.cxf.rs.security.saml.sso.state;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import net.sf.ehcache.Cache;
import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Ehcache;
import net.sf.ehcache.Element;
import net.sf.ehcache.config.CacheConfiguration;
import net.sf.ehcache.config.Configuration;
import net.sf.ehcache.config.ConfigurationFactory;
import net.sf.ehcache.config.DiskStoreConfiguration;
import org.apache.cxf.Bus;
import org.apache.cxf.BusFactory;
import org.apache.cxf.jaxrs.utils.ResourceUtils;
import org.apache.cxf.rs.security.saml.sso.EHCacheUtil;
/**
* An in-memory EHCache implementation of the SPStateManager interface.
* The default TTL is 5 minutes.
*/
public class EHCacheSPStateManager implements SPStateManager {
public static final long DEFAULT_TTL = 60L * 5L;
public static final String REQUEST_CACHE_KEY = "cxf.samlp.request.state.cache";
public static final String RESPONSE_CACHE_KEY = "cxf.samlp.response.state.cache";
private static final String DEFAULT_CONFIG_URL = "cxf-samlp-ehcache.xml";
private Ehcache requestCache;
private Ehcache responseCache;
private CacheManager cacheManager;
private long ttl = DEFAULT_TTL;
public EHCacheSPStateManager() {
this(DEFAULT_CONFIG_URL, null);
}
public EHCacheSPStateManager(Bus bus) {
this(DEFAULT_CONFIG_URL, bus);
}
public EHCacheSPStateManager(String configFileURL) {
this(configFileURL, null);
}
public EHCacheSPStateManager(String configFileURL, Bus bus) {
createCaches(configFileURL, bus);
}
private void createCaches(String configFile, Bus bus) {
if (bus == null) {
bus = BusFactory.getThreadDefaultBus(true);
}
URL configFileURL = null;
try {
configFileURL =
ResourceUtils.getClasspathResourceURL(configFile, EHCacheSPStateManager.class, bus);
} catch (Exception ex) {
// ignore
}
if (configFileURL == null) {
cacheManager = EHCacheUtil.createCacheManager();
} else {
Configuration conf = ConfigurationFactory.parseConfiguration(configFileURL);
if (bus != null) {
conf.setName(bus.getId());
DiskStoreConfiguration dsc = conf.getDiskStoreConfiguration();
if (dsc != null && "java.io.tmpdir".equals(dsc.getOriginalPath())) {
String path = conf.getDiskStoreConfiguration().getPath() + File.separator
+ bus.getId();
conf.getDiskStoreConfiguration().setPath(path);
}
}
cacheManager = EHCacheUtil.createCacheManager(conf);
}
CacheConfiguration requestCC = EHCacheUtil.getCacheConfiguration(REQUEST_CACHE_KEY, cacheManager);
Ehcache newCache = new Cache(requestCC);
requestCache = cacheManager.addCacheIfAbsent(newCache);
CacheConfiguration responseCC = EHCacheUtil.getCacheConfiguration(RESPONSE_CACHE_KEY, cacheManager);
newCache = new Cache(responseCC);
responseCache = cacheManager.addCacheIfAbsent(newCache);
}
/**
* Set a new (default) TTL value in seconds
* @param newTtl a new (default) TTL value in seconds
*/
public void setTTL(long newTtl) {
ttl = newTtl;
}
/**
* Get the (default) TTL value in seconds
* @return the (default) TTL value in seconds
*/
public long getTTL() {
return ttl;
}
public ResponseState getResponseState(String securityContextKey) {
Element element = responseCache.get(securityContextKey);
if (element != null) {
if (responseCache.isExpired(element)) {
responseCache.remove(securityContextKey);
return null;
}
return (ResponseState)element.getObjectValue();
}
return null;
}
public ResponseState removeResponseState(String securityContextKey) {
Element element = responseCache.get(securityContextKey);
if (element != null) {
responseCache.remove(securityContextKey);
return (ResponseState)element.getObjectValue();
}
return null;
}
public void setResponseState(String securityContextKey, ResponseState state) {
if (securityContextKey == null || "".equals(securityContextKey)) {
return;
}
int parsedTTL = (int)ttl;
if (ttl != (long)parsedTTL) {
// Fall back to 5 minutes if the default TTL is set incorrectly
parsedTTL = 60 * 5;
}
Element element = new Element(securityContextKey, state);
element.setTimeToLive(parsedTTL);
element.setTimeToIdle(parsedTTL);
responseCache.put(element);
}
public void setRequestState(String relayState, RequestState state) {
if (relayState == null || "".equals(relayState)) {
return;
}
int parsedTTL = (int)ttl;
if (ttl != (long)parsedTTL) {
// Fall back to 60 minutes if the default TTL is set incorrectly
parsedTTL = 3600;
}
Element element = new Element(relayState, state);
element.setTimeToLive(parsedTTL);
element.setTimeToIdle(parsedTTL);
requestCache.put(element);
}
public RequestState removeRequestState(String relayState) {
Element element = requestCache.get(relayState);
if (element != null) {
requestCache.remove(relayState);
return (RequestState)element.getObjectValue();
}
return null;
}
public void close() throws IOException {
if (cacheManager != null) {
cacheManager.shutdown();
cacheManager = null;
requestCache = null;
responseCache = null;
}
}
}