org.apache.pulsar.client.api

Interface MessageCrypto<MetadataT,BuilderT>

@InterfaceAudience.Public
 @InterfaceStability.Stable
public interface MessageCrypto<MetadataT,BuilderT>

Interface that abstracts the method to encrypt/decrypt message for End to End Encryption.

Field Summary

Fields

Modifier and Type	Field and Description
static int	IV_LEN

Method Summary

Modifier and Type	Method and Description
void	addPublicKeyCipher(Set<String> keyNames, CryptoKeyReader keyReader)
boolean	decrypt(Supplier<MetadataT> messageMetadataSupplier, ByteBuffer payload, ByteBuffer outBuffer, CryptoKeyReader keyReader)
void	encrypt(Set<String> encKeys, CryptoKeyReader keyReader, Supplier<BuilderT> messageMetadataBuilderSupplier, ByteBuffer payload, ByteBuffer outBuffer)
int	getMaxOutputSize(int inputLen) Return the maximum for a given buffer to be encrypted or decrypted.
boolean	removeKeyCipher(String keyName)

Field Detail

IV_LEN

static final int IV_LEN

See Also:

Constant Field Values

Method Detail

addPublicKeyCipher

void addPublicKeyCipher(Set<String> keyNames,
                        CryptoKeyReader keyReader)
                 throws PulsarClientException.CryptoException

Throws:

PulsarClientException.CryptoException

removeKeyCipher

boolean removeKeyCipher(String keyName)

getMaxOutputSize

int getMaxOutputSize(int inputLen)

Return the maximum for a given buffer to be encrypted or decrypted. This is meant to allow to pre-allocate a buffer with enough space to be passed as

Parameters:

inputLen - the length of the input buffer

Returns:

the maximum size of the buffer to hold the encrypted/decrypted version of the input buffer

encrypt

void encrypt(Set<String> encKeys,
             CryptoKeyReader keyReader,
             Supplier<BuilderT> messageMetadataBuilderSupplier,
             ByteBuffer payload,
             ByteBuffer outBuffer)
      throws PulsarClientException

Throws:

PulsarClientException

decrypt

boolean decrypt(Supplier<MetadataT> messageMetadataSupplier,
                ByteBuffer payload,
                ByteBuffer outBuffer,
                CryptoKeyReader keyReader)