PGP (Beta) Sign activity

Introduction

A PGP (Beta) Sign activity, using its PGP (Beta) connection, signs files and is intended to be used as a target to consume data in an operation.

Create a PGP (Beta) Sign activity

An instance of a PGP (Beta) Sign activity is created from a PGP (Beta) connection using its Sign activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing PGP (Beta) Sign activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a PGP (Beta) Sign activity

Follow these steps to configure a PGP (Beta) Sign activity:

• Step 1: Enter a name and specify settings
  Provide a name for the activity and specify the PGP signing settings.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the PGP signing settings. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each PGP (Beta) Sign activity and must not contain forward slashes / or colons :.

• Hash algorithm: Select the hash algorithm to use for signing. Choose one of DOUBLE_SHA (double-width SHA), HAVAL_5_160, MD2, MD5, RIPEMD160, SHA1, SHA224, SHA256, SHA3_256, SHA3_512, SHA384, SHA512, or TIGER_192.

  Note

  Hash algorithms not defined in the OpenPGP standard are provided as part of the Bouncy Castle API.

• Signature type: Select the signature type, either BINARY_DOCUMENT or CANONICAL_TEXT_DOCUMENT.

• Signing mode: Select the signing mode of the signature packet, one of ATTACHED, CLEARTEXT, or DETACHED.

  • ATTACHED: The file and its signature are combined and compressed after signing.
  • CLEARTEXT: The file and its signature are combined, but the file remains human-readable after signing. For more information, refer to the Cleartext Signature Framework.
  • DETACHED: The file and its signature are separate files after signing.

• Private key: Enter the private key used for signing.

• Compression type: When using the ATTACHED signing mode, select the compression algorithm, one of BZIP2, ZIP, ZLIB, or UNCOMPRESSED.

• File content: Enter the content of the file to be signed.

• Base64 Encoded: Select if the file content is Base64-encoded.

• Optional settings: Click to expand additional optional settings:

  • Passphrase: Enter the passphrase that protects the private key, if required.
  • Signer user ID: Enter the signer's user ID.
  • File name: When using the ATTACHED signing mode, enter the name of the file.
  • Key ID: Enter the issuer key ID.
  • Armor: When using the ATTACHED or DETACHED signing modes, select to encode the signed files with ASCII armor, a non-binary encoding.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The PGP (Beta) connector uses the Bouncy Castle API v1.80 which implements the OpenPGP encryption standard. Refer to the API documentation for additional information.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the PGP (Beta) endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a PGP (Beta) Sign activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

PGP (Beta) Sign activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.