org.apache.nifi.security.repository.stream

Interface RepositoryObjectStreamEncryptor

All Superinterfaces:

RepositoryObjectEncryptor

All Known Implementing Classes:

RepositoryObjectAESCTREncryptor

public interface RepositoryObjectStreamEncryptor
extends RepositoryObjectEncryptor

Provides an interface for encrypting and decrypting repository objects using a stream cipher. This is suited for large objects like content claims. For small objects (like flowfile and provenance events), see RepositoryObjectBlockEncryptor.

Method Summary

Modifier and Type	Method and Description
InputStream	decrypt(InputStream encryptedRecord, String recordId) Decrypts the provided byte[] (an encrypted record with accompanying metadata).
OutputStream	encrypt(OutputStream plainRecord, String recordId, String keyId) Encrypts the serialized byte[].
String	getNextKeyId() Returns a valid key identifier for this encryptor (valid for encryption and decryption) or throws an exception if none are available.
void	initialize(KeyProvider keyProvider) Initializes the encryptor with a KeyProvider.

Method Detail

initialize

void initialize(KeyProvider keyProvider)
         throws KeyManagementException

Initializes the encryptor with a KeyProvider.

Specified by:

initialize in interface RepositoryObjectEncryptor

Parameters:

keyProvider - the key provider which will be responsible for accessing keys

Throws:

KeyManagementException - if there is an issue configuring the key provider

encrypt

OutputStream encrypt(OutputStream plainRecord,
                     String recordId,
                     String keyId)
              throws EncryptionException

Encrypts the serialized byte[].

Parameters:

plainRecord - the plain record, serialized to a byte[]

recordId - an identifier for this record (eventId, generated, etc.)

keyId - the ID of the key to use

Returns:

the encrypted record

Throws:

EncryptionException - if there is an issue encrypting this record

decrypt

InputStream decrypt(InputStream encryptedRecord,
                    String recordId)
             throws EncryptionException

Decrypts the provided byte[] (an encrypted record with accompanying metadata).

Parameters:

encryptedRecord - the encrypted record in byte[] form

recordId - an identifier for this record (eventId, generated, etc.)

Returns:

the decrypted record

Throws:

EncryptionException - if there is an issue decrypting this record

getNextKeyId

String getNextKeyId()
             throws KeyManagementException

Returns a valid key identifier for this encryptor (valid for encryption and decryption) or throws an exception if none are available.

Returns:

the key ID

Throws:

KeyManagementException - if no available key IDs are valid for both operations