Multi-line svn commit, see body.

[shibboleth/cpp-opensaml.git] / saml / binding / SecurityPolicyRule.h

diff --git a/saml/binding/SecurityPolicyRule.h b/saml/binding/SecurityPolicyRule.h
index f547251..095e115 100644 (file)
--- a/saml/binding/SecurityPolicyRule.h
+++ b/saml/binding/SecurityPolicyRule.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2006 Internet2
+ *  Copyright 2001-2007 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,18 +23,9 @@
 #ifndef __saml_secrule_h__
 #define __saml_secrule_h__
 
-#include <saml/binding/GenericRequest.h>
-#include <xmltooling/XMLObject.h>
+#include <saml/binding/SecurityPolicy.h>
 
 namespace opensaml {
-    class SAML_API TrustEngine;
-    
-    namespace saml2 {
-        class SAML_API Issuer;
-    };
-    namespace saml2md {
-        class SAML_API RoleDescriptor;
-    };
     
     /**
      * A rule that a protocol request and message must meet in order to be valid and secure.
@@ -52,24 +43,28 @@ namespace opensaml {
         virtual ~SecurityPolicyRule() {}
 
         /**
-         * Evaluates the rule against the given request and message. If an Issuer is
-         * returned, the caller is responsible for freeing the Issuer object.
+         * Returns the rule's class/type.
+         *
+         * @return  the class/type of the object
+         */
+        virtual const char* getType() const=0;
+
+        /**
+         * Evaluates the rule against the given request and message.
          * 
-         * @param request           the protocol request
-         * @param message           the incoming message
-         * @param metadataProvider  locked MetadataProvider instance to authenticate the message
-         * @param role              identifies the role (generally IdP or SP) of the peer who issued the message 
-         * @param trustEngine       TrustEngine to authenticate the message
-         * @return the identity of the message issuer, in two forms, or NULL
+         * <p>An exception will be raised if the message is invalid according to
+         * a policy rule.
          * 
-         * @throws BindingException thrown if the request/message do not meet the requirements of this rule
+         * @param message   the incoming message
+         * @param request   the protocol request
+         * @param protocol  the protocol family in use
+         * @param policy    SecurityPolicy to provide various components and track message data
          */
-        virtual std::pair<saml2::Issuer*,const saml2md::RoleDescriptor*> evaluate(
-            const GenericRequest& request,
+        virtual void evaluate(
             const xmltooling::XMLObject& message,
-            const saml2md::MetadataProvider* metadataProvider,
-            const xmltooling::QName* role,
-            const TrustEngine* trustEngine
+            const xmltooling::GenericRequest* request,
+            const XMLCh* protocol,
+            SecurityPolicy& policy
             ) const=0;
     };
 
@@ -79,25 +74,63 @@ namespace opensaml {
     void SAML_API registerSecurityPolicyRules();
 
     /**
+     * SecurityPolicyRule for processing SAML 1.x messages.
+     * 
+     * Extracts message ID, timestamp, and issuer information.
+     */
+    #define SAML1MESSAGE_POLICY_RULE  "SAML1Message"
+
+    /**
+     * SecurityPolicyRule for processing SAML 2.0 messages.
+     * 
+     * Extracts message ID, timestamp, and issuer information.
+     */
+    #define SAML2MESSAGE_POLICY_RULE  "SAML2Message"
+
+    /**
+     * SecurityPolicyRule for TLS client certificate authentication.
+     * 
+     * Evaluates client certificates against the issuer's metadata.
+     */
+    #define CLIENTCERTAUTH_POLICY_RULE  "ClientCertAuth"
+
+    /**
      * SecurityPolicyRule for replay detection and freshness checking.
      * 
      * <p>A ReplayCache instance must be available from the runtime, unless
      * a "checkReplay" XML attribute is set to "0" or "false" when instantiating
-     * the policy.
+     * the policy rule.
      * 
      * <p>Messages must have been issued in the past, but no more than 60 seconds ago,
      * or up to a number of seconds set by an "expires" XML attribute when
-     * instantiating the policy.
+     * instantiating the policy rule.
+     */
+    #define MESSAGEFLOW_POLICY_RULE  "MessageFlow"
+
+    /**
+     * SecurityPolicyRule for disabling security.
+     * 
+     * Allows the message issuer to be authenticated regardless of the message or
+     * transport. Used mainly for debugging or in situations that I wouldn't care to
+     * comment on.
+     */
+    #define NULLSECURITY_POLICY_RULE  "NullSecurity"
+
+    /**
+     * SecurityPolicyRule for protocol message "blob" signing.
+     * 
+     * Allows the message issuer to be authenticated using a non-XML digital signature
+     * over the message body. The transport layer is not considered.
      */
-    #define MESSAGEFLOW_POLICY_RULE  "org.opensaml.binding.MessageFlowRule"
+    #define SIMPLESIGNING_POLICY_RULE  "SimpleSigning"
 
     /**
-     * SecurityPolicyRule for protocol message signing.
+     * SecurityPolicyRule for protocol message XML signing.
      * 
-     * Allows the message issuer to be authenticated using an XML or binding-specific
-     * digital signature over the message. The transport layer is not considered.
+     * Allows the message issuer to be authenticated using an XML digital signature
+     * over the message. The transport layer is not considered.
      */
-    #define MESSAGESIGNING_POLICY_RULE  "org.opensaml.binding.MessageSigningRule"
+    #define XMLSIGNING_POLICY_RULE  "XMLSigning"
 };
 
 #endif /* __saml_secrule_h__ */