xmltooling/encryption/EncryptedKeyResolver.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file xmltooling/encryption/EncryptedKeyResolver.h
  23  *
  24  * Resolves encrypted keys based on EncryptedData information or other external factors.
  25  */
  26
  27 #if !defined(__xmltooling_enckeyres_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  28 #define __xmltooling_enckeyres_h__
  29
  30 #include <xmltooling/encryption/Encryption.h>
  31
  32 namespace xmlencryption {
  33
  34     /**
  35      * An API for resolving encrypted decryption keys.
  36      */
  37     class XMLTOOL_API EncryptedKeyResolver {
  38         MAKE_NONCOPYABLE(EncryptedKeyResolver);
  39     public:
  40         EncryptedKeyResolver();
  41         virtual ~EncryptedKeyResolver();
  42
  43         /**
  44          * Returns an encrypted key based on the supplied object's KeyInfo information.
  45          *
  46          * @param encryptedData an encrypted object
  47          * @param recipient identifier of recipient of encrypted key
  48          * @return  the resolved EncryptedKey object
  49          */
  50         virtual const EncryptedKey* resolveKey(const EncryptedData& encryptedData, const XMLCh* recipient=nullptr) const;
  51     };
  52
  53 };
  54
  55 #endif /* __xmltooling_enckeyres_h__ */