xmltooling/signature/SigningContext.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 SigningContext.h\r
  19  * \r
  20  * Interface to signing process supplied by a signing application \r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_signctx_h__) && !defined(XMLTOOLING_NO_XMLSEC)\r
  24 #define __xmltooling_signctx_h__\r
  25 \r
  26 #include <vector>\r
  27 #include <xsec/dsig/DSIGSignature.hpp>\r
  28 \r
  29 #if defined (_MSC_VER)\r
  30     #pragma warning( push )\r
  31     #pragma warning( disable : 4250 4251 )\r
  32 #endif\r
  33 \r
  34 namespace xmltooling {\r
  35 \r
  36     /**\r
  37      * Interface to signing process supplied by a signing application\r
  38      */\r
  39     class XMLTOOL_API SigningContext\r
  40     {\r
  41         MAKE_NONCOPYABLE(SigningContext);\r
  42     public:\r
  43         virtual ~SigningContext() {}\r
  44 \r
  45         /**\r
  46          * Given a "blank" native signature, asks the context to define the\r
  47          * appropriate signature transforms, references, etc.\r
  48          * This method MAY attach ds:KeyInfo information, or a set of X.509\r
  49          * certificates can be returned from the SigningContext::getX509Certificates()\r
  50          * method instead.\r
  51          * \r
  52          * @param sig   native signature interface\r
  53          */\r
  54         virtual void createSignature(DSIGSignature* sig) const=0;\r
  55         \r
  56         /**\r
  57          * Gets a reference to a collection of certificates to append to\r
  58          * the ds:KeyInfo element in a ds:X509Data chain.\r
  59          * The certificate corresponding to the signing key SHOULD be\r
  60          * first, followed by any additional intermediates to append. \r
  61          * \r
  62          * @return  an immutable collection of certificates to embed\r
  63          */\r
  64         virtual const std::vector<XSECCryptoX509*>& getX509Certificates() const=0;\r
  65         \r
  66         /**\r
  67          * Gets the signing key to use.\r
  68          * Must be compatible with the intended signature algorithm. Ownership of the key\r
  69          * MUST be transferred to the caller.\r
  70          * \r
  71          * @return  pointer to a signing key, will be freed by caller\r
  72          */\r
  73         virtual XSECCryptoKey* getSigningKey() const=0;\r
  74         \r
  75     protected:\r
  76         SigningContext() {}\r
  77     };\r
  78 \r
  79 };\r
  80 \r
  81 #if defined (_MSC_VER)\r
  82     #pragma warning( pop )\r
  83 #endif\r
  84 \r
  85 #endif /* __xmltooling_signctx_h__ */\r