org.opensaml.xml.signature.impl.PKIXSignatureTrustEngine Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmltooling Show documentation
Show all versions of xmltooling Show documentation
XMLTooling-J is a low-level library that may be used to construct libraries that allow developers to work with
XML in a Java beans manner.
/*
* Licensed to the University Corporation for Advanced Internet Development,
* Inc. (UCAID) under one or more contributor license agreements. See the
* NOTICE file distributed with this work for additional information regarding
* copyright ownership. The UCAID 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.opensaml.xml.signature.impl;
import java.util.Set;
import org.opensaml.xml.security.CriteriaSet;
import org.opensaml.xml.security.SecurityException;
import org.opensaml.xml.security.SecurityHelper;
import org.opensaml.xml.security.SigningUtil;
import org.opensaml.xml.security.credential.Credential;
import org.opensaml.xml.security.keyinfo.KeyInfoCredentialResolver;
import org.opensaml.xml.security.x509.BasicX509CredentialNameEvaluator;
import org.opensaml.xml.security.x509.PKIXTrustEngine;
import org.opensaml.xml.security.x509.CertPathPKIXTrustEvaluator;
import org.opensaml.xml.security.x509.PKIXTrustEvaluator;
import org.opensaml.xml.security.x509.PKIXValidationInformation;
import org.opensaml.xml.security.x509.PKIXValidationInformationResolver;
import org.opensaml.xml.security.x509.X509Credential;
import org.opensaml.xml.security.x509.X509CredentialNameEvaluator;
import org.opensaml.xml.signature.Signature;
import org.opensaml.xml.signature.SignatureTrustEngine;
import org.opensaml.xml.util.Pair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An implementation of {@link SignatureTrustEngine} which evaluates the validity and trustworthiness of XML and raw
* signatures.
*
*
* Processing is performed as described in {@link BaseSignatureTrustEngine}. If based on this processing, it is
* determined that the Signature's KeyInfo is not present or does not contain a valid (and trusted) signing key, then
* trust engine validation fails. Since the PKIX engine is based on the assumption that trusted signing keys are not
* known in advance, the signing key must be present in, or derivable from, the information in the Signature's KeyInfo
* element.
*
*/
public class PKIXSignatureTrustEngine extends
BaseSignatureTrustEngine, Iterable>> implements
PKIXTrustEngine {
/** Class logger. */
private final Logger log = LoggerFactory.getLogger(PKIXSignatureTrustEngine.class);
/** Resolver used for resolving trusted credentials. */
private PKIXValidationInformationResolver pkixResolver;
/** The external PKIX trust evaluator used to establish trust. */
private PKIXTrustEvaluator pkixTrustEvaluator;
/** The external credential name evaluator used to establish trusted name compliance. */
private X509CredentialNameEvaluator credNameEvaluator;
/**
* Constructor.
*
* The PKIX trust evaluator used defaults to {@link CertPathPKIXTrustEvaluator}.
*
* The X.509 credential name evaluator used defaults to {@link BasicX509CredentialNameEvaluator}.
*
* @param resolver credential resolver used to resolve trusted credentials.
* @param keyInfoResolver KeyInfo credential resolver used to obtain the (advisory) signing credential from a
* Signature's KeyInfo element.
*/
public PKIXSignatureTrustEngine(PKIXValidationInformationResolver resolver,
KeyInfoCredentialResolver keyInfoResolver) {
super(keyInfoResolver);
if (resolver == null) {
throw new IllegalArgumentException("PKIX trust information resolver may not be null");
}
pkixResolver = resolver;
pkixTrustEvaluator = new CertPathPKIXTrustEvaluator();
credNameEvaluator = new BasicX509CredentialNameEvaluator();
}
/**
* Constructor.
*
* @param resolver credential resolver used to resolve trusted credentials.
* @param keyInfoResolver KeyInfo credential resolver used to obtain the (advisory) signing credential from a
* Signature's KeyInfo element.
* * @param pkixEvaluator the PKIX trust evaluator to use
* @param nameEvaluator the X.509 credential name evaluator to use (may be null)
*/
public PKIXSignatureTrustEngine(PKIXValidationInformationResolver resolver,
KeyInfoCredentialResolver keyInfoResolver, PKIXTrustEvaluator pkixEvaluator,
X509CredentialNameEvaluator nameEvaluator) {
super(keyInfoResolver);
if (resolver == null) {
throw new IllegalArgumentException("PKIX trust information resolver may not be null");
}
pkixResolver = resolver;
if (pkixEvaluator == null) {
throw new IllegalArgumentException("PKIX trust evaluator may not be null");
}
pkixTrustEvaluator = pkixEvaluator;
credNameEvaluator = nameEvaluator;
}
/**
* Get the PKIXTrustEvaluator instance used to evalute trust.
*
* The parameters of this evaluator may be modified to
* adjust trust evaluation processing.
*
* @return the PKIX trust evaluator instance that will be used
*/
public PKIXTrustEvaluator getPKIXTrustEvaluator() {
return pkixTrustEvaluator;
}
/**
* Get the X509CredentialNameEvaluator instance used to evalute a credential
* against trusted names.
*
* The parameters of this evaluator may be modified to
* adjust trust evaluation processing.
*
* @return the PKIX trust evaluator instance that will be used
*/
public X509CredentialNameEvaluator getX509CredentialNameEvaluator() {
return credNameEvaluator;
}
/** {@inheritDoc} */
public PKIXValidationInformationResolver getPKIXResolver() {
return pkixResolver;
}
/** {@inheritDoc} */
public boolean validate(Signature signature, CriteriaSet trustBasisCriteria) throws SecurityException {
checkParams(signature, trustBasisCriteria);
Pair, Iterable> validationPair =
resolveValidationInfo(trustBasisCriteria);
if (validate(signature, validationPair)) {
return true;
}
log.debug("PKIX validation of signature failed, unable to resolve valid and trusted signing key");
return false;
}
/** {@inheritDoc} */
public boolean validate(byte[] signature, byte[] content, String algorithmURI, CriteriaSet trustBasisCriteria,
Credential candidateCredential) throws SecurityException {
if (candidateCredential == null || SecurityHelper.extractVerificationKey(candidateCredential) == null) {
log.debug("Candidate credential was either not supplied or did not contain verification key");
log.debug("PKIX trust engine requires supplied key, skipping PKIX trust evaluation");
return false;
}
checkParamsRaw(signature, content, algorithmURI, trustBasisCriteria);
Pair, Iterable> validationPair =
resolveValidationInfo(trustBasisCriteria);
if (SigningUtil.verifyWithURI(candidateCredential, algorithmURI, signature, content)) {
log.debug("Successfully verified raw signature using supplied candidate credential");
log.debug("Attempting to establish trust of supplied candidate credential");
if (evaluateTrust(candidateCredential, validationPair)) {
log.debug("Successfully established trust of supplied candidate credential");
return true;
} else {
log.debug("Failed to establish trust of supplied candidate credential");
}
} else {
log.debug("Cryptographic verification of raw signature failed with candidate credential");
}
log.debug("PKIX validation of raw signature failed, "
+ "unable to establish trust of supplied verification credential");
return false;
}
/** {@inheritDoc} */
protected boolean evaluateTrust(Credential untrustedCredential,
Pair, Iterable> validationPair) throws SecurityException {
if (!(untrustedCredential instanceof X509Credential)) {
log.debug("Can not evaluate trust of non-X509Credential");
return false;
}
X509Credential untrustedX509Credential = (X509Credential) untrustedCredential;
Set trustedNames = validationPair.getFirst();
Iterable validationInfoSet = validationPair.getSecond();
if (!checkNames(trustedNames, untrustedX509Credential)) {
log.debug("Evaluation of credential against trusted names failed. Aborting PKIX validation");
return false;
}
for (PKIXValidationInformation validationInfo : validationInfoSet) {
try {
if (pkixTrustEvaluator.validate(validationInfo, untrustedX509Credential)) {
log.debug("Signature trust established via PKIX validation of signing credential");
return true;
}
} catch (SecurityException e) {
// log the operational error, but allow other validation info sets to be tried
log.debug("Error performing PKIX validation on untrusted credential", e);
}
}
log.debug("Signature trust could not be established via PKIX validation of signing credential");
return false;
}
/**
* Resolve and return a set of trusted validation information.
*
* @param trustBasisCriteria criteria used to describe and/or resolve the information which serves as the basis for
* trust evaluation
* @return a pair consisting of an optional set of trusted names, and an iterable of trusted
* PKIXValidationInformation
* @throws SecurityException thrown if there is an error resolving the information from the trusted resolver
*/
protected Pair, Iterable> resolveValidationInfo(
CriteriaSet trustBasisCriteria) throws SecurityException {
Set trustedNames = null;
if (pkixResolver.supportsTrustedNameResolution()) {
trustedNames = pkixResolver.resolveTrustedNames(trustBasisCriteria);
} else {
log.debug("PKIX resolver does not support resolution of trusted names, skipping name checking");
}
Iterable validationInfoSet = pkixResolver.resolve(trustBasisCriteria);
Pair, Iterable> validationPair =
new Pair, Iterable>(trustedNames, validationInfoSet);
return validationPair;
}
/**
* Evaluate the credential against the set of trusted names.
*
* Evaluates to true if no intsance of {@link X509CredentialNameEvaluator} is configured.
*
* @param trustedNames set of trusted names
* @param untrustedCredential the credential being evaluated
* @return true if evaluation is successful, false otherwise
* @throws SecurityException thrown if there is an error evaluation the credential
*/
protected boolean checkNames(Set trustedNames, X509Credential untrustedCredential)
throws SecurityException {
if (credNameEvaluator == null) {
log.debug("No credential name evaluator was available, skipping trusted name evaluation");
return true;
} else {
return credNameEvaluator.evaluate(untrustedCredential, trustedNames);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy