| /** |
| * 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.saml; |
| |
| import java.security.PrivateKey; |
| import java.security.cert.X509Certificate; |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.TreeMap; |
| |
| import javax.xml.namespace.QName; |
| |
| import org.apache.wss4j.common.WSEncryptionPart; |
| import org.apache.wss4j.common.crypto.Crypto; |
| import org.apache.wss4j.common.crypto.CryptoFactory; |
| import org.apache.wss4j.common.crypto.CryptoType; |
| 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.builder.SAML1Constants; |
| import org.apache.wss4j.common.saml.builder.SAML2Constants; |
| import org.apache.wss4j.common.util.SOAPUtil; |
| import org.apache.wss4j.common.util.XMLUtils; |
| import org.apache.wss4j.dom.WSConstants; |
| import org.apache.wss4j.dom.common.CustomHandler; |
| import org.apache.wss4j.dom.common.SAML1CallbackHandler; |
| import org.apache.wss4j.dom.common.SAML2CallbackHandler; |
| |
| import org.apache.wss4j.dom.engine.WSSConfig; |
| import org.apache.wss4j.dom.engine.WSSecurityEngine; |
| import org.apache.wss4j.dom.handler.HandlerAction; |
| import org.apache.wss4j.dom.handler.RequestData; |
| import org.apache.wss4j.dom.handler.WSHandlerConstants; |
| import org.apache.wss4j.dom.handler.WSHandlerResult; |
| import org.apache.wss4j.dom.message.WSSecHeader; |
| import org.apache.wss4j.dom.message.WSSecSignature; |
| import org.apache.wss4j.dom.validate.SamlAssertionValidator; |
| import org.apache.wss4j.dom.validate.Validator; |
| import org.apache.xml.security.signature.XMLSignature; |
| import org.apache.xml.security.transforms.Transforms; |
| import org.apache.xml.security.transforms.params.XPath2FilterContainer; |
| import org.apache.xml.security.utils.Constants; |
| |
| import org.junit.jupiter.api.Test; |
| import org.w3c.dom.Document; |
| import org.w3c.dom.Element; |
| |
| import static org.junit.jupiter.api.Assertions.assertTrue; |
| import static org.junit.jupiter.api.Assertions.fail; |
| |
| /** |
| */ |
| public class SamlTokenCustomSignatureTest { |
| private static final org.slf4j.Logger LOG = |
| org.slf4j.LoggerFactory.getLogger(SamlTokenCustomSignatureTest.class); |
| |
| private Crypto crypto; |
| |
| public SamlTokenCustomSignatureTest() throws Exception { |
| WSSConfig.init(); |
| crypto = CryptoFactory.getInstance("crypto.properties"); |
| } |
| |
| /** |
| * Test that creates, sends and processes a signed SAML 1.1 authentication assertion. |
| */ |
| @Test |
| public void testSAML1AuthnAssertion() throws Exception { |
| SAML1CallbackHandler callbackHandler = new SAML1CallbackHandler(); |
| callbackHandler.setStatement(SAML1CallbackHandler.Statement.AUTHN); |
| callbackHandler.setConfirmationMethod(SAML1Constants.CONF_BEARER); |
| callbackHandler.setIssuer("www.example.com"); |
| |
| SAMLCallback samlCallback = new SAMLCallback(); |
| SAMLUtil.doSAMLCallback(callbackHandler, samlCallback); |
| SamlAssertionWrapper samlAssertion = new SamlAssertionWrapper(samlCallback); |
| |
| Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG); |
| Element assertionElement = samlAssertion.toDOM(doc); |
| |
| WSSecHeader secHeader = new WSSecHeader(doc); |
| secHeader.insertSecurityHeader(); |
| secHeader.getSecurityHeaderElement().appendChild(assertionElement); |
| |
| // Sign |
| signAssertion(doc, assertionElement); |
| |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("SAML 1.1 Authn Assertion (Bearer):"); |
| String outputString = XMLUtils.prettyDocumentToString(doc); |
| LOG.debug(outputString); |
| } |
| |
| try { |
| verify(doc); |
| fail("Failure expected on a signature that doesn't conform with the signature profile"); |
| } catch (WSSecurityException ex) { |
| assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.FAILURE); |
| } |
| |
| // This should pass as we are disabling signature profile validation in the Validator |
| verifyWithoutProfile(doc); |
| } |
| |
| @Test |
| public void testSAML1AuthnAssertionValidatorMap() throws Exception { |
| SAML1CallbackHandler callbackHandler = new SAML1CallbackHandler(); |
| callbackHandler.setStatement(SAML1CallbackHandler.Statement.AUTHN); |
| callbackHandler.setConfirmationMethod(SAML1Constants.CONF_BEARER); |
| callbackHandler.setIssuer("www.example.com"); |
| |
| SAMLCallback samlCallback = new SAMLCallback(); |
| SAMLUtil.doSAMLCallback(callbackHandler, samlCallback); |
| SamlAssertionWrapper samlAssertion = new SamlAssertionWrapper(samlCallback); |
| |
| Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG); |
| Element assertionElement = samlAssertion.toDOM(doc); |
| |
| WSSecHeader secHeader = new WSSecHeader(doc); |
| secHeader.insertSecurityHeader(); |
| secHeader.getSecurityHeaderElement().appendChild(assertionElement); |
| |
| // Sign |
| signAssertion(doc, assertionElement); |
| |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("SAML 1.1 Authn Assertion (Bearer):"); |
| String outputString = XMLUtils.prettyDocumentToString(doc); |
| LOG.debug(outputString); |
| } |
| |
| try { |
| verify(doc); |
| fail("Failure expected on a signature that doesn't conform with the signature profile"); |
| } catch (WSSecurityException ex) { |
| assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.FAILURE); |
| } |
| |
| // This should pass as we are disabling signature profile validation in the Validator, |
| // which is configured via ConfigurationConstants.VALIDATOR_MAP |
| |
| SamlAssertionValidator validator = new SamlAssertionValidator(); |
| validator.setValidateSignatureAgainstProfile(false); |
| Map<QName, Validator> validatorMap = new HashMap<>(); |
| validatorMap.put(WSConstants.SAML_TOKEN, validator); |
| |
| RequestData requestData = new RequestData(); |
| Map<String, Object> config = new TreeMap<>(); |
| config.put(WSHandlerConstants.SIG_VER_PROP_FILE, "crypto.properties"); |
| config.put(WSHandlerConstants.VALIDATOR_MAP, validatorMap); |
| requestData.setMsgContext(config); |
| requestData.setSigVerCrypto(crypto); |
| |
| CustomHandler handler = new CustomHandler(); |
| |
| List<Integer> actions = new ArrayList<>(); |
| actions.add(WSConstants.ST_SIGNED); |
| handler.receive(actions, requestData); |
| |
| WSSecurityEngine secEngine = new WSSecurityEngine(); |
| secEngine.processSecurityHeader(doc, requestData); |
| |
| String outputString = XMLUtils.prettyDocumentToString(doc); |
| assertTrue(outputString.indexOf("counter_port_type") > 0 ? true : false); |
| } |
| |
| /** |
| * Test that creates, sends and processes a signed SAML 2.0 authentication assertion. |
| */ |
| @Test |
| public void testSAML2AuthnAssertion() throws Exception { |
| SAML2CallbackHandler callbackHandler = new SAML2CallbackHandler(); |
| callbackHandler.setStatement(SAML2CallbackHandler.Statement.AUTHN); |
| callbackHandler.setConfirmationMethod(SAML2Constants.CONF_BEARER); |
| callbackHandler.setIssuer("www.example.com"); |
| |
| SAMLCallback samlCallback = new SAMLCallback(); |
| SAMLUtil.doSAMLCallback(callbackHandler, samlCallback); |
| SamlAssertionWrapper samlAssertion = new SamlAssertionWrapper(samlCallback); |
| |
| Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG); |
| Element assertionElement = samlAssertion.toDOM(doc); |
| |
| WSSecHeader secHeader = new WSSecHeader(doc); |
| secHeader.insertSecurityHeader(); |
| secHeader.getSecurityHeaderElement().appendChild(assertionElement); |
| |
| // Sign |
| signAssertion(doc, assertionElement); |
| |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("SAML 2.0 Authn Assertion (Bearer):"); |
| String outputString = XMLUtils.prettyDocumentToString(doc); |
| LOG.debug(outputString); |
| } |
| |
| try { |
| verify(doc); |
| fail("Failure expected on a signature that doesn't conform with the signature profile"); |
| } catch (WSSecurityException ex) { |
| assertTrue(ex.getErrorCode() == WSSecurityException.ErrorCode.FAILURE); |
| } |
| |
| // This should pass as we are disabling signature profile validation in the Validator |
| verifyWithoutProfile(doc); |
| } |
| |
| @Test |
| public void testAddSAML1AndSign() throws Exception { |
| SAML1CallbackHandler callbackHandler = new SAML1CallbackHandler(); |
| callbackHandler.setStatement(SAML1CallbackHandler.Statement.AUTHN); |
| callbackHandler.setConfirmationMethod(SAML1Constants.CONF_SENDER_VOUCHES); |
| callbackHandler.setIssuer("www.example.com"); |
| |
| SAMLCallback samlCallback = new SAMLCallback(); |
| SAMLUtil.doSAMLCallback(callbackHandler, samlCallback); |
| SamlAssertionWrapper samlAssertion = new SamlAssertionWrapper(samlCallback); |
| |
| Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG); |
| Element assertionElement = samlAssertion.toDOM(doc); |
| |
| WSSecHeader secHeader = new WSSecHeader(doc); |
| secHeader.insertSecurityHeader(); |
| secHeader.getSecurityHeaderElement().appendChild(assertionElement); |
| |
| WSSecSignature sign = new WSSecSignature(secHeader); |
| sign.setUserInfo("16c73ab6-b892-458f-abf5-2f875f74882e", "security"); |
| sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL); |
| |
| WSEncryptionPart encP = |
| new WSEncryptionPart( |
| "Assertion", |
| "urn:oasis:names:tc:SAML:1.0:assertion", |
| "Element"); |
| encP.setRequired(false); |
| sign.getParts().add(encP); |
| |
| Document signedDoc = sign.build(crypto); |
| |
| if (LOG.isDebugEnabled()) { |
| String outputString = XMLUtils.prettyDocumentToString(doc); |
| LOG.debug(outputString); |
| } |
| |
| verify(signedDoc); |
| } |
| |
| @Test |
| public void testAddSAML1AndSignAction() throws Exception { |
| SAML1CallbackHandler callbackHandler = new SAML1CallbackHandler(); |
| callbackHandler.setStatement(SAML1CallbackHandler.Statement.AUTHN); |
| callbackHandler.setConfirmationMethod(SAML1Constants.CONF_SENDER_VOUCHES); |
| callbackHandler.setIssuer("www.example.com"); |
| |
| final WSSConfig cfg = WSSConfig.getNewInstance(); |
| final RequestData reqData = new RequestData(); |
| reqData.setWssConfig(cfg); |
| reqData.setUsername("16c73ab6-b892-458f-abf5-2f875f74882e"); |
| |
| Map<String, Object> config = new TreeMap<>(); |
| config.put(WSHandlerConstants.SIG_PROP_FILE, "crypto.properties"); |
| config.put("password", "security"); |
| config.put(WSHandlerConstants.SIG_KEY_ID, "DirectReference"); |
| config.put( |
| WSHandlerConstants.SIGNATURE_PARTS, |
| "{Element}{urn:oasis:names:tc:SAML:1.0:assertion}Assertion" |
| ); |
| config.put(WSHandlerConstants.SAML_CALLBACK_REF, callbackHandler); |
| reqData.setMsgContext(config); |
| |
| final Document doc = SOAPUtil.toSOAPPart(SOAPUtil.SAMPLE_SOAP_MSG); |
| CustomHandler handler = new CustomHandler(); |
| |
| List<HandlerAction> actions = new ArrayList<>(); |
| HandlerAction action = new HandlerAction(WSConstants.ST_UNSIGNED); |
| actions.add(action); |
| action = new HandlerAction(WSConstants.SIGN); |
| actions.add(action); |
| |
| handler.send( |
| doc, |
| reqData, |
| actions, |
| true |
| ); |
| String outputString = |
| XMLUtils.prettyDocumentToString(doc); |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("Signed message:"); |
| LOG.debug(outputString); |
| } |
| |
| verify(doc); |
| } |
| |
| private void signAssertion(Document doc, Element assertionElement) throws Exception { |
| XMLSignature sig = |
| new XMLSignature(doc, null, XMLSignature.ALGO_ID_SIGNATURE_RSA); |
| assertionElement.appendChild(sig.getElement()); |
| |
| Transforms transforms = new Transforms(doc); |
| String filter = "here()/ancestor::ds.Signature/parent::node()/descendant-or-self::*"; |
| XPath2FilterContainer xpathC = XPath2FilterContainer.newInstanceIntersect(doc, filter); |
| xpathC.setXPathNamespaceContext("dsig-xpath", Transforms.TRANSFORM_XPATH2FILTER); |
| |
| Element node = xpathC.getElement(); |
| transforms.addTransform(Transforms.TRANSFORM_XPATH2FILTER, node); |
| sig.addDocument("", transforms, Constants.ALGO_ID_DIGEST_SHA1); |
| |
| PrivateKey privateKey = crypto.getPrivateKey("16c73ab6-b892-458f-abf5-2f875f74882e", "security"); |
| |
| sig.sign(privateKey); |
| |
| CryptoType cryptoType = new CryptoType(CryptoType.TYPE.ALIAS); |
| cryptoType.setAlias("16c73ab6-b892-458f-abf5-2f875f74882e"); |
| X509Certificate cert = crypto.getX509Certificates(cryptoType)[0]; |
| sig.addKeyInfo(cert); |
| sig.checkSignatureValue(cert); |
| } |
| |
| /** |
| * Verifies the soap envelope |
| * |
| * @param doc |
| * @throws Exception Thrown when there is a problem in verification |
| */ |
| private WSHandlerResult verify(Document doc) throws Exception { |
| WSSecurityEngine secEngine = new WSSecurityEngine(); |
| RequestData requestData = new RequestData(); |
| requestData.setDecCrypto(crypto); |
| requestData.setSigVerCrypto(crypto); |
| requestData.setValidateSamlSubjectConfirmation(false); |
| |
| WSHandlerResult results = secEngine.processSecurityHeader(doc, requestData); |
| String outputString = XMLUtils.prettyDocumentToString(doc); |
| assertTrue(outputString.indexOf("counter_port_type") > 0 ? true : false); |
| return results; |
| } |
| |
| private WSHandlerResult verifyWithoutProfile(Document doc) throws Exception { |
| SamlAssertionValidator validator = new SamlAssertionValidator(); |
| validator.setValidateSignatureAgainstProfile(false); |
| |
| WSSecurityEngine secEngine = new WSSecurityEngine(); |
| WSSConfig config = secEngine.getWssConfig(); |
| config.setValidator(WSConstants.SAML_TOKEN, validator); |
| config.setValidator(WSConstants.SAML2_TOKEN, validator); |
| |
| WSHandlerResult results = |
| secEngine.processSecurityHeader( |
| doc, null, null, crypto |
| ); |
| String outputString = XMLUtils.prettyDocumentToString(doc); |
| assertTrue(outputString.indexOf("counter_port_type") > 0 ? true : false); |
| return results; |
| } |
| |
| |
| } |
