grpc/include/grpc++/credentials.h

/*
 *
 * Copyright 2014, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __GRPCPP_CREDENTIALS_H_
#define __GRPCPP_CREDENTIALS_H_

#include <memory>

#include <grpc++/config.h>

struct grpc_credentials;

namespace grpc {

// grpc_credentials wrapper class. Typical use in C++ applications is limited
// to creating an instance using CredentialsFactory, and passing it down
// during channel construction.

class Credentials final {
 public:
  ~Credentials();
  // TODO(abhikumar): Specify a plugin API here to be implemented by
  // credentials that do not have a corresponding implementation in C.

 protected:
  explicit Credentials(grpc_credentials*);

 private:
  grpc_credentials* GetRawCreds();

  friend class CredentialsFactory;

  grpc_credentials* creds_;
};

// Options used to build SslCredentials
struct SslCredentialsOptions {
  grpc::string pem_root_certs;
  grpc::string pem_private_key;
  grpc::string pem_cert_chain;
};

// Factory for building different types of Credentials
class CredentialsFactory {
 public:
  // Builds credentials with reasonable defaults.
  static std::unique_ptr<Credentials> DefaultCredentials();

  // Builds SSL Credentials given SSL specific options
  static std::unique_ptr<Credentials> SslCredentials(
      const SslCredentialsOptions& options);

  // Builds credentials for use when running in GCE
  static std::unique_ptr<Credentials> ComputeEngineCredentials();


  // Combines two credentials objects into a composite credentials
  static std::unique_ptr<Credentials> ComposeCredentials(
      const std::unique_ptr<Credentials>& creds1,
      const std::unique_ptr<Credentials>& creds2);
};

}  // namespace grpc

#endif  // __GRPCPP_CREDENTIALS_H_