alts_handshaker_client.h File Reference

#include <grpc/support/port_platform.h>
#include <grpc/byte_buffer.h>
#include <grpc/byte_buffer_reader.h>
#include <grpc/grpc.h>
#include "src/core/tsi/alts/handshaker/alts_tsi_handshaker.h"
#include "src/core/tsi/transport_security_interface.h"
#include "src/core/lib/iomgr/closure.h"
#include "src/core/lib/iomgr/pollset_set.h"

Go to the source code of this file.

Data Structures
struct	alts_handshaker_client_vtable

Macros
#define	ALTS_SERVICE_METHOD   "/grpc.gcp.HandshakerService/DoHandshake"
#define	ALTS_APPLICATION_PROTOCOL   "grpc"
#define	ALTS_RECORD_PROTOCOL   "ALTSRP_GCM_AES128_REKEY"
#define	ALTS_HANDSHAKER_SERVICE_URL_FOR_TESTING   "lame"

Typedefs
typedef struct alts_tsi_handshaker	alts_tsi_handshaker
typedef struct alts_handshaker_client	alts_handshaker_client
	A ALTS handshaker client interface. More...
typedef grpc_call_error(*	alts_grpc_caller) (grpc_call *call, const grpc_op *ops, size_t nops, grpc_closure *tag)
typedef struct alts_handshaker_client_vtable	alts_handshaker_client_vtable

Functions
tsi_result	alts_handshaker_client_start_client (alts_handshaker_client *client)
	This method schedules a client_start handshaker request to ALTS handshaker service. More...
tsi_result	alts_handshaker_client_start_server (alts_handshaker_client *client, grpc_slice *bytes_received)
	This method schedules a server_start handshaker request to ALTS handshaker service. More...
tsi_result	alts_handshaker_client_next (alts_handshaker_client *client, grpc_slice *bytes_received)
	This method schedules a next handshaker request to ALTS handshaker service. More...
void	alts_handshaker_client_shutdown (alts_handshaker_client *client)
	This method cancels previously scheduled, but yet executed handshaker requests to ALTS handshaker service. More...
void	alts_handshaker_client_destroy (alts_handshaker_client *client)
	This method destroys an ALTS handshaker client. More...
alts_handshaker_client *	alts_grpc_handshaker_client_create (alts_tsi_handshaker *handshaker, grpc_channel *channel, const char *handshaker_service_url, grpc_pollset_set *interested_parties, grpc_alts_credentials_options *options, const grpc_slice &target_name, grpc_iomgr_cb_func grpc_cb, tsi_handshaker_on_next_done_cb cb, void *user_data, alts_handshaker_client_vtable *vtable_for_testing, bool is_client)
	This method creates an ALTS handshaker client. More...
void	alts_handshaker_client_handle_response (alts_handshaker_client *client, bool is_ok)
	This method handles handshaker response returned from ALTS handshaker service. More...

Variables
const size_t	kAltsAes128GcmRekeyKeyLength = 44

Macro Definition Documentation

ALTS_APPLICATION_PROTOCOL

#define ALTS_APPLICATION_PROTOCOL   "grpc"

ALTS_HANDSHAKER_SERVICE_URL_FOR_TESTING

#define ALTS_HANDSHAKER_SERVICE_URL_FOR_TESTING   "lame"

ALTS_RECORD_PROTOCOL

#define ALTS_RECORD_PROTOCOL   "ALTSRP_GCM_AES128_REKEY"

ALTS_SERVICE_METHOD

#define ALTS_SERVICE_METHOD   "/grpc.gcp.HandshakerService/DoHandshake"

Typedef Documentation

alts_grpc_caller

typedef grpc_call_error(* alts_grpc_caller) (grpc_call *call, const grpc_op *ops, size_t nops, grpc_closure *tag)

alts_handshaker_client

typedef struct alts_handshaker_client alts_handshaker_client

A ALTS handshaker client interface.

It is used to communicate with ALTS handshaker service by scheduling a handshaker request that could be one of client_start, server_start, and next handshaker requests. All APIs in the header are thread-compatible.

alts_handshaker_client_vtable

typedef struct alts_handshaker_client_vtable alts_handshaker_client_vtable

alts_tsi_handshaker

typedef struct alts_tsi_handshaker alts_tsi_handshaker

Function Documentation

alts_grpc_handshaker_client_create()

alts_handshaker_client* alts_grpc_handshaker_client_create	(	alts_tsi_handshaker *	handshaker,
		grpc_channel *	channel,
		const char *	handshaker_service_url,
		grpc_pollset_set *	interested_parties,
		grpc_alts_credentials_options *	options,
		const grpc_slice &	target_name,
		grpc_iomgr_cb_func	grpc_cb,
		tsi_handshaker_on_next_done_cb	cb,
		void *	user_data,
		alts_handshaker_client_vtable *	vtable_for_testing,
		bool	is_client
	)

This method creates an ALTS handshaker client.

• handshaker: ALTS TSI handshaker to which the created handshaker client belongs to.
• channel: grpc channel to ALTS handshaker service.
• handshaker_service_url: address of ALTS handshaker service in the format of "host:port".
• interested_parties: set of pollsets interested in this connection.
• options: ALTS credentials options containing information passed from TSI caller (e.g., rpc protocol versions)
• target_name: the name of the endpoint that the channel is connecting to, and will be used for secure naming check
• grpc_cb: gRPC provided callbacks passed from TSI handshaker.
• cb: callback to be executed when tsi_handshaker_next API compltes.
• user_data: argument passed to cb.
• vtable_for_testing: ALTS handshaker client vtable instance used for testing purpose.
• is_client: a boolean value indicating if the created handshaker client is used at the client (is_client = true) or server (is_client = false) side. It returns the created ALTS handshaker client on success, and NULL on failure.

alts_handshaker_client_destroy()

void alts_handshaker_client_destroy

(

alts_handshaker_client *

client

)

This method destroys an ALTS handshaker client.

• client: an ALTS handshaker client instance.

alts_handshaker_client_handle_response()

void alts_handshaker_client_handle_response	(	alts_handshaker_client *	client,
		bool	is_ok
	)

This method handles handshaker response returned from ALTS handshaker service.

Note that the only reason the API is exposed is that it is used in alts_shared_resources.cc.

• client: an ALTS handshaker client instance.
• is_ok: a boolean value indicating if the handshaker response is ok to read.

alts_handshaker_client_next()

tsi_result alts_handshaker_client_next	(	alts_handshaker_client *	client,
		grpc_slice *	bytes_received
	)

This method schedules a next handshaker request to ALTS handshaker service.

• client: ALTS handshaker client instance.
• bytes_received: bytes in out_frames returned from the peer's handshaker response.

It returns TSI_OK on success and an error status code on failure.

alts_handshaker_client_shutdown()

void alts_handshaker_client_shutdown

(

alts_handshaker_client *

client

)

This method cancels previously scheduled, but yet executed handshaker requests to ALTS handshaker service.

After this operation, the handshake will be shutdown, and no more handshaker requests will get scheduled.

• client: ALTS handshaker client instance.

alts_handshaker_client_start_client()

tsi_result alts_handshaker_client_start_client

(

alts_handshaker_client *

client

)

This method schedules a client_start handshaker request to ALTS handshaker service.

• client: ALTS handshaker client instance.

It returns TSI_OK on success and an error status code on failure.

alts_handshaker_client_start_server()

tsi_result alts_handshaker_client_start_server	(	alts_handshaker_client *	client,
		grpc_slice *	bytes_received
	)

This method schedules a server_start handshaker request to ALTS handshaker service.

• client: ALTS handshaker client instance.
• bytes_received: bytes in out_frames returned from the peer's handshaker response.

It returns TSI_OK on success and an error status code on failure.

Variable Documentation

kAltsAes128GcmRekeyKeyLength

const size_t kAltsAes128GcmRekeyKeyLength = 44