Panel | |
---|---|
|
Disclaimer
Your use of this download is governed by Stonebranch’s Terms of Use, available at Stonebranch Integration Hub - Terms of Use.
Version Information
Template Name | Internal Name | Template Version |
---|---|---|
CS GPG | ut-cs-gpg | 1.0.2 |
Overview
This Universal Task provides the capabilities for Encrypting and Decrypting Files using GnuPG.
GnuPG (GNU Privacy Guard) is a free and open-source software tool that provides encryption and digital signature functionality for secure communication and data protection.
Key Features
The Universal Task provides the following key features:
...
Import Universal Template
Note |
---|
Data type scripts Alternatively, remove the value for the choice fields in the json by setting them to null. |
To use the Universal Template, you first must perform the following steps.
This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
To import the Universal Template into your Controller, follow the instructions here.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
Modifications of this integration, applied by users or customers, before or after import, might affect the support of this integration. For more information, refer to Integration Modifications.
Configure Universal Task
For a new Universal Task, create a new task, and enter the required input fields.
The following list the different input fields required for a selected Action.
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Encrypt | Choice | The following Actions can be selected: [ encrypt | decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Directory for Files to Encrypt or Sign | Required | /Input | Text | Input directory for the Files to Encrypt or Sign |
Encrypt File Pattern | Required | files_[1-2].txt | Text | Match Pattern to select the files for encryption |
Directory for encrypted Files | Required | /Encrypted | Text | Output directory for the encrypted Files |
Email/ID of the Recipient Public Key | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Email/ID of the Recipient Public Key used to encrypt the file |
Overwrite Encrypted Files | Required | True | False | Boolean | Overwrite existing Encrypted Files |
Encrypt and Sign | Optional | True | False | Boolean | Encrypt and Sign the files using the private key |
Delete After Encryption | Optional | True | False | Boolean | Delete Input files in "Directory for Files to Encrypt or Sign" After Encryption. |
Passphrase used for Signing | Optional | '***' | Credential | Passphrase of the Private Key owner used for Signing |
Email/ KeyID of the Private Key used for signing | Optional | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Email/ KeyID of the Private Key used for signing |
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Decrypt | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Directory for Encrypted Files | Required | /encrypted | Text | Input directory for the Files to Decrypt |
Decrypt File Pattern | Required | files_[1-2].txt | Text | Match Pattern to select the files for decryption |
Overwrite Decrypted Files | Required | True | False | Boolean | Overwrite existing Decrypted Files |
Directory for Decrypted Files | Required | /Encrypted | Text | Output directory for the Decrypted Files |
Email/ KeyID of the private key | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Email/ID of the Recipient Private Key used to decrypt the file |
Delete After Decryption | Optional | True | False | Boolean | Delete Encrypted files in "Directory for Decrypted Files" After Decryption. |
Passphrase | Required | '***' | Credential | Passphrase of the Private Key owner used for decryption |
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Directory for Files to Encrypt or Sign | Required | /files | Text | Input directory for the Files to Sign |
Sign File Pattern | Required | files_[1-2].txt | Text | Match Pattern to select the files for decryption |
Overwrite Signed Files | Required | True | False | Boolean | Overwrite existing Signed Files |
Directory for Signed Files | Required | /signed | Text | Output directory for the Signed Files |
Signing Options | Required | Default: Sign | Choice | [ Sign | Clearsign | Detachsign ]
|
Local User for Signing | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Email/ID of the Recipient Private Key used to Sign the file |
Delete After Sign | Optional | True | False | Boolean | Delete Signed files in "Directory for Signed Files" After Signing. |
Passphrase | Required | '***' | Credential | Passphrase of the Private Key owner used for signing |
Configuration examples
Action: Sign Key
Input Fields
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
KEY ID | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Email/ID of the key pair owner |
Passphrase | Required | '***' | Credential | Passphrase of the Private Key owner used for signing |
Local User for Signing | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Private Key owner used for signing |
Configuration examples
Action: Import Private Key
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Private Key | Required | private_key.asc | Script | Script File with Private Key in ASC format. |
Action: Import Public Key
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Public Key | Required | public_key.asc | Script | Script File with Public Key in ASC format. |
Configuration examples
Action: Export Private Key
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Export Private Keys Path | Required | /private_keys | Text | Export Private Keys Path |
Key ID or Email | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | KeyID or Email of the private key to export |
Configuration examples
Action: Export Public Key
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Export Public Keys Path | Required | /public_keys | Text | Export Public Keys Path |
Key ID or Email | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | KeyID or Email of the public key to export |
Configuration examples
Action: List Keys
Input Fields
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Email/ID to List Keys | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Email/ID to List Keys |
Configuration examples
Action: List Secret Keys
Input Fields
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Email/ID of user to list secret keys | Required | Email: peter.meyer@yahoo.com ID: pmeyer | Text | Email/ID of user to list secret keys |
Configuration examples
Action: Generate Key Pair
...
Field | Input Type | Value | Type | Description |
---|---|---|---|---|
Action | Required | Sign | Choice | The following Actions can be selected: [ encrypt| decrypt | sign | sign_key | import_private_keys | import_public_keys | export_private_keys | export_public_keys | delete_keys | delete_secret_keys | list_keys | list_secret_keys | generate_key_pair ] |
GPG Home Directory | Required | Default: /usr/bin | Text | Home directory of the gpg installation. |
Key ID | Required | Key ID of the Key Pair | ||
Required | Email of the Key Pair | |||
Passphrase | Required | '***' | Passphrase for the generated Key Pair | |
Key Type | Required | Default: RSA | Choice | RSA Key Type: [ RSA | RSA1 | RSA2 | RSA3 ] |
Key Length | Required | Default: 2048 | Choice | Length of the RSA key in bits: [1024 | 2048 | 4096 | 8192 ] |
Expire Date | Required | Default: 0 YYYY-MM-DD | Text | Key expiary date Format: YYYY-MM-DD ;e.g. 2024-01-31 '0' : no expiary date |
Configuration examples
Action: Delete Key
Input Fields
...