2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file xmltooling/encryption/Encrypter.h
20 * Methods for encrypting XMLObjects and other data.
23 #if !defined(__xmltooling_encrypter_h__) && !defined(XMLTOOLING_NO_XMLSEC)
24 #define __xmltooling_encrypter_h__
26 #include <xmltooling/encryption/Encryption.h>
28 #include <xsec/enc/XSECCryptoKey.hpp>
29 #include <xsec/xenc/XENCCipher.hpp>
31 namespace xmltooling {
32 class XMLTOOL_API Credential;
35 namespace xmlencryption {
38 * Wrapper API for XML Encryption functionality.
39 * Designed to allow both external and internal key generation as follows:
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).
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.
48 * If a raw key is provided, then a key object can also be created internally if the
49 * algorithm is recognized.
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
56 * Finally, when encrypting data, the key transport algorithm can be left blank to
57 * derive it from the data encryption algorithm.
59 class XMLTOOL_API Encrypter
64 * Structure to collect encryption requirements.
66 struct XMLTOOL_API EncryptionParams {
70 * The algorithm constant and key buffer <strong>MUST</strong> be accessible for the life of
73 * @param algorithm the XML Encryption algorithm constant
74 * @param keyBuffer buffer containing the raw key information
75 * @param keyBufferSize the size of the raw key buffer in bytes
76 * @param credential optional Credential supplying the encryption key
77 * @param compact true iff the encrypted representation should be made as small as possible
80 const XMLCh* algorithm=DSIGConstants::s_unicodeStrURIAES128_CBC,
81 const unsigned char* keyBuffer=NULL,
82 unsigned int keyBufferSize=0,
83 const xmltooling::Credential* credential=NULL,
85 ) : m_algorithm(algorithm), m_keyBuffer(keyBuffer), m_keyBufferSize(keyBufferSize),
86 m_credential(credential), m_compact(compact) {
89 ~EncryptionParams() {}
91 /** Data encryption algorithm. */
92 const XMLCh* m_algorithm;
94 /** Buffer containing encryption key. */
95 const unsigned char* m_keyBuffer;
97 /** Size of buffer. */
98 unsigned int m_keyBufferSize;
100 /** Credential containing the encryption key. */
101 const xmltooling::Credential* m_credential;
103 /** Flag limiting the size of the encrypted XML representation. */
108 * Structure to collect key wrapping/transport requirements.
110 struct XMLTOOL_API KeyEncryptionParams {
114 * @param credential a Credential supplying the key encryption key
115 * @param algorithm XML Encryption key wrapping or transport algorithm constant
116 * @param recipient optional name of recipient of encrypted key
119 const xmltooling::Credential& credential,
120 const XMLCh* algorithm=NULL,
121 const XMLCh* recipient=NULL
122 ) : m_credential(credential), m_algorithm(algorithm), m_recipient(recipient) {
125 ~KeyEncryptionParams() {}
127 /** Credential containing key encryption key. */
128 const xmltooling::Credential& m_credential;
130 /** Key transport or wrapping algorithm. */
131 const XMLCh* m_algorithm;
133 /** Name of recipient that owns the key encryption key. */
134 const XMLCh* m_recipient;
137 Encrypter() : m_cipher(NULL) {}
142 * Encrypts the supplied element and returns the resulting object.
144 * If an encryption algorithm is set, but no key, a random key will be
145 * generated iff kencParams is non-NULL and the algorithm is known.
147 * If key encryption parameters are supplied, then the encryption key
148 * is wrapped and the result placed into an EncryptedKey object in the
149 * KeyInfo of the returned EncryptedData.
151 * @param element the DOM element to encrypt
152 * @param encParams primary encryption settings
153 * @param kencParams key encryption settings, or NULL
154 * @return a stand-alone EncryptedData object, unconnected to the source DOM
156 EncryptedData* encryptElement(
157 xercesc::DOMElement* element, EncryptionParams& encParams, KeyEncryptionParams* kencParams=NULL
161 * Encrypts the supplied element's children and returns the resulting object.
163 * If an encryption algorithm is set, but no key, a random key will be
164 * generated iff kencParams is non-NULL and the algorithm is known.
166 * If key encryption parameters are supplied, then the encryption key
167 * is wrapped and the result placed into an EncryptedKey object in the
168 * KeyInfo of the returned EncryptedData.
170 * @param element parent element of children to encrypt
171 * @param encParams primary encryption settings
172 * @param kencParams key encryption settings, or NULL
173 * @return a stand-alone EncryptedData object, unconnected to the source DOM
175 EncryptedData* encryptElementContent(
176 xercesc::DOMElement* element, EncryptionParams& encParams, KeyEncryptionParams* kencParams=NULL
180 * Encrypts the supplied input stream and returns the resulting object.
182 * If an encryption algorithm is set, but no key, a random key will be
183 * generated iff kencParams is non-NULL and the algorithm is known.
185 * If key encryption parameters are supplied, then the encryption key
186 * is wrapped and the result placed into an EncryptedKey object in the
187 * KeyInfo of the returned EncryptedData.
189 * @param input the stream to encrypt
190 * @param encParams primary encryption settings
191 * @param kencParams key encryption settings, or NULL
192 * @return a stand-alone EncryptedData object, unconnected to any DOM
194 EncryptedData* encryptStream(std::istream& input, EncryptionParams& encParams, KeyEncryptionParams* kencParams=NULL);
197 * Encrypts the supplied key and returns the resulting object.
199 * @param keyBuffer raw key material to encrypt
200 * @param keyBufferSize size in bytes of raw key material
201 * @param kencParams key encryption settings
202 * @param compact true iff the encrypted representation should be made as small as possible
203 * @return a stand-alone EncryptedKey object, unconnected to any DOM
205 EncryptedKey* encryptKey(
206 const unsigned char* keyBuffer, unsigned int keyBufferSize, KeyEncryptionParams& kencParams, bool compact=false
210 * Maps a data encryption algorithm to an appropriate key transport algorithm to use.
212 * @param credential the key encryption key
213 * @param encryptionAlg data encryption algorithm
214 * @return a key transport algorithm
216 static const XMLCh* getKeyTransportAlgorithm(const xmltooling::Credential& credential, const XMLCh* encryptionAlg);
219 void checkParams(EncryptionParams& encParams, KeyEncryptionParams* kencParams);
220 EncryptedData* decorateAndUnmarshall(EncryptionParams& encParams, KeyEncryptionParams* kencParams);
222 XENCCipher* m_cipher;
223 unsigned char m_keyBuffer[32];
226 DECL_XMLTOOLING_EXCEPTION(EncryptionException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmlencryption,xmltooling::XMLSecurityException,Exceptions in encryption processing);
230 #endif /* __xmltooling_encrypter_h__ */