2 * Copyright 2001-2007 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/AbstractPKIXTrustEngine.h
20 * A trust engine that uses X.509 trust anchors and CRLs associated with a peer
21 * to perform PKIX validation of signatures and credentials.
24 #if !defined(__xmltooling_pkixtrust_h__) && !defined(XMLTOOLING_NO_XMLSEC)
25 #define __xmltooling_pkixtrust_h__
27 #include <xmltooling/security/OpenSSLTrustEngine.h>
28 #include <xmltooling/security/XSECCryptoX509CRL.h>
30 namespace xmltooling {
33 * A trust engine that uses X.509 trust anchors and CRLs associated with a peer
34 * to perform PKIX validation of signatures and credentials.
36 class XMLTOOL_API AbstractPKIXTrustEngine : public OpenSSLTrustEngine
42 * If a DOM is supplied, the following XML content is supported:
45 * <li><KeyInfoResolver> elements with a type attribute
48 * XML namespaces are ignored in the processing of this content.
50 * @param e DOM to supply configuration for provider
52 AbstractPKIXTrustEngine(const xercesc::DOMElement* e=NULL) : OpenSSLTrustEngine(e) {}
55 * Checks that either the name of the peer with the given credentials or the names
56 * of the credentials match the subject or subject alternate names of the certificate.
58 * @param certEE the credential for the entity to validate
59 * @param credResolver source of credentials
60 * @param criteria criteria for selecting credentials, including the peer name
62 * @return true the name check succeeds, false if not
64 bool checkEntityNames(X509* certEE, const CredentialResolver& credResolver, const CredentialCriteria& criteria) const;
67 virtual ~AbstractPKIXTrustEngine() {}
70 xmlsignature::Signature& sig,
71 const CredentialResolver& credResolver,
72 CredentialCriteria* criteria=NULL
76 const XMLCh* sigAlgorithm,
78 xmlsignature::KeyInfo* keyInfo,
81 const CredentialResolver& credResolver,
82 CredentialCriteria* criteria=NULL
86 XSECCryptoX509* certEE,
87 const std::vector<XSECCryptoX509*>& certChain,
88 const CredentialResolver& credResolver,
89 CredentialCriteria* criteria=NULL
94 STACK_OF(X509)* certChain,
95 const CredentialResolver& credResolver,
96 CredentialCriteria* criteria=NULL
100 * Stateful interface that supplies PKIX validation data to the trust engine.
101 * Applications can adapt this TrustEngine to their environment by returning
102 * implementations of this interface from the getPKIXValidationInfoIterator
105 class XMLTOOL_API PKIXValidationInfoIterator {
106 MAKE_NONCOPYABLE(PKIXValidationInfoIterator);
108 PKIXValidationInfoIterator() {}
111 virtual ~PKIXValidationInfoIterator() {}
114 * Advances to the next set of information, if any.
116 * @return true iff another set of information is available
118 virtual bool next()=0;
121 * Returns the allowable trust chain verification depth for the
122 * validation data in the current position.
124 * @return allowable trust chain verification depth
126 virtual int getVerificationDepth() const=0;
129 * Returns the set of trust anchors for the validation data in the
130 * current position. Keeping the certificates beyond the lifetime
131 * of the iterator or after advancing to the next position requires
134 * @return set of trust anchors
136 virtual const std::vector<XSECCryptoX509*>& getTrustAnchors() const=0;
139 * Returns the set of CRLs for the validation data in the
140 * current position. Keeping the CRLs beyond the lifetime
141 * of the iterator or after advancing to the next position requires
144 * @return set of CRLs
146 virtual const std::vector<XSECCryptoX509CRL*>& getCRLs() const=0;
150 * Provides access to the information necessary, for the given credential source, for
151 * PKIX validation of credentials. Each set of validation information returned
152 * will be tried, in turn, until one succeeds or no more remain.
153 * The caller must free the returned interface when finished with it.
155 * @param pkixSource the peer for which validation rules are required
156 * @param criteria criteria for selecting validation rules
157 * @return interface for obtaining validation data
159 virtual PKIXValidationInfoIterator* getPKIXValidationInfoIterator(
160 const CredentialResolver& pkixSource, CredentialCriteria* criteria=NULL
165 #endif /* __xmltooling_pkixtrust_h__ */