Class AltsTsiFrameProtector

java.lang.Object

io.grpc.alts.internal.AltsTsiFrameProtector

All Implemented Interfaces:

TsiFrameProtector

public final class AltsTsiFrameProtector
extends Object
implements TsiFrameProtector

Frame protector that uses the ALTS framing.

Nested Class Summary

Nested classes/interfaces inherited from interface TsiFrameProtector

TsiFrameProtector.Consumer<T>

Constructor Summary

Constructors

Constructor	Description
AltsTsiFrameProtector(int maxProtectedFrameBytes, ChannelCrypterNetty crypter, io.netty.buffer.ByteBufAllocator alloc)	Create a new AltsTsiFrameProtector.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Must be called to release all associated resources (instance cannot be used afterwards).
static int	getHeaderBytes()
static int	getMaxFrameSize()
static int	getMinFrameSize()
void	protectFlush(List<io.netty.buffer.ByteBuf> unprotectedBufs, TsiFrameProtector.Consumer<io.netty.buffer.ByteBuf> ctxWrite, io.netty.buffer.ByteBufAllocator alloc)	Protects the buffers by performing framing and encrypting/appending MACs.
void	unprotect(io.netty.buffer.ByteBuf in, List<Object> out, io.netty.buffer.ByteBufAllocator alloc)	Unprotects the buffers by removing the framing and decrypting/checking MACs.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AltsTsiFrameProtector

public AltsTsiFrameProtector(int maxProtectedFrameBytes,
 ChannelCrypterNetty crypter,
 io.netty.buffer.ByteBufAllocator alloc)

Create a new AltsTsiFrameProtector.

Method Details

getHeaderBytes

public static int getHeaderBytes()

getMinFrameSize

public static int getMinFrameSize()

getMaxFrameSize

public static int getMaxFrameSize()

protectFlush

public void protectFlush(List<io.netty.buffer.ByteBuf> unprotectedBufs,
 TsiFrameProtector.Consumer<io.netty.buffer.ByteBuf> ctxWrite,
 io.netty.buffer.ByteBufAllocator alloc)
                  throws GeneralSecurityException

Description copied from interface: TsiFrameProtector

Protects the buffers by performing framing and encrypting/appending MACs.

Specified by:

protectFlush in interface TsiFrameProtector

Parameters:

unprotectedBufs - contain the payload that will be protected

ctxWrite - is called with buffers containing protected frames and must release the given buffers

alloc - is used to allocate new buffers for the protected frames

Throws:

GeneralSecurityException

unprotect

public void unprotect(io.netty.buffer.ByteBuf in,
 List<Object> out,
 io.netty.buffer.ByteBufAllocator alloc)
               throws GeneralSecurityException

Description copied from interface: TsiFrameProtector

Unprotects the buffers by removing the framing and decrypting/checking MACs.

Specified by:

unprotect in interface TsiFrameProtector

Parameters:

in - contains (partial) protected frames

out - is only used to append unprotected payload buffers

alloc - is used to allocate new buffers for the unprotected frames

Throws:

GeneralSecurityException

destroy

public void destroy()

Description copied from interface: TsiFrameProtector

Must be called to release all associated resources (instance cannot be used afterwards).

Specified by:

destroy in interface TsiFrameProtector