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/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/SignatureTrustEngine.h>
30 namespace xmltooling {
32 class XMLTOOL_API XSECCryptoX509CRL;
35 * A trust engine that uses X.509 trust anchors and CRLs associated with a peer
36 * to perform PKIX validation of signatures and credentials.
38 class XMLTOOL_API AbstractPKIXTrustEngine : public SignatureTrustEngine, public OpenSSLTrustEngine
44 * If a DOM is supplied, the following XML content is supported:
47 * <li>fullCRLChain boolean attribute
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 AbstractPKIXTrustEngine(const xercesc::DOMElement* e=NULL);
57 /** Flag controls whether every issuer in the trust path must have a CRL loaded. */
61 * Checks that either the name of the peer with the given credentials or the names
62 * of the credentials match the subject or subject alternate names of the certificate.
64 * @param certEE the credential for the entity to validate
65 * @param credResolver source of credentials
66 * @param criteria criteria for selecting credentials, including the peer name
68 * @return true the name check succeeds, false if not
70 bool checkEntityNames(X509* certEE, const CredentialResolver& credResolver, const CredentialCriteria& criteria) const;
73 virtual ~AbstractPKIXTrustEngine();
76 xmlsignature::Signature& sig,
77 const CredentialResolver& credResolver,
78 CredentialCriteria* criteria=NULL
82 const XMLCh* sigAlgorithm,
84 xmlsignature::KeyInfo* keyInfo,
87 const CredentialResolver& credResolver,
88 CredentialCriteria* criteria=NULL
92 XSECCryptoX509* certEE,
93 const std::vector<XSECCryptoX509*>& certChain,
94 const CredentialResolver& credResolver,
95 CredentialCriteria* criteria=NULL
100 STACK_OF(X509)* certChain,
101 const CredentialResolver& credResolver,
102 CredentialCriteria* criteria=NULL
106 * Stateful interface that supplies PKIX validation data to the trust engine.
107 * Applications can adapt this TrustEngine to their environment by returning
108 * implementations of this interface from the getPKIXValidationInfoIterator
111 class XMLTOOL_API PKIXValidationInfoIterator {
112 MAKE_NONCOPYABLE(PKIXValidationInfoIterator);
114 PKIXValidationInfoIterator();
117 virtual ~PKIXValidationInfoIterator();
120 * Advances to the next set of information, if any.
122 * @return true iff another set of information is available
124 virtual bool next()=0;
127 * Returns the allowable trust chain verification depth for the
128 * validation data in the current position.
130 * @return allowable trust chain verification depth
132 virtual int getVerificationDepth() const=0;
135 * Returns the set of trust anchors for the validation data in the
136 * current position. Keeping the certificates beyond the lifetime
137 * of the iterator or after advancing to the next position requires
140 * @return set of trust anchors
142 virtual const std::vector<XSECCryptoX509*>& getTrustAnchors() const=0;
145 * Returns the set of CRLs for the validation data in the
146 * current position. Keeping the CRLs beyond the lifetime
147 * of the iterator or after advancing to the next position requires
150 * @return set of CRLs
152 virtual const std::vector<XSECCryptoX509CRL*>& getCRLs() const=0;
156 * Provides access to the information necessary, for the given credential source, for
157 * PKIX validation of credentials. Each set of validation information returned
158 * will be tried, in turn, until one succeeds or no more remain.
159 * The caller must free the returned interface when finished with it.
161 * @param pkixSource the peer for which validation rules are required
162 * @param criteria criteria for selecting validation rules
163 * @return interface for obtaining validation data
165 virtual PKIXValidationInfoIterator* getPKIXValidationInfoIterator(
166 const CredentialResolver& pkixSource, CredentialCriteria* criteria=NULL
170 bool validateWithCRLs(
172 STACK_OF(X509)* certChain,
173 const CredentialResolver& credResolver,
174 CredentialCriteria* criteria=NULL,
175 const std::vector<XSECCryptoX509CRL*>* inlineCRLs=NULL
180 #endif /* __xmltooling_pkixtrust_h__ */