/**
* 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.cxf.ws.security.wss4j.policyvalidators;
import java.security.cert.X509Certificate;
import java.util.Collection;
import java.util.List;
import org.w3c.dom.Element;
import org.apache.cxf.message.Message;
import org.apache.cxf.ws.policy.AssertionInfo;
import org.apache.cxf.ws.policy.AssertionInfoMap;
import org.apache.wss4j.dom.WSConstants;
import org.apache.wss4j.dom.WSSecurityEngineResult;
import org.apache.wss4j.policy.SPConstants;
import org.apache.wss4j.policy.model.AbstractToken;
import org.apache.wss4j.policy.model.AbstractTokenWrapper;
import org.apache.wss4j.policy.model.AsymmetricBinding;
import org.apache.wss4j.policy.model.X509Token;
/**
* Validate an AsymmetricBinding policy.
*/
public class AsymmetricBindingPolicyValidator extends AbstractBindingPolicyValidator {
public boolean validatePolicy(
AssertionInfoMap aim,
Message message,
Element soapBody,
List<WSSecurityEngineResult> results,
List<WSSecurityEngineResult> signedResults,
List<WSSecurityEngineResult> encryptedResults
) {
Collection<AssertionInfo> ais = getAllAssertionsByLocalname(aim, SPConstants.ASYMMETRIC_BINDING);
if (!ais.isEmpty()) {
parsePolicies(aim, ais, message, soapBody, results, signedResults, encryptedResults);
}
return true;
}
private void parsePolicies(
AssertionInfoMap aim,
Collection<AssertionInfo> ais,
Message message,
Element soapBody,
List<WSSecurityEngineResult> results,
List<WSSecurityEngineResult> signedResults,
List<WSSecurityEngineResult> encryptedResults
) {
boolean hasDerivedKeys = false;
for (WSSecurityEngineResult result : results) {
Integer actInt = (Integer)result.get(WSSecurityEngineResult.TAG_ACTION);
if (actInt.intValue() == WSConstants.DKT) {
hasDerivedKeys = true;
break;
}
}
for (AssertionInfo ai : ais) {
AsymmetricBinding binding = (AsymmetricBinding)ai.getAssertion();
ai.setAsserted(true);
// Check the protection order
if (!checkProtectionOrder(binding, aim, ai, results)) {
continue;
}
// Check various properties of the binding
if (!checkProperties(binding, ai, aim, results, signedResults, message)) {
continue;
}
// Check various tokens of the binding
if (!checkTokens(binding, ai, aim, hasDerivedKeys, signedResults, encryptedResults)) {
continue;
}
}
}
/**
* Check various tokens of the binding
*/
private boolean checkTokens(
AsymmetricBinding binding,
AssertionInfo ai,
AssertionInfoMap aim,
boolean hasDerivedKeys,
List<WSSecurityEngineResult> signedResults,
List<WSSecurityEngineResult> encryptedResults
) {
boolean result = true;
if (binding.getInitiatorToken() != null) {
result &= checkInitiatorTokens(binding.getInitiatorToken(), binding, ai, aim, hasDerivedKeys,
signedResults, encryptedResults);
}
if (binding.getInitiatorSignatureToken() != null) {
result &= checkInitiatorTokens(binding.getInitiatorSignatureToken(), binding, ai, aim,
hasDerivedKeys, signedResults, encryptedResults);
}
if (binding.getInitiatorEncryptionToken() != null) {
result &= checkInitiatorTokens(binding.getInitiatorEncryptionToken(), binding, ai, aim,
hasDerivedKeys, signedResults, encryptedResults);
}
if (binding.getRecipientToken() != null) {
result &= checkRecipientTokens(binding.getRecipientToken(), binding, ai, aim, hasDerivedKeys,
signedResults, encryptedResults);
}
if (binding.getRecipientSignatureToken() != null) {
result &= checkRecipientTokens(binding.getRecipientSignatureToken(), binding, ai, aim,
hasDerivedKeys, signedResults, encryptedResults);
}
if (binding.getRecipientEncryptionToken() != null) {
result &= checkRecipientTokens(binding.getRecipientEncryptionToken(), binding, ai, aim,
hasDerivedKeys, signedResults, encryptedResults);
}
return result;
}
private boolean checkInitiatorTokens(
AbstractTokenWrapper wrapper,
AsymmetricBinding binding,
AssertionInfo ai,
AssertionInfoMap aim,
boolean hasDerivedKeys,
List<WSSecurityEngineResult> signedResults,
List<WSSecurityEngineResult> encryptedResults) {
AbstractToken token = wrapper.getToken();
if (token instanceof X509Token) {
boolean foundCert = false;
for (WSSecurityEngineResult result : signedResults) {
X509Certificate cert = (X509Certificate)result
.get(WSSecurityEngineResult.TAG_X509_CERTIFICATE);
if (cert != null) {
foundCert = true;
break;
}
}
if (!foundCert && !signedResults.isEmpty()) {
String error = "An X.509 certificate was not used for the " + wrapper.getName();
notAssertPolicy(aim, wrapper.getName(), error);
ai.setNotAsserted(error);
return false;
}
}
assertPolicy(aim, wrapper);
if (!checkDerivedKeys(wrapper, hasDerivedKeys, signedResults, encryptedResults)) {
ai.setNotAsserted("Message fails the DerivedKeys requirement");
return false;
}
assertPolicy(aim, SPConstants.REQUIRE_DERIVED_KEYS);
assertPolicy(aim, SPConstants.REQUIRE_IMPLIED_DERIVED_KEYS);
assertPolicy(aim, SPConstants.REQUIRE_EXPLICIT_DERIVED_KEYS);
return true;
}
private boolean checkRecipientTokens(
AbstractTokenWrapper wrapper,
AsymmetricBinding binding,
AssertionInfo ai,
AssertionInfoMap aim,
boolean hasDerivedKeys,
List<WSSecurityEngineResult> signedResults,
List<WSSecurityEngineResult> encryptedResults) {
assertPolicy(aim, wrapper);
if (!checkDerivedKeys(wrapper, hasDerivedKeys, signedResults, encryptedResults)) {
ai.setNotAsserted("Message fails the DerivedKeys requirement");
return false;
}
assertPolicy(aim, SPConstants.REQUIRE_DERIVED_KEYS);
assertPolicy(aim, SPConstants.REQUIRE_IMPLIED_DERIVED_KEYS);
assertPolicy(aim, SPConstants.REQUIRE_EXPLICIT_DERIVED_KEYS);
return true;
}
}