saml/binding/SecurityPolicyRule.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 saml/binding/SecurityPolicyRule.h
  19  *
  20  * Policy rules that secure and authenticate bindings.
  21  */
  22
  23 #ifndef __saml_secrule_h__
  24 #define __saml_secrule_h__
  25
  26 #include <saml/binding/SecurityPolicy.h>
  27
  28 namespace opensaml {
  29
  30     /**
  31      * A rule that a protocol request and message must meet in order to be valid and secure.
  32      *
  33      * <p>Rules must be stateless and thread-safe across evaluations. Evaluation should not
  34      * result in an exception if the request/message properties do not apply to the rule
  35      * (e.g. particular security mechanisms that are not present).
  36      */
  37     class SAML_API SecurityPolicyRule
  38     {
  39         MAKE_NONCOPYABLE(SecurityPolicyRule);
  40     protected:
  41         SecurityPolicyRule() {}
  42     public:
  43         virtual ~SecurityPolicyRule() {}
  44
  45         /**
  46          * Evaluates the rule against the given request and message.
  47          *
  48          * @param message   the incoming message
  49          * @param request   the protocol request
  50          * @param policy    SecurityPolicy to provide various components and track message data
  51          *
  52          * @throws BindingException raised if the message/request is not acceptable to the policy rule
  53          */
  54         virtual void evaluate(
  55             const xmltooling::XMLObject& message, const GenericRequest* request, SecurityPolicy& policy
  56             ) const=0;
  57     };
  58
  59     /**
  60      * Registers SecurityPolicyRule plugins into the runtime.
  61      */
  62     void SAML_API registerSecurityPolicyRules();
  63
  64     /**
  65      * SecurityPolicyRule for processing SAML 1.x messages.
  66      *
  67      * Extracts message ID, timestamp, and issuer information.
  68      */
  69     #define SAML1MESSAGE_POLICY_RULE  "org.opensaml.saml1.binding.SAML1MessageRule"
  70
  71     /**
  72      * SecurityPolicyRule for processing SAML 2.0 messages.
  73      *
  74      * Extracts message ID, timestamp, and issuer information.
  75      */
  76     #define SAML2MESSAGE_POLICY_RULE  "org.opensaml.saml2.binding.SAML2MessageRule"
  77
  78     /**
  79      * SecurityPolicyRule for TLS client certificate authentication.
  80      *
  81      * Evaluates client certificates against the issuer's metadata.
  82      */
  83     #define CLIENTCERTAUTH_POLICY_RULE  "org.opensaml.binding.ClientCertAuthRule"
  84
  85     /**
  86      * SecurityPolicyRule for replay detection and freshness checking.
  87      *
  88      * <p>A ReplayCache instance must be available from the runtime, unless
  89      * a "checkReplay" XML attribute is set to "0" or "false" when instantiating
  90      * the policy rule.
  91      *
  92      * <p>Messages must have been issued in the past, but no more than 60 seconds ago,
  93      * or up to a number of seconds set by an "expires" XML attribute when
  94      * instantiating the policy rule.
  95      */
  96     #define MESSAGEFLOW_POLICY_RULE  "org.opensaml.binding.MessageFlowRule"
  97
  98     /**
  99      * SecurityPolicyRule for protocol message "blob" signing.
 100      *
 101      * Allows the message issuer to be authenticated using a non-XML digital signature
 102      * over the message body. The transport layer is not considered.
 103      */
 104     #define SIMPLESIGNING_POLICY_RULE  "org.opensaml.binding.SimpleSigningRule"
 105
 106     /**
 107      * SecurityPolicyRule for protocol message XML signing.
 108      *
 109      * Allows the message issuer to be authenticated using an XML digital signature
 110      * over the message. The transport layer is not considered.
 111      */
 112     #define XMLSIGNING_POLICY_RULE  "org.opensaml.binding.XMLSigningRule"
 113 };
 114
 115 #endif /* __saml_secrule_h__ */