GPG Key Manager

---

The built-in GPG Key Manager stores GPG and PGP keys for use across your site.

It allows you to create, import, update, and delete keys. Keys that are stored in the GPG Key Manager can be used for encryption and decryption actions. As a central store for your keys, it allows you to import, or create, a key and use it multiple times on your site.

The GPG Key Manager can be found by navigating to Encryption > GPG > GPG Key Manager.

The GPG Key Manager will display a key's name, type (Public only, or Public and Private key pair), expiration date, and MD5 hash values. You can use this information to identify the stored keys, and to compare stored keys to find duplicate entries.

You can generate a GPG/PGP key pair using a web browser.

Navigate to the GPG Key Manager and select the Create button. Enter your full name, or a notable name for this key, and enter your email address.

If you'd like a passphrase for your new key, enter it. This is optional. You can leave this option blank if you wish to have no passphrase to protect the private key.

Select the Generate key pair button. You'll be able to view the public key before you continue to the next step. If you would like to keep a copy of the Public Key, select all of the text and copy it to a file.

Click Save GPG and then a popup window will appear showing the Private Key. Click Download Private Key to save the Private Key.

You can view the GPG/PGP keys that are stored in the GPG Key Manager using a web browser, our Command Line (CLI) App, or by using our APIs.

To view stored GPG/PGP keys using a web browser, navigate to Encryption > GPG > GPG Key Manager.

The GPG Key Manager table will display a key's name, type (Public only, or Public and Private key pair), expiration date, and MD5 hash values. You can use the displayed information to identify the stored keys, and to compare stored keys to find duplicate entries.

You can use our Command Line (CLI) App to programmatically view the stored GPG/PGP keys from a command line or script:

files-cli gpg-keys list

You can use our API, and SDKs, to programmatically view the stored GPG/PGP keys, using the List GPG Keys API.

You can import GPG/PGP keys into the GPG Key Manager using a web browser, our Command Line (CLI) App, or by using our APIs.

When importing a key pair (both the Public Key and the Private Key together), make sure that the Private Key corresponds to its matching Public Key. You cannot import a Private Key without its corresponding Public Key.

When importing private keys that are protected by a passphrase, you must provide the passphrase during the import for the import to succeed.

To import GPG/PGP keys using a web browser, navigate to the GPG Key Manager and select the Import button. Enter your full name or a notable name for this key or key pair.

Paste the Public Key into the Public Key text field, or use the Choose File button to upload the Public Key from your computer.

Paste the Private Key into the Private Key text field, or use the Choose File button to upload the Private Key from your computer. If the Private Key is protected with a passphrase, enter the passphrase for it. You can leave this option blank if there is no passphrase for the private key.

Select the Import button to complete the import of the key.

You can use our Command Line (CLI) App to programmatically import GPG/PGP keys from a command line or script:

files-cli gpg-keys create --user-id=12345 --name="MY FULL KEY NAME" --public-key="PUBLIC_KEY_TEXT" --private-key="PRIVATE_KEY_TEXT" --private-key-password="PASSWORD"

When using the CLI with a user session (your username and password), or an API Key that belongs to a user, you can specify 0 (zero) for the --user-id option and it will automatically determine the user id of your username.

When using the CLI with a site-wide API Key, you must enter a valid user id. You can find a user id by using the files-cli users list command.

Here is an example of importing a Public Key:

files-cli gpg-keys create --user-id=521581 --name="Acme Corp. Public Key" --public-key="-----BEGIN PGP PUBLIC KEY BLOCK-----

mQENBGUA5egBCADJCOH3Jng1QTHI+7ETosi80BwPh+p7AC+id7l1ibximJYzwlOW
wuR7+xgr0474MYOKvKTI3iLCPDEWonY4IV8rUhiww/n4mzdobqz+bOU1cZM657vm
xoINa+VpB00NOTYKHHqnkoKUJpBNzS7SjliQ8j07rcEsJaaijuaa7a6LqXR8vJPZ
8f+c6mHmMYosoG45IcBElY9oKApKMARm9ZZ3hRe5Squ3FtuXA9PrBaQwHU+JFS4c
1iqZZeUHKi258xZ4dHrZN4p//eQgCnSY7lumwnfvO6Hm2UgSG+eRosbe+7fRc7+Z
91TaDZr0ced9SpIvb26jYVnHcEaVFpa3p2GjABEBAAG0U0FjbWUgQ29ycC4gKFRo
aXMgaXMgZm9yIEZpbGVzLmNvbSBkZW1vbnN0cmF0aW9uIHB1cnBvc2VzIG9ubHku
KSA8YWNtZUBtb29ubGlmZS5jb20+iQFOBBMBCAA4FiEEi3/UZ0g0e0uZ0ioqNiIQ
h29xRo0FAmUA5egCGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQNiIQh29x
Ro3LIgf+PUCaMnVSFuJ0vdC6HjgIuJ27ThEd2NhoqAhy6Y5TrtOoz5IWDwqcQwiM
5a1vbt14hOfgXz73TvEvN5djsrwkVHsjzpdGslezRGsq3fkC2+RkuVmKPzrmdvba
HqOp2FNQU5y4W99wWBnudqD1HlzY7BfADsHZ1L4MY0Ehf4E5ZZFqfpn07egLlH8v
JwZUL2hsyS8yKPmr9y0lp8goiqBdm74pHCyFtrPXSOsVYqpiUQ9jeNYju8KLBcsT
sG13akn9j+x7e8RMQjAogtdURBz2Q69SqcvW2vJ+y9gBRoFNzttwSrslJW0Z5tUn
aVgkknP0m6OBFffZcMUUUyb721OIHLkBDQRlAOXoAQgAy3QhrwaSaWC3nE2dAcwJ
0PxZLK0B2OUe8DZ/XlgcJblUaIbQDSLpTockQYlqJFV6ho5RCueUT42/HIsVfpnN
4dOYYUDXtSBw6xDgYGWHcJ/Au0f06qPUQY84zfMydBm5f6bY2Y9L1q4OISp85ekp
pGGSSDWqE4PanICmMTZV/kaqIhgwoRwOpKdDVW4upJIKSP9/rBCnxtArDf3OIkT/
Jf97+/4Fvt6fQtIRhzuiTdBglmiKZLNhvu3b/47cTtkuNwe/6viMcyh45PmlKFMP
mngMoZ9qO0BkqfytdO1XcnPfpJhyFYpljYyq9g2LIW5JlnXqIwddKo7txgb+XNEQ
owARAQABiQE2BBgBCAAgFiEEi3/UZ0g0e0uZ0ioqNiIQh29xRo0FAmUA5egCGwwA
CgkQNiIQh29xRo09wwf/SpM/g/gsAhgr4nWVXP2q6IaKy/iaX/BARkpDRgbptO9/
pBWmt/R8p8TxWD1itKR+gVO1TCQXig1gwyhr3cVWvM5+1ezTi1R08wcczyaXpItp
GjouWcS/z5Awr/XePpO7GIsfGE+HspsmXFDwOAIiKsmqGHF/NDwascxKhHsrhlSt
CZi9iI0LR6V9waAGomJ7qsd9kG6BrLPZFLXsFcLF3STrZSZqAhMRO0CAxanIt0JA
mq92THGN42lnu/HM7J15Z/FxAqE/srarMy3Qpfb54YHQHzVeI9hIoW+qRMFzqHJx
sTR7e//Sqk6HH+xzklRi/gYQz4KBLp7A9iVo9CZ3Vg==
=1DlG
-----END PGP PUBLIC KEY BLOCK-----"

You can use our API, and SDKs, to programmatically import GPG/PGP keys, using the Create GPG Key API.

You can update GPG/PGP keys into the GPG Key Manager using a web browser, our Command Line (CLI) App, or by using our APIs.

When updating a key pair (both the Public Key and the Private Key together), make sure that the Private Key corresponds to its matching Public Key. You cannot update a Private Key without its corresponding Public Key.

When updating private keys that are protected by a passphrase, you must provide the passphrase for the update to succeed.

To update GPG/PGP keys using a web browser, navigate to the GPG Key Manager and select the Edit button on the row of the key that you wish to update. Select the Change Credentials button and enter your full name or a notable name for this key or key pair.

Paste the Public Key into the Public Key text field, or use the Choose File button to upload the Public Key from your computer.

Paste the Private Key into the Private Key text field, or use the Choose File button to upload the Private Key from your computer. If the Private Key is protected with a passphrase, enter the passphrase for it. You can leave this option blank if there is no passphrase for the private key.

Click the Update button to complete the update.

You can use our Command Line (CLI) App to programmatically update GPG/PGP keys from a command line or script:

files-cli gpg-keys update --id=1 --name="MY FULL KEY NAME" --public-key="PUBLIC_KEY_TEXT" --private-key="PRIVATE_KEY_TEXT" --private-key-password="PASSWORD"

Replace the --id value with the id that corresponds to the stored key that you wish to update.

You can find a stored key's id by using the files-cli gpg-keys list command.

Here is an example of updating a Public Key:

files-cli gpg-keys update --id=4 --name="Acme Corp. Updated Public Key" --public-key="-----BEGIN PGP PUBLIC KEY BLOCK-----

mQENBGUA5egBCADJCOH3Jng1QTHI+7ETosi80BwPh+p7AC+id7l1ibximJYzwlOW
wuR7+xgr0474MYOKvKTI3iLCPDEWonY4IV8rUhiww/n4mzdobqz+bOU1cZM657vm
xoINa+VpB00NOTYKHHqnkoKUJpBNzS7SjliQ8j07rcEsJaaijuaa7a6LqXR8vJPZ
8f+c6mHmMYosoG45IcBElY9oKApKMARm9ZZ3hRe5Squ3FtuXA9PrBaQwHU+JFS4c
1iqZZeUHKi258xZ4dHrZN4p//eQgCnSY7lumwnfvO6Hm2UgSG+eRosbe+7fRc7+Z
91TaDZr0ced9SpIvb26jYVnHcEaVFpa3p2GjABEBAAG0U0FjbWUgQ29ycC4gKFRo
aXMgaXMgZm9yIEZpbGVzLmNvbSBkZW1vbnN0cmF0aW9uIHB1cnBvc2VzIG9ubHku
KSA8YWNtZUBtb29ubGlmZS5jb20+iQFOBBMBCAA4FiEEi3/UZ0g0e0uZ0ioqNiIQ
h29xRo0FAmUA5egCGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQNiIQh29x
Ro3LIgf+PUCaMnVSFuJ0vdC6HjgIuJ27ThEd2NhoqAhy6Y5TrtOoz5IWDwqcQwiM
5a1vbt14hOfgXz73TvEvN5djsrwkVHsjzpdGslezRGsq3fkC2+RkuVmKPzrmdvba
HqOp2FNQU5y4W99wWBnudqD1HlzY7BfADsHZ1L4MY0Ehf4E5ZZFqfpn07egLlH8v
JwZUL2hsyS8yKPmr9y0lp8goiqBdm74pHCyFtrPXSOsVYqpiUQ9jeNYju8KLBcsT
sG13akn9j+x7e8RMQjAogtdURBz2Q69SqcvW2vJ+y9gBRoFNzttwSrslJW0Z5tUn
aVgkknP0m6OBFffZcMUUUyb721OIHLkBDQRlAOXoAQgAy3QhrwaSaWC3nE2dAcwJ
0PxZLK0B2OUe8DZ/XlgcJblUaIbQDSLpTockQYlqJFV6ho5RCueUT42/HIsVfpnN
4dOYYUDXtSBw6xDgYGWHcJ/Au0f06qPUQY84zfMydBm5f6bY2Y9L1q4OISp85ekp
pGGSSDWqE4PanICmMTZV/kaqIhgwoRwOpKdDVW4upJIKSP9/rBCnxtArDf3OIkT/
Jf97+/4Fvt6fQtIRhzuiTdBglmiKZLNhvu3b/47cTtkuNwe/6viMcyh45PmlKFMP
mngMoZ9qO0BkqfytdO1XcnPfpJhyFYpljYyq9g2LIW5JlnXqIwddKo7txgb+XNEQ
owARAQABiQE2BBgBCAAgFiEEi3/UZ0g0e0uZ0ioqNiIQh29xRo0FAmUA5egCGwwA
CgkQNiIQh29xRo09wwf/SpM/g/gsAhgr4nWVXP2q6IaKy/iaX/BARkpDRgbptO9/
pBWmt/R8p8TxWD1itKR+gVO1TCQXig1gwyhr3cVWvM5+1ezTi1R08wcczyaXpItp
GjouWcS/z5Awr/XePpO7GIsfGE+HspsmXFDwOAIiKsmqGHF/NDwascxKhHsrhlSt
CZi9iI0LR6V9waAGomJ7qsd9kG6BrLPZFLXsFcLF3STrZSZqAhMRO0CAxanIt0JA
mq92THGN42lnu/HM7J15Z/FxAqE/srarMy3Qpfb54YHQHzVeI9hIoW+qRMFzqHJx
sTR7e//Sqk6HH+xzklRi/gYQz4KBLp7A9iVo9CZ3Vg==
=1DlG
-----END PGP PUBLIC KEY BLOCK-----"

You can use our API, and SDKs, to programmatically update GPG/PGP keys, using the Update GPG Key API.

You can delete GPG/PGP keys from the GPG Key Manager using a web browser, our Command Line (CLI) App, or by using our APIs.

Keys that are in use for encryption or decryption cannot be deleted. Remove the key from use prior to attempting to delete it.

To delete stored GPG/PGP keys using a web browser, navigate to the GPG Key Manager and select the Delete button on the row of the key you wish to delete.

You can use our Command Line (CLI) App to programmatically delete stored GPG/PGP keys from a command line or script:

files-cli gpg-keys delete --id=1

Replace the --id value with the id that corresponds to the stored key that you wish to update.

You can find a stored key's id by using the files-cli gpg-keys list command.

You can use our API, and SDKs, to programmatically delete stored GPG/PGP keys, using the the Delete GPG Key API.