saml/saml1/profile/AssertionValidator.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/saml1/profile/AssertionValidator.h
  19  *
  20  * SAML 1.x basic assertion validator
  21  */
  22
  23 #ifndef __saml1_assval_h__
  24 #define __saml1_assval_h__
  25
  26 #include <saml/base.h>
  27 #include <xmltooling/validation/Validator.h>
  28
  29 namespace opensaml {
  30     namespace saml1 {
  31
  32         class SAML_API Assertion;
  33         class SAML_API Condition;
  34
  35         /**
  36          * SAML 1.x basic assertion validator provides time and audience condition checking.
  37          */
  38         class SAML_API AssertionValidator : public virtual xmltooling::Validator
  39         {
  40         public:
  41             /**
  42              * Constructor
  43              *
  44              * @param audiences set of audience values representing recipient
  45              * @param ts        timestamp to evaluate assertion conditions, or 0 to bypass check
  46              */
  47             AssertionValidator(const std::vector<const XMLCh*>& audiences, time_t ts=0) : m_audiences(audiences), m_ts(ts) {}
  48
  49             virtual ~AssertionValidator() {}
  50
  51             void validate(const xmltooling::XMLObject* xmlObject) const;
  52
  53             /**
  54              * Type-safe validation method.
  55              *
  56              * @param assertion assertion to validate
  57              */
  58             virtual void validateAssertion(const Assertion& assertion) const;
  59
  60             /**
  61              * Condition validation.
  62              *
  63              * <p>Base class version only understands AudienceRestrictionConditions.
  64              *
  65              * @param condition condition to validate
  66              * @return true iff condition was understood
  67              */
  68             virtual bool validateCondition(const Condition* condition) const;
  69
  70         protected:
  71             /** Set of audience values representing recipient. */
  72             const std::vector<const XMLCh*>& m_audiences;
  73
  74             /** Timestamp to evaluate assertion conditions. */
  75             time_t m_ts;
  76         };
  77
  78     };
  79 };
  80
  81 #endif /* __saml1_assval_h__ */