OpenPGP Pipeline Component

The OpenPGP Pipeline Component provides OpenPGP signing and encryption functionality.

Remarks

The OpenPGP Pipeline Component is used for sending and receiving OpenPGP signed and encrypted messages. The messages may be signed, encrypted, or both.

By default the OpenPGP Pipeline Component will use an internal OpenPGP implementation. This implementation of OpenPGP does not require any additional dependencies and is completely managed.

Alternatively the pipeline component may be configured to use an external implementation such as GnuPG. See PGPProviderType for details.

OpenPGP Encoder Pipeline Component

The encoder takes raw messages as input, and generates a signed, encrypted, or signed and encrypted OpenPGP message as output. This pipeline component can be used when creating pipelines to create such messages.

Use the PGPParams property to specify any parameters the interface will need to complete its execution. The SignData and EncryptData properties tell the pipeline component which operations should be performed on the message.

OpenPGP Decoder Pipeline Component

The decoder takes OpenPGP signed, encrypted, or signed and encrypted messages as input, then verifies and/or decrypts the message. The resulting message will be the raw original message.

Use the PGPParams property to specify any parameters the interface will need to complete its execution.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Encoder Property List

The following is the full list of the properties of the encoder pipeline component with short descriptions. Click on the links for further details.


ASCIIArmor	Specifies whether to use ASCII armor to encode the output message.
CompressionMethod	The compression algorithm used.
EncryptData	Whether or not to encrypt the data.
EncryptingAlgorithm	The encryption algorithm used when encrypting.
HomeDir	The home directory containing the keyring.
Key	Specifies the OpenPGP private key to use for decryption and signing.
Other	Defines a set of configuration settings to be used by the pipeline component.
Passphrase	The passphrase of the private/secret key.
PGPParams	Sets the parameters in the OpenPGP provider.
PGPProvider	The OpenPGP provider provides an interface to the OpenPGP cryptography software.
PGPProviderType	The PGP provider to use.
ProtectedPGPParams	Sets the protected parameters in the OpenPGP provider.
RecipientKey	Specifies the OpenPGP public key to use for encryption.
RecipientUserId	The user Id of the recipient.
SignData	Whether or not to sign the data.
SigningAlgorithm	The signature hash algorithm used when signing.
TempPath	The path to which temporary files are written at runtime.
TransportLog	Tells the adapter where and how to report information about its operations.
UserId	The user Id of the key.

Decoder Property List

The following is the full list of the properties of the decoder pipeline component with short descriptions. Click on the links for further details.


HomeDir	The home directory containing the keyring.
Key	Specifies the OpenPGP private key to use for decryption and signing.
Other	Defines a set of configuration settings to be used by the pipeline component.
Passphrase	The passphrase of the private/secret key.
PGPParams	Sets the parameters in the OpenPGP provider.
PGPProvider	The OpenPGP provider provides an interface to the OpenPGP cryptography software.
PGPProviderType	The PGP provider to use.
ProtectedPGPParams	Sets the protected parameters in the OpenPGP provider.
SignerKey	Specifies the OpenPGP public key to use for signature verification.
SignerUserId	The user Id of the signer.
TempPath	The path to which temporary files are written at runtime.
TransportLog	Tells the adapter where and how to report information about its operations.
UserId	The user Id of the key.

Configuration Settings

The following is a list of configuration settings for the pipeline component with short descriptions. Click on the links for further details.


AllowOldPacketType	Whether to allow the older encrypted packet type.
Filename	The original name of the file to encrypt.
LogDebugData	Whether to include debug information in the log.
PublicKeyringFile	The name of the public keyring file.
RecursiveDecryptMode	Whether the encrypted data should be decrypted recursively.
RequireEncryption	Whether an error should be thrown if the message is not encrypted.
RequireSignature	Whether an error should be thrown if the message is not signed.
SecretKeyringFile	The name of the secret keyring file.
SymmetricPassphrase	The password used for symmetric encryption or decryption.
SSOPassword	Specifies the key name in the SSO configuration that holds the key passphrase value.
PipelineOptions	Options defining the validation and protection functionality of the pipeline component.