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 \r
  29 namespace xmltooling {\r
  30 \r
  31     /**\r
  32      * XMLObject representing XML Digital Signature, version 20020212, Signature element.\r
  33      * The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,\r
  34      * and RSA-SHA1 signing. \r
  35      */\r
  36     class XMLTOOL_API Signature : public virtual XMLObject\r
  37     {\r
  38     public:\r
  39         virtual ~Signature() {}\r
  40 \r
  41         /** Element prefix */\r
  42         static const XMLCh PREFIX[];\r
  43 \r
  44         /** Element local name */\r
  45         static const XMLCh LOCAL_NAME[];\r
  46 \r
  47         /**\r
  48          * Gets the canonicalization method for the ds:SignedInfo element.\r
  49          * \r
  50          * @return the canonicalization method\r
  51          */\r
  52         virtual const XMLCh* getCanonicalizationMethod() const=0;\r
  53         \r
  54         /**\r
  55          * Gets the signing algorithm for the signature.\r
  56          * \r
  57          * @return the signature algorithm\r
  58          */\r
  59         virtual const XMLCh* getSignatureAlgorithm() const=0;\r
  60 \r
  61         /**\r
  62          * Returns the ds:KeyInfo information attached to the signature.\r
  63          * The Signature object must be marshalled before this will return anything.\r
  64          * The caller MUST NOT mutate the information through the provided pointer.\r
  65          * \r
  66          * @return the ds:KeyInfo information\r
  67          */\r
  68         virtual DSIGKeyInfoList* getKeyInfo() const=0; \r
  69 \r
  70         /**\r
  71          * Sets the canonicalization method for the ds:SignedInfo element\r
  72          * \r
  73          * @param c14n  the canonicalization method\r
  74          */\r
  75         virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;\r
  76         \r
  77         /**\r
  78          * Sets the signing algorithm for the signature.\r
  79          * \r
  80          * @param sm    the signature algorithm\r
  81          */\r
  82         virtual void setSignatureAlgorithm(const XMLCh* sm)=0;\r
  83         \r
  84         /**\r
  85          * Applies an XML signature based on the supplied context.\r
  86          * \r
  87          * @param ctx   the signing context that determines the signature's content\r
  88          * @throws SignatureException   thrown if the signing operation fails\r
  89          */\r
  90         virtual void sign(const SigningContext* ctx)=0;\r
  91         \r
  92     protected:\r
  93         Signature() {}\r
  94     };\r
  95 \r
  96 };\r
  97 \r
  98 #endif /* __xmltooling_sig_h__ */\r