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