org.apache.wss4j.policy.stax.assertionStates.SignatureProtectionAssertionState Maven / Gradle / Ivy
/**
* 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.policy.stax.assertionStates;
import org.apache.wss4j.policy.AssertionState;
import org.apache.wss4j.policy.SPConstants;
import org.apache.wss4j.common.WSSPolicyException;
import org.apache.wss4j.policy.model.AbstractSecurityAssertion;
import org.apache.wss4j.policy.model.AbstractSymmetricAsymmetricBinding;
import org.apache.xml.security.exceptions.XMLSecurityException;
import org.apache.xml.security.stax.securityEvent.EncryptedElementSecurityEvent;
import org.apache.xml.security.stax.securityEvent.SecurityEvent;
import org.apache.xml.security.stax.securityEvent.SecurityEventConstants;
import org.apache.xml.security.stax.securityEvent.TokenSecurityEvent;
import org.apache.xml.security.stax.securityToken.SecurityToken;
import org.apache.wss4j.policy.stax.Assertable;
import org.apache.wss4j.policy.stax.DummyPolicyAsserter;
import org.apache.wss4j.policy.stax.PolicyAsserter;
import org.apache.wss4j.stax.ext.WSSConstants;
import org.apache.wss4j.stax.securityEvent.WSSecurityEventConstants;
import org.apache.wss4j.stax.securityToken.WSSecurityTokenConstants;
import org.apache.wss4j.stax.utils.WSSUtils;
import javax.xml.namespace.QName;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
/**
* WSP1.3, 6.4 Signature Protection Property
*/
public class SignatureProtectionAssertionState extends AssertionState implements Assertable {
private final List encryptedElementEvents = new ArrayList<>();
private final List> tokenSecurityEvents = new ArrayList<>();
private final List> elementPaths = new ArrayList<>();
private PolicyAsserter policyAsserter;
public SignatureProtectionAssertionState(AbstractSecurityAssertion assertion,
PolicyAsserter policyAsserter,
boolean asserted) {
super(assertion, asserted);
List signature11Path = new LinkedList<>();
signature11Path.addAll(WSSConstants.SOAP_11_HEADER_PATH);
signature11Path.add(WSSConstants.TAG_WSSE_SECURITY);
signature11Path.add(WSSConstants.TAG_dsig_Signature);
elementPaths.add(signature11Path);
List signatureConfirmation11Path = new LinkedList<>();
signatureConfirmation11Path.addAll(WSSConstants.SOAP_11_HEADER_PATH);
signatureConfirmation11Path.add(WSSConstants.TAG_WSSE_SECURITY);
signatureConfirmation11Path.add(WSSConstants.TAG_WSSE11_SIG_CONF);
elementPaths.add(signatureConfirmation11Path);
this.policyAsserter = policyAsserter;
if (this.policyAsserter == null) {
this.policyAsserter = new DummyPolicyAsserter();
}
if (asserted) {
String namespace = getAssertion().getName().getNamespaceURI();
policyAsserter.assertPolicy(new QName(namespace, SPConstants.ENCRYPT_SIGNATURE));
}
}
@Override
public SecurityEventConstants.Event[] getSecurityEventType() {
return new SecurityEventConstants.Event[]{
WSSecurityEventConstants.EncryptedElement,
WSSecurityEventConstants.EncryptedKeyToken,
WSSecurityEventConstants.ISSUED_TOKEN,
WSSecurityEventConstants.KERBEROS_TOKEN,
SecurityEventConstants.KeyValueToken,
WSSecurityEventConstants.REL_TOKEN,
WSSecurityEventConstants.SAML_TOKEN,
WSSecurityEventConstants.SECURITY_CONTEXT_TOKEN,
WSSecurityEventConstants.USERNAME_TOKEN,
SecurityEventConstants.X509Token,
WSSecurityEventConstants.OPERATION,
};
}
@Override
public boolean assertEvent(SecurityEvent securityEvent) throws WSSPolicyException {
if (securityEvent instanceof EncryptedElementSecurityEvent) {
EncryptedElementSecurityEvent encryptedElementSecurityEvent =
(EncryptedElementSecurityEvent) securityEvent;
// Store all matching Signature/SignatureConfirmation Elements
Iterator> pathElementsIterator = elementPaths.iterator();
while (pathElementsIterator.hasNext()) {
List qNameList = pathElementsIterator.next();
if (WSSUtils.pathMatches(qNameList, encryptedElementSecurityEvent.getElementPath(), true, false)) {
encryptedElementEvents.add(encryptedElementSecurityEvent);
}
}
} else if (securityEvent instanceof TokenSecurityEvent) {
@SuppressWarnings("unchecked")
TokenSecurityEvent tokenSecurityEvent
= (TokenSecurityEvent) securityEvent;
tokenSecurityEvents.add(tokenSecurityEvent);
}
return true;
}
@Override
public boolean isAsserted() {
clearErrorMessage();
// If we only have one (main) Signature, then check that it matches the policy
if (encryptedElementEvents.size() == 1) {
return testEncryptedSignature(encryptedElementEvents.get(0));
} else if (encryptedElementEvents.size() > 1) {
// Otherwise we only check the policy for the main Signature
String endorsingSignatureId = findEndorsingSignatureId();
for (EncryptedElementSecurityEvent encryptedElementSecurityEvent : encryptedElementEvents) {
String elementId = encryptedElementSecurityEvent.getCorrelationID();
if (endorsingSignatureId != null && endorsingSignatureId.equals(elementId)) {
// Skip this Endorsing Signature
continue;
}
if (!testEncryptedSignature(encryptedElementSecurityEvent)) {
return false;
}
}
}
return true;
}
private String findEndorsingSignatureId() {
for (int i = 0; i < tokenSecurityEvents.size(); i++) {
TokenSecurityEvent tokenSecurityEvent = tokenSecurityEvents.get(i);
try {
SecurityToken securityToken =
getEffectiveSignatureToken(tokenSecurityEvent.getSecurityToken());
if (isSignatureToken(securityToken) && !isMainSignatureToken(securityToken)) {
return tokenSecurityEvent.getCorrelationID();
}
} catch (XMLSecurityException e) {
// Just return null here
return null;
}
}
return null;
}
private boolean isSignatureToken(SecurityToken securityToken) {
List tokenUsages = securityToken.getTokenUsages();
for (int i = 0; i < tokenUsages.size(); i++) {
WSSecurityTokenConstants.TokenUsage tokenUsage = tokenUsages.get(i);
if (WSSecurityTokenConstants.TokenUsage_Signature.equals(tokenUsage)
|| WSSecurityTokenConstants.TOKENUSAGE_MAIN_SIGNATURE.equals(tokenUsage)
|| tokenUsage.getName().contains("Endorsing")) {
return true;
}
}
return false;
}
private boolean isMainSignatureToken(SecurityToken securityToken) throws XMLSecurityException {
SecurityToken rootToken = WSSUtils.getRootToken(securityToken);
List tokenUsages = rootToken.getTokenUsages();
return tokenUsages.contains(WSSecurityTokenConstants.TOKENUSAGE_MAIN_SIGNATURE);
}
private SecurityToken getEffectiveSignatureToken(SecurityToken securityToken) throws XMLSecurityException {
SecurityToken tmp = WSSUtils.getRootToken(securityToken);
List wrappedTokens = tmp.getWrappedTokens();
for (int i = 0; i < wrappedTokens.size(); i++) {
SecurityToken token = wrappedTokens.get(i);
if (isSignatureToken(token)) {
//WSP 1.3, 6.5 [Token Protection] Property: Note that in cases where derived keys are used
//the 'main' token, and NOT the derived key token, is covered by the signature.
if (WSSecurityTokenConstants.DerivedKeyToken.equals(token.getTokenType())) {
return tmp;
}
tmp = token;
}
}
return tmp;
}
private boolean testEncryptedSignature(EncryptedElementSecurityEvent encryptedElementSecurityEvent) {
AbstractSymmetricAsymmetricBinding abstractSymmetricAsymmetricBinding =
(AbstractSymmetricAsymmetricBinding) getAssertion();
String namespace = getAssertion().getName().getNamespaceURI();
if (encryptedElementSecurityEvent.isEncrypted()) {
if (abstractSymmetricAsymmetricBinding.isEncryptSignature()) {
setAsserted(true);
policyAsserter.assertPolicy(new QName(namespace, SPConstants.ENCRYPT_SIGNATURE));
return true;
} else {
setAsserted(false);
setErrorMessage("Element " + WSSUtils.pathAsString(encryptedElementSecurityEvent.getElementPath())
+ " must not be encrypted");
policyAsserter.unassertPolicy(new QName(namespace, SPConstants.ENCRYPT_SIGNATURE),
getErrorMessage());
return false;
}
} else {
if (abstractSymmetricAsymmetricBinding.isEncryptSignature()) {
setAsserted(false);
setErrorMessage("Element " + WSSUtils.pathAsString(encryptedElementSecurityEvent.getElementPath())
+ " must be encrypted");
policyAsserter.unassertPolicy(new QName(namespace, SPConstants.ENCRYPT_SIGNATURE),
getErrorMessage());
return false;
} else {
setAsserted(true);
policyAsserter.assertPolicy(new QName(namespace, SPConstants.ENCRYPT_SIGNATURE));
return true;
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy