saml/signature/SignableObject.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/signature/SignableObject.h
  23  *
  24  * Base class for SAML objects that can be signed.
  25  */
  26
  27 #ifndef __saml_signable_h__
  28 #define __saml_signable_h__
  29
  30 #include <saml/base.h>
  31 #include <xmltooling/XMLObject.h>
  32
  33 namespace xmlsignature {
  34     class XMLTOOL_API Signature;
  35 };
  36
  37 namespace opensaml {
  38
  39     /**
  40      * Base class for SAML objects that can be signed.
  41      */
  42     class SAML_API SignableObject : public virtual xmltooling::XMLObject
  43     {
  44     public:
  45         virtual ~SignableObject();
  46
  47         /**
  48          * Returns the enveloped Signature from the object.
  49          *
  50          * @return the enveloped Signature, or nullptr
  51          */
  52         virtual xmlsignature::Signature* getSignature() const=0;
  53
  54         /**
  55          * Sets an enveloped Signature in the object.
  56          *
  57          * @param sig the enveloped Signature, or nullptr
  58          */
  59         virtual void setSignature(xmlsignature::Signature* sig)=0;
  60
  61     protected:
  62         SignableObject();
  63
  64         /**
  65          * Search the object for non-visible namespaces, and pin them
  66          * on the root of the object where necessary, adding them to
  67          * the inclusive prefix list for signing purposes.
  68          */
  69         void declareNonVisibleNamespaces() const;
  70     };
  71
  72 };
  73
  74 #endif /* __saml_signable_h__ */