Syntax:
com.ibi.agents.PGPEncrypt
iIT Service Object:
format: PGP Encryption and Signature
Description: Encrypts and signs documents using PGP.
Parameters:
Parameter |
Description |
---|---|
Armor * |
Determines whether the binary message will be armored for transfer in ASCII. |
Literal Filename |
The filename to appear in the Literal Data Packet. The receiving program may use this name when storing the data to disk. The special value _CONSOLE means the data is unusually sensitive. |
Signature |
|
Sign |
Determines whether to sign the data in the PGP message. |
Signature Hash Algorithm |
The algorithm to use for the signature digest. |
Secret Key Ring |
The location of the secret key ring containing the signature key. |
Signature Key User ID |
The User ID of the private key used for signing. The format can be =name for the exact User ID, user@host to match only the email address, or <user@host> optionally surrounded by ignored comments to match only the value within angle brackets against the email address. This property also determines which User ID(s) will be listed in Signer's User ID subpackets. |
Signature Key ID |
The Key ID of the private key used for signing. The format can be 8 hex digits for the short key ID, 16 hex digits for the long key ID, or 40 hex digits for the fingerprint. Spaces are allowed and are not counted in the length. This property can be used in place of or together with the Signature Key User ID to select a more specific key. |
Signature Key Passphrase |
The case-sensitive passphrase to unlock the Signature Private Key. |
Signature Expiration |
The number of seconds after the signature creation time that the signature expires. The format is [xxh][xxm]xx[s]. If absent or has a value of zero, the signature never expires. |
Compression |
|
Compress |
Determines whether to compress the data in the PGP message. |
Compression Algorithm |
The algorithm to use to compress the data in the PGP message. |
Encryption |
|
Encrypt |
Determines whether to encrypt the data in the PGP message. |
Symmetric Algorithm |
A symmetric algorithm to be used for encryption. |
Encryption Method |
Determines how the session key is encrypted, use Passphrase for Password-Based Encryption (PBE), use Keypair to encrypt with a public key. |
Encryption Passphrase |
The case-sensitive passphrase for when using the Passphrase encryption method. The passphrase will be used to generate a key encryption key to encrypt the session key. |
Recipient 1 |
|
Public Key Ring 1 |
When using the Keypair encryption method, this is the location of the public key ring containing the encryption public key for the first recipient. |
Encryption Key User ID 1 |
When using the Keypair encryption method, this is the User ID of the public key for the first recipient. The format can be =name for the exact User ID, user@host to match only the email address, or <user@host> optionally surrounded by ignored comments to match only the value within angle brackets against the email address. For backwards compatibility, this parameter defaults to the value of the Encryption Passphrase parameter. |
Encryption Key ID 1 |
When using the Keypair encryption method, this is the Key ID of the public key for the first recipient. The format can be 8 hex digits for the short key ID, 16 hex digits for the long key ID, or 40 hex digits for the fingerprint. Spaces are allowed and are not counted in the length. This property can be used in place or together with the Encryption Key User ID 1 to select a more specific key. |
Recipient 2 |
|
Public Key Ring 2 |
When using the Keypair encryption method with more than one recipient, this is the Location of the public key ring containing the encryption public key for the second recipient. |
Encryption Key User ID 2 |
When using the Keypair encryption method with more than one recipient, this is the User ID of the public key for the second recipient. The format can be =name for the exact User ID, user@host to match only the email address, or <user@host> optionally surrounded by ignored comments to match only the value within angle brackets against the email address. |
Encryption Key ID 2 |
When using the Keypair encryption method with more than one recipient, this is the Key ID of the public key for the second recipient. The format can be 8 hex digits for the short key ID, 16 hex digits for the long key ID, or 40 hex digits for the fingerprint. Spaces are allowed and are not counted in the length. This property can be used in place or together with the Encryption Key User ID 2 to select a more specific key. |
Edges:
The following table lists the available Line Edges for the PGP Encryption and Signature Service (com.ibi.agents.PGPEncrypt).
Line Edge |
Description |
---|---|
OnError |
An exception occurred during execution. |
OnSuccess |
The operation was successful. |
OnFailure |
A fail condition occurred during execution. |
OnParseError |
Could not parse a document. |
OnFailSecurity |
Could not operate due to a security violation. |