Skip to content

Cryptography (PGP) Module Overview

The Cryptography Module adds OpenPGP (RFC 9580 / RFC 4880) message-level cryptography to WSO2 Integrator: MI mediation flows. It lets you encrypt, decrypt, sign and verify payloads in line protecting data for storage or store-and-forward exchange (files, batch B2B transfers, archives) and proving its origin. The cryptographic core is Bouncy Castle, so the output is standard OpenPGP and interoperates with GnuPG and any other compliant tool.

  • This is a message-mediation module: each operation takes its input from the message body (the default) or an expression (such as ${payload.x} or ${vars.x}), performs a single PGP operation, and writes the result back to the message body or to a response variable.
  • Keys are supplied through PGP key connections — one connection per key — that operations reference by config key.
  • Each operation reads and writes either TEXT or BINARY, mirroring the File Connector / VFS transport, so it slots directly into file-based read → PGP → write flows.

Go to the WSO2 Connector Store to download the Cryptography Module.

Operations

The module provides six operations:

  • pgpEncrypt — encrypt the input for a recipient using their public key.
  • pgpDecrypt — decrypt the input using recipient's private key and passphrase.
  • pgpSign — sign the input with sender's private key.
  • pgpVerify — verify a signed message with the sender's public key.
  • pgpSignAndEncrypt — sign then encrypt in a single pass (outbound).
  • pgpDecryptAndVerify — decrypt then verify in a single pass (inbound).

Compatibility

Module version Supported product versions
1.0.0 MI 4.6.0 onwards

Cryptography Module documentation

How to contribute

As an open source project, WSO2 extensions welcome contributions from the community.

To contribute to the code for this module, please create a pull request in the module's GitHub repository.

Check the issue tracker for open issues that interest you. We look forward to receiving your contributions.