org.apache.nifi.processors.pgp

Class EncryptContentPGP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.pgp.EncryptContentPGP

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"PGP","GPG","OpenPGP","Encryption","RFC 4880"})
 @CapabilityDescription(value="Encrypt contents using OpenPGP. The processor reads input and detects OpenPGP messages to avoid unnecessary additional wrapping in Literal Data packets.")
 @SeeAlso(value={DecryptContentPGP.class,SignContentPGP.class,VerifyContentPGP.class})
 @WritesAttribute(attribute="pgp.symmetric.key.algorithm",description="Symmetric-Key Algorithm") @WritesAttribute(attribute="pgp.symmetric.key.algorithm.block.cipher",description="Symmetric-Key Algorithm Block Cipher") @WritesAttribute(attribute="pgp.symmetric.key.algorithm.key.size",description="Symmetric-Key Algorithm Key Size") @WritesAttribute(attribute="pgp.symmetric.key.algorithm.id",description="Symmetric-Key Algorithm Identifier") @WritesAttribute(attribute="pgp.file.encoding",description="File Encoding") @WritesAttribute(attribute="pgp.compression.algorithm",description="Compression Algorithm") @WritesAttribute(attribute="pgp.compression.algorithm.id",description="Compression Algorithm Identifier")
public class EncryptContentPGP
extends AbstractProcessor

Encrypt Content using Open Pretty Good Privacy encryption methods

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	EncryptContentPGP.EncryptStreamCallback
private class	EncryptContentPGP.PacketReadInputStreamCallback

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	COMPRESSION_ALGORITHM
private static List<PropertyDescriptor>	DESCRIPTORS
private static boolean	ENCRYPTION_INTEGRITY_PACKET_ENABLED Enable Integrity Protection as described in RFC 4880 Section 5.13
static Relationship	FAILURE
static PropertyDescriptor	FILE_ENCODING
static PropertyDescriptor	PASSPHRASE
static PropertyDescriptor	PUBLIC_KEY_SEARCH
static PropertyDescriptor	PUBLIC_KEY_SERVICE
private static Set<Relationship>	RELATIONSHIPS
static Relationship	SUCCESS
static PropertyDescriptor	SYMMETRIC_KEY_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
EncryptContentPGP()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext context) Custom Validate requires at least one encryption property to be configured
private Map<String,String>	getAttributes(SymmetricKeyAlgorithm symmetricKeyAlgorithm, FileEncoding fileEncoding, CompressionAlgorithm compressionAlgorithm)
private CompressionAlgorithm	getCompressionAlgorithm(ProcessContext context)
private List<org.bouncycastle.openpgp.operator.PGPKeyEncryptionMethodGenerator>	getEncryptionMethodGenerators(ProcessContext context, FlowFile flowFile, SecureRandom secureRandom)
private StreamCallback	getEncryptStreamCallback(ProcessContext context, FlowFile flowFile, SymmetricKeyAlgorithm symmetricKeyAlgorithm, CompressionAlgorithm compressionAlgorithm, FileEncoding fileEncoding, boolean packetFound)
private FileEncoding	getFileEncoding(ProcessContext context)
Set<Relationship>	getRelationships() Get Relationships
List<PropertyDescriptor>	getSupportedPropertyDescriptors() Get Supported Property Descriptors
private SymmetricKeyAlgorithm	getSymmetricKeyAlgorithm(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session) On Trigger encrypts Flow File contents using configured properties

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

SUCCESS

public static final Relationship SUCCESS

FAILURE

public static final Relationship FAILURE

SYMMETRIC_KEY_ALGORITHM

public static final PropertyDescriptor SYMMETRIC_KEY_ALGORITHM

COMPRESSION_ALGORITHM

public static final PropertyDescriptor COMPRESSION_ALGORITHM

FILE_ENCODING

public static final PropertyDescriptor FILE_ENCODING

PASSPHRASE

public static final PropertyDescriptor PASSPHRASE

PUBLIC_KEY_SERVICE

public static final PropertyDescriptor PUBLIC_KEY_SERVICE

PUBLIC_KEY_SEARCH

public static final PropertyDescriptor PUBLIC_KEY_SEARCH

ENCRYPTION_INTEGRITY_PACKET_ENABLED

private static final boolean ENCRYPTION_INTEGRITY_PACKET_ENABLED

Enable Integrity Protection as described in RFC 4880 Section 5.13

See Also:

Constant Field Values

RELATIONSHIPS

private static final Set<Relationship> RELATIONSHIPS

DESCRIPTORS

private static final List<PropertyDescriptor> DESCRIPTORS

Constructor Detail

EncryptContentPGP

public EncryptContentPGP()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Get Relationships

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Processor Relationships

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Get Supported Property Descriptors

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

Processor Supported Property Descriptors

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

On Trigger encrypts Flow File contents using configured properties

Specified by:

onTrigger in class AbstractProcessor

Parameters:

context - Process Context

session - Process Session

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Custom Validate requires at least one encryption property to be configured

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

context - Validation Context

Returns:

Collection of Validation Results

getEncryptStreamCallback

private StreamCallback getEncryptStreamCallback(ProcessContext context,
                                                FlowFile flowFile,
                                                SymmetricKeyAlgorithm symmetricKeyAlgorithm,
                                                CompressionAlgorithm compressionAlgorithm,
                                                FileEncoding fileEncoding,
                                                boolean packetFound)

getEncryptionMethodGenerators

private List<org.bouncycastle.openpgp.operator.PGPKeyEncryptionMethodGenerator> getEncryptionMethodGenerators(ProcessContext context,
                                                                                                              FlowFile flowFile,
                                                                                                              SecureRandom secureRandom)

getSymmetricKeyAlgorithm

private SymmetricKeyAlgorithm getSymmetricKeyAlgorithm(ProcessContext context)

getCompressionAlgorithm

private CompressionAlgorithm getCompressionAlgorithm(ProcessContext context)

getFileEncoding

private FileEncoding getFileEncoding(ProcessContext context)

getAttributes

private Map<String,String> getAttributes(SymmetricKeyAlgorithm symmetricKeyAlgorithm,
                                         FileEncoding fileEncoding,
                                         CompressionAlgorithm compressionAlgorithm)