xmltooling/encryption/EncryptedKeyResolver.h

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