GRPC Core  18.0.0
Data Structures | Functions
alts_credentials.h File Reference
#include <grpc/support/port_platform.h>
#include <grpc/grpc_security.h>
#include "src/core/lib/security/credentials/alts/grpc_alts_credentials_options.h"
#include "src/core/lib/security/credentials/credentials.h"

Go to the source code of this file.

Data Structures

class  grpc_alts_credentials
 
class  grpc_alts_server_credentials
 

Functions

grpc_channel_credentialsgrpc_alts_credentials_create_customized (const grpc_alts_credentials_options *options, const char *handshaker_service_url, bool enable_untrusted_alts)
 This method creates an ALTS channel credential object with customized information provided by caller. More...
 
grpc_server_credentialsgrpc_alts_server_credentials_create_customized (const grpc_alts_credentials_options *options, const char *handshaker_service_url, bool enable_untrusted_alts)
 This method creates an ALTS server credential object with customized information provided by caller. More...
 

Function Documentation

◆ grpc_alts_credentials_create_customized()

grpc_channel_credentials* grpc_alts_credentials_create_customized ( const grpc_alts_credentials_options options,
const char *  handshaker_service_url,
bool  enable_untrusted_alts 
)

This method creates an ALTS channel credential object with customized information provided by caller.

  • options: grpc ALTS credentials options instance for client.
  • handshaker_service_url: address of ALTS handshaker service in the format of "host:port". If it's nullptr, the address of default metadata server will be used.
  • enable_untrusted_alts: a boolean flag used to enable ALTS in untrusted mode. This mode can be enabled when we are sure ALTS is running on GCP or for testing purpose.

It returns nullptr if the flag is disabled AND ALTS is not running on GCP. Otherwise, it returns the created credential object.

◆ grpc_alts_server_credentials_create_customized()

grpc_server_credentials* grpc_alts_server_credentials_create_customized ( const grpc_alts_credentials_options options,
const char *  handshaker_service_url,
bool  enable_untrusted_alts 
)

This method creates an ALTS server credential object with customized information provided by caller.

  • options: grpc ALTS credentials options instance for server.
  • handshaker_service_url: address of ALTS handshaker service in the format of "host:port". If it's nullptr, the address of default metadata server will be used.
  • enable_untrusted_alts: a boolean flag used to enable ALTS in untrusted mode. This mode can be enabled when we are sure ALTS is running on GCP or for testing purpose.

It returns nullptr if the flag is disabled and ALTS is not running on GCP. Otherwise, it returns the created credential object.