Change license header, remove stale pkg files.
[shibboleth/cpp-opensaml.git] / saml / saml2 / profile / AssertionValidator.h
index f1276bd..b6ef86e 100644 (file)
@@ -1,38 +1,46 @@
-/*
- *  Copyright 2001-2007 Internet2
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
  * @file saml/saml2/profile/AssertionValidator.h
- * 
- * SAML 2.0 basic assertion validator
+ *
+ * SAML 2.0 basic assertion validator.
  */
 
 #ifndef __saml2_assval_h__
 #define __saml2_assval_h__
 
 #include <saml/base.h>
+
+#include <ctime>
+#include <vector>
 #include <xmltooling/validation/Validator.h>
 
 namespace opensaml {
     namespace saml2 {
-        
+
         class SAML_API Assertion;
         class SAML_API Condition;
-        
+
         /**
+         * @deprecated
          * SAML 2.0 basic assertion validator provides time and audience condition checking.
          */
         class SAML_API AssertionValidator : public virtual xmltooling::Validator
@@ -40,19 +48,20 @@ namespace opensaml {
         public:
             /**
              * Constructor
-             * 
-             * @param audiences set of audience values representing recipient
+             *
+             * @param recipient name of assertion recipient (implicit audience)
+             * @param audiences additional audience values
              * @param ts        timestamp to evaluate assertion conditions, or 0 to bypass check
              */
-            AssertionValidator(const std::vector<const XMLCh*>& audiences, time_t ts=0) : m_audiences(audiences), m_ts(ts) {}
+            AssertionValidator(const XMLCh* recipient, const std::vector<const XMLCh*>* audiences=nullptr, time_t ts=0);
+
+            virtual ~AssertionValidator();
 
-            virtual ~AssertionValidator() {}
-    
             void validate(const xmltooling::XMLObject* xmlObject) const;
 
             /**
              * Type-safe validation method.
-             * 
+             *
              * @param assertion assertion to validate
              */
             virtual void validateAssertion(const Assertion& assertion) const;
@@ -60,21 +69,25 @@ namespace opensaml {
             /**
              * Condition validation.
              *
-             * <p>Base class version only understands AudienceRestrictions.
-             * 
+             * <p>The base class version only understands AudienceRestriction conditions.
+             * All other condition types will be rejected and require subclassing to
+             * prevent validation failure.
+             *
              * @param condition condition to validate
-             * @return true iff condition was understood
              */
-            virtual bool validateCondition(const Condition* condition) const;
+            virtual void validateCondition(const Condition* condition) const;
 
         protected:
-            /** Set of audience values representing recipient. */
-            const std::vector<const XMLCh*>& m_audiences;
+            /** Name of recipient (implicit audience). */
+            const XMLCh* m_recipient;
+
+            /** Additional audience values. */
+            const std::vector<const XMLCh*>* m_audiences;
 
             /** Timestamp to evaluate assertion conditions. */
             time_t m_ts;
         };
-        
+
     };
 };