blob: b7c1f3853098db8ad35dcff3e55874e8f0b3d3b0 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SignContentPGP</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;">SignContentPGP</h1><h2>Description: </h2><p>Sign content using OpenPGP Private Keys</p><h3>Tags: </h3><p>PGP, GPG, OpenPGP, Encryption, Signing, 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, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</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>Compression Algorithm</strong></td><td>compression-algorithm</td><td id="default-value">ZIP</td><td id="allowable-values"><ul><li>UNCOMPRESSED</li><li>ZIP</li><li>ZLIB</li><li>BZIP2</li></ul></td><td id="description">Compression Algorithm for signing</td></tr><tr><td id="name"><strong>File Encoding</strong></td><td>file-encoding</td><td id="default-value">BINARY</td><td id="allowable-values"><ul><li>ASCII</li><li>BINARY</li></ul></td><td id="description">File Encoding for signing</td></tr><tr><td id="name"><strong>Hash Algorithm</strong></td><td>hash-algorithm</td><td id="default-value">SHA512</td><td id="allowable-values"><ul><li>SHA256</li><li>SHA384</li><li>SHA512</li></ul></td><td id="description">Hash Algorithm for signing</td></tr><tr><td id="name"><strong>Signing Strategy</strong></td><td>signing-strategy</td><td id="default-value">SIGNED</td><td id="allowable-values"><ul><li>SIGNED <img src="../../../../../html/images/iconInfo.png" alt="Produce signed content packaged as an OpenPGP message" title="Produce signed content packaged as an OpenPGP message"></img></li><li>DETACHED <img src="../../../../../html/images/iconInfo.png" alt="Produce detached signature based on associated content packaged according to OpenPGP encoding" title="Produce detached signature based on associated content packaged according to OpenPGP encoding"></img></li></ul></td><td id="description">Strategy for writing files to success after signing</td></tr><tr><td id="name"><strong>Private Key Service</strong></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.1/org.apache.nifi.pgp.service.standard.StandardPGPPrivateKeyService/index.html">StandardPGPPrivateKeyService</a></td><td id="description">PGP Private Key Service for generating content signatures</td></tr><tr><td id="name"><strong>Private Key ID</strong></td><td>private-key-id</td><td></td><td id="allowable-values"></td><td id="description">PGP Private Key Identifier formatted as uppercase hexadecimal string of 16 characters used for signing<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Content signing succeeded</td></tr><tr><td>failure</td><td>Content signing 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.compression.algorithm</td><td>Compression Algorithm</td></tr><tr><td>pgp.compression.algorithm.id</td><td>Compression Algorithm Identifier</td></tr><tr><td>pgp.file.encoding</td><td>File Encoding</td></tr><tr><td>pgp.signature.algorithm</td><td>Signature Algorithm including key and hash algorithm names</td></tr><tr><td>pgp.signature.hash.algorithm.id</td><td>Signature Hash Algorithm Identifier</td></tr><tr><td>pgp.signature.key.algorithm.id</td><td>Signature Key Algorithm Identifier</td></tr><tr><td>pgp.signature.key.id</td><td>Signature Public Key Identifier</td></tr><tr><td>pgp.signature.type.id</td><td>Signature Type Identifier</td></tr><tr><td>pgp.signature.version</td><td>Signature Version Number</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.DecryptContentPGP/index.html">DecryptContentPGP</a>, <a href="../org.apache.nifi.processors.pgp.EncryptContentPGP/index.html">EncryptContentPGP</a>, <a href="../org.apache.nifi.processors.pgp.VerifyContentPGP/index.html">VerifyContentPGP</a></p></body></html>