Encrypt contents using OpenPGP. The processor reads input and detects OpenPGP messages to avoid unnecessary additional wrapping in Literal Data packets.


PGP, GPG, OpenPGP, Encryption, RFC 4880


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Symmetric-Key AlgorithmAES_256
  • AES_128
  • AES_192
  • AES_256
  • CAMELLIA_128
  • CAMELLIA_192
  • CAMELLIA_256
Symmetric-Key Algorithm for encryption
Compression AlgorithmZIP
  • ZIP
  • ZLIB
  • BZIP2
Compression Algorithm for encryption
File EncodingBINARY
File Encoding for encryption
PassphrasePassphrase used for encrypting data with Password-Based Encryption
Sensitive Property: true
Public Key ServiceController Service API:
Implementation: StandardPGPPublicKeyService
PGP Public Key Service for encrypting data with Public Key Encryption
Public Key SearchPGP Public Key Search will be used to match against the User ID or Key ID when formatted as uppercase hexadecimal string of 16 characters
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

This Property is only considered if the [Public Key Service] Property has a value specified.


successEncryption Succeeded
failureEncryption Failed

Reads Attributes:

None specified.

Writes Attributes:

pgp.symmetric.key.algorithmSymmetric-Key Algorithm
pgp.symmetric.key.algorithm.block.cipherSymmetric-Key Algorithm Block Cipher
pgp.symmetric.key.algorithm.key.sizeSymmetric-Key Algorithm Key Size
pgp.symmetric.key.algorithm.idSymmetric-Key Algorithm Identifier
pgp.file.encodingFile Encoding
pgp.compression.algorithmCompression Algorithm
pgp.compression.algorithm.idCompression Algorithm Identifier

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

DecryptContentPGP, SignContentPGP, VerifyContentPGP