xmltooling/encryption/EncryptedKeyResolver.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 EncryptedKeyResolver.h\r
  19  * \r
  20  * Resolves encrypted keys based on EncryptedData information or other external factors.\r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_enckeyres_h__) && !defined(XMLTOOLING_NO_XMLSEC)\r
  24 #define __xmltooling_enckeyres_h__\r
  25 \r
  26 #include <xmltooling/encryption/Encryption.h>\r
  27 #include <xmltooling/signature/KeyResolver.h>\r
  28 \r
  29 namespace xmlencryption {\r
  30 \r
  31     /**\r
  32      * An API for resolving encrypted decryption keys.\r
  33      */\r
  34     class XMLTOOL_API EncryptedKeyResolver : public xmlsignature::KeyResolver {\r
  35     public:\r
  36         virtual ~EncryptedKeyResolver() {}\r
  37         \r
  38         /**\r
  39          * Returns an encrypted key based on the supplied KeyInfo information.\r
  40          * \r
  41          * @param encryptedData an encrypted object\r
  42          * @return  the resolved EncryptedKey object\r
  43          */\r
  44         virtual EncryptedKey* resolveKey(EncryptedData* encryptedData)=0;\r
  45     };\r
  46 \r
  47 };\r
  48 \r
  49 #endif /* __xmltooling_enckeyres_h__ */\r