Java tutorial
/** * 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 wssec; import junit.framework.Test; import junit.framework.TestCase; import junit.framework.TestSuite; import org.apache.axis.Message; import org.apache.axis.MessageContext; import org.apache.axis.client.AxisClient; import org.apache.axis.configuration.NullProvider; import org.apache.axis.message.SOAPEnvelope; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.ws.security.WSPasswordCallback; import org.apache.ws.security.WSSConfig; import org.apache.ws.security.WSSecurityEngine; import org.apache.ws.security.WSConstants; import org.apache.ws.security.handler.RequestData; import org.apache.ws.security.handler.WSHandlerConstants; import org.apache.ws.security.message.WSSecUsernameToken; import org.apache.ws.security.message.WSSecSignature; import org.apache.ws.security.message.WSSecHeader; import org.apache.xml.security.signature.XMLSignature; import org.w3c.dom.Document; import javax.security.auth.callback.Callback; import javax.security.auth.callback.CallbackHandler; import javax.security.auth.callback.UnsupportedCallbackException; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; /** * WS-Security Test Case * <p/> * * @author Werner Dittmann (Wern.erDittmann@siemens.com) */ public class TestWSSecurityNew13 extends TestCase implements CallbackHandler { private static final Log LOG = LogFactory.getLog(TestWSSecurityNew13.class); private static final String SOAPMSG = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + "<SOAP-ENV:Envelope " + "xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" " + "xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" " + "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">" + "<SOAP-ENV:Body>" + "<add xmlns=\"http://ws.apache.org/counter/counter_port_type\">" + "<value xmlns=\"\">15</value>" + "</add>" + "</SOAP-ENV:Body>" + "</SOAP-ENV:Envelope>"; private WSSecurityEngine secEngine = new WSSecurityEngine(); private MessageContext msgContext; private SOAPEnvelope unsignedEnvelope; /** * TestWSSecurity constructor * <p/> * * @param name name of the test */ public TestWSSecurityNew13(String name) { super(name); } /** * JUnit suite * <p/> * * @return a junit test suite */ public static Test suite() { return new TestSuite(TestWSSecurityNew13.class); } /** * Setup method * <p/> * * @throws java.lang.Exception Thrown when there is a problem in setup */ protected void setUp() throws Exception { AxisClient tmpEngine = new AxisClient(new NullProvider()); msgContext = new MessageContext(tmpEngine); unsignedEnvelope = getSOAPEnvelope(); } /** * Constructs a soap envelope * <p/> * * @return soap envelope * @throws java.lang.Exception if there is any problem constructing the soap envelope */ protected SOAPEnvelope getSOAPEnvelope() throws Exception { InputStream in = new ByteArrayInputStream(SOAPMSG.getBytes()); Message msg = new Message(in); msg.setMessageContext(msgContext); return msg.getSOAPEnvelope(); } /** * Test the specific signing method that use UsernameToken values * <p/> * * @throws java.lang.Exception Thrown when there is any problem in signing or verification */ public void testUsernameTokenSigning() throws Exception { Document doc = unsignedEnvelope.getAsDocument(); WSSecHeader secHeader = new WSSecHeader(); secHeader.insertSecurityHeader(doc); WSSecUsernameToken builder = new WSSecUsernameToken(); builder.setPasswordType(WSConstants.PASSWORD_TEXT); builder.setUserInfo("wernerd", "verySecret"); builder.addCreated(); builder.addNonce(); builder.prepare(doc); WSSecSignature sign = new WSSecSignature(); sign.setUsernameToken(builder); sign.setKeyIdentifierType(WSConstants.UT_SIGNING); sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_MAC_HMAC_SHA1); LOG.info("Before signing with UT text...."); sign.build(doc, null, secHeader); LOG.info("Before adding UsernameToken PW Text...."); builder.prependToHeader(secHeader); Document signedDoc = doc; if (LOG.isDebugEnabled()) { LOG.debug("Message with UserNameToken PW Text:"); String outputString = org.apache.ws.security.util.XMLUtils.PrettyDocumentToString(signedDoc); LOG.debug(outputString); } LOG.info("After adding UsernameToken PW Text...."); verify(signedDoc); } /** * Test that uses a 32 byte key length for the secret key, instead of the default 16 bytes. */ public void testWSS226() throws Exception { Document doc = unsignedEnvelope.getAsDocument(); WSSecHeader secHeader = new WSSecHeader(); secHeader.insertSecurityHeader(doc); WSSecUsernameToken builder = new WSSecUsernameToken(); builder.setPasswordType(WSConstants.PASSWORD_TEXT); builder.setUserInfo("wernerd", "verySecret"); builder.addCreated(); builder.setSecretKeyLength(32); builder.addNonce(); builder.prepare(doc); WSSecSignature sign = new WSSecSignature(); sign.setUsernameToken(builder); sign.setKeyIdentifierType(WSConstants.UT_SIGNING); sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_MAC_HMAC_SHA1); LOG.info("Before signing with UT text...."); sign.build(doc, null, secHeader); LOG.info("Before adding UsernameToken PW Text...."); builder.prependToHeader(secHeader); Document signedDoc = doc; if (LOG.isDebugEnabled()) { LOG.debug("Message using a 32 byte key length:"); String outputString = org.apache.ws.security.util.XMLUtils.PrettyDocumentToString(signedDoc); LOG.debug(outputString); } // // It should fail on the default key length of 16... // try { secEngine.processSecurityHeader(doc, null, this, null); fail("An error was expected on verifying the signature"); } catch (Exception ex) { // expected } WSSecurityEngine wss226SecurityEngine = new WSSecurityEngine(); WSSConfig wssConfig = WSSConfig.getNewInstance(); wssConfig.setSecretKeyLength(32); wss226SecurityEngine.setWssConfig(wssConfig); wss226SecurityEngine.processSecurityHeader(doc, null, this, null); } /** * Test that uses a 32 byte key length for the secret key, instead of the default 16 bytes. * This test configures the key length via WSHandler. */ public void testWSS226Handler() throws Exception { MyHandler handler = new MyHandler(); Document doc = unsignedEnvelope.getAsDocument(); RequestData reqData = new RequestData(); reqData.setWssConfig(WSSConfig.getNewInstance()); java.util.Map config = new java.util.TreeMap(); config.put("password", "verySecret"); config.put(WSHandlerConstants.PASSWORD_TYPE, WSConstants.PW_TEXT); config.put(WSHandlerConstants.WSE_SECRET_KEY_LENGTH, "32"); reqData.setUsername("wernerd"); reqData.setMsgContext(config); java.util.Vector actions = new java.util.Vector(); actions.add(new Integer(WSConstants.UT_SIGN)); handler.send(WSConstants.UT_SIGN, doc, reqData, actions, true); if (LOG.isDebugEnabled()) { LOG.debug("Username Token Signature via WSHandler"); String outputString = org.apache.ws.security.util.XMLUtils.PrettyDocumentToString(doc); LOG.debug(outputString); } // // It should fail on the default key length of 16... // try { secEngine.processSecurityHeader(doc, null, this, null); fail("An error was expected on verifying the signature"); } catch (Exception ex) { // expected } handler.receive(WSConstants.UT_SIGN, reqData); WSSecurityEngine wss226SecurityEngine = new WSSecurityEngine(); wss226SecurityEngine.setWssConfig(reqData.getWssConfig()); wss226SecurityEngine.processSecurityHeader(doc, null, this, null); } /** * Test the specific signing method that use UsernameToken values * <p/> * * @throws java.lang.Exception Thrown when there is any problem in signing or verification */ public void testUsernameTokenSigningDigest() throws Exception { Document doc = unsignedEnvelope.getAsDocument(); WSSecHeader secHeader = new WSSecHeader(); secHeader.insertSecurityHeader(doc); WSSecUsernameToken builder = new WSSecUsernameToken(); builder.setPasswordType(WSConstants.PASSWORD_DIGEST); builder.setUserInfo("wernerd", "verySecret"); builder.addCreated(); builder.addNonce(); builder.prepare(doc); WSSecSignature sign = new WSSecSignature(); sign.setUsernameToken(builder); sign.setKeyIdentifierType(WSConstants.UT_SIGNING); sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_MAC_HMAC_SHA1); LOG.info("Before signing with UT digest...."); sign.build(doc, null, secHeader); LOG.info("Before adding UsernameToken PW Digest...."); builder.prependToHeader(secHeader); Document signedDoc = doc; if (LOG.isDebugEnabled()) { LOG.debug("Message with UserNameToken PW Digest:"); String outputString = org.apache.ws.security.util.XMLUtils.PrettyDocumentToString(signedDoc); LOG.debug(outputString); } LOG.info("After adding UsernameToken PW Digest...."); verify(signedDoc); } /** * Verifies the soap envelope * <p/> * * @param env soap envelope * @throws java.lang.Exception Thrown when there is a problem in verification */ private void verify(Document doc) throws Exception { LOG.info("Before verifying UsernameToken...."); secEngine.processSecurityHeader(doc, null, this, null); LOG.info("After verifying UsernameToken...."); } public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException { for (int i = 0; i < callbacks.length; i++) { if (callbacks[i] instanceof WSPasswordCallback) { WSPasswordCallback pc = (WSPasswordCallback) callbacks[i]; /* * here call a function/method to lookup the password for * the given identifier (e.g. a user name or keystore alias) * e.g.: pc.setPassword(passStore.getPassword(pc.getIdentfifier)) * for Testing we supply a fixed name here. */ pc.setPassword("verySecret"); } else { throw new UnsupportedCallbackException(callbacks[i], "Unrecognized Callback"); } } } }