saml/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 saml/encryption/EncryptedKeyResolver.h
  19  *
  20  * SAML-specific encrypted key resolver.
  21  */
  22
  23 #ifndef __saml_enckeyres_h__
  24 #define __saml_enckeyres_h__
  25
  26 #include <saml/base.h>
  27 #include <xmltooling/encryption/EncryptedKeyResolver.h>
  28
  29 namespace opensaml {
  30
  31     namespace saml2 {
  32         class SAML_API EncryptedElementType;
  33     };
  34
  35     /**
  36      * SAML-specific encrypted key resolver.
  37      *
  38      * SAML allows placement of keys alongside the encrypted data. This resolver
  39      * recognizes the implied placement.
  40      */
  41     class SAML_API EncryptedKeyResolver : public xmlencryption::EncryptedKeyResolver
  42     {
  43     public:
  44         /**
  45          * Constructor.
  46          *
  47          * @param ref   reference to encrypted element
  48          */
  49         EncryptedKeyResolver(const saml2::EncryptedElementType& ref);
  50
  51         virtual ~EncryptedKeyResolver();
  52
  53         const xmlencryption::EncryptedKey* resolveKey(const xmlencryption::EncryptedData& encryptedData, const XMLCh* recipient=nullptr) const;
  54
  55     protected:
  56         /** Reference to encrypted element. */
  57         const saml2::EncryptedElementType& m_ref;
  58     };
  59
  60 };
  61
  62 #endif /* __saml_enckeyres_h__ */