xmltooling/encryption/Encrypter.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file xmltooling/encryption/Encrypter.h
  19  *
  20  * Methods for encrypting XMLObjects and other data.
  21  */
  22
  23 #if !defined(__xmltooling_encrypter_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  24 #define __xmltooling_encrypter_h__
  25
  26 #include <xmltooling/encryption/Encryption.h>
  27
  28 #include <xsec/enc/XSECCryptoKey.hpp>
  29 #include <xsec/xenc/XENCCipher.hpp>
  30
  31 namespace xmltooling {
  32     class XMLTOOL_API Credential;
  33 };
  34
  35 namespace xmlencryption {
  36
  37     /**
  38      * Wrapper API for XML Encryption functionality.
  39      * Designed to allow both external and internal key generation as follows:
  40      *
  41      * If no keying material is supplied, then the algorithm MAY be recognized
  42      * and a key can be generated internally. This is only done if a KeyEncryptionParams
  43      * structure is also supplied to the operation (otherwise the key would be lost).
  44      *
  45      * If an XSECCryptoKey is supplied, then it is used directly, but if KeyEncryptionParams
  46      * are supplied, an exception will result unless the raw key buffer is also supplied.
  47      *
  48      * If a raw key is provided, then a key object can also be created internally if the
  49      * algorithm is recognized.
  50      *
  51      * Summing up, if KeyEncryptionParams are used, a raw key must be available or the
  52      * key can be generated when the encryption algorithm itself is a standard one. If
  53      * no KeyEncryptionParams are supplied, then the key must be supplied either in raw
  54      * or object form.
  55      *
  56      * Finally, when encrypting data, the key transport algorithm can be left blank to
  57      * derive it from the data encryption algorithm.
  58      */
  59     class XMLTOOL_API Encrypter
  60     {
  61     public:
  62
  63         /**
  64          * Structure to collect encryption requirements.
  65          */
  66         struct XMLTOOL_API EncryptionParams {
  67
  68             /**
  69              * Constructor.
  70              *
  71              * The algorithm constant and key buffer <strong>MUST</strong> be accessible for the life of
  72              * the structure.
  73              *
  74              * @param algorithm     the XML Encryption algorithm constant
  75              * @param keyBuffer     buffer containing the raw key information
  76              * @param keyBufferSize the size of the raw key buffer in bytes
  77              * @param credential    optional Credential supplying the encryption key
  78              * @param compact       true iff the encrypted representation should be made as small as possible
  79              */
  80             EncryptionParams(
  81                 const XMLCh* algorithm=DSIGConstants::s_unicodeStrURIAES256_CBC,
  82                 const unsigned char* keyBuffer=NULL,
  83                 unsigned int keyBufferSize=0,
  84                 const xmltooling::Credential* credential=NULL,
  85                 bool compact=false
  86                 ) :  m_algorithm(algorithm), m_keyBuffer(keyBuffer), m_keyBufferSize(keyBufferSize),
  87                     m_credential(credential), m_compact(compact) {
  88             }
  89
  90             ~EncryptionParams() {}
  91         private:
  92             const XMLCh* m_algorithm;
  93             const unsigned char* m_keyBuffer;
  94             unsigned int m_keyBufferSize;
  95             const xmltooling::Credential* m_credential;
  96             bool m_compact;
  97
  98             friend class Encrypter;
  99         };
 100
 101         /**
 102          * Structure to collect key wrapping/transport requirements.
 103          */
 104         struct XMLTOOL_API KeyEncryptionParams {
 105
 106             /**
 107              * Constructor.
 108              *
 109              * @param credential    a Credential supplying the key encryption key
 110              * @param algorithm     XML Encryption key wrapping or transport algorithm constant
 111              * @param recipient     optional name of recipient of encrypted key
 112              */
 113             KeyEncryptionParams(
 114                 const xmltooling::Credential& credential,
 115                 const XMLCh* algorithm=NULL,
 116                 const XMLCh* recipient=NULL
 117                 ) : m_credential(credential), m_algorithm(algorithm), m_recipient(recipient) {
 118             }
 119
 120             ~KeyEncryptionParams() {}
 121         private:
 122             const xmltooling::Credential& m_credential;
 123             const XMLCh* m_algorithm;
 124             const XMLCh* m_recipient;
 125
 126             friend class Encrypter;
 127         };
 128
 129         Encrypter() : m_cipher(NULL) {}
 130
 131         ~Encrypter();
 132
 133         /**
 134          * Encrypts the supplied element and returns the resulting object.
 135          *
 136          * If an encryption algorithm is set, but no key, a random key will be
 137          * generated iff kencParams is non-NULL and the algorithm is known.
 138          *
 139          * If key encryption parameters are supplied, then the encryption key
 140          * is wrapped and the result placed into an EncryptedKey object in the
 141          * KeyInfo of the returned EncryptedData.
 142          *
 143          * @param element       the DOM element to encrypt
 144          * @param encParams     primary encryption settings
 145          * @param kencParams    key encryption settings, or NULL
 146          * @return a stand-alone EncryptedData object, unconnected to the source DOM
 147          */
 148         EncryptedData* encryptElement(
 149             xercesc::DOMElement* element, EncryptionParams& encParams, KeyEncryptionParams* kencParams=NULL
 150             );
 151
 152         /**
 153          * Encrypts the supplied element's children and returns the resulting object.
 154          *
 155          * If an encryption algorithm is set, but no key, a random key will be
 156          * generated iff kencParams is non-NULL and the algorithm is known.
 157
 158          * If key encryption parameters are supplied, then the encryption key
 159          * is wrapped and the result placed into an EncryptedKey object in the
 160          * KeyInfo of the returned EncryptedData.
 161          *
 162          * @param element       parent element of children to encrypt
 163          * @param encParams     primary encryption settings
 164          * @param kencParams    key encryption settings, or NULL
 165          * @return a stand-alone EncryptedData object, unconnected to the source DOM
 166          */
 167         EncryptedData* encryptElementContent(
 168             xercesc::DOMElement* element, EncryptionParams& encParams, KeyEncryptionParams* kencParams=NULL
 169             );
 170
 171         /**
 172          * Encrypts the supplied input stream and returns the resulting object.
 173          *
 174          * If an encryption algorithm is set, but no key, a random key will be
 175          * generated iff kencParams is non-NULL and the algorithm is known.
 176
 177          * If key encryption parameters are supplied, then the encryption key
 178          * is wrapped and the result placed into an EncryptedKey object in the
 179          * KeyInfo of the returned EncryptedData.
 180          *
 181          * @param input         the stream to encrypt
 182          * @param encParams     primary encryption settings
 183          * @param kencParams    key encryption settings, or NULL
 184          * @return a stand-alone EncryptedData object, unconnected to any DOM
 185          */
 186         EncryptedData* encryptStream(std::istream& input, EncryptionParams& encParams, KeyEncryptionParams* kencParams=NULL);
 187
 188         /**
 189          * Encrypts the supplied key and returns the resulting object.
 190          *
 191          * @param keyBuffer     raw key material to encrypt
 192          * @param keyBufferSize size in bytes of raw key material
 193          * @param kencParams    key encryption settings
 194          * @param compact       true iff the encrypted representation should be made as small as possible
 195          * @return a stand-alone EncryptedKey object, unconnected to any DOM
 196          */
 197         EncryptedKey* encryptKey(
 198             const unsigned char* keyBuffer, unsigned int keyBufferSize, KeyEncryptionParams& kencParams, bool compact=false
 199             );
 200
 201         /**
 202          * Maps a data encryption algorithm to an appropriate key transport algorithm to use.
 203          *
 204          * @param algorithm data encryption algorithm
 205          * @return a key transport algorithm
 206          */
 207         static const XMLCh* getKeyTransportAlgorithm(const XMLCh* algorithm) {
 208             if (xercesc::XMLString::equals(algorithm,DSIGConstants::s_unicodeStrURI3DES_CBC))
 209                 return DSIGConstants::s_unicodeStrURIRSA_1_5;
 210             else
 211                 return DSIGConstants::s_unicodeStrURIRSA_OAEP_MGFP1;
 212         }
 213
 214     private:
 215         void checkParams(EncryptionParams& encParams, KeyEncryptionParams* kencParams);
 216         EncryptedData* decorateAndUnmarshall(EncryptionParams& encParams, KeyEncryptionParams* kencParams);
 217
 218         XENCCipher* m_cipher;
 219         unsigned char m_keyBuffer[32];
 220     };
 221
 222     DECL_XMLTOOLING_EXCEPTION(EncryptionException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmlencryption,xmltooling::XMLSecurityException,Exceptions in encryption processing);
 223
 224 };
 225
 226 #endif /* __xmltooling_encrypter_h__ */