/n software Connectors for MuleSoft
/n software Connectors for MuleSoft
Questions / Feedback?

OpenPGP Module

Properties   Configuration Settings  

The OpenPGP Transformer provides OpenPGP signing and encryption functionality.

Remarks

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

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

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

OpenPGP Encoder Module

The encoder takes raw messages as input, and generates a signed, encrypted, or signed and encrypted OpenPGP message as output. This module 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 module which operations should be performed on the message.

OpenPGP Decoder Module

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.

Encoder Property List


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

ASCIIArmorSpecifies whether to use ASCII armor to encode the output message.
CompressionMethodThe compression algorithm used.
EncryptDataWhether or not to encrypt the data.
EncryptingAlgorithmThe encryption algorithm used when encrypting.
HomeDirThe home directory containing the keyring.
KeySpecifies the OpenPGP private key to use for decryption and signing.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
PassphraseThe passphrase of the private/secret key.
PGPParamsSets the parameters in the OpenPGP provider.
RecipientKeySpecifies the OpenPGP public key to use for encryption.
RecipientUserIdThe user Id of the recipient.
SignDataWhether or not to sign the data.
SigningAlgorithmThe signature hash algorithm used when signing.
TempPathThe path to which temporary files are written at runtime.
UserIdThe user Id of the key.

Decoder Property List


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

HomeDirThe home directory containing the keyring.
KeySpecifies the OpenPGP private key to use for decryption and signing.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
PassphraseThe passphrase of the private/secret key.
PGPParamsSets the parameters in the OpenPGP provider.
SignerKeySpecifies the OpenPGP public key to use for signature verification.
SignerUserIdThe user Id of the signer.
TempPathThe path to which temporary files are written at runtime.
UserIdThe user Id of the key.

Configuration Settings


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

AllowOldPacketTypeWhether to allow the older encrypted packet type.
FilenameThe original name of the file to encrypt.
LogDebugDataWhether to include debug information in the log.
PublicKeyringFileThe name of the public keyring file.
RecursiveDecryptModeWhether the encrypted data should be decrypted recursively.
RequireEncryptionWhether an error should be thrown if the message is not encrypted.
RequireSignatureWhether an error should be thrown if the message is not signed.
SecretKeyringFileThe name of the secret keyring file.
SymmetricPassphraseThe password used for symmetric encryption or decryption.

 
 
Copyright (c) 2019 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 16.0 [Build 7240]