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