io.quicksign.kafka.crypto

Class CryptoSerializer<T>

java.lang.Object

io.quicksign.kafka.crypto.CryptoSerializer<T>

Type Parameters:

T -

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.kafka.common.serialization.ExtendedSerializer<T>, org.apache.kafka.common.serialization.Serializer<T>

public class CryptoSerializer<T>
extends Object
implements org.apache.kafka.common.serialization.ExtendedSerializer<T>

Serializer for encrypted

Data is first serialized with the underlying serializer

If a key reference is found either in the Kafka Header KafkaCryptoConstants.KEY_REF_HEADER, or in the ThreadLocal keyRefHolder, then the serialized data is encrypted using the Encryptor. If data has been encrypted, the result of the serialization is a byte array having the following structure:

magic_bytes(KafkaCryptoConstants.ENCRYPTED_PREFIX)(6 bytes)|keyref.length(4 bytes)|keyref|encrypted_data

If the result of encryption is null, then the result of serialization will be null.

If no key reference was found, the result of serialization will be directly the output of the underlying Serializer.

Please note that this Serializer has no default constructor, so it can not be configured via properties. So if you want to use it into a Producer, you will have to use org.apache.kafka.clients.producer.KafkaProducer#KafkaProducer(Properties, Serializer, Serializer) or org.apache.kafka.clients.producer.KafkaProducer#KafkaProducer(Map, Serializer, Serializer) with your instance of CryptoDeserializer

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.common.serialization.ExtendedSerializer

org.apache.kafka.common.serialization.ExtendedSerializer.Wrapper<T>

Constructor Summary

Constructors

Constructor and Description
CryptoSerializer(org.apache.kafka.common.serialization.ExtendedSerializer<? super T> rawSerializer, Encryptor encryptor, ThreadLocal<byte[]> keyRefHolder)

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(Map<String,?> configs, boolean isKey)
byte[]	serialize(String topic, org.apache.kafka.common.header.Headers headers, T data) serialize data with encryption (if needed).
byte[]	serialize(String topic, T data) serialize data with encryption (if needed).

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptoSerializer

public CryptoSerializer(org.apache.kafka.common.serialization.ExtendedSerializer<? super T> rawSerializer,
                        Encryptor encryptor,
                        ThreadLocal<byte[]> keyRefHolder)

Parameters:

rawSerializer - Serializer to serialize data before encryption

encryptor - Encryptor to encrypt data

keyRefHolder - ThreadLocal used to communicate the key reference when using Kafka Stream (unused for regular Kafka Producer)

Method Detail

serialize

public byte[] serialize(String topic,
                        org.apache.kafka.common.header.Headers headers,
                        T data)

serialize data with encryption (if needed). Key reference will be looked for exclusively in the Kafka Header KafkaCryptoConstants.KEY_REF_HEADER

Specified by:

serialize in interface org.apache.kafka.common.serialization.ExtendedSerializer<T>

Parameters:

topic -

headers -

data -

Returns:

serialize

public byte[] serialize(String topic,
                        T data)

serialize data with encryption (if needed). Key reference will be looked for into the keyRefHolder

Specified by:

serialize in interface org.apache.kafka.common.serialization.Serializer<T>

Parameters:

topic -

data -

Returns:

configure

public void configure(Map<String,?> configs,
                      boolean isKey)

Specified by:

configure in interface org.apache.kafka.common.serialization.Serializer<T>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.kafka.common.serialization.Serializer<T>