xmltooling/security/KeyInfoCredentialContext.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/security/KeyInfoCredentialContext.h
  23  *
  24  * Context for credentials resolved out of a KeyInfo.
  25  */
  26
  27 #if !defined(__xmltooling_keyinfocredctx_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  28 #define __xmltooling_keyinfocredctx_h__
  29
  30 #include <xmltooling/security/CredentialContext.h>
  31
  32 class DSIGKeyInfoList;
  33
  34 namespace xmlsignature {
  35     class XMLTOOL_API KeyInfo;
  36 }
  37
  38 namespace xmltooling {
  39
  40     /**
  41      * Context for credentials resolved out of a KeyInfo.
  42      */
  43     class XMLTOOL_API KeyInfoCredentialContext : public CredentialContext
  44     {
  45     public:
  46         /**
  47          * Constructor
  48          *
  49          * @param keyInfo   surrounding KeyInfo context object
  50          */
  51         KeyInfoCredentialContext(const xmlsignature::KeyInfo* keyInfo=nullptr);
  52
  53         /**
  54          * Constructor
  55          *
  56          * @param keyInfo   surrounding native KeyInfo context object
  57          */
  58         KeyInfoCredentialContext(DSIGKeyInfoList* keyInfo);
  59
  60         virtual ~KeyInfoCredentialContext();
  61
  62         /**
  63          * Gets the KeyInfo context.
  64          *
  65          * @return the KeyInfo context
  66          */
  67         const xmlsignature::KeyInfo* getKeyInfo() const;
  68
  69         /**
  70          * Gets the native KeyInfo context.
  71          *
  72          * @return the native KeyInfo context
  73          */
  74         DSIGKeyInfoList* getNativeKeyInfo() const;
  75
  76     private:
  77         const xmlsignature::KeyInfo* m_keyInfo;
  78         DSIGKeyInfoList* m_nativeKeyInfo;
  79     };
  80 };
  81
  82 #endif /* __xmltooling_keyinfocredctx_h__ */