alts_zero_copy_grpc_protector.cc File Reference

#include <grpc/support/port_platform.h>
#include "src/core/tsi/alts/zero_copy_frame_protector/alts_zero_copy_grpc_protector.h"
#include <string.h>
#include <grpc/support/alloc.h>
#include <grpc/support/log.h>
#include "src/core/lib/gpr/useful.h"
#include "src/core/lib/iomgr/exec_ctx.h"
#include "src/core/lib/slice/slice_internal.h"
#include "src/core/tsi/alts/crypt/gsec.h"
#include "src/core/tsi/alts/zero_copy_frame_protector/alts_grpc_integrity_only_record_protocol.h"
#include "src/core/tsi/alts/zero_copy_frame_protector/alts_grpc_privacy_integrity_record_protocol.h"
#include "src/core/tsi/alts/zero_copy_frame_protector/alts_grpc_record_protocol.h"
#include "src/core/tsi/alts/zero_copy_frame_protector/alts_iovec_record_protocol.h"
#include "src/core/tsi/transport_security_grpc.h"

Data Structures
struct	alts_zero_copy_grpc_protector
	Main struct for alts_zero_copy_grpc_protector. More...

Typedefs
typedef struct alts_zero_copy_grpc_protector	alts_zero_copy_grpc_protector
	Main struct for alts_zero_copy_grpc_protector. More...

Functions
tsi_result	alts_zero_copy_grpc_protector_create (const uint8_t *key, size_t key_size, bool is_rekey, bool is_client, bool is_integrity_only, bool enable_extra_copy, size_t *max_protected_frame_size, tsi_zero_copy_grpc_protector **protector)
	This method creates an ALTS zero-copy grpc protector. More...

Variables
constexpr size_t	kMinFrameLength = 1024
constexpr size_t	kDefaultFrameLength = 16 * 1024
constexpr size_t	kMaxFrameLength = 16 * 1024 * 1024

Typedef Documentation

alts_zero_copy_grpc_protector

typedef struct alts_zero_copy_grpc_protector alts_zero_copy_grpc_protector

Main struct for alts_zero_copy_grpc_protector.

We choose to have two alts_grpc_record_protocol objects and two sets of slice buffers: one for protect and the other for unprotect, so that protect and unprotect can be executed in parallel. Implementations of this object must be thread compatible.

Function Documentation

alts_zero_copy_grpc_protector_create()

tsi_result alts_zero_copy_grpc_protector_create	(	const uint8_t *	key,
		size_t	key_size,
		bool	is_rekey,
		bool	is_client,
		bool	is_integrity_only,
		bool	enable_extra_copy,
		size_t *	max_protected_frame_size,
		tsi_zero_copy_grpc_protector **	protector
	)

This method creates an ALTS zero-copy grpc protector.

• key: a symmetric key used to seal/unseal frames.
• key_size: the size of symmetric key.
• is_rekey: use rekeying AEAD crypter.
• is_client: a flag indicating if the protector will be used at client or server side.
• is_integrity_only: a flag indicating if the protector instance will be used for integrity-only or privacy-integrity mode.
• enable_extra_copy: a flag indicating if the protector instance does one extra memory copy during the protect operation for integrity_only mode. For the unprotect operation, it is still zero-copy. If application intends to modify the data buffer after the protect operation, we can turn on this mode to avoid integrity check failure.
• max_protected_frame_size: an in/out parameter indicating max frame size to be used by the protector. If it is nullptr, the default frame size will be used. Otherwise, the provided frame size will be adjusted (if not falling into a valid frame range) and used.
• protector: a pointer to the zero-copy protector returned from the method.

This method returns TSI_OK on success or a specific error code otherwise.

Variable Documentation

kDefaultFrameLength

constexpr size_t kDefaultFrameLength = 16 * 1024

constexpr

kMaxFrameLength

constexpr size_t kMaxFrameLength = 16 * 1024 * 1024

constexpr

kMinFrameLength

constexpr size_t kMinFrameLength = 1024

constexpr