blob: 3aec9ebaa3dedbbf85fef634df5fb2d9f2cae851 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DecryptContentPGP</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DecryptContentPGP</h1><h2>Description: </h2><p>Decrypt contents of OpenPGP messages. Using the Packaged Decryption Strategy preserves OpenPGP encoding to support subsequent signature verification.</p><h3>Tags: </h3><p>PGP, GPG, OpenPGP, Encryption, RFC 4880</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Decryption Strategy</strong></td><td>decryption-strategy</td><td id="default-value">DECRYPTED</td><td id="allowable-values"><ul><li>DECRYPTED <img src="../../../../../html/images/iconInfo.png" alt="Produce decrypted content read from literal data ignoring signatures" title="Produce decrypted content read from literal data ignoring signatures"></img></li><li>PACKAGED <img src="../../../../../html/images/iconInfo.png" alt="Produce decrypted content packaged as an OpenPGP message for additional processing" title="Produce decrypted content packaged as an OpenPGP message for additional processing"></img></li></ul></td><td id="description">Strategy for writing files to success after decryption</td></tr><tr><td id="name">Passphrase</td><td>passphrase</td><td></td><td id="allowable-values"></td><td id="description">Passphrase used for decrypting data encrypted with Password-Based Encryption<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Private Key Service</td><td>private-key-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>PGPPrivateKeyService<br/><strong>Implementation: </strong><a href="../../../nifi-pgp-service-nar/1.19.0/org.apache.nifi.pgp.service.standard.StandardPGPPrivateKeyService/index.html">StandardPGPPrivateKeyService</a></td><td id="description">PGP Private Key Service for decrypting data encrypted with Public Key Encryption</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Decryption Succeeded</td></tr><tr><td>failure</td><td>Decryption Failed</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>pgp.literal.data.filename</td><td>Filename from decrypted Literal Data</td></tr><tr><td>pgp.literal.data.modified</td><td>Modified Date from decrypted Literal Data</td></tr><tr><td>pgp.symmetric.key.algorithm.block.cipher</td><td>Symmetric-Key Algorithm Block Cipher</td></tr><tr><td>pgp.symmetric.key.algorithm.id</td><td>Symmetric-Key Algorithm Identifier</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.pgp.EncryptContentPGP/index.html">EncryptContentPGP</a>, <a href="../org.apache.nifi.processors.pgp.SignContentPGP/index.html">SignContentPGP</a>, <a href="../org.apache.nifi.processors.pgp.VerifyContentPGP/index.html">VerifyContentPGP</a></p></body></html>