saml/binding/MessageFlowRule.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/MessageFlowRule.h
  19  *
  20  * SAML replay and freshness checking SecurityPolicyRule
  21  */
  22
  23 #ifndef __saml_flowrule_h__
  24 #define __saml_flowrule_h__
  25
  26 #include <saml/binding/SecurityPolicyRule.h>
  27
  28
  29 namespace opensaml {
  30     /**
  31      * SAML replay and freshness checking SecurityPolicyRule
  32      *
  33      * Some form of message rule to extract ID and timestamp must be
  34      * run prior to this rule.
  35      */
  36     class SAML_API MessageFlowRule : public SecurityPolicyRule
  37     {
  38     public:
  39         MessageFlowRule(const DOMElement* e);
  40         virtual ~MessageFlowRule() {}
  41
  42         void evaluate(const xmltooling::XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
  43
  44         /**
  45          * Controls whether rule executes replay checking.
  46          *
  47          * @param checkReplay  replay checking value to set
  48          */
  49         void setCheckReplay(bool checkReplay) {
  50             m_checkReplay = checkReplay;
  51         }
  52
  53         /**
  54          * Controls maximum elapsed time between message issue and rule execution.
  55          *
  56          * @param expires  maximum elapsed time in seconds
  57          */
  58         void setExpires(time_t expires) {
  59             m_expires = expires;
  60         }
  61
  62     private:
  63         bool m_checkReplay;
  64         time_t m_expires;
  65     };
  66
  67 };
  68
  69 #endif /* __saml_flowrule_h__ */