src/core/ext/xds/certificate_provider_factory.h

   1 //
   2 //
   3 // Copyright 2020 gRPC authors.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 //
  18
  19 #ifndef GRPC_CORE_EXT_XDS_CERTIFICATE_PROVIDER_FACTORY_H
  20 #define GRPC_CORE_EXT_XDS_CERTIFICATE_PROVIDER_FACTORY_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include "src/core/lib/iomgr/error.h"
  25 #include "src/core/lib/json/json.h"
  26 #include "src/core/lib/security/credentials/tls/grpc_tls_certificate_provider.h"
  27
  28 namespace grpc_core {
  29
  30 // Factories for plugins. Each plugin implementation should create its own
  31 // factory implementation and register an instance with the registry.
  32 class CertificateProviderFactory {
  33  public:
  34   // Interface for configs for CertificateProviders.
  35   class Config : public RefCounted<Config> {
  36    public:
  37     ~Config() override = default;
  38
  39     // Name of the type of the CertificateProvider. Unique to each type of
  40     // config.
  41     virtual const char* name() const = 0;
  42
  43     virtual std::string ToString() const = 0;
  44   };
  45
  46   virtual ~CertificateProviderFactory() = default;
  47
  48   // Name of the plugin.
  49   virtual const char* name() const = 0;
  50
  51   virtual RefCountedPtr<Config> CreateCertificateProviderConfig(
  52       const Json& config_json, grpc_error** error) = 0;
  53
  54   // Create a CertificateProvider instance from config.
  55   virtual RefCountedPtr<grpc_tls_certificate_provider>
  56   CreateCertificateProvider(RefCountedPtr<Config> config) = 0;
  57 };
  58
  59 }  // namespace grpc_core
  60
  61 #endif  // GRPC_CORE_EXT_XDS_CERTIFICATE_PROVIDER_FACTORY_H