saml/saml2/profile/AssertionValidator.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file saml/saml2/profile/AssertionValidator.h
  23  *
  24  * SAML 2.0 basic assertion validator.
  25  */
  26
  27 #ifndef __saml2_assval_h__
  28 #define __saml2_assval_h__
  29
  30 #include <saml/base.h>
  31
  32 #include <ctime>
  33 #include <vector>
  34 #include <xmltooling/validation/Validator.h>
  35
  36 namespace opensaml {
  37     namespace saml2 {
  38
  39         class SAML_API Assertion;
  40         class SAML_API Condition;
  41
  42         /**
  43          * @deprecated
  44          * SAML 2.0 basic assertion validator provides time and audience condition checking.
  45          */
  46         class SAML_API AssertionValidator : public virtual xmltooling::Validator
  47         {
  48         public:
  49             /**
  50              * Constructor
  51              *
  52              * @param recipient name of assertion recipient (implicit audience)
  53              * @param audiences additional audience values
  54              * @param ts        timestamp to evaluate assertion conditions, or 0 to bypass check
  55              */
  56             AssertionValidator(const XMLCh* recipient, const std::vector<const XMLCh*>* audiences=nullptr, time_t ts=0);
  57
  58             virtual ~AssertionValidator();
  59
  60             void validate(const xmltooling::XMLObject* xmlObject) const;
  61
  62             /**
  63              * Type-safe validation method.
  64              *
  65              * @param assertion assertion to validate
  66              */
  67             virtual void validateAssertion(const Assertion& assertion) const;
  68
  69             /**
  70              * Condition validation.
  71              *
  72              * <p>The base class version only understands AudienceRestriction conditions.
  73              * All other condition types will be rejected and require subclassing to
  74              * prevent validation failure.
  75              *
  76              * @param condition condition to validate
  77              */
  78             virtual void validateCondition(const Condition* condition) const;
  79
  80         protected:
  81             /** Name of recipient (implicit audience). */
  82             const XMLCh* m_recipient;
  83
  84             /** Additional audience values. */
  85             const std::vector<const XMLCh*>* m_audiences;
  86
  87             /** Timestamp to evaluate assertion conditions. */
  88             time_t m_ts;
  89         };
  90
  91     };
  92 };
  93
  94 #endif /* __saml2_assval_h__ */