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/Decrypter.h
20 * Wrapper API for XML Decryption functionality.
23 #if !defined(__xmltooling_decrypter_h__) && !defined(XMLTOOLING_NO_XMLSEC)
24 #define __xmltooling_decrypter_h__
26 #include <xmltooling/encryption/Encryption.h>
28 #include <xsec/xenc/XENCCipher.hpp>
30 namespace xmltooling {
31 class XMLTOOL_API CredentialCriteria;
32 class XMLTOOL_API CredentialResolver;
35 namespace xmlencryption {
37 class XMLTOOL_API EncryptedKeyResolver;
40 * Wrapper API for XML Decryption functionality.
42 class XMLTOOL_API Decrypter
48 * @param credResolver locked credential resolver to supply decryption keys
49 * @param criteria optional external criteria to use with resolver
50 * @param EKresolver locates an EncryptedKey pertaining to the EncryptedData
53 const xmltooling::CredentialResolver* credResolver=NULL,
54 xmltooling::CredentialCriteria* criteria=NULL,
55 const EncryptedKeyResolver* EKResolver=NULL
56 ) : m_cipher(NULL), m_credResolver(credResolver), m_criteria(criteria), m_EKResolver(EKResolver) {
62 * Replace the current EncryptedKeyResolver interface, if any, with a new one.
64 * @param EKresolver the EncryptedKeyResolver to attach
66 void setEncryptedKeyResolver(const EncryptedKeyResolver* EKResolver) {
67 m_EKResolver=EKResolver;
71 * Replace the current CredentialResolver interface, if any, with a new one.
73 * @param resolver the locked CredentialResolver to attach, or NULL to clear
74 * @param criteria optional external criteria to use with resolver
76 void setKEKResolver(const xmltooling::CredentialResolver* resolver, xmltooling::CredentialCriteria* criteria) {
77 m_credResolver=resolver;
82 * Decrypts the supplied information using the supplied key, and returns
83 * the resulting as a DOM fragment owned by the document associated with the
84 * marshalled EncryptedData object.
86 * Note that the DOM nodes will be invalidated once that document
87 * is released. The caller should therefore process the DOM fragment as
88 * required and drop all references to it before that happens. The usual
89 * approach should be to unmarshall the DOM and then release it, or the
90 * DOM can also be imported into a separately owned document.
92 * @param encryptedData the data to decrypt
93 * @param key the decryption key to use (it will not be freed internally)
94 * @return the decrypted DOM fragment
96 DOMDocumentFragment* decryptData(const EncryptedData& encryptedData, XSECCryptoKey* key);
99 * Decrypts the supplied information and returns the resulting as a DOM
100 * fragment owned by the document associated with the marshalled EncryptedData
103 * Note that the DOM nodes will be invalidated once that document
104 * is released. The caller should therefore process the DOM fragment as
105 * required and drop all references to it before that happens. The usual
106 * approach should be to unmarshall the DOM and then release it, or the
107 * DOM can also be imported into a separately owned document.
109 * @param encryptedData the data to decrypt
110 * @param recipient identifier of decrypting entity for use in identifying multi-cast keys
111 * @return the decrypted DOM fragment
113 DOMDocumentFragment* decryptData(const EncryptedData& encryptedData, const XMLCh* recipient=NULL);
116 * Decrypts the supplied information and returns the resulting key.
117 * The caller is responsible for deleting the key. The algorithm of the
118 * key must be supplied by the caller based on knowledge of the associated
119 * EncryptedData information.
121 * @param encryptedKey the encrypted/wrapped key to decrypt
122 * @param algorithm the algorithm associated with the decrypted key
123 * @return the decrypted key
125 XSECCryptoKey* decryptKey(const EncryptedKey& encryptedKey, const XMLCh* algorithm);
128 XENCCipher* m_cipher;
129 const xmltooling::CredentialResolver* m_credResolver;
130 xmltooling::CredentialCriteria* m_criteria;
131 const EncryptedKeyResolver* m_EKResolver;
134 DECL_XMLTOOLING_EXCEPTION(DecryptionException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmlencryption,xmltooling::XMLToolingException,Exceptions in decryption processing);
138 #endif /* __xmltooling_decrypter_h__ */