Package de.otto.kafka.messaging.e2ee

Interface KafkaEncryptionHelper

public interface KafkaEncryptionHelper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KAFKA_HEADER_CIPHER_KEY	Name of Kafka Header for the cipher metadata for the partition key
static final String	KAFKA_HEADER_CIPHER_VALUE	Name of Kafka Header for the cipher metadata for the payload (or value)
static final String	KAFKA_HEADER_IV_KEY	Name of Kafka Header for the initialization vector for the partition key
static final String	KAFKA_HEADER_IV_VALUE	Name of Kafka Header for the initialization vector for the payload (or value)

Method Summary

Static Methods

Modifier and Type	Method	Description
static AesEncryptedPayload	aesEncryptedPayloadOfKafka(byte[] encryptedPayload, byte[] kafkaHeaderInitializationVector, byte[] kafkaHeaderCiphersText)
static AesEncryptedPayload	aesEncryptedPayloadOfKafka(byte[] encryptedPayload, String kafkaHeaderInitializationVector, String kafkaHeaderCiphersText)
static AesEncryptedPayload	aesEncryptedPayloadOfKafkaForKey(byte[] encryptedPayload, Map<String,?> kafkaHeaders)
static AesEncryptedPayload	aesEncryptedPayloadOfKafkaForValue(byte[] encryptedPayload, Map<String,?> kafkaHeaders)
static String	byteArrayToUtf8String(byte[] kafkaHeaderValue)
static EncryptionCipherSpec	extractCipherSpec(byte[] cipherHeaderValue)
static EncryptionCipherSpec	extractCipherSpec(String ciphersText)
static String	extractEncryptionKeyAttributeName(String ciphersText)
static byte[]	extractIv(byte[] ivRaw)
static byte[]	extractIv(String ivText)
static String	extractKafkaHeaderValueText(Map<String,?> kafkaHeaders, String headerName)	find and extract the value of the specified kafka header
static int	extractKeyVersion(byte[] cipherHeaderValue)
static int	extractKeyVersion(String ciphersText)
static String	headerNameCiphers(boolean isForKey)
static String	headerNameIv(boolean isForKey)
static byte[]	mapToCipherHeaderValue(AesEncryptedPayload encryptedPayload)
static String	mapToCipherHeaderValueText(AesEncryptedPayload encryptedPayload)
static String	mapToCipherHeaderValueText(EncryptionCipherSpec cipherSpec)
static byte[]	mapToIvHeaderValue(AesEncryptedPayload encryptedPayload)
static String	mapToIvHeaderValueText(AesEncryptedPayload encryptedPayload)
static Map<String,byte[]>	mapToKafkaHeadersForKey(AesEncryptedPayload encryptedPayload)
static Map<String,byte[]>	mapToKafkaHeadersForValue(AesEncryptedPayload encryptedPayload)

Field Details

KAFKA_HEADER_IV_KEY

static final String KAFKA_HEADER_IV_KEY

Name of Kafka Header for the initialization vector for the partition key

See Also:

• Constant Field Values

KAFKA_HEADER_IV_VALUE

static final String KAFKA_HEADER_IV_VALUE

Name of Kafka Header for the initialization vector for the payload (or value)

See Also:

• Constant Field Values

KAFKA_HEADER_CIPHER_KEY

static final String KAFKA_HEADER_CIPHER_KEY

Name of Kafka Header for the cipher metadata for the partition key

See Also:

• Constant Field Values

KAFKA_HEADER_CIPHER_VALUE

static final String KAFKA_HEADER_CIPHER_VALUE

Name of Kafka Header for the cipher metadata for the payload (or value)

See Also:

• Constant Field Values

Method Details

headerNameIv

static String headerNameIv(boolean isForKey)

headerNameCiphers

static String headerNameCiphers(boolean isForKey)

aesEncryptedPayloadOfKafka

static AesEncryptedPayload aesEncryptedPayloadOfKafka(byte[] encryptedPayload,
 String kafkaHeaderInitializationVector,
 String kafkaHeaderCiphersText)

Parameters:

encryptedPayload - the encrypted payload

kafkaHeaderInitializationVector - value of kafka header of "initialization vector"

kafkaHeaderCiphersText - value of kafka header of "ciphers"

Returns:

a AesEncryptedPayload instance with the given values

aesEncryptedPayloadOfKafka

static AesEncryptedPayload aesEncryptedPayloadOfKafka(byte[] encryptedPayload,
 byte[] kafkaHeaderInitializationVector,
 byte[] kafkaHeaderCiphersText)

Parameters:

encryptedPayload - the encrypted payload

kafkaHeaderInitializationVector - value of kafka header of "initialization vector"

kafkaHeaderCiphersText - value of kafka header of "ciphers"

Returns:

a AesEncryptedPayload instance with the given values

aesEncryptedPayloadOfKafkaForKey

static AesEncryptedPayload aesEncryptedPayloadOfKafkaForKey(byte[] encryptedPayload,
 Map<String,?> kafkaHeaders)

Parameters:

encryptedPayload - the encrypted payload

kafkaHeaders - all kafka headers including "initialization vector" and "ciphers"

Returns:

a AesEncryptedPayload instance with the given values to represent an encrypted kafka key

See Also:

• aesEncryptedPayloadOfKafkaForValue(byte[], Map)

aesEncryptedPayloadOfKafkaForValue

static AesEncryptedPayload aesEncryptedPayloadOfKafkaForValue(byte[] encryptedPayload,
 Map<String,?> kafkaHeaders)

Parameters:

encryptedPayload - the encrypted payload

kafkaHeaders - all kafka headers including "initialization vector" and "ciphers"

Returns:

a AesEncryptedPayload instance with the given values to represent an encrypted kafka value a.k.a. payload

See Also:

• aesEncryptedPayloadOfKafkaForKey(byte[], Map)

extractKafkaHeaderValueText

static String extractKafkaHeaderValueText(Map<String,?> kafkaHeaders,
 String headerName)

find and extract the value of the specified kafka header

Parameters:

kafkaHeaders - all kafka headers

headerName - name of the kafka header that are of interest

Returns:

the found header or null

byteArrayToUtf8String

static String byteArrayToUtf8String(byte[] kafkaHeaderValue)

Parameters:

kafkaHeaderValue - a Kafka header value as raw byte array or null

Returns:

the header value as String can be null

mapToKafkaHeadersForKey

static Map<String,byte[]> mapToKafkaHeadersForKey(AesEncryptedPayload encryptedPayload)

Parameters:

encryptedPayload - a AesEncryptedPayload object for a Kafka key

Returns:

the kafka headers needed for given AesEncryptedPayload

See Also:

• mapToKafkaHeadersForValue(AesEncryptedPayload)

mapToKafkaHeadersForValue

static Map<String,byte[]> mapToKafkaHeadersForValue(AesEncryptedPayload encryptedPayload)

Parameters:

encryptedPayload - a AesEncryptedPayload object for a Kafka value a.k.a. payload

Returns:

the kafka headers needed for given AesEncryptedPayload

See Also:

• mapToKafkaHeadersForValue(AesEncryptedPayload)

mapToIvHeaderValueText

static String mapToIvHeaderValueText(AesEncryptedPayload encryptedPayload)

Parameters:

encryptedPayload - the payload

Returns:

the value for the initialization vector. Note: you should check AesEncryptedPayload.isEncrypted() before calling this method.

See Also:

• headerNameIv(boolean)

mapToIvHeaderValue

static byte[] mapToIvHeaderValue(AesEncryptedPayload encryptedPayload)

Parameters:

encryptedPayload - the payload

Returns:

the value for the initialization vector. Note: you should check AesEncryptedPayload.isEncrypted() before calling this method.

See Also:

• headerNameIv(boolean)

mapToCipherHeaderValueText

static String mapToCipherHeaderValueText(AesEncryptedPayload encryptedPayload)

Parameters:

encryptedPayload - the payload

Returns:

the value for the cipher metadata. Note: you should check AesEncryptedPayload.isEncrypted() before calling this method.

See Also:

• headerNameCiphers(boolean)

mapToCipherHeaderValueText

static String mapToCipherHeaderValueText(EncryptionCipherSpec cipherSpec)

Parameters:

cipherSpec - the cipher spec

Returns:

the value for the cipher metadata.

See Also:

• headerNameCiphers(boolean)

mapToCipherHeaderValue

static byte[] mapToCipherHeaderValue(AesEncryptedPayload encryptedPayload)

Parameters:

encryptedPayload - the payload

Returns:

the value for the cipher metadata. Note: you should check AesEncryptedPayload.isEncrypted() before calling this method.

See Also:

• headerNameCiphers(boolean)

extractIv

static byte[] extractIv(byte[] ivRaw)

Parameters:

ivRaw - the raw kafka header value of the initialization vector

Returns:

the initialization vector

See Also:

• mapToIvHeaderValue(AesEncryptedPayload)
• headerNameIv(boolean)

extractIv

static byte[] extractIv(String ivText)

Parameters:

ivText - the kafka header value of the initialization vector

Returns:

the initialization vector

See Also:

• mapToIvHeaderValue(AesEncryptedPayload)
• headerNameIv(boolean)

extractKeyVersion

static int extractKeyVersion(byte[] cipherHeaderValue)

Parameters:

cipherHeaderValue - the raw kafka header value of the cipher metadata.

Returns:

the key version used to encrypt the payload

See Also:

• mapToCipherHeaderValue(AesEncryptedPayload)
• headerNameCiphers(boolean)

extractKeyVersion

static int extractKeyVersion(String ciphersText)

Parameters:

ciphersText - the kafka header value of the cipher metadata.

Returns:

the key version used to encrypt the payload

See Also:

• mapToCipherHeaderValue(AesEncryptedPayload)
• headerNameCiphers(boolean)
• extractCipherSpec(String)

extractEncryptionKeyAttributeName

static String extractEncryptionKeyAttributeName(String ciphersText)

Parameters:

ciphersText - the kafka header value of the cipher metadata.

Returns:

the encryptionKeyAttributeName used to fetch the key from the vault

See Also:

• mapToCipherHeaderValue(AesEncryptedPayload)
• headerNameCiphers(boolean)
• extractCipherSpec(String)

extractCipherSpec

static EncryptionCipherSpec extractCipherSpec(byte[] cipherHeaderValue)

Parameters:

cipherHeaderValue - the kafka header value of the cipher metadata.

Returns:

the EncryptionCipherSpec used to fetch the key from the vault

See Also:

• mapToCipherHeaderValue(AesEncryptedPayload)
• headerNameCiphers(boolean)

extractCipherSpec

static EncryptionCipherSpec extractCipherSpec(String ciphersText)

Parameters:

ciphersText - the kafka header value of the cipher metadata.

Returns:

the EncryptionCipherSpec used to fetch the key from the vault

See Also:

• mapToCipherHeaderValue(AesEncryptedPayload)
• headerNameCiphers(boolean)