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/exceptions.h>\r
  27 #include <xmltooling/XMLObjectBuilder.h>\r
  28 #include <xmltooling/signature/SigningContext.h>\r
  29 #include <xmltooling/signature/VerifyingContext.h>\r
  30 \r
  31 /**\r
  32  * @namespace xmlsignature\r
  33  * Public namespace of XML Signature classes\r
  34  */\r
  35 namespace xmlsignature {\r
  36 \r
  37     /**\r
  38      * XMLObject representing XML Digital Signature, version 20020212, Signature element.\r
  39      * The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,\r
  40      * and RSA-SHA1 signing. \r
  41      */\r
  42     class XMLTOOL_API Signature : public virtual xmltooling::XMLObject\r
  43     {\r
  44     public:\r
  45         virtual ~Signature() {}\r
  46 \r
  47         /** Element local name */\r
  48         static const XMLCh LOCAL_NAME[];\r
  49 \r
  50         /**\r
  51          * Sets the canonicalization method for the ds:SignedInfo element\r
  52          * \r
  53          * @param c14n  the canonicalization method\r
  54          */\r
  55         virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;\r
  56         \r
  57         /**\r
  58          * Sets the signing algorithm for the signature.\r
  59          * \r
  60          * @param sm    the signature algorithm\r
  61          */\r
  62         virtual void setSignatureAlgorithm(const XMLCh* sm)=0;\r
  63         \r
  64         /**\r
  65          * Applies an XML signature based on the supplied context.\r
  66          * \r
  67          * @param ctx   the signing context that determines the signature's content\r
  68          * @throws SignatureException   thrown if the signing operation fails\r
  69          */\r
  70         virtual void sign(const SigningContext& ctx)=0;\r
  71         \r
  72         /**\r
  73          * Verifies an XML signature based on the supplied context.\r
  74          * \r
  75          * @param ctx   the verifying context that validates the signature's content\r
  76          * @throws SignatureException   thrown if the verifying operation fails\r
  77          */\r
  78         virtual void verify(const VerifyingContext& ctx) const=0;\r
  79 \r
  80     protected:\r
  81         Signature() {}\r
  82     };\r
  83 \r
  84     /**\r
  85      * Builder for Signature objects.\r
  86      */\r
  87     class XMLTOOL_API SignatureBuilder : public xmltooling::XMLObjectBuilder\r
  88     {\r
  89     public:\r
  90         virtual Signature* buildObject(\r
  91             const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL\r
  92             ) const;\r
  93             \r
  94         /**\r
  95          * Default builder\r
  96          * \r
  97          * @return empty Signature object\r
  98          */\r
  99         virtual Signature* buildObject() const;\r
 100     };\r
 101 \r
 102     DECL_XMLTOOLING_EXCEPTION(SignatureException,xmlsignature,xmltooling::XMLToolingException,Exceptions in signature processing);\r
 103 \r
 104 };\r
 105 \r
 106 #endif /* __xmltooling_sig_h__ */\r