2 * Copyright 2001-2009 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * @file xmltooling/security/X509TrustEngine.h
20 * TrustEngine interface that adds validation of X.509 credentials.
23 #if !defined(__xmltooling_x509trust_h__) && !defined(XMLTOOLING_NO_XMLSEC)
24 #define __xmltooling_x509trust_h__
26 #include <xmltooling/security/TrustEngine.h>
32 namespace xmltooling {
34 class XMLTOOL_API CredentialCriteria;
35 class XMLTOOL_API CredentialResolver;
38 * TrustEngine interface that adds validation of X.509 credentials.
40 class XMLTOOL_API X509TrustEngine : public virtual TrustEngine {
45 * If a DOM is supplied, the following XML content is supported:
48 * <li><KeyInfoResolver> elements with a type attribute
51 * XML namespaces are ignored in the processing of this content.
53 * @param e DOM to supply configuration for provider
55 X509TrustEngine(const xercesc::DOMElement* e=NULL);
58 virtual ~X509TrustEngine();
61 * Determines whether an X.509 credential is valid with respect to the
62 * source of credentials supplied.
64 * <p>It is the responsibility of the application to ensure that the credentials
65 * supplied are in fact associated with the peer who presented the credential.
67 * <p>If criteria with a peer name are supplied, the "name" of the EE certificate
68 * may also be checked to ensure that it identifies the intended peer.
69 * The peer name itself or implementation-specific rules based on the content of the
70 * peer credentials may be applied. Implementations may omit this check if they
71 * deem it unnecessary.
73 * @param certEE end-entity certificate to validate
74 * @param certChain the complete set of certificates presented for validation (includes certEE)
75 * @param credResolver a locked resolver to supply trusted peer credentials to the TrustEngine
76 * @param criteria criteria for selecting peer credentials
78 virtual bool validate(
79 XSECCryptoX509* certEE,
80 const std::vector<XSECCryptoX509*>& certChain,
81 const CredentialResolver& credResolver,
82 CredentialCriteria* criteria=NULL
88 #endif /* __xmltooling_x509trust_h__ */