/**
* 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.wss4j.dom.message;
import java.util.List;
import javax.security.auth.callback.CallbackHandler;
import org.apache.wss4j.dom.WSConstants;
import org.apache.wss4j.dom.common.KeystoreCallbackHandler;
import org.apache.wss4j.dom.common.SAML2CallbackHandler;
import org.apache.wss4j.dom.common.SOAPUtil;
import org.apache.wss4j.dom.common.SecurityTestUtil;
import org.apache.wss4j.dom.common.UsernamePasswordCallbackHandler;
import org.apache.wss4j.dom.engine.WSSConfig;
import org.apache.wss4j.dom.engine.WSSecurityEngine;
import org.apache.wss4j.common.WSEncryptionPart;
import org.apache.wss4j.common.cache.MemoryReplayCache;
import org.apache.wss4j.common.cache.ReplayCache;
import org.apache.wss4j.common.crypto.Crypto;
import org.apache.wss4j.common.crypto.CryptoFactory;
import org.apache.wss4j.common.ext.WSSecurityException;
import org.apache.wss4j.common.saml.SAMLCallback;
import org.apache.wss4j.common.saml.SAMLUtil;
import org.apache.wss4j.common.saml.SamlAssertionWrapper;
import org.apache.wss4j.common.saml.bean.ConditionsBean;
import org.apache.wss4j.common.saml.builder.SAML2Constants;
import org.apache.wss4j.common.util.XMLUtils;
import org.apache.wss4j.dom.handler.RequestData;
import org.apache.wss4j.dom.handler.WSHandlerResult;
import org.apache.wss4j.dom.util.WSSecurityUtil;
import org.apache.wss4j.dom.validate.SamlAssertionValidator;
import org.junit.Test;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* Some test-cases for replay attacks.
*/
public class ReplayTest extends org.junit.Assert {
private static final org.slf4j.Logger LOG =
org.slf4j.LoggerFactory.getLogger(ReplayTest.class);
private CallbackHandler callbackHandler = new KeystoreCallbackHandler();
private Crypto crypto;
@org.junit.AfterClass
public static void cleanup() throws Exception {
SecurityTestUtil.cleanup();
}
public ReplayTest() throws Exception {
crypto = CryptoFactory.getInstance();
}
@Test
public void testReplayedTimestamp() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecTimestamp timestamp = new WSSecTimestamp(secHeader);
timestamp.setTimeToLive(300);
Document createdDoc = timestamp.build();
WSSecSignature builder = new WSSecSignature(secHeader);
builder.setUserInfo("16c73ab6-b892-458f-abf5-2f875f74882e", "security");
builder.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
WSEncryptionPart encP =
new WSEncryptionPart(
"Timestamp", WSConstants.WSU_NS, "");
builder.getParts().add(encP);
builder.prepare(crypto);
List<javax.xml.crypto.dsig.Reference> referenceList =
builder.addReferencesToSign(builder.getParts());
builder.computeSignature(referenceList, false, null);
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(createdDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
data.setTimestampReplayCache(new MemoryReplayCache());
// Successfully verify timestamp
verify(createdDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(createdDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
}
@Test
public void testEhCacheReplayedTimestamp() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecTimestamp timestamp = new WSSecTimestamp(secHeader);
timestamp.setTimeToLive(300);
Document createdDoc = timestamp.build();
WSSecSignature builder = new WSSecSignature(secHeader);
builder.setUserInfo("16c73ab6-b892-458f-abf5-2f875f74882e", "security");
builder.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
WSEncryptionPart encP =
new WSEncryptionPart(
"Timestamp", WSConstants.WSU_NS, "");
builder.getParts().add(encP);
builder.prepare(crypto);
List<javax.xml.crypto.dsig.Reference> referenceList =
builder.addReferencesToSign(builder.getParts());
builder.computeSignature(referenceList, false, null);
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(createdDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
ReplayCache replayCache = SecurityTestUtil.createCache("wss4j.timestamp.cache-");
data.setTimestampReplayCache(replayCache);
// Successfully verify timestamp
verify(createdDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(createdDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
replayCache.close();
}
@Test
public void testReplayedTimestampBelowSignature() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecTimestamp timestamp = new WSSecTimestamp(secHeader);
timestamp.setTimeToLive(300);
Document createdDoc = timestamp.build();
WSSecSignature builder = new WSSecSignature(secHeader);
builder.setUserInfo("16c73ab6-b892-458f-abf5-2f875f74882e", "security");
builder.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
WSEncryptionPart encP =
new WSEncryptionPart(
"Timestamp", WSConstants.WSU_NS, "");
builder.getParts().add(encP);
builder.build(crypto);
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(createdDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
data.setTimestampReplayCache(new MemoryReplayCache());
// Successfully verify timestamp
verify(createdDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(createdDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
}
@Test
public void testEhCacheReplayedTimestampBelowSignature() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecTimestamp timestamp = new WSSecTimestamp(secHeader);
timestamp.setTimeToLive(300);
Document createdDoc = timestamp.build();
WSSecSignature builder = new WSSecSignature(secHeader);
builder.setUserInfo("16c73ab6-b892-458f-abf5-2f875f74882e", "security");
builder.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
WSEncryptionPart encP =
new WSEncryptionPart(
"Timestamp", WSConstants.WSU_NS, "");
builder.getParts().add(encP);
builder.build(crypto);
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(createdDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
ReplayCache replayCache = SecurityTestUtil.createCache("wss4j.timestamp.cache-");
data.setTimestampReplayCache(replayCache);
// Successfully verify timestamp
verify(createdDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(createdDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
replayCache.close();
}
@Test
public void testReplayedTimestampNoExpires() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecTimestamp timestamp = new WSSecTimestamp(secHeader);
timestamp.setTimeToLive(0);
Document createdDoc = timestamp.build();
WSSecSignature builder = new WSSecSignature(secHeader);
builder.setUserInfo("16c73ab6-b892-458f-abf5-2f875f74882e", "security");
builder.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
WSEncryptionPart encP =
new WSEncryptionPart(
"Timestamp", WSConstants.WSU_NS, "");
builder.getParts().add(encP);
builder.prepare(crypto);
List<javax.xml.crypto.dsig.Reference> referenceList =
builder.addReferencesToSign(builder.getParts());
builder.computeSignature(referenceList, false, null);
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(createdDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
data.setTimestampReplayCache(new MemoryReplayCache());
// Successfully verify timestamp
verify(createdDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(createdDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
}
@Test
public void testEhCacheReplayedTimestampNoExpires() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecTimestamp timestamp = new WSSecTimestamp(secHeader);
timestamp.setTimeToLive(0);
Document createdDoc = timestamp.build();
WSSecSignature builder = new WSSecSignature(secHeader);
builder.setUserInfo("16c73ab6-b892-458f-abf5-2f875f74882e", "security");
builder.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
WSEncryptionPart encP =
new WSEncryptionPart(
"Timestamp", WSConstants.WSU_NS, "");
builder.getParts().add(encP);
builder.prepare(crypto);
List<javax.xml.crypto.dsig.Reference> referenceList =
builder.addReferencesToSign(builder.getParts());
builder.computeSignature(referenceList, false, null);
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(createdDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
ReplayCache replayCache = SecurityTestUtil.createCache("wss4j.timestamp.cache-");
data.setTimestampReplayCache(replayCache);
// Successfully verify timestamp
verify(createdDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(createdDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
replayCache.close();
}
@Test
public void testReplayedUsernameToken() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecUsernameToken builder = new WSSecUsernameToken(secHeader);
builder.setUserInfo("wernerd", "verySecret");
Document signedDoc = builder.build();
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(signedDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setCallbackHandler(new UsernamePasswordCallbackHandler());
data.setWssConfig(wssConfig);
data.setNonceReplayCache(new MemoryReplayCache());
// Successfully verify UsernameToken
verify(signedDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(signedDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
}
@Test
public void testEhCacheReplayedUsernameToken() throws Exception {
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecUsernameToken builder = new WSSecUsernameToken(secHeader);
builder.setUserInfo("wernerd", "verySecret");
Document signedDoc = builder.build();
if (LOG.isDebugEnabled()) {
String outputString =
XMLUtils.prettyDocumentToString(signedDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
RequestData data = new RequestData();
data.setCallbackHandler(new UsernamePasswordCallbackHandler());
data.setWssConfig(wssConfig);
ReplayCache replayCache = SecurityTestUtil.createCache("wss4j.nonce.cache-");
data.setNonceReplayCache(replayCache);
// Successfully verify UsernameToken
verify(signedDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(signedDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
replayCache.close();
}
/**
* Test that creates, sends and processes an unsigned SAML 2 authentication assertion. This
* is just a sanity test to make sure that it is possible to send the SAML token twice, as
* no "OneTimeUse" Element is defined there is no problem with replaying it.
* with a OneTimeUse Element
*/
@Test
public void testEhCacheReplayedSAML2() throws Exception {
SAML2CallbackHandler callbackHandler = new SAML2CallbackHandler();
callbackHandler.setStatement(SAML2CallbackHandler.Statement.AUTHN);
callbackHandler.setIssuer("www.example.com");
callbackHandler.setConfirmationMethod(SAML2Constants.CONF_BEARER);
ConditionsBean conditions = new ConditionsBean();
conditions.setTokenPeriodMinutes(5);
callbackHandler.setConditions(conditions);
SAMLCallback samlCallback = new SAMLCallback();
SAMLUtil.doSAMLCallback(callbackHandler, samlCallback);
SamlAssertionWrapper samlAssertion = new SamlAssertionWrapper(samlCallback);
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecSAMLToken wsSign = new WSSecSAMLToken(secHeader);
Document unsignedDoc = wsSign.build(samlAssertion);
if (LOG.isDebugEnabled()) {
String outputString = XMLUtils.prettyDocumentToString(unsignedDoc);
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
SamlAssertionValidator assertionValidator = new SamlAssertionValidator();
assertionValidator.setRequireBearerSignature(false);
wssConfig.setValidator(WSConstants.SAML_TOKEN, assertionValidator);
wssConfig.setValidator(WSConstants.SAML2_TOKEN, assertionValidator);
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
ReplayCache replayCache = SecurityTestUtil.createCache("wss4j.saml.one.time.use.cache-");
data.setSamlOneTimeUseReplayCache(replayCache);
// Successfully verify SAML Token
verify(unsignedDoc, wssConfig, data);
// Now try again - this should work fine as well
verify(unsignedDoc, wssConfig, data);
replayCache.close();
}
/**
* Test that creates, sends and processes an unsigned SAML 2 authentication assertion
* with a OneTimeUse Element
*/
@Test
public void testEhCacheReplayedSAML2OneTimeUse() throws Exception {
SAML2CallbackHandler callbackHandler = new SAML2CallbackHandler();
callbackHandler.setStatement(SAML2CallbackHandler.Statement.AUTHN);
callbackHandler.setIssuer("www.example.com");
callbackHandler.setConfirmationMethod(SAML2Constants.CONF_BEARER);
ConditionsBean conditions = new ConditionsBean();
conditions.setTokenPeriodMinutes(5);
conditions.setOneTimeUse(true);
callbackHandler.setConditions(conditions);
SAMLCallback samlCallback = new SAMLCallback();
SAMLUtil.doSAMLCallback(callbackHandler, samlCallback);
SamlAssertionWrapper samlAssertion = new SamlAssertionWrapper(samlCallback);
Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG);
WSSecHeader secHeader = new WSSecHeader(doc);
secHeader.insertSecurityHeader();
WSSecSAMLToken wsSign = new WSSecSAMLToken(secHeader);
Document unsignedDoc = wsSign.build(samlAssertion);
String outputString =
XMLUtils.prettyDocumentToString(unsignedDoc);
assertTrue(outputString.contains("OneTimeUse"));
if (LOG.isDebugEnabled()) {
LOG.debug(outputString);
}
WSSConfig wssConfig = WSSConfig.getNewInstance();
SamlAssertionValidator assertionValidator = new SamlAssertionValidator();
assertionValidator.setRequireBearerSignature(false);
wssConfig.setValidator(WSConstants.SAML_TOKEN, assertionValidator);
wssConfig.setValidator(WSConstants.SAML2_TOKEN, assertionValidator);
RequestData data = new RequestData();
data.setWssConfig(wssConfig);
data.setCallbackHandler(callbackHandler);
ReplayCache replayCache = SecurityTestUtil.createCache("wss4j.saml.one.time.use.cache-");
data.setSamlOneTimeUseReplayCache(replayCache);
// Successfully verify SAML Token
verify(unsignedDoc, wssConfig, data);
// Now try again - a replay attack should be detected
try {
verify(unsignedDoc, wssConfig, data);
fail("Expected failure on a replay attack");
} catch (WSSecurityException ex) {
assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.INVALID_SECURITY);
}
replayCache.close();
}
/**
* Verifies the soap envelope
*
* @param env soap envelope
* @param wssConfig
* @throws java.lang.Exception Thrown when there is a problem in verification
*/
private WSHandlerResult verify(
Document doc, WSSConfig wssConfig, RequestData data
) throws Exception {
WSSecurityEngine secEngine = new WSSecurityEngine();
secEngine.setWssConfig(wssConfig);
Element elem = WSSecurityUtil.getSecurityHeader(doc, null);
data.setSigVerCrypto(crypto);
return secEngine.processSecurityHeader(elem, data);
}
}