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