2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * @file xmltooling/security/AbstractPKIXTrustEngine.h
24 * A trust engine that uses X.509 trust anchors and CRLs associated with a peer
25 * to perform PKIX validation of signatures and credentials.
28 #if !defined(__xmltooling_pkixtrust_h__) && !defined(XMLTOOLING_NO_XMLSEC)
29 #define __xmltooling_pkixtrust_h__
31 #include <xmltooling/security/OpenSSLTrustEngine.h>
32 #include <xmltooling/security/SignatureTrustEngine.h>
37 namespace xmltooling {
39 class XMLTOOL_API XSECCryptoX509CRL;
42 * A trust engine that uses X.509 trust anchors and CRLs associated with a peer
43 * to perform PKIX validation of signatures and credentials.
45 class XMLTOOL_API AbstractPKIXTrustEngine : public SignatureTrustEngine, public OpenSSLTrustEngine
51 * If a DOM is supplied, the following XML content is supported:
54 * <li>checkRevocation attribute (off, entityOnly, fullChain)
55 * <li>policyMappingInhibit attribute (boolean)
56 * <li>anyPolicyInhibit attribute (boolean)
57 * <li><TrustedName> element (zero or more)
58 * <li><PolicyOID> element (zero or more)
61 * @param e DOM to supply configuration for provider
63 AbstractPKIXTrustEngine(const xercesc::DOMElement* e=nullptr);
65 /** Controls revocation checking, currently limited to CRLs and supports "off", "entityOnly", "fullChain". */
66 std::string m_checkRevocation;
68 /** Deprecated option, equivalent to checkRevocation="fullChain". */
71 /** Disable policy mapping when applying PKIX policy checking. */
72 bool m_policyMappingInhibit;
74 /** Disallow the anyPolicy OID (2.5.29.32.0) when applying PKIX policy checking. */
75 bool m_anyPolicyInhibit;
77 /** A list of acceptable policy OIDs (explicit policy checking). */
78 std::set<std::string> m_policyOIDs;
80 /** A list of trusted names (subject DNs / CN attributes / subjectAltName entries). */
81 std::set<std::string> m_trustedNames;
84 * Checks that either the name of the peer with the given credentials or the names
85 * of the credentials match the subject or subject alternate names of the certificate.
86 * Alternatively explicit trusted names can be supplied statically via configuration.
88 * @param certEE the credential for the entity to validate
89 * @param credResolver source of trusted credentials
90 * @param criteria criteria for selecting credentials, including the peer name
92 * @return true the name check succeeds, false if not
94 bool checkEntityNames(X509* certEE, const CredentialResolver& credResolver, const CredentialCriteria& criteria) const;
97 virtual ~AbstractPKIXTrustEngine();
100 xmlsignature::Signature& sig,
101 const CredentialResolver& credResolver,
102 CredentialCriteria* criteria=nullptr
106 const XMLCh* sigAlgorithm,
108 xmlsignature::KeyInfo* keyInfo,
111 const CredentialResolver& credResolver,
112 CredentialCriteria* criteria=nullptr
116 XSECCryptoX509* certEE,
117 const std::vector<XSECCryptoX509*>& certChain,
118 const CredentialResolver& credResolver,
119 CredentialCriteria* criteria=nullptr
124 STACK_OF(X509)* certChain,
125 const CredentialResolver& credResolver,
126 CredentialCriteria* criteria=nullptr
130 * Stateful interface that supplies PKIX validation data to the trust engine.
131 * Applications can adapt this TrustEngine to their environment by returning
132 * implementations of this interface from the getPKIXValidationInfoIterator
135 class XMLTOOL_API PKIXValidationInfoIterator {
136 MAKE_NONCOPYABLE(PKIXValidationInfoIterator);
138 PKIXValidationInfoIterator();
141 virtual ~PKIXValidationInfoIterator();
144 * Advances to the next set of information, if any.
146 * @return true iff another set of information is available
148 virtual bool next()=0;
151 * Returns the allowable trust chain verification depth for the
152 * validation data in the current position.
154 * @return allowable trust chain verification depth
156 virtual int getVerificationDepth() const=0;
159 * Returns the set of trust anchors for the validation data in the
160 * current position. Keeping the certificates beyond the lifetime
161 * of the iterator or after advancing to the next position requires
164 * @return set of trust anchors
166 virtual const std::vector<XSECCryptoX509*>& getTrustAnchors() const=0;
169 * Returns the set of CRLs for the validation data in the
170 * current position. Keeping the CRLs beyond the lifetime
171 * of the iterator or after advancing to the next position requires
174 * @return set of CRLs
176 virtual const std::vector<XSECCryptoX509CRL*>& getCRLs() const=0;
180 * Provides access to the information necessary, for the given credential source, for
181 * PKIX validation of credentials. Each set of validation information returned
182 * will be tried, in turn, until one succeeds or no more remain.
183 * The caller must free the returned interface when finished with it.
185 * @param pkixSource the peer for which validation rules are required
186 * @param criteria criteria for selecting validation rules
187 * @return interface for obtaining validation data
189 virtual PKIXValidationInfoIterator* getPKIXValidationInfoIterator(
190 const CredentialResolver& pkixSource, CredentialCriteria* criteria=nullptr
194 bool validateWithCRLs(
196 STACK_OF(X509)* certChain,
197 const CredentialResolver& credResolver,
198 CredentialCriteria* criteria=nullptr,
199 const std::vector<XSECCryptoX509CRL*>* inlineCRLs=nullptr
204 #endif /* __xmltooling_pkixtrust_h__ */