OpenPGP Tasks
Properties Configuration Settings
The OpenPGP Task provides OpenPGP signing and encryption functionality.
Remarks
The OpenPGP Task is used when generating BizTalk Pipelines for sending and receiving OpenPGP signed and encrypted messages. The messages may be signed, encrypted, or both.
The OpenPGP Task does not by itself implement OpenPGP, instead it uses the provider pattern to interface with external cryptography libraries. An OpenPGP provider is a simple module that allows the task to offload OpenPGP operations to the OpenPGP software of your choice. The interface is designed to be generic in its ability to work with various OpenPGP software. We include an OpenPGP provider implementation for GnuPG which may be used as a reference to implement other providers.
OpenPGP Encoder Task
The encoder takes raw messages as input, and generates a signed, encrypted, or signed and encrypted OpenPGP message as output. This task can be used when generating pipelines to create such messages.
Set the PGPProvider property to the provider interface to your desired OpenPGP implementation. Use the PGPParams property to specify any parameters the interface will need to complete its execution. The SignData and EncryptData properties tell the component which operations should be performed on the message.
OpenPGP Decoder Task
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.
Set the PGPProvider property to the provider interface to your desired OpenPGP implementation. Use the PGPParams property to specify any parameters the interface will need to complete its execution.
Encoder Property List
The following is the full list of the properties of the encoder task with short descriptions. Click on the links for further details.
EncryptData | Whether or not to encrypt the data. |
InputFile | The name of the input file for the task. |
Other | Defines a set of configuration settings to be used by the task. |
OutputFile | The name of the output file for the task. |
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. |
RuntimeLicense | Specifies the task runtime license key. |
SignData | Whether or not to sign the data. |
TempPath | The path to which temporary files are written at runtime. |
Decoder Property List
The following is the full list of the properties of the decoder task with short descriptions. Click on the links for further details.
InputFile | The name of the input file for the task. |
Other | Defines a set of configuration settings to be used by the task. |
OutputFile | The name of the output file for the task. |
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. |
RuntimeLicense | Specifies the task runtime license key. |
TempPath | The path to which temporary files are written at runtime. |
Configuration Settings
The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.
RecursiveDecryptMode | Whether the encrypted data should be decrypted recursively. |
LogDebugData | Whether to include debug information in the log. |
PublicKeyringFile | The name of the public keyring file. |
SecretKeyringFile | The name of the secret keyring file. |