saml/binding/SecurityPolicyRule.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 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          * <p>Exceptions should be reserved for fatal request processing errors;
  49          * otherwise rules should return false to indicate they were not applicable
  50          * or unsuccessful.
  51          *
  52          * @param message   the incoming message
  53          * @param request   the protocol request
  54          * @param policy    SecurityPolicy to provide various components and track message data
  55          * @return  true iff the rule ran successfully, false otherwise
  56          *
  57          * @throws BindingException thrown if the request/message is invalid in some way
  58          */
  59         virtual bool evaluate(
  60             const xmltooling::XMLObject& message, const GenericRequest* request, SecurityPolicy& policy
  61             ) const=0;
  62     };
  63
  64     /**
  65      * Registers SecurityPolicyRule plugins into the runtime.
  66      */
  67     void SAML_API registerSecurityPolicyRules();
  68
  69     /**
  70      * SecurityPolicyRule for processing SAML 1.x messages.
  71      *
  72      * Extracts message ID, timestamp, and issuer information.
  73      */
  74     #define SAML1MESSAGE_POLICY_RULE  "org.opensaml.saml1.binding.SAML1MessageRule"
  75
  76     /**
  77      * SecurityPolicyRule for processing SAML 2.0 messages.
  78      *
  79      * Extracts message ID, timestamp, and issuer information.
  80      */
  81     #define SAML2MESSAGE_POLICY_RULE  "org.opensaml.saml2.binding.SAML2MessageRule"
  82
  83     /**
  84      * SecurityPolicyRule for TLS client certificate authentication.
  85      *
  86      * Evaluates client certificates against the issuer's metadata.
  87      */
  88     #define CLIENTCERTAUTH_POLICY_RULE  "org.opensaml.binding.ClientCertAuthRule"
  89
  90     /**
  91      * SecurityPolicyRule for replay detection and freshness checking.
  92      *
  93      * <p>A ReplayCache instance must be available from the runtime, unless
  94      * a "checkReplay" XML attribute is set to "0" or "false" when instantiating
  95      * the policy rule.
  96      *
  97      * <p>Messages must have been issued in the past, but no more than 60 seconds ago,
  98      * or up to a number of seconds set by an "expires" XML attribute when
  99      * instantiating the policy rule.
 100      */
 101     #define MESSAGEFLOW_POLICY_RULE  "org.opensaml.binding.MessageFlowRule"
 102
 103     /**
 104      * SecurityPolicyRule for protocol message "blob" signing.
 105      *
 106      * Allows the message issuer to be authenticated using a non-XML digital signature
 107      * over the message body. The transport layer is not considered.
 108      */
 109     #define SIMPLESIGNING_POLICY_RULE  "org.opensaml.binding.SimpleSigningRule"
 110
 111     /**
 112      * SecurityPolicyRule for protocol message XML signing.
 113      *
 114      * Allows the message issuer to be authenticated using an XML digital signature
 115      * over the message. The transport layer is not considered.
 116      */
 117     #define XMLSIGNING_POLICY_RULE  "org.opensaml.binding.XMLSigningRule"
 118 };
 119
 120 #endif /* __saml_secrule_h__ */