xmltooling/security/TrustEngine.h

   1 /*
   2  *  Copyright 2001-2006 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/TrustEngine.h
  19  *
  20  * Evaluates the trustworthiness and validity of XML Signatures against
  21  * implementation-specific requirements.
  22  */
  23
  24 #if !defined(__xmltooling_trust_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  25 #define __xmltooling_trust_h__
  26
  27 #include <xmltooling/signature/KeyResolver.h>
  28 #include <xmltooling/signature/Signature.h>
  29
  30 namespace xmltooling {
  31
  32     /**
  33      * Evaluates the trustworthiness and validity of XML Signatures against
  34      * implementation-specific requirements.
  35      */
  36     class XMLTOOL_API TrustEngine {
  37         MAKE_NONCOPYABLE(TrustEngine);
  38     protected:
  39         /**
  40          * Constructor.
  41          *
  42          * If a DOM is supplied, the following XML content is supported:
  43          *
  44          * <ul>
  45          *  <li>&lt;KeyResolver&gt; elements with a type attribute
  46          * </ul>
  47          *
  48          * XML namespaces are ignored in the processing of this content.
  49          *
  50          * @param e DOM to supply configuration for provider
  51          */
  52         TrustEngine(const DOMElement* e=NULL);
  53
  54         /** Default KeyResolver instance. */
  55         xmlsignature::KeyResolver* m_keyResolver;
  56
  57     public:
  58         virtual ~TrustEngine();
  59
  60         /**
  61          * Callback interface to supply KeyInfo objects to a TrustEngine.
  62          * Applications can adapt TrustEngines to their environment by supplying
  63          * implementations of this interface, or create specialized TrustEngine APIs
  64          * by combining a KeyInfoIterator with a delegated TrustEngine.
  65          */
  66         class XMLTOOL_API KeyInfoIterator {
  67             MAKE_NONCOPYABLE(KeyInfoIterator);
  68         protected:
  69             KeyInfoIterator() {}
  70         public:
  71             virtual ~KeyInfoIterator() {}
  72
  73             /**
  74              * Indicates whether additional KeyInfo objects are available.
  75              *
  76              * @return true iff another KeyInfo object can be fetched
  77              */
  78             virtual bool hasNext() const=0;
  79
  80             /**
  81              * Returns the next KeyInfo object available.
  82              *
  83              * @return the next KeyInfo object, or NULL if none are left
  84              */
  85             virtual const xmlsignature::KeyInfo* next()=0;
  86         };
  87
  88         /**
  89          * Determines whether a signature is correct and valid with respect to the
  90          * KeyInfo data supplied. It is the responsibility of the application to
  91          * ensure that the KeyInfo information supplied is in fact associated with
  92          * the peer who created the signature.
  93          *
  94          * A custom KeyResolver can be supplied from outside the TrustEngine.
  95          * Alternatively, one may be specified to the plugin constructor.
  96          * A non-caching, inline resolver will be used as a fallback.
  97          *
  98          * @param sig           reference to a signature object to validate
  99          * @param keyInfoSource supplies KeyInfo objects to the TrustEngine
 100          * @param keyResolver   optional externally supplied KeyResolver, or NULL
 101          */
 102         virtual bool validate(
 103             xmlsignature::Signature& sig,
 104             KeyInfoIterator& keyInfoSource,
 105             const xmlsignature::KeyResolver* keyResolver=NULL
 106             ) const=0;
 107     };
 108
 109     /**
 110      * Registers TrustEngine classes into the runtime.
 111      */
 112     void XMLTOOL_API registerTrustEngines();
 113
 114     /** TrustEngine based on explicit knowledge of peer key information. */
 115     #define EXPLICIT_KEY_TRUSTENGINE  "org.opensaml.xmlooling.security.ExplicitKeyTrustEngine"
 116 };
 117
 118 #endif /* __xmltooling_trust_h__ */