c++/html/credentials_8h_source.html

 /*

-  *

-  * Copyright 2015, 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 GRPCXX_CREDENTIALS_H

- #define GRPCXX_CREDENTIALS_H

-

- #include <memory>

-

- #include <grpc++/impl/grpc_library.h>

- #include <grpc++/support/config.h>

-

- namespace grpc {

- class ChannelArguments;

- class Channel;

- class SecureCredentials;

-

- class Credentials : public GrpcLibrary {

-  public:

-   ~Credentials() GRPC_OVERRIDE;

-

-   virtual bool ApplyToCall(grpc_call* call) = 0;

-

-  protected:

-   friend std::shared_ptr<Credentials> CompositeCredentials(

-       const std::shared_ptr<Credentials>& creds1,

-       const std::shared_ptr<Credentials>& creds2);

-

-   virtual SecureCredentials* AsSecureCredentials() = 0;

-

-  private:

-   friend std::shared_ptr<Channel> CreateCustomChannel(

-       const grpc::string& target, const std::shared_ptr<Credentials>& creds,

-       const ChannelArguments& args);

-

-   virtual std::shared_ptr<Channel> CreateChannel(

-       const grpc::string& target, const ChannelArguments& args) = 0;

- };

-

- struct SslCredentialsOptions {

-   grpc::string pem_root_certs;

-

-   grpc::string pem_private_key;

-

-   grpc::string pem_cert_chain;

- };

-

- // Factories for building different types of Credentials The functions may

- // return empty shared_ptr when credentials cannot be created. If a

- // Credentials pointer is returned, it can still be invalid when used to create

- // a channel. A lame channel will be created then and all rpcs will fail on it.

-

- std::shared_ptr<Credentials> GoogleDefaultCredentials();

-

- std::shared_ptr<Credentials> SslCredentials(

-     const SslCredentialsOptions& options);

-

- std::shared_ptr<Credentials> GoogleComputeEngineCredentials();

-

- std::shared_ptr<Credentials> ServiceAccountJWTAccessCredentials(

-     const grpc::string& json_key, long token_lifetime_seconds);

-

- std::shared_ptr<Credentials> GoogleRefreshTokenCredentials(

-     const grpc::string& json_refresh_token);

-

- std::shared_ptr<Credentials> AccessTokenCredentials(

-     const grpc::string& access_token);

-

- std::shared_ptr<Credentials> GoogleIAMCredentials(

-     const grpc::string& authorization_token,

-     const grpc::string& authority_selector);

-

- std::shared_ptr<Credentials> CompositeCredentials(

-     const std::shared_ptr<Credentials>& creds1,

-     const std::shared_ptr<Credentials>& creds2);

-

- std::shared_ptr<Credentials> InsecureCredentials();

-

- }  // namespace grpc

-

- #endif  // GRPCXX_CREDENTIALS_H

-grpc::SslCredentials
std::shared_ptr< Credentials > SslCredentials(const SslCredentialsOptions &options)
Builds SSL Credentials given SSL specific options.

-grpc::string
std::string string
Definition: config.h:112

-grpc::GoogleRefreshTokenCredentials
std::shared_ptr< Credentials > GoogleRefreshTokenCredentials(const grpc::string &json_refresh_token)
Builds refresh token credentials.

-grpc::ChannelArguments
Options for channel creation.
Definition: channel_arguments.h:52

-grpc::ServiceAccountJWTAccessCredentials
std::shared_ptr< Credentials > ServiceAccountJWTAccessCredentials(const grpc::string &json_key, long token_lifetime_seconds)
Builds Service Account JWT Access credentials.

-grpc_library.h

-grpc::Credentials::CreateCustomChannel
friend std::shared_ptr< Channel > CreateCustomChannel(const grpc::string &target, const std::shared_ptr< Credentials > &creds, const ChannelArguments &args)
Create a new custom Channel pointing to target.

-config.h

-grpc::Credentials::~Credentials
~Credentials() GRPC_OVERRIDE

-grpc::AccessTokenCredentials
std::shared_ptr< Credentials > AccessTokenCredentials(const grpc::string &access_token)
Builds access token credentials.

-grpc::Credentials::ApplyToCall
virtual bool ApplyToCall(grpc_call *call)=0
Apply this instance's credentials to call.

-grpc::SslCredentialsOptions::pem_root_certs
grpc::string pem_root_certs
The buffer containing the PEM encoding of the server root certificates.
Definition: credentials.h:83

-grpc::SslCredentialsOptions
Options used to build SslCredentials.
Definition: credentials.h:77

-grpc::GrpcLibrary
Definition: grpc_library.h:41

-grpc::Credentials::AsSecureCredentials
virtual SecureCredentials * AsSecureCredentials()=0

-grpc::SslCredentialsOptions::pem_cert_chain
grpc::string pem_cert_chain
The buffer containing the PEM encoding of the client's certificate chain.
Definition: credentials.h:92

-grpc::GoogleIAMCredentials
std::shared_ptr< Credentials > GoogleIAMCredentials(const grpc::string &authorization_token, const grpc::string &authority_selector)
Builds IAM credentials.

-grpc::Credentials
A credentials object encapsulates all the state needed by a client to authenticate with a server and ...
Definition: credentials.h:53

-grpc::SslCredentialsOptions::pem_private_key
grpc::string pem_private_key
The buffer containing the PEM encoding of the client's private key.
Definition: credentials.h:87

-grpc::GoogleDefaultCredentials
std::shared_ptr< Credentials > GoogleDefaultCredentials()
Builds credentials with reasonable defaults.

-grpc::Credentials::CompositeCredentials
friend std::shared_ptr< Credentials > CompositeCredentials(const std::shared_ptr< Credentials > &creds1, const std::shared_ptr< Credentials > &creds2)
Combines two credentials objects into a composite credentials.

-grpc::InsecureCredentials
std::shared_ptr< Credentials > InsecureCredentials()
Credentials for an unencrypted, unauthenticated channel.

-grpc::GoogleComputeEngineCredentials
std::shared_ptr< Credentials > GoogleComputeEngineCredentials()
Builds credentials for use when running in GCE.

-grpc::CompositeCredentials
std::shared_ptr< Credentials > CompositeCredentials(const std::shared_ptr< Credentials > &creds1, const std::shared_ptr< Credentials > &creds2)
Combines two credentials objects into a composite credentials.

-GRPC_OVERRIDE
#define GRPC_OVERRIDE
Definition: config.h:77

-