Difference between revisions of "OS4X plugin os4xplugin pgp encrypt"

From OS4X
Jump to navigation Jump to search
 
Line 18: Line 18:
 
*Recipient key file (PGP public key): Absolute path to the PGP/GnuPG key file of the recipient of the data. The format must be supported by the command line tool defined above.
 
*Recipient key file (PGP public key): Absolute path to the PGP/GnuPG key file of the recipient of the data. The format must be supported by the command line tool defined above.
 
*Encrypt as ASCII output (instead of binary): When enabled, the output file will contain ASCII characters (with file suffix "<code>.asc</code>" added dynamically), otherwise the data will be created in binary more (with file suffix "<code>.pgp</code>" added dynamically).
 
*Encrypt as ASCII output (instead of binary): When enabled, the output file will contain ASCII characters (with file suffix "<code>.asc</code>" added dynamically), otherwise the data will be created in binary more (with file suffix "<code>.pgp</code>" added dynamically).
 +
 +
= Remarks =
 +
When using GnuPG instead of PGP, the typical filename suffix for binary encryption is "<code>.gpg</code> instead of "<code>.pgp</code>". This plugin enforces the output to obtain the suffix "<code>.pgp</code>" in both cases.

Latest revision as of 10:28, 22 January 2025

Purpose

Encrypt every file of the job with a given public key file in binary or ASCII mode. In typical installations, GnuPG will be used for this task.

Requirements

  • OS4X Enterprise license

Configuration

  • PGP/GnuPG executable (default: gpg): The executable of GnuPG or PGP. It must support the following command line parameters:
    • --recipient-file
    • --encrypt
    • --armor (when in ASCII mode)
    • --verbose
    • --batch
    • --yes
    • --homedir
    • --output
  • Recipient key file (PGP public key): Absolute path to the PGP/GnuPG key file of the recipient of the data. The format must be supported by the command line tool defined above.
  • Encrypt as ASCII output (instead of binary): When enabled, the output file will contain ASCII characters (with file suffix ".asc" added dynamically), otherwise the data will be created in binary more (with file suffix ".pgp" added dynamically).

Remarks

When using GnuPG instead of PGP, the typical filename suffix for binary encryption is ".gpg instead of ".pgp". This plugin enforces the output to obtain the suffix ".pgp" in both cases.