shibsp/security/SecurityPolicy.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 shibsp/security/SecurityPolicy.h
  23  *
  24  * SP-specific SecurityPolicy subclass.
  25  */
  26
  27 #ifndef __shibsp_secpol_h__
  28 #define __shibsp_secpol_h__
  29
  30 #include <shibsp/base.h>
  31 #include <saml/saml2/profile/SAML2AssertionPolicy.h>
  32
  33 namespace shibsp {
  34
  35     class SHIBSP_API Application;
  36
  37     /**
  38      * SP-specific SecurityPolicy subclass.
  39      */
  40     class SHIBSP_API SecurityPolicy : public opensaml::saml2::SAML2AssertionPolicy
  41     {
  42     public:
  43         /**
  44          * Constructor for policy.
  45          *
  46          * @param application       an Application instance
  47          * @param role              identifies the role (generally IdP or SP) of the policy peer
  48          * @param validate          true iff XML parsing should be done with validation
  49          * @param policyId          identifies policy rules to auto-attach, defaults to the application's set
  50          */
  51         SecurityPolicy(const Application& application, const xmltooling::QName* role=nullptr, bool validate=true, const char* policyId=nullptr);
  52
  53         virtual ~SecurityPolicy();
  54
  55         opensaml::saml2md::MetadataProvider::Criteria& getMetadataProviderCriteria() const;
  56
  57         /**
  58          * Returns the Application associated with the policy.
  59          *
  60          * @return the associated Application
  61          */
  62         const Application& getApplication() const;
  63
  64     private:
  65         const Application& m_application;
  66     };
  67
  68 };
  69
  70 #endif /* __shibsp_secpol_h__ */