xmltooling/signature/Signature.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file Signature.h\r
  19  * \r
  20  * XMLObject representing XML Digital Signature, version 20020212, Signature element. \r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_sig_h__) && !defined(XMLTOOLING_NO_XMLSEC)\r
  24 #define __xmltooling_sig_h__\r
  25 \r
  26 #include <xmltooling/XMLObjectBuilder.h>\r
  27 #include <xmltooling/signature/SigningContext.h>\r
  28 #include <xmltooling/signature/VerifyingContext.h>\r
  29 \r
  30 namespace xmltooling {\r
  31 \r
  32     /**\r
  33      * XMLObject representing XML Digital Signature, version 20020212, Signature element.\r
  34      * The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,\r
  35      * and RSA-SHA1 signing. \r
  36      */\r
  37     class XMLTOOL_API Signature : public virtual XMLObject\r
  38     {\r
  39     public:\r
  40         virtual ~Signature() {}\r
  41 \r
  42         /** Element local name */\r
  43         static const XMLCh LOCAL_NAME[];\r
  44 \r
  45         /**\r
  46          * Sets the canonicalization method for the ds:SignedInfo element\r
  47          * \r
  48          * @param c14n  the canonicalization method\r
  49          */\r
  50         virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;\r
  51         \r
  52         /**\r
  53          * Sets the signing algorithm for the signature.\r
  54          * \r
  55          * @param sm    the signature algorithm\r
  56          */\r
  57         virtual void setSignatureAlgorithm(const XMLCh* sm)=0;\r
  58         \r
  59         /**\r
  60          * Applies an XML signature based on the supplied context.\r
  61          * \r
  62          * @param ctx   the signing context that determines the signature's content\r
  63          * @throws SignatureException   thrown if the signing operation fails\r
  64          */\r
  65         virtual void sign(const SigningContext& ctx)=0;\r
  66         \r
  67         /**\r
  68          * Verifies an XML signature based on the supplied context.\r
  69          * \r
  70          * @param ctx   the verifying context that validates the signature's content\r
  71          * @throws SignatureException   thrown if the verifying operation fails\r
  72          */\r
  73         virtual void verify(const VerifyingContext& ctx) const=0;\r
  74 \r
  75     protected:\r
  76         Signature() {}\r
  77     };\r
  78 \r
  79     /**\r
  80      * Builder for Signature objects.\r
  81      */\r
  82     class XMLTOOL_API SignatureBuilder : public XMLObjectBuilder\r
  83     {\r
  84     public:\r
  85         virtual Signature* buildObject(\r
  86             const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const QName* schemaType=NULL\r
  87             ) const;\r
  88             \r
  89         /**\r
  90          * Default builder\r
  91          * \r
  92          * @return empty Signature object\r
  93          */\r
  94         virtual Signature* buildObject() const;\r
  95     };\r
  96 \r
  97 };\r
  98 \r
  99 #endif /* __xmltooling_sig_h__ */\r