## Description:

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

### Tags:

PGP, GPG, OpenPGP, Encryption, RFC 4880

### Properties:

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, and whether a property supports the NiFi Expression Language.

Display Name | API Name | Default Value | Allowable Values | Description |
---|

**Symmetric-Key Algorithm** | symmetric-key-algorithm | AES_256 | - AES_128
- AES_192
- AES_256
- CAMELLIA_128
- CAMELLIA_192
- CAMELLIA_256
| Symmetric-Key Algorithm for encryption |

**Compression Algorithm** | compression-algorithm | ZIP | | Compression Algorithm for encryption |

**File Encoding** | file-encoding | BINARY | | File Encoding for encryption |

Passphrase | passphrase | | | Passphrase used for encrypting data with Password-Based Encryption
**Sensitive Property: true** |

Public Key Service | public-key-service | | **Controller Service API: ** PGPPublicKeyService
**Implementation: **StandardPGPPublicKeyService | PGP Public Key Service for encrypting data with Public Key Encryption |

Public Key Search | public-key-search | | | PGP 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.** |

### Relationships:

Name | Description |
---|

success | Encryption Succeeded |

failure | Encryption Failed |

### Reads Attributes:

None specified.### Writes Attributes:

Name | Description |
---|

pgp.symmetric.key.algorithm | Symmetric-Key Algorithm |

pgp.symmetric.key.algorithm.block.cipher | Symmetric-Key Algorithm Block Cipher |

pgp.symmetric.key.algorithm.key.size | Symmetric-Key Algorithm Key Size |

pgp.symmetric.key.algorithm.id | Symmetric-Key Algorithm Identifier |

pgp.file.encoding | File Encoding |

pgp.compression.algorithm | Compression Algorithm |

pgp.compression.algorithm.id | Compression Algorithm Identifier |

### 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:

None specified.### See Also:

DecryptContentPGP, SignContentPGP, VerifyContentPGP