Skip to main content

EncryptContentPGP

Description

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

Tags

Encryption, GPG, OpenPGP, PGP, RFC 4880

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Symmetric-Key Algorithm *symmetric-key-algorithmAES_256
  • AES_128
  • AES_192
  • AES_256
Symmetric-Key Algorithm for encryption
File Encoding *file-encodingBINARY
  • ASCII
  • BINARY
File Encoding for encryption
PassphrasepassphrasePassphrase used for encrypting data with Password-Based Encryption
Public Key Servicepublic-key-serviceController Service:
PGPPublicKeyService

Implementations:
StandardPGPPublicKeyService
PGP Public Key Service for encrypting data with Public Key Encryption
Public Key Searchpublic-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, using FlowFile attributes and Environment variables.

This property is only considered if:
  • the property Public Key Service has a value specified

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureEncryption Failed
successEncryption Succeeded

Reads Attributes

This processor does not read attributes.

Writes Attributes

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

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

This component requires an incoming relationship.

System Resource Considerations

This component does not specify system resource considerations.

See Also

DecryptContentPGP, SignContentPGP, VerifyContentPGP