Convert from NULL macro to nullptr.

[shibboleth/cpp-xmltooling.git] / xmltooling / security / TrustEngine.h

diff --git a/xmltooling/security/TrustEngine.h b/xmltooling/security/TrustEngine.h
index e582fd0..6c25ec4 100644 (file)
--- a/xmltooling/security/TrustEngine.h
+++ b/xmltooling/security/TrustEngine.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2007 Internet2
+ *  Copyright 2001-2010 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,21 +17,22 @@
 /**
  * @file xmltooling/security/TrustEngine.h
  * 
- * Evaluates the trustworthiness and validity of XML Signatures against
+ * Evaluates the trustworthiness and validity of security information against
  * implementation-specific requirements.
  */
 
 #if !defined(__xmltooling_trust_h__) && !defined(XMLTOOLING_NO_XMLSEC)
 #define __xmltooling_trust_h__
 
-#include <xmltooling/security/KeyInfoSource.h>
-#include <xmltooling/signature/KeyResolver.h>
-#include <xmltooling/signature/Signature.h>
+#include <xmltooling/base.h>
+#include <xercesc/dom/DOM.hpp>
 
 namespace xmltooling {
 
+    class XMLTOOL_API KeyInfoResolver;
+
     /**
-     * Evaluates the trustworthiness and validity of XML or raw Signatures against
+     * Evaluates the trustworthiness and validity of security information against
      * implementation-specific requirements.
      */
     class XMLTOOL_API TrustEngine {
@@ -43,74 +44,29 @@ namespace xmltooling {
          * If a DOM is supplied, the following XML content is supported:
          * 
          * <ul>
-         *  <li>&lt;KeyResolver&gt; elements with a type attribute
+         *  <li>&lt;KeyInfoResolver&gt; elements with a type attribute
          * </ul>
          * 
          * XML namespaces are ignored in the processing of this content.
          * 
          * @param e DOM to supply configuration for provider
          */
-        TrustEngine(const DOMElement* e=NULL);
+        TrustEngine(const xercesc::DOMElement* e=nullptr);
         
-        /** Default KeyResolver instance. */
-        xmlsignature::KeyResolver* m_keyResolver;
+        /** Custom KeyInfoResolver instance. */
+        KeyInfoResolver* m_keyInfoResolver;
         
     public:
         virtual ~TrustEngine();
-        
-        /**
-         * Determines whether an XML signature is correct and valid with respect to
-         * the source of KeyInfo data supplied. It is the responsibility of the
-         * application to ensure that the KeyInfo information supplied is in fact
-         * associated with the peer who created the signature. 
-         * 
-         * <p>A custom KeyResolver can be supplied from outside the TrustEngine.
-         * Alternatively, one may be specified to the plugin constructor.
-         * A non-caching, inline resolver will be used as a fallback.
-         * 
-         * @param sig           reference to a signature object to validate
-         * @param keyInfoSource supplies KeyInfo objects to the TrustEngine
-         * @param keyResolver   optional externally supplied KeyResolver, or NULL
-         * @return  true iff the signature validates
-         */
-        virtual bool validate(
-            xmlsignature::Signature& sig,
-            const KeyInfoSource& keyInfoSource,
-            const xmlsignature::KeyResolver* keyResolver=NULL
-            ) const=0;
 
         /**
-         * Determines whether a raw signature is correct and valid with respect to
-         * the source of KeyInfo data supplied. It is the responsibility of the
-         * application to ensure that the KeyInfo information supplied is in fact
-         * associated with the peer who created the signature.
+         * Supplies a KeyInfoResolver instance.
+         * <p>This method must be externally synchronized with any code that uses the object.
+         * Any previously set object is destroyed.
          * 
-         * <p>A custom KeyResolver can be supplied from outside the TrustEngine.
-         * Alternatively, one may be specified to the plugin constructor.
-         * A non-caching, inline resolver will be used as a fallback.
-         * 
-         * <p>Note that the keyInfo parameter is not part of the implicitly trusted
-         * set of key information supplied via the KeyInfoSource, but rather advisory
-         * data that may have accompanied the signature itself.
-         * 
-         * @param sigAlgorithm  XML Signature identifier for the algorithm used
-         * @param sig           null-terminated base64-encoded signature value
-         * @param keyInfo       KeyInfo object accompanying the signature, if any
-         * @param in            the input data over which the signature was created
-         * @param in_len        size of input data in bytes
-         * @param keyInfoSource supplies KeyInfo objects to the TrustEngine
-         * @param keyResolver   optional externally supplied KeyResolver, or NULL
-         * @return  true iff the signature validates
+         * @param keyInfoResolver   new KeyInfoResolver instance to use
          */
-        virtual bool validate(
-            const XMLCh* sigAlgorithm,
-            const char* sig,
-            xmlsignature::KeyInfo* keyInfo,
-            const char* in,
-            unsigned int in_len,
-            const KeyInfoSource& keyInfoSource,
-            const xmlsignature::KeyResolver* keyResolver=NULL
-            ) const=0;
+        void setKeyInfoResolver(KeyInfoResolver* keyInfoResolver);
     };
 
     /**
@@ -120,7 +76,10 @@ namespace xmltooling {
 
     /** TrustEngine based on explicit knowledge of peer key information. */
     #define EXPLICIT_KEY_TRUSTENGINE  "ExplicitKey"
-    
+
+    /** TrustEngine based on PKIX evaluation against a static set of trust anchors. */
+    #define STATIC_PKIX_TRUSTENGINE  "StaticPKIX"
+
     /** TrustEngine that tries multiple engines in sequence. */
     #define CHAINING_TRUSTENGINE  "Chaining"