xmltooling/security/KeyInfoResolver.h

   1 /*
   2  *  Copyright 2001-2007 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/security/KeyInfoResolver.h
  19  *
  20  * Resolves credentials from KeyInfo information.
  21  */
  22
  23 #if !defined(__xmltooling_keyres_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  24 #define __xmltooling_keyres_h__
  25
  26 #include <xsec/dsig/DSIGKeyInfoList.hpp>
  27
  28 namespace xmlsignature {
  29     class XMLTOOL_API KeyInfo;
  30     class XMLTOOL_API Signature;
  31 };
  32
  33 namespace xmltooling {
  34
  35     class XMLTOOL_API Credential;
  36     class XMLTOOL_API CredentialCriteria;
  37
  38     /**
  39      * Resolves credentials from KeyInfo information.
  40      *
  41      * <p>Credential-specific bitmasks can be provided to control what to resolve.
  42      */
  43     class XMLTOOL_API KeyInfoResolver {
  44         MAKE_NONCOPYABLE(KeyInfoResolver);
  45     protected:
  46         KeyInfoResolver() {}
  47     public:
  48         virtual ~KeyInfoResolver() {}
  49
  50         /**
  51          * Returns a credential based on the supplied KeyInfo information.
  52          * The caller must release the credential when done with it.
  53          *
  54          * @param keyInfo   the key information
  55          * @param types     types of credentials to resolve, or 0 for any/all
  56          * @return  the resolved credential, or NULL
  57          */
  58         virtual Credential* resolve(const xmlsignature::KeyInfo* keyInfo, int types=0) const=0;
  59
  60         /**
  61          * Returns a credential based on the supplied KeyInfo information.
  62          * The caller must release the credential when done with it.
  63          *
  64          * @param keyInfo   the key information
  65          * @param types     types of credentials to resolve, or 0 for any/all
  66          * @return  the resolved credential, or NULL
  67          */
  68         virtual Credential* resolve(DSIGKeyInfoList* keyInfo, int types=0) const=0;
  69
  70         /**
  71          * Returns a credential based on the supplied KeyInfo information.
  72          * The caller must release the credential when done with it.
  73          *
  74          * @param sig   signature containing the key information
  75          * @param types types of credentials to resolve, or 0 for any/all
  76          * @return  the resolved credential, or NULL
  77          */
  78         Credential* resolve(const xmlsignature::Signature* sig, int types=0) const;
  79
  80         /**
  81          * Returns a credential based on the KeyInfo information in the supplied
  82          * criteria. The caller must release the credential when done with it.
  83          *
  84          * @param criteria   criteria containing the key information
  85          * @param types types of credentials to resolve, or 0 for any/all
  86          * @return  the resolved credential, or NULL
  87          */
  88         Credential* resolve(const CredentialCriteria& criteria, int types=0) const;
  89     };
  90
  91     /**
  92      * Registers KeyInfoResolver classes into the runtime.
  93      */
  94     void XMLTOOL_API registerKeyInfoResolvers();
  95
  96     /** KeyInfoResolver based on extracting by value directly out of a KeyInfo */
  97     #define INLINE_KEYINFO_RESOLVER  "Inline"
  98 };
  99
 100 #endif /* __xmltooling_keyres_h__ */