Line data    Source code

       1             : /*
       2             :  *
       3             :  * Copyright 2015, Google Inc.
       4             :  * All rights reserved.
       5             :  *
       6             :  * Redistribution and use in source and binary forms, with or without
       7             :  * modification, are permitted provided that the following conditions are
       8             :  * met:
       9             :  *
      10             :  *     * Redistributions of source code must retain the above copyright
      11             :  * notice, this list of conditions and the following disclaimer.
      12             :  *     * Redistributions in binary form must reproduce the above
      13             :  * copyright notice, this list of conditions and the following disclaimer
      14             :  * in the documentation and/or other materials provided with the
      15             :  * distribution.
      16             :  *     * Neither the name of Google Inc. nor the names of its
      17             :  * contributors may be used to endorse or promote products derived from
      18             :  * this software without specific prior written permission.
      19             :  *
      20             :  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
      21             :  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
      22             :  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
      23             :  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
      24             :  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
      25             :  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
      26             :  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
      27             :  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      28             :  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
      29             :  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
      30             :  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
      31             :  *
      32             :  */
      33             : 
      34             : #ifndef GRPCXX_SERVER_CREDENTIALS_H
      35             : #define GRPCXX_SERVER_CREDENTIALS_H
      36             : 
      37             : #include <memory>
      38             : #include <vector>
      39             : 
      40             : #include <grpc++/security/auth_metadata_processor.h>
      41             : #include <grpc++/support/config.h>
      42             : 
      43             : struct grpc_server;
      44             : 
      45             : namespace grpc {
      46             : class Server;
      47             : 
      48             : // Wrapper around \a grpc_server_credentials, a way to authenticate a server.
      49         205 : class ServerCredentials {
      50             :  public:
      51             :   virtual ~ServerCredentials();
      52             : 
      53             :   // This method is not thread-safe and has to be called before the server is
      54             :   // started. The last call to this function wins.
      55             :   virtual void SetAuthMetadataProcessor(
      56             :       const std::shared_ptr<AuthMetadataProcessor>& processor) = 0;
      57             : 
      58             :  private:
      59             :   friend class ::grpc::Server;
      60             : 
      61             :   /// Tries to bind \a server to the given \a addr (eg, localhost:1234,
      62             :   /// 192.168.1.1:31416, [::1]:27182, etc.)
      63             :   ///
      64             :   /// \return bound port number on sucess, 0 on failure.
      65             :   // TODO(dgq): the "port" part seems to be a misnomer.
      66             :   virtual int AddPortToServer(const grpc::string& addr,
      67             :                               grpc_server* server) = 0;
      68             : };
      69             : 
      70             : /// Options to create ServerCredentials with SSL
      71          46 : struct SslServerCredentialsOptions {
      72          46 :   SslServerCredentialsOptions() : force_client_auth(false) {}
      73             : 
      74         138 :   struct PemKeyCertPair {
      75             :     grpc::string private_key;
      76             :     grpc::string cert_chain;
      77             :   };
      78             :   grpc::string pem_root_certs;
      79             :   std::vector<PemKeyCertPair> pem_key_cert_pairs;
      80             :   bool force_client_auth;
      81             : };
      82             : 
      83             : /// Builds SSL ServerCredentials given SSL specific options
      84             : std::shared_ptr<ServerCredentials> SslServerCredentials(
      85             :     const SslServerCredentialsOptions& options);
      86             : 
      87             : /// Builds insecure server credentials.
      88             : std::shared_ptr<ServerCredentials> InsecureServerCredentials();
      89             : 
      90             : }  // namespace grpc
      91             : 
      92             : #endif  // GRPCXX_SERVER_CREDENTIALS_H