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