saml/saml2/profile/SAML2AssertionPolicy.h

   1 /*
   2  *  Copyright 2009 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/saml2/profile/SAML2AssertionPolicy.h
  19  *
  20  * Policy subclass to track SAML 2.0 Assertion SubjectConfirmation.
  21  */
  22
  23 #ifndef __saml_saml2asspol_h__
  24 #define __saml_saml2asspol_h__
  25
  26 #include <saml/binding/SecurityPolicy.h>
  27
  28 #if defined (_MSC_VER)
  29     #pragma warning( push )
  30     #pragma warning( disable : 4250 4251 )
  31 #endif
  32
  33 namespace opensaml {
  34
  35     namespace saml2 {
  36         class SAML_API SubjectConfirmation;
  37
  38         /**
  39          * Policy subclass to track SAML 2.0 Assertion SubjectConfirmation.
  40          */
  41         class SAML_API SAML2AssertionPolicy : virtual public SecurityPolicy
  42         {
  43         public:
  44             /**
  45              * Constructor for policy.
  46              *
  47              * @param metadataProvider  locked MetadataProvider instance
  48              * @param role              identifies the role (generally IdP or SP) of the policy peer
  49              * @param trustEngine       TrustEngine to authenticate policy peer
  50              * @param validate          true iff XML parsing should be done with validation
  51              */
  52             SAML2AssertionPolicy(
  53                 const saml2md::MetadataProvider* metadataProvider=NULL,
  54                 const xmltooling::QName* role=NULL,
  55                 const xmltooling::TrustEngine* trustEngine=NULL,
  56                 bool validate=true
  57                 ) : SecurityPolicy(metadataProvider, role, trustEngine, validate) {
  58             }
  59
  60             virtual ~SAML2AssertionPolicy() {}
  61
  62             virtual void reset(bool messageOnly=false);
  63             void _reset(bool messageOnly=false) {
  64                 m_confirmation = false;
  65             }
  66
  67             /**
  68              * Returns the subject confirmation that was successfully accepted by the policy.
  69              *
  70              * @return a successfully evaluated SubjectConfirmation
  71              */
  72             const saml2::SubjectConfirmation* getSubjectConfirmation() const {
  73                 return m_confirmation;
  74             }
  75
  76             /**
  77              * Sets the SubjectConfirmation that was successfully accepted by the policy.
  78              *
  79              * <p>The lifetime of the SubjectConfirmation object <strong>MUST</strong> be longer
  80              * than the lifetime of the policy object.
  81              *
  82              * @param confirmation the successfully evaluated SubjectConfirmation
  83              */
  84             void setSubjectConfirmation(const saml2::SubjectConfirmation* confirmation) {
  85                 m_confirmation = confirmation;
  86             }
  87
  88         private:
  89             const saml2::SubjectConfirmation* m_confirmation;
  90         };
  91     };
  92 };
  93
  94 #if defined (_MSC_VER)
  95     #pragma warning( pop )
  96 #endif
  97
  98 #endif /* __saml_saml2asspol_h__ */