com.sun.xml.wss.NonceManager Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.wss;
import com.sun.xml.ws.api.ha.HighAvailabilityProvider;
import com.sun.xml.ws.api.server.WSEndpoint;
import com.sun.xml.ws.commons.AbstractMOMRegistrationAware;
import com.sun.xml.ws.commons.WSEndpointCollectionBasedMOMListener;
import com.sun.xml.wss.impl.XWSSecurityRuntimeException;
import com.sun.xml.wss.impl.misc.DefaultNonceManager;
import com.sun.xml.wss.impl.misc.HANonceManager;
import com.sun.xml.wss.impl.misc.SecurityUtil;
import com.sun.xml.wss.logging.LogDomainConstants;
import org.glassfish.gmbal.AMXMetadata;
import org.glassfish.gmbal.Description;
import org.glassfish.gmbal.ManagedAttribute;
import org.glassfish.gmbal.ManagedObject;
import java.net.URL;
import java.util.WeakHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* This abstract class defines an SPI that Metro Application developers can implement, to handle custom
* validation of Nonces used in conjunction with Password-Digest Authentication. A repeated nonce would
* generally indicate a possible replay-attack.
*
* The SPI implementation class needs to be
* specified as a META-INF/services entry with name "com.sun.xml.xwss.NonceManager".
* A default implementation of this SPI is returned if no entry is configured.
*
*
*/
@ManagedObject
@Description("per-endpoint NonceManager")
@AMXMetadata(type = "WSNonceManager")
public abstract class NonceManager extends AbstractMOMRegistrationAware {
protected static final Logger LOGGER =
Logger.getLogger(LogDomainConstants.WSS_API_DOMAIN,
LogDomainConstants.WSS_API_DOMAIN_BUNDLE);
public static final String nonceManager = "com.sun.xml.xwss.NonceManager";
private static final String NONCE_MANAGER = "NonceManager"; // monitoring
private static WeakHashMap, NonceManager> nonceMgrMap = new WeakHashMap<>();
private static NonceManager jaxRPCNonceManager = null;
private long maxNonceAge;
private static final Object LOCK = new Object();
private static final WSEndpointCollectionBasedMOMListener listener;
static {
listener = new WSEndpointCollectionBasedMOMListener(LOCK, NONCE_MANAGER, nonceMgrMap);
listener.initialize();
}
/**
* Default constructor.
*/
protected NonceManager() {}
/**
*
* @return the approximate maximum age for which a received nonce would be stored by the NonceManager
*/
@ManagedAttribute
public long getMaxNonceAge() {
return maxNonceAge;
}
/**
* Set the approximate maximum age for which a received nonce needs to be stored by the NonceManager
*/
public void setMaxNonceAge(long maxNonceAge) {
this.maxNonceAge = maxNonceAge;
}
/**
* Exception to be thrown when an Error in processing received nonces occurs.
* A Nonce-replay would also be indicated by a NonceException.
*/
public static class NonceException extends XWSSecurityException {
private static final long serialVersionUID = 234506161204469172L;
/**
* Constructor specifying the message string.
* @param message the exception message string
*/
public NonceException(String message) {
super(message);
}
/**
* Constructor specifying the message string and a nested exception
* @param message the exception message string
* @param cause the nested exception as a Throwable
*/
public NonceException(String message, Throwable cause) {
super(message, cause);
}
/**
* Constructor specifying a nested exception
* @param cause the nested exception as a Throwable
*/
public NonceException(Throwable cause) {
super(cause);
}
}
/**
*
* @param nonce the nonce to be validated
* @param created the creation time of the nonce as indicated in the UsernameToken
* @return true if the nonce is not a replay
* @throws com.sun.xml.wss.NonceManager.NonceException if a replay is detected
*/
public abstract boolean validateNonce(String nonce, String created) throws NonceException;
/**
*
* @param maxNonceAge the approximate maximum age for which a received nonce would be stored by the NonceManager
* @return the singleton instance of the configured NonceManager, calling getInstance with different maxNonceAge
* will have no effect and will instead return the same NonceManager which was initialized first.
*/
public static NonceManager getInstance(final long maxNonceAge, final WSEndpoint endpoint) {
synchronized (LOCK) {
if (endpoint == null) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
"getInstance(): endpoint is null: using singleton");
}
}
NonceManager nonceMgr =
endpoint != null ? nonceMgrMap.get(endpoint) : jaxRPCNonceManager;
if (nonceMgr != null) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
String.format("getInstance(%s): found existing: %s",
endpoint, nonceMgr));
}
return nonceMgr;
}
final URL url = SecurityUtil.loadFromClasspath("/META-INF/services/" + nonceManager);
if (url != null) {
Object obj = SecurityUtil.loadSPIClass(url, nonceManager);
if ((obj != null) && !(obj instanceof NonceManager)) {
throw new XWSSecurityRuntimeException("Class :" + obj.getClass().getName() + " is not a valid NonceManager");
}
nonceMgr = (NonceManager) obj;
}
if (HighAvailabilityProvider.INSTANCE.isHaEnvironmentConfigured()) {
nonceMgr = new HANonceManager(maxNonceAge);
} else {
if (url == null) {
nonceMgr = new DefaultNonceManager();
}
}
//is this check still needed ?
if (nonceMgr == null) {
nonceMgr = new DefaultNonceManager();
}
nonceMgr.setMaxNonceAge(maxNonceAge);
if (endpoint != null) {
nonceMgrMap.put(endpoint, nonceMgr);
if (listener.canRegisterAtMOM()) {
listener.registerAtMOM(nonceMgr, endpoint);
}
} else {
jaxRPCNonceManager = nonceMgr;
}
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
String.format("getInstance(%s): created: %s",
endpoint, nonceMgr));
}
return nonceMgr;
}
}
public static void deleteInstance(final WSEndpoint endpoint) {
synchronized (LOCK) {
final NonceManager o = endpoint != null ? nonceMgrMap.remove(endpoint) : jaxRPCNonceManager;
if (endpoint == null) {
jaxRPCNonceManager = null;
}
NonceManager nonceManager = o;
if (endpoint != null && o != null && nonceManager.isRegisteredAtMOM()) {
listener.unregisterFromMOM(nonceManager, endpoint);
}
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
String.format("deleteInstance(%s): %s", endpoint, o));
}
}
}
}