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      * Subclasses can provide support for additional message types
  31      * by overriding the main method and then calling the check method.
  32      */
  33     class SAML_API MessageFlowRule : public SecurityPolicyRule
  34     {
  35     public:
  36         MessageFlowRule(const DOMElement* e);
  37         virtual ~MessageFlowRule() {}
  38
  39         std::pair<saml2::Issuer*,const saml2md::RoleDescriptor*> evaluate(
  40             const GenericRequest& request,
  41             const xmltooling::XMLObject& message,
  42             const saml2md::MetadataProvider* metadataProvider,
  43             const xmltooling::QName* role,
  44             const xmltooling::TrustEngine* trustEngine
  45             ) const;
  46
  47         /**
  48          * Controls whether rule executes replay checking.
  49          *
  50          * @param checkReplay  replay checking value to set
  51          */
  52         void setCheckReplay(bool checkReplay) {
  53             m_checkReplay = checkReplay;
  54         }
  55
  56         /**
  57          * Controls maximum elapsed time between message issue and rule execution.
  58          *
  59          * @param expires  maximum elapsed time in seconds
  60          */
  61         void setExpires(time_t expires) {
  62             m_expires = expires;
  63         }
  64
  65     protected:
  66         /**
  67          * Performs the check.
  68          *
  69          * @param id            message identifier
  70          * @param issueInstant  timestamp of protocol message
  71          *
  72          * @exception BindingException  raised if a check fails
  73          */
  74         void check(const XMLCh* id, time_t issueInstant) const;
  75
  76     private:
  77         bool m_checkReplay;
  78         time_t m_expires;
  79     };
  80
  81 };