Managing Crypto Configurations

Managing Crypto Configurations#

This guide explains how to create, edit, and delete Crypto Configurations so that Adverity can encrypt or decrypt PGP- or GPG-encrypted files.

Introduction#

What is a Crypto Configuration?

A Crypto Configuration stores a PGP or GPG key pair that Adverity uses to encrypt files sent to a destination or decrypt files fetched by a datastream. A configuration can hold a public key for encryption, a private key for decryption, or both.

A Crypto Configuration belongs to a workspace. Once you create one, select it from the encryption or decryption field of a compatible connector or destination.

Creating a Crypto Configuration#

Prerequisites#

Before you complete the procedure in this guide, make sure you have the following:

  • The public key of the recipient, if you want Adverity to encrypt files.

  • The private key, and its passphrase if it has one, if you want Adverity to decrypt files.

Procedure#

To create a Crypto Configuration, follow these steps:

  1. Go to the Administration page.

  2. In the secondary menu, click Crypto Configurations.

  3. In the top right corner, click + Create configuration.

  4. In Name, enter a unique name for the configuration.

  5. In Workspace, select the workspace the configuration belongs to.

  6. From Engine, select the key format:

    • PGP (default) — the standard option for most use cases.

    • GPG — use this option for larger payloads.

  7. In File Extension, enter the extension Adverity appends to encrypted files, for example .gpg. The extension must start with a period followed by three characters.

  8. Select Binary Mode to export encrypted files in binary format. Clear Binary Mode to export them as armored ASCII text instead.

  9. Under Encryption, in Public Key, paste the public key Adverity uses to encrypt files.

  10. Under Decryption, in Private Key, paste the private key Adverity uses to decrypt files.

  11. If the private key is protected by a passphrase, in Passphrase, enter the passphrase.

  12. Click Save.

As a result, the Crypto Configuration is created and available for selection on compatible connectors and destinations in the same workspace.

Note

Provide at least one of Public Key or Private Key. Provide both if the same configuration is used to both encrypt and decrypt files.

Editing a Crypto Configuration#

To edit a Crypto Configuration, follow these steps:

  1. Go to the Administration page.

  2. In the secondary menu, click Crypto Configurations.

  3. Click the Crypto Configuration you want to edit.

  4. Update the fields you want to change.

  5. Click Save.

As a result, your changes apply immediately, and connectors and destinations that use this Crypto Configuration use the new key material the next time they run.

Note

Once saved, a Private Key or Passphrase is never displayed again. To remove a stored private key or passphrase without replacing it, select Remove stored Private Key or Remove stored Passphrase, and then click Save.

Deleting a Crypto Configuration#

To delete a Crypto Configuration, follow these steps:

  1. Go to the Administration page.

  2. In the secondary menu, click Crypto Configurations.

  3. Click the Crypto Configuration you want to delete.

  4. Click Delete.

  5. Review the list of connectors and destinations that reference the configuration.

  6. Click Delete to confirm.

As a result, the Crypto Configuration is permanently deleted.

Warning

Deleting a Crypto Configuration does not delete or disable the connectors or destinations that reference it. Instead, they silently stop encrypting or decrypting files the next time they run. Before deleting a configuration, review its usages and update any affected connectors or destinations.

What’s next?#

Contents