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 TrustEngine* trustEngine,
  45             const MessageExtractor& extractor
  46             ) const;
  47
  48         /**
  49          * Controls whether rule executes replay checking.
  50          *
  51          * @param checkReplay  replay checking value to set
  52          */
  53         void setCheckReplay(bool checkReplay) {
  54             m_checkReplay = checkReplay;
  55         }
  56
  57         /**
  58          * Controls maximum elapsed time between message issue and rule execution.
  59          *
  60          * @param expires  maximum elapsed time in seconds
  61          */
  62         void setExpires(time_t expires) {
  63             m_expires = expires;
  64         }
  65
  66     protected:
  67         /**
  68          * Performs the check.
  69          *
  70          * @param id            message identifier
  71          * @param issueInstant  timestamp of protocol message
  72          *
  73          * @exception BindingException  raised if a check fails
  74          */
  75         void check(const XMLCh* id, time_t issueInstant) const;
  76
  77     private:
  78         bool m_checkReplay;
  79         time_t m_expires;
  80     };
  81
  82 };