.. /*  
    * This file is part of the SavaPage project <https://www.savapage.org>.
    * Copyright (c) 2026 Datraverse B.V.
    * Author: Rijk Ravestein.
    *
    * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. <info@datraverse.com>
    * SPDX-License-Identifier: CC-BY-SA-4.0
    *
    * For more information, please contact Datraverse B.V. at this
    * address: info@datraverse.com
    */

.. _ch-install-on-linux-openpgp-keys:

OpenPGP Settings
----------------

|PRODUCT_NAME| can be configured to use
`OpenPGP <https://www.openpgp.org/>`__ for PGP/MIME email signing and
encryption. See :ref:`Mail <ch-webapp-admin-options-mail>`.

The first step is to set the Public and Secret Key of the |PRODUCT_NAME|
server instance in the
:ref:`server.properties <ch-install-on-linux-config-server-properties>`
configuration file, as shown in the table below.

.. list-table:: OpenPGP server.properties
   :width: 100%
   :widths: 20 80
   :header-rows: 1
   
   * - Key
     - Description

   * - ``pgp.publickey.file``
     - The path of the ASCII Armored public OpenPGP key, relative to |br|
       ``/opt/savapage/server/data/``

   * - ``pgp.secretkey.file``
     - The path of the ASCII Armored secret (private) OpenPGP key, relative to. |br|
       ``/opt/savapage/server/data/``

   * - ``pgp.secretkey.passphrase``
     - The pass-phrase of the ``openpgp.secretkey.file``
   

OpenPGP server information is shown on the :ref:`Admin Dashboard <ch-webapp-admin-dashboard-status>`.

The Secret Key of the server is used to sign e-mail content. Content
encryption is done with the recipient's public key, when present. See
:ref:`OpenPGP <ch-webapp-admin-user-edit-openpgp>`.

Next, PGP/MIME must be activated with the following configuration
properties:

.. table:: OpenPGP Configuration Properties

   +---------------------------------+------------------------------------+
   | Configuration property          | Description                        |
   +=================================+====================================+
   | mail.pgp.mime.sign              | Set to ``Y`` (default) or ``N``,   |
   |                                 | to enable/disable PGP/MIME         |
   |                                 | signing.                           |
   +---------------------------------+------------------------------------+
   | mail.pgp.mime.encrypt           | Set to ``Y`` (default) or ``N``,   |
   |                                 | to enable/disable PGP/MIME         |
   |                                 | encryption.                        |
   +---------------------------------+------------------------------------+
   | pgp.pks.url                     | URL of an OpenPGP Public Key       |
   |                                 | Server. Required if OpenPGP is     |
   |                                 | configured.                        |
   +---------------------------------+------------------------------------+

See |RST_LINK_CONFIG_EDITOR| on how to set these properties.

.. admonition:: |ADMONITION_TITLE_PREVIEW|

   OpenPGP Server Properties are also used for the :ref:`PDF/PGP Verification <ch-pdfpgp>`
   Feature Preview.