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/OpenSSLTrustEngine.h
24 * Extended TrustEngine interface that adds validation of X.509 credentials
25 * using OpenSSL data types directly for efficiency.
28 #if !defined(__xmltooling_openssltrust_h__) && !defined(XMLTOOLING_NO_XMLSEC)
29 #define __xmltooling_openssltrust_h__
31 #include <xmltooling/security/X509TrustEngine.h>
33 #include <openssl/x509.h>
35 namespace xmltooling {
38 * Extended TrustEngine interface that adds validation of X.509 credentials
39 * using OpenSSL data types directly for efficiency.
41 class XMLTOOL_API OpenSSLTrustEngine : public X509TrustEngine {
46 * @param e DOM to supply configuration for provider
48 OpenSSLTrustEngine(const xercesc::DOMElement* e=nullptr);
51 virtual ~OpenSSLTrustEngine();
53 using X509TrustEngine::validate;
56 * Determines whether an X.509 credential is valid with respect to the
57 * source of credentials supplied.
59 * <p>It is the responsibility of the application to ensure that the credentials
60 * supplied are in fact associated with the peer who presented the credential.
62 * <p>If criteria with a peer name are supplied, the "name" of the EE certificate
63 * may also be checked to ensure that it identifies the intended peer.
64 * The peer name itself or implementation-specific rules based on the content of the
65 * peer credentials may be applied. Implementations may omit this check if they
66 * deem it unnecessary.
68 * @param certEE end-entity certificate to validate
69 * @param certChain the complete set of certificates presented for validation (includes certEE)
70 * @param credResolver a locked resolver to supply trusted peer credentials to the TrustEngine
71 * @param criteria criteria for selecting peer credentials
73 virtual bool validate(
74 X509* certEE, STACK_OF(X509)* certChain,
75 const CredentialResolver& credResolver,
76 CredentialCriteria* criteria=nullptr
82 #endif /* __xmltooling_openssltrust_h__ */