GRPC C++  1.32.0
server_credentials.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015 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 GRPCPP_SECURITY_SERVER_CREDENTIALS_H
20 #define GRPCPP_SECURITY_SERVER_CREDENTIALS_H
21 
22 #include <memory>
23 #include <vector>
24 
28 #include <grpcpp/support/config.h>
29 
30 struct grpc_server;
31 
32 namespace grpc_impl {
33 
34 class Server;
35 } // namespace grpc_impl
36 namespace grpc {
37 
42  : force_client_auth(false),
46  : force_client_auth(false), client_certificate_request(request_type) {}
47 
48  struct PemKeyCertPair {
49  std::string private_key;
50  std::string cert_chain;
51  };
52  std::string pem_root_certs;
53  std::vector<PemKeyCertPair> pem_key_cert_pairs;
56 
62 };
63 
66  public:
67  virtual ~ServerCredentials();
68 
71  virtual void SetAuthMetadataProcessor(
72  const std::shared_ptr<grpc::AuthMetadataProcessor>& processor) = 0;
73 
74  private:
76 
81  // TODO(dgq): the "port" part seems to be a misnomer.
82  virtual int AddPortToServer(const std::string& addr, grpc_server* server) = 0;
83 };
84 
86 std::shared_ptr<ServerCredentials> SslServerCredentials(
87  const grpc::SslServerCredentialsOptions& options);
88 
89 std::shared_ptr<ServerCredentials> InsecureServerCredentials();
90 
91 namespace experimental {
92 
96 };
97 
99 std::shared_ptr<ServerCredentials> AltsServerCredentials(
100  const AltsServerCredentialsOptions& options);
101 
103 std::shared_ptr<ServerCredentials> AltsServerCredentials(
104  const AltsServerCredentialsOptions& options);
105 
106 std::shared_ptr<ServerCredentials> LocalServerCredentials(
108 
110 std::shared_ptr<ServerCredentials> TlsServerCredentials(
111  const experimental::TlsCredentialsOptions& options);
112 
113 } // namespace experimental
114 } // namespace grpc
115 
116 #endif // GRPCPP_SECURITY_SERVER_CREDENTIALS_H
grpc::InsecureServerCredentials
std::shared_ptr< ServerCredentials > InsecureServerCredentials()
tls_credentials_options.h
grpc::SslServerCredentials
std::shared_ptr< ServerCredentials > SslServerCredentials(const grpc::SslServerCredentialsOptions &options)
Builds SSL ServerCredentials given SSL specific options.
grpc::SslServerCredentialsOptions::PemKeyCertPair
Definition: server_credentials.h:48
grpc
This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...
Definition: alarm.h:24
grpc::SslServerCredentialsOptions::force_client_auth
bool force_client_auth
Definition: server_credentials.h:55
grpc::ServerCredentials
Wrapper around grpc_server_credentials, a way to authenticate a server.
Definition: server_credentials.h:65
grpc::Server
::grpc_impl::Server Server
Definition: server.h:26
grpc::SslServerCredentialsOptions::PemKeyCertPair::private_key
std::string private_key
Definition: server_credentials.h:49
grpc::experimental::LocalServerCredentials
std::shared_ptr< ServerCredentials > LocalServerCredentials(grpc_local_connect_type type)
grpc::ServerCredentials::SetAuthMetadataProcessor
virtual void SetAuthMetadataProcessor(const std::shared_ptr< grpc::AuthMetadataProcessor > &processor)=0
This method is not thread-safe and has to be called before the server is started.
auth_metadata_processor.h
grpc_server
struct grpc_server grpc_server
A server listens to some port and responds to request calls.
Definition: grpc_types.h:65
grpc_ssl_client_certificate_request_type
grpc_ssl_client_certificate_request_type
Definition: grpc_security_constants.h:62
grpc::SslServerCredentialsOptions::SslServerCredentialsOptions
SslServerCredentialsOptions()
Definition: server_credentials.h:41
grpc::SslServerCredentialsOptions
Options to create ServerCredentials with SSL.
Definition: server_credentials.h:39
grpc::SslServerCredentialsOptions::PemKeyCertPair::cert_chain
std::string cert_chain
Definition: server_credentials.h:50
grpc::SslServerCredentialsOptions::SslServerCredentialsOptions
SslServerCredentialsOptions(grpc_ssl_client_certificate_request_type request_type)
Definition: server_credentials.h:44
grpc::SslServerCredentialsOptions::pem_root_certs
std::string pem_root_certs
Definition: server_credentials.h:52
config.h
GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE
@ GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE
Server does not request client certificate.
Definition: grpc_security_constants.h:67
grpc::experimental::TlsCredentialsOptions
TLS credentials options, wrapper for grpc_tls_credentials_options.
Definition: tls_credentials_options.h:279
grpc::SslServerCredentialsOptions::pem_key_cert_pairs
std::vector< PemKeyCertPair > pem_key_cert_pairs
Definition: server_credentials.h:53
grpc::ServerCredentials::~ServerCredentials
virtual ~ServerCredentials()
grpc_security_constants.h
grpc::SslServerCredentialsOptions::client_certificate_request
grpc_ssl_client_certificate_request_type client_certificate_request
If both force_client_auth and client_certificate_request fields are set, force_client_auth takes effe...
Definition: server_credentials.h:61
grpc_impl
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm_impl.h:33
grpc::experimental::AltsServerCredentials
std::shared_ptr< ServerCredentials > AltsServerCredentials(const AltsServerCredentialsOptions &options)
Builds ALTS ServerCredentials given ALTS specific options.
grpc::experimental::TlsServerCredentials
std::shared_ptr< ServerCredentials > TlsServerCredentials(const experimental::TlsCredentialsOptions &options)
Builds TLS ServerCredentials given TLS options.
grpc::experimental::AltsServerCredentialsOptions
Options to create ServerCredentials with ALTS.
Definition: server_credentials.h:94
grpc_local_connect_type
grpc_local_connect_type
Type of local connections for which local channel/server credentials will be applied.
Definition: grpc_security_constants.h:140