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/XMLObject.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 prefix */\r
  43         static const XMLCh PREFIX[];\r
  44 \r
  45         /** Element local name */\r
  46         static const XMLCh LOCAL_NAME[];\r
  47 \r
  48         /**\r
  49          * Sets the canonicalization method for the ds:SignedInfo element\r
  50          * \r
  51          * @param c14n  the canonicalization method\r
  52          */\r
  53         virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;\r
  54         \r
  55         /**\r
  56          * Sets the signing algorithm for the signature.\r
  57          * \r
  58          * @param sm    the signature algorithm\r
  59          */\r
  60         virtual void setSignatureAlgorithm(const XMLCh* sm)=0;\r
  61         \r
  62         /**\r
  63          * Applies an XML signature based on the supplied context.\r
  64          * \r
  65          * @param ctx   the signing context that determines the signature's content\r
  66          * @throws SignatureException   thrown if the signing operation fails\r
  67          */\r
  68         virtual void sign(const SigningContext& ctx)=0;\r
  69         \r
  70         /**\r
  71          * Verifies an XML signature based on the supplied context.\r
  72          * \r
  73          * @param ctx   the verifying context that validates the signature's content\r
  74          * @throws SignatureException   thrown if the verifying operation fails\r
  75          */\r
  76         virtual void verify(const VerifyingContext& ctx) const=0;\r
  77 \r
  78     protected:\r
  79         Signature() {}\r
  80     };\r
  81 \r
  82 };\r
  83 \r
  84 #endif /* __xmltooling_sig_h__ */\r