xmltooling/security/CredentialResolver.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/CredentialResolver.h
  23  *
  24  * An API for resolving keys and certificates based on application criteria.
  25  */
  26
  27 #if !defined(__xmltooling_credres_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  28 #define __xmltooling_credres_h__
  29
  30 #include <xmltooling/Lockable.h>
  31
  32 namespace xmltooling {
  33
  34     class XMLTOOL_API Credential;
  35     class XMLTOOL_API CredentialCriteria;
  36
  37     /**
  38      * An API for resolving keys and certificates based on application criteria.
  39      */
  40     class XMLTOOL_API CredentialResolver : public virtual Lockable
  41     {
  42         MAKE_NONCOPYABLE(CredentialResolver);
  43     protected:
  44         CredentialResolver();
  45
  46     public:
  47         virtual ~CredentialResolver();
  48
  49         /**
  50          * Returns a single Credential according to the supplied criteria.
  51          *
  52          * @param criteria   an optional CredentialCriteria object
  53          * @return  a Credential, or nullptr if none could be found
  54          */
  55         virtual const Credential* resolve(const CredentialCriteria* criteria=nullptr) const=0;
  56
  57         /**
  58          * Returns all matching Credentials according to the supplied criteria.
  59          *
  60          * @param results   array to store matching Credentials
  61          * @param criteria  an optional CredentialCriteria object
  62          * @return  number of credentials found
  63          */
  64         virtual std::vector<const Credential*>::size_type resolve(
  65             std::vector<const Credential*>& results, const CredentialCriteria* criteria=nullptr
  66             ) const=0;
  67     };
  68
  69     /**
  70      * Registers CredentialResolver classes into the runtime.
  71      */
  72     void XMLTOOL_API registerCredentialResolvers();
  73
  74     /** CredentialResolver based on local files with no criteria support. */
  75     #define FILESYSTEM_CREDENTIAL_RESOLVER  "File"
  76
  77     /** CredentialResolver based on chaining together other resolvers. */
  78     #define CHAINING_CREDENTIAL_RESOLVER    "Chaining"
  79 };
  80
  81 #endif /* __xmltooling_credres_h__ */