Decrypt a file encrypted with PGP.

yaml
type: "io.kestra.plugin.crypto.openpgp.decrypt"

Examples

Decrypt a file

yaml
id: crypto_decrypt
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: decrypt
    type: io.kestra.plugin.crypto.openpgp.Decrypt
    from: "{{ inputs.file }}"
    privateKey: |
      -----BEGIN PGP PRIVATE KEY BLOCK-----
    privateKeyPassphrase: my-passphrase

Decrypt a file and verify signature

yaml

id: crypto_decrypt
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: decrypt
    type: io.kestra.plugin.crypto.openpgp.Decrypt
    from: "{{ inputs.file }}"
    privateKey: |
      -----BEGIN PGP PRIVATE KEY BLOCK-----
    privateKeyPassphrase: my-passphrase
    signUsersKey:
      - |
        -----BEGIN PGP PRIVATE KEY BLOCK-----
    requiredSignerUsers:
      - [email protected]

Properties

from string

The file to crypt

Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.

privateKey string

The private key to decrypt

Must be an ascii key export with gpg --export-secret-key -a

privateKeyPassphrase string

The passphrase use to unlock the secret ring

requiredSignerUsers array

SubType string

The list of recipients the file will be generated.

signUsersKey array

SubType string

The public key use to sign the files

Must be an ascii key export with gpg --export -a

Outputs

uri string

Format uri

The decrypted files uri