GRPC C++  1.62.0
authorization_policy_provider.h
Go to the documentation of this file.
1 // Copyright 2021 gRPC authors.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef GRPCPP_SECURITY_AUTHORIZATION_POLICY_PROVIDER_H
16 #define GRPCPP_SECURITY_AUTHORIZATION_POLICY_PROVIDER_H
17 
18 #include <memory>
19 
20 #include <grpc/grpc_security.h>
21 #include <grpc/status.h>
23 
24 namespace grpc {
25 namespace experimental {
26 
27 // Wrapper around C-core grpc_authorization_policy_provider. Internally, it
28 // handles creating and updating authorization engine objects, using SDK
29 // authorization policy.
31  public:
32  virtual ~AuthorizationPolicyProviderInterface() = default;
34 };
35 
36 // Implementation obtains authorization policy from static string. This provider
37 // will always return the same authorization engines.
40  public:
41  static std::shared_ptr<StaticDataAuthorizationPolicyProvider> Create(
42  const std::string& authz_policy, grpc::Status* status);
43 
44  // Use factory method "Create" to create an instance of
45  // StaticDataAuthorizationPolicyProvider.
48  : c_provider_(provider) {}
49 
51 
53  return c_provider_;
54  }
55 
56  private:
57  grpc_authorization_policy_provider* c_provider_ = nullptr;
58 };
59 
60 // Implementation obtains authorization policy by watching for changes in
61 // filesystem.
64  public:
65  static std::shared_ptr<FileWatcherAuthorizationPolicyProvider> Create(
66  const std::string& authz_policy_path, unsigned int refresh_interval_sec,
67  grpc::Status* status);
68 
69  // Use factory method "Create" to create an instance of
70  // FileWatcherAuthorizationPolicyProvider.
73  : c_provider_(provider) {}
74 
76 
78  return c_provider_;
79  }
80 
81  private:
82  grpc_authorization_policy_provider* c_provider_ = nullptr;
83 };
84 
85 } // namespace experimental
86 } // namespace grpc
87 
88 #endif // GRPCPP_SECURITY_AUTHORIZATION_POLICY_PROVIDER_H
grpc::experimental::FileWatcherAuthorizationPolicyProvider
Definition: authorization_policy_provider.h:62
grpc::experimental::StaticDataAuthorizationPolicyProvider
Definition: authorization_policy_provider.h:38
grpc
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
status.h
grpc::experimental::AuthorizationPolicyProviderInterface
Definition: authorization_policy_provider.h:30
grpc_security.h
grpc::experimental::FileWatcherAuthorizationPolicyProvider::FileWatcherAuthorizationPolicyProvider
FileWatcherAuthorizationPolicyProvider(grpc_authorization_policy_provider *provider)
Definition: authorization_policy_provider.h:71
status.h
grpc::experimental::StaticDataAuthorizationPolicyProvider::c_provider
grpc_authorization_policy_provider * c_provider() override
Definition: authorization_policy_provider.h:52
grpc::Status
Did it work? If it didn't, why?
Definition: status.h:35
grpc::experimental::AuthorizationPolicyProviderInterface::c_provider
virtual grpc_authorization_policy_provider * c_provider()=0
grpc::experimental::StaticDataAuthorizationPolicyProvider::~StaticDataAuthorizationPolicyProvider
~StaticDataAuthorizationPolicyProvider() override
grpc::experimental::FileWatcherAuthorizationPolicyProvider::Create
static std::shared_ptr< FileWatcherAuthorizationPolicyProvider > Create(const std::string &authz_policy_path, unsigned int refresh_interval_sec, grpc::Status *status)
grpc::experimental::FileWatcherAuthorizationPolicyProvider::c_provider
grpc_authorization_policy_provider * c_provider() override
Definition: authorization_policy_provider.h:77
grpc_authorization_policy_provider
struct grpc_authorization_policy_provider grpc_authorization_policy_provider
EXPERIMENTAL - Subject to change.
Definition: grpc_security.h:1261
grpc::experimental::StaticDataAuthorizationPolicyProvider::Create
static std::shared_ptr< StaticDataAuthorizationPolicyProvider > Create(const std::string &authz_policy, grpc::Status *status)
grpc::experimental::AuthorizationPolicyProviderInterface::~AuthorizationPolicyProviderInterface
virtual ~AuthorizationPolicyProviderInterface()=default
grpc::experimental::StaticDataAuthorizationPolicyProvider::StaticDataAuthorizationPolicyProvider
StaticDataAuthorizationPolicyProvider(grpc_authorization_policy_provider *provider)
Definition: authorization_policy_provider.h:46
grpc::experimental::FileWatcherAuthorizationPolicyProvider::~FileWatcherAuthorizationPolicyProvider
~FileWatcherAuthorizationPolicyProvider() override