xmltooling/security/X509TrustEngine.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * @file xmltooling/security/X509TrustEngine.h
  19  *
  20  * TrustEngine interface that adds validation of X.509 credentials.
  21  */
  22
  23 #if !defined(__xmltooling_x509trust_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  24 #define __xmltooling_x509trust_h__
  25
  26 #include <xmltooling/security/TrustEngine.h>
  27
  28 namespace xmltooling {
  29
  30     class XMLTOOL_API CredentialCriteria;
  31     class XMLTOOL_API CredentialResolver;
  32
  33     /**
  34      * TrustEngine interface that adds validation of X.509 credentials.
  35      */
  36     class XMLTOOL_API X509TrustEngine : public virtual TrustEngine {
  37     protected:
  38         /**
  39          * Constructor.
  40          *
  41          * If a DOM is supplied, the following XML content is supported:
  42          *
  43          * <ul>
  44          *  <li>&lt;KeyInfoResolver&gt; elements with a type attribute
  45          * </ul>
  46          *
  47          * XML namespaces are ignored in the processing of this content.
  48          *
  49          * @param e DOM to supply configuration for provider
  50          */
  51         X509TrustEngine(const xercesc::DOMElement* e=NULL) : TrustEngine(e) {}
  52
  53     public:
  54         virtual ~X509TrustEngine() {}
  55
  56         /**
  57          * Determines whether an X.509 credential is valid with respect to the
  58          * source of credentials supplied.
  59          *
  60          * <p>It is the responsibility of the application to ensure that the credentials
  61          * supplied are in fact associated with the peer who presented the credential.
  62          *
  63          * <p>If criteria with a peer name are supplied, the "name" of the EE certificate
  64          * may also be checked to ensure that it identifies the intended peer.
  65          * The peer name itself or implementation-specific rules based on the content of the
  66          * peer credentials may be applied. Implementations may omit this check if they
  67          * deem it unnecessary.
  68          *
  69          * @param certEE        end-entity certificate to validate
  70          * @param certChain     the complete set of certificates presented for validation (includes certEE)
  71          * @param credResolver  a locked resolver to supply trusted peer credentials to the TrustEngine
  72          * @param criteria      criteria for selecting peer credentials
  73          */
  74         virtual bool validate(
  75             XSECCryptoX509* certEE,
  76             const std::vector<XSECCryptoX509*>& certChain,
  77             const CredentialResolver& credResolver,
  78             CredentialCriteria* criteria=NULL
  79             ) const=0;
  80     };
  81
  82 };
  83
  84 #endif /* __xmltooling_x509trust_h__ */