.. Reminder for header structure:        
  Parts (H1)          : #################### with overline
  Chapters (H2)       : ******************** with overline
  Sections (H3)       : ====================
  Subsections (H4)    : --------------------
  Subsubsections (H5) : ^^^^^^^^^^^^^^^^^^^^
  Paragraphs (H6)     : """""""""""""""""""""

.. meta::
 :description: Enhancing the security of your WAPT setup
 :keywords: Documentation, Security, WAPT

.. |date| date::

.. _enhancing_the_security_of_your_wapt_setup:

#######################################################
Enhancing the security of your WAPT setup - Server side
#######################################################

By default, all WAPT packages are signed with your private key, which already provides a great level of security. However you can further improve the security of WAPT.

To fully secure your WAPT setup; you will want to do the following:

* Enable authenticated registration to filter who is authorized to register the device with the WAPT Server.

* Enable https certificate verification on the WAPT Agents and the WAPT Console to ensure that the WAPT Agents and the WAPT Console are connecting to the correct WAPT Server.

* Configure authentication against Active Directory to allow access to the WAPT Console only to authorized WAPT admins.

* Enable Client-Side Certificate Authentication to only allow authenticated devices to access the WAPT Server (Note: it is especially important if you want to expose your WAPT Server to the outside in a :abbr:`DMZ (De-Militarized Zone)`).

* If you are using the **Enterprise** version of WAPT and you operate a large fleet with multiple administrators, you may be interested in knowing how to properly configure and apply the :abbr:`ACLs (Access Control Lists)`.

.. _firewall_wapt_secure:

*******************************************
Configuring the firewall on the WAPT Server
*******************************************

WAPT Server firewall configuration is essential and should be the first step towards achieving better security in WAPT.

As WAPT aims to be secure by design, only a minimal :ref:`set of open ports <open_ports>` is needed on the WAPT Server compared to other solutions.

You will find in the following documentation firewall tips to improve WAPT security.

Configuring the firewall for WAPT Server on Debian and derivatives
==================================================================

**By default on Debian Linux, no firewall rule applies**.

* Disable :program:`ufw` and install :program:`firewalld` instead.

.. code-block:: bash

  ufw disable
  apt update
  apt -y install firewalld

* Simply apply this :program:`firewalld` configuration.

.. code-block:: bash

  systemctl start firewalld
  systemctl enable firewalld
  firewall-cmd --zone=public --add-port=80/tcp --permanent
  firewall-cmd --zone=public --add-port=443/tcp --permanent
  systemctl restart firewalld

Configuring the firewall for WAPT Server on RedHat and derivatives
==================================================================

* Simply apply this :program:`firewalld` configuration.

.. code-block:: bash

  systemctl start firewalld
  systemctl enable firewalld
  firewall-cmd --zone=public --add-port=80/tcp --permanent
  firewall-cmd --zone=public --add-port=443/tcp --permanent
  systemctl restart firewalld

.. _configuring_kerberos_authentication:

********************************************************
Configuring kerberos authentication |enterprise_feature|
********************************************************

.. note::

  * Without kerberos authentication, you have to either trust initial registration or enter a password for each workstation on initial registration.

  * For more information, visit the documentation on :ref:`registering a host with the WAPT Server <initial_host_registration>` and :ref:`signing inventory updates <signing_inventory_updates>`.

  * The kerberos authentication will be used only when registering the device.

Installing the kerberos components and configuring krb5.conf file
=================================================================

.. tabs::

  .. code-tab:: bash Debian and derivatives

    apt install krb5-user msktutil libnginx-mod-http-auth-spnego

  .. code-tab:: bash RedHat and derivatives

    yum install krb5-workstation msktutil nginx-mod-http-auth-spnego

.. note::

  **Registering with kerberos is not available with a WAPT Server running on Windows.**

Modify the :file:`/etc/krb5.conf` file and **replace all the content with the following 4 lines** replacing **MYDOMAIN.LAN** with your Active Directory domain name (i.e. *<MYDOMAIN.LAN>*).

.. attention::

  :code:`default_realm` value **MUST** be written with **ALL CAPS**!!

.. code-block:: ini

  [libdefaults]
    default_realm = MYDOMAIN.LAN
    dns_lookup_kdc = true
    dns_lookup_realm=false

Retrieving a service keytab. Use the :command:`kinit` and :command:`klist`.
You can use an :term:`Administrator` account or any other account with the delegated right to join a computer to the domain in the proper destination container (by default *CN=Computers*).

In the shell transcript below, commands are in black and returned text is commented in light gray:

.. code-block:: bash

  sudo kinit administrator
  ## Password for administrator@MYDOMAIN.LAN:
  ## Warning: Your password will expire in 277 days on Mon. 17 sept. 2018 10:51:21 CEST
  sudo klist
  ## Ticket cache: FILE:/tmp/krb5cc_0
  ## Default principal: administrator@MYDOMAIN.LAN
  ##
  ## Valid starting       Expires              Service principal
  ## 01/12/2017 16:49:31  02/12/2017 02:49:31  krbtgt/MYDOMAIN.LAN@MYDOMAIN.LAN
  ## renew until 02/12/2017 16:49:27

If the authentication request is successful, you can then create your HTTP Keytab with the :program:`msktutil` command.

Adapt the command to your context.

.. code-block:: bash

  sudo msktutil --server srvads.mydomain.lan --create --host srvwapt --computer-name srvwapt -b cn=computers --service HTTP/srvwapt.ad.mydomain.lan --keytab /etc/nginx/http-krb5.keytab --no-reverse-lookups --dont-update-dnshostname  --enctypes 0x18

.. attention::

  Be sure to have properly configured your WAPT Server *hostname* before running these commands;

  In order to double check your *hostname*, you can run :command:`echo $(hostname)` and it **MUST** return the name that will be used by WAPT Agent running on client workstations.
  If your WAPT server is available from the internet, you should add another servicePrincipalName (SPN) to match with the WAPT public URL.
  In order to update the keytab file, you must run the 2nd msktutil command every time you add a new SPN.

You can add an auto-update task in *crontab*.
It will frequently change the machine account password in Active Directory so you can pass security audits.
*Crontab* content:

.. code:: bash
  
  32 23 * * * root msktutil --auto-update --keytab /etc/nginx/http-krb5.keytab  --enctypes 0x18

.. warning::

  The computer account must be able to change its own password (Security tab, group SELF, "Change password" permission).

.. figure:: wapt-resources/computer_account_password.png
  :align: center
  :alt: Change password permission
  



* Apply the proper access rights to the :file:`http-krb5.keytab` file. If you are with RedHat based OS with selinux, please fix rights with :program:`restorecon`.

.. tabs::

  .. code-tab:: bash Debian and derivatives

    sudo chmod 640 /etc/nginx/http-krb5.keytab
    sudo chown root:www-data /etc/nginx/http-krb5.keytab

  .. code-tab:: bash RedHat and derivatives
    
    sudo chown root:nginx /etc/nginx/http-krb5.keytab
    sudo chmod 640 /etc/nginx/http-krb5.keytab
    restorecon -v -R /etc/nginx/http-krb5.keytab

Post-configuring kerberos for the WAPT Server
=============================================

You can now use post-configuration script to configure the WAPT Server to use kerberos.

The post-configuration script will configure :program:`Nginx` and the WAPT Server to use kerberos authentication.

.. hint::

  This post-configuration script **MUST** be run as **root**.

.. code-block:: bash

  /opt/wapt/waptserver/scripts/postconf.sh --force-https

Kerberos authentication will now be configured.

Special use cases
=================

My WAPT server is integrated into a global Active Directory (AD) environment.
-----------------------------------------------------------------------------

**Security Considerations**

The French National Cybersecurity Agency (**ANSSI**) regularly observes that compromises of information systems (IS) based on Active Directory (AD) often stem from poor `administrative practices and insufficient compartmentalization <https://cyber.gouv.fr/publications/recommandations-pour-ladministration-securisee-des-si-reposant-sur-ad>`_. These breaches typically begin with attacks targeting workstations. Attackers then exploit vulnerabilities in the IS to move laterally, escalate privileges, and eventually gain full control of the AD.

Once an attacker achieves this level of control, they can create persistent backdoors, allowing them to maintain long-term access to the IS, including the organization's critical business processes and data.

`ANSSI's Secure Administration Guide <https://cyber.gouv.fr/sites/default/files/document/anssi-guide-admin_securisee_si_ad_v1-0%20%283%29.pdf>`_.

The Guide to Secure Administration of Information Systems Based on an AD Directory addresses the specific challenges of administering AD environments and provides recommendations for partitioning the IS into trusted zones. This guide complements ANSSI's broader technology-agnostic security recommendations for secure IS administration.


My WAPT Server does not have access to a writeable Active Directory
-------------------------------------------------------------------

* Connect to your Active Directory (Not a RODC).

* Create a computer account *srvwapt*.

* Add a :abbr:`SPN (Service Principal Name)` on the *srvwapt$* account.

.. code-block:: bash

  setspn -A HTTP/srvwapt.mydomain.lan srvwapt

* Create a keytab for this WAPT Server.

.. code-block:: batch

  ktpass -out C:\http-krb5.keytab -princ HTTP/srvwapt.mydomain.lan@MYDOMAIN.LAN rndpass -minpass 64 -crypto all -pType KRB5_NT_PRINCIPAL /mapuser srvwapt$@MYDOMAIN.LAN
  Reset SRVWAPT$'s password [y/n]? y

.. note::

  If the address of your WAPT Server is different from your active directory domain, replace *HTTP/srvwapt.mydomain.lan@MYDOMAIN.LAN* with *HTTP/srvwapt.othername.com@MYDOMAIN.LAN*.

* Transfer this file to :file:`/etc/nginx/` (with :program:`winscp` for example).

* Apply the proper access rights to the :file:`http-krb5.keytab` file.
  If you are with RedHat based OS with selinux, please fix rights with :program:`restorecon`.

.. tabs::

  .. code-tab:: bash Debian and derivatives

    sudo chmod 640 /etc/nginx/http-krb5.keytab
    sudo chown root:www-data /etc/nginx/http-krb5.keytab

  .. code-tab:: bash RedHat and derivatives

    sudo chown root:nginx /etc/nginx/http-krb5.keytab
    sudo chmod 640 /etc/nginx/http-krb5.keytab
    restorecon -v -R /etc/nginx/http-krb5.keytab

WAPT Agents only have access to a RODC domain controller
--------------------------------------------------------

* For :abbr:`RODC (Read-Only Domain Controller)`, add the *srvwapt* account to the allowed password group for replication.

* Remember to preload the password of the WAPT Server with the different RODC servers.

.. figure:: wapt-resources/windows_rsat_rodc-preload_dialog-box.png
  :align: center
  :alt: Preload Password srvwapt account

You have multiple Active Directory domains with or without relationships
------------------------------------------------------------------------

If you have multiple Active Directory domains, you **MUST** create one :file:`keytab` per domain by following the procedure above, ex:

* :file:`http-krb5-domain1.local.keytab`;

* :file:`http-krb5-domain2.local.keytab`;

* :file:`http-krb5-domain3.local.keytab`.

You will then have to merge all these :file:`keytabs` into a unique :file:`keytab`:

.. code-block:: bash

  ktutil
  read_kt http-krb5-domain1.local.keytab
  read_kt http-krb5-domain2.local.keytab
  read_kt http-krb5-domain3.local.keytab
  write_kt http-krb5.keytab

Debug problems with the kerberos
================================

.. attention::

  * The WAPT Server address cannot be an IP, Kerberos works well only with DNS.

  * In your test, the url used **MUST** be **exactly** the same address as the one indicated in :file:`C:\\Program Files (x86)\\wapt\\wapt-get.ini`.

Did you restart nginx correctly?
--------------------------------

.. code-block:: bash

  systemctl restart nginx

Check the permissions of the http-krb5.keytab file
--------------------------------------------------

.. code-block:: bash

  [root@srvwapt.mydomain.lan]# ls -l /etc/nginx/http-krb5.keytab
  -rw-r----- 1 root www-data 921 janv. 4 16:20 /etc/nginx/http-krb5.keytab

Is kerberos mode active on my WAPT Agent?
-----------------------------------------

On the Windows host:

* Check in your :file:`C:\\Program Files (x86)\\wapt\\wapt-get.ini` that the :code:`use_kerberos` value is ``True``.

.. code-block:: bash

  [global]
  use_kerberos=True

* If you change the value, do not forget to restart the WAPT service.

.. code-block:: bash

  net stop waptservice
  net start waptservice

Is Kerberos mode active on my WAPT Server?
------------------------------------------

On the Linux host:

* Check in your :file:`/opt/wapt/conf/waptserver.ini` that the :code:`use_kerberos` value is ``True``.

.. code-block:: bash

  [options]
  use_kerberos=True

* Check in your :file:`/etc/nginx/sites-enabled/wapt.conf` that this configuration is present.

.. code-block:: bash

  location ~ ^/.*_kerberos$ {

        proxy_http_version 1.1;
        proxy_request_buffering off;

        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

        # be sure these headers are not forwarded
        proxy_set_header X-Ssl-Client-Dn "";
        proxy_set_header X-Ssl-Authenticated "";

        auth_gss on;
        auth_gss_keytab /etc/nginx/http-krb5.keytab;
        proxy_pass http://127.0.0.1:8080;
 
    }

* If one of the two configurations is not present, restart the post-configuration and activate kerberos.

Checking that the keytab file contains the correct url
------------------------------------------------------

.. code-block:: bash

  [root@srvwapt.mydomaine.lan]# KRB5_KTNAME=/etc/nginx/http-krb5.keytab klist -k
  Keytab name: FILE:/etc/nginx/http-krb5.keytab
  KVNO Principal
  ---- --------------------------------------------------------------------------
     ...
     3 HTTP/srvwapt.ad.mydomain.lan@AD.MYDOMAIN.LAN
     ...

Trying to register the host using a system account
--------------------------------------------------

To switch to a system account you **MUST** use the :program:`psexe` tool from Microsoft: :download:`psexe <https://download.sysinternals.com/files/PSTools.zip>`.

* In :program:`cmd` as an Administrator.

.. code-block:: bash

  C:\Users\\xxxxxx\\Downloads\\PSTools\\psexec.exe -accepteula -s -i cmd

* In the new :program:`cmd` window, check that you are identified as *System*.

.. code-block:: bash

  C:\WINDOWS\\system32>whoami

  NT AUTHORITY\System

* Run :command:`register`.

.. code-block:: bash

  wapt-get register

Trying an authentication with the keytab from your WAPT Server
--------------------------------------------------------------

* On the Linux host.

.. code-block:: bash

  [root@srvwapt.ad.tranq ~]# ktutil
  ktutil: read_kt /etc/nginx/http-krb5.keytab
  ktutil: list
  slot KVNO Principal
  ---- ---- ---------------------------------------------------------------------
    1    3                  srvwapt$@AD.TRANQUIL.IT
    2    3                  srvwapt$@AD.TRANQUIL.IT
    3    3                  srvwapt$@AD.TRANQUIL.IT
    4    3                  SRVWAPT$@AD.TRANQUIL.IT
    5    3                  SRVWAPT$@AD.TRANQUIL.IT
    6    3                  SRVWAPT$@AD.TRANQUIL.IT
    7    3              host/srvwapt@AD.TRANQUIL.IT
    8    3              host/srvwapt@AD.TRANQUIL.IT
    9    3              host/srvwapt@AD.TRANQUIL.IT
   10    3 HTTP/srvwapt.ad.tranquil.it@AD.TRANQUIL.IT
   11    3 HTTP/srvwapt.ad.tranquil.it@AD.TRANQUIL.IT
   12    3 HTTP/srvwapt.ad.tranquil.it@AD.TRANQUIL.IT
  ktutil: quit
  [root@srvwapt.ad.tranq ~]# kinit -k -t /etc/nginx/http-krb5.keytab srvwapt\$@AD.TRANQUIL.IT
  [root@srvwapt.ad.tranq ~]# klist
  Ticket cache: FILE:/tmp/krb5cc_0
  Default principal: srvwapt$@AD.TRANQUIL.IT

  Valid starting       Expires              Service principal
  05/02/2021 19:06:05  06/02/2021 05:06:05  krbtgt/AD.TRANQUIL.IT@AD.TRANQUIL.IT
    renew until 06/02/2021 19:06:05

Attempting an authentication with curl
--------------------------------------

* On the Linux host.

.. code-block:: bash

  [root@srvwapt.ad.tranq ~]# kdestroy
  [root@srvwapt.ad.tranq ~]# kinit sfonteneau
  Password for sfonteneau@AD.TRANQUIL.IT:
  [root@srvwapt.ad.tranq ~]# klist
  Ticket cache: FILE:/tmp/krb5cc_0
  Default principal: sfonteneau@AD.TRANQUIL.IT

  Valid starting       Expires              Service principal
  05/02/2021 19:10:42  06/02/2021 05:10:42  krbtgt/AD.TRANQUIL.IT@AD.TRANQUIL.IT
    renew until 06/02/2021 19:10:39

  root@srvwapt.ad.tranq ~]# curl -v --negotiate -u : https://srvwapt.ad.tranquil.it/api/v3/add_host_kerberos -k
  * Expire in 0 ms for 6 (transfer 0x563dece09f90)
  * Uses proxy env variable no_proxy == 'localhost,127.0.01/8,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12,ad.tranquil.it'
  * Expire in 1 ms for 1 (transfer 0x563dece09f90)
  ...
  {"success":true,"msg":"Authentication OK","result":{"auth_result":{"auth_method":"kerb","user":"sfonteneau","auth_date":"2024-11-04T16:53:03.817821","with2fa":false},"server_uuid":"7j54647e-1b54-11ea-bcbe-cae466b691e5","version":"2.6.0","server_domain":"ad.tranquil.it","edition":"enterprise","user_acls":{},"token":null},"request_time":0.006450653076171875}

Verifying that you are successfully obtaining a Kerberos ticket
---------------------------------------------------------------

.. attention::

  Always execute commands in system account (see previous point)!

.. code-block:: bash

  klist purge
  klist get http/srvwapt.ad.mydomain.lan

You should get (in your language):

.. code-block:: bash

  C:\Windows\System32>klist get http/srvwapt.ad.mydomain.lan

  LogonId est 0:0x13794d
  Un ticket pour http/srvwapt.ad.mydomain.lan a été récupéré.

  Tickets mis en cache : (2)

  #0> Client : sfonteneau @ AD.MYDOMAIN.LAN
    Serveur : krbtgt/AD.MYDOMAIN.LAN @ AD.MYDOMAIN.LAN
    Type de chiffrement KerbTicket : AES-256-CTS-HMAC-SHA1-96
    Indicateurs de tickets 0x40e00000 -> forwardable renewable initial pre_authent
    Heure de démarrage : 2/4/2021 15:51:07 (Local)
    Heure de fin :   2/5/2021 1:51:07 (Local)
    Heure de renouvellement : 2/11/2021 15:51:07 (Local)
    Type de clé de session : AES-256-CTS-HMAC-SHA1-96
    Indicateurs de cache : 0x1 -> PRIMARY
    KDC appelé : srvads.AD.MYDOMAIN.LAN

  #1> Client : sfonteneau @ AD.MYDOMAIN.LAN
    Serveur : http/srvwapt.AD.MYDOMAIN.LAN @ AD.MYDOMAIN.LAN
    Type de chiffrement KerbTicket : AES-256-CTS-HMAC-SHA1-96
    Indicateurs de tickets 0x40a80000 -> forwardable renewable pre_authent 0x80000
    Heure de démarrage : 2/4/2021 15:51:07 (Local)
    Heure de fin : 2/5/2021 1:51:07 (Local)
    Heure de renouvellement : 2/11/2021 15:51:07 (Local)
    Type de clé de session : AES-256-CTS-HMAC-SHA1-96
    Indicateurs de cache : 0
    KDC appelé : srvads.AD.MYDOMAIN.LAN

If that does not work, check in your Active Directory that the :code:`serviceprincipalname` attribute on the computer account of the WAPT Server has this value: ``HTTP/srvwapt.mydomain.lan``.

Check that it works with Firefox
--------------------------------

.. note::

  You need to first configure Firefox for kerberos authentication.

* Type :command:`about:config` in the URL bar in your Firefox.

* Edit ``network.negotiate-auth.trusted-uris``, and add the url of the WAPT Server: ``srvwapt.mydomain.lan``.

* You can now visit the url: https://srvwapt.mydomain.lan/add_host_kerberos.

* If the authentication does not work, then the WAPT Server will return a 403 error message.

In case of an error on one of the previous checks
-------------------------------------------------

* Delete the host account from the Active Directory.

* Delete the :file:`/etc/nginx/http-krb5.keytab` file.

* Reboot the host you are testing with and re-run the keytab creation process again.

.. note::

  * It is important to restart the host to purge the kerberos tickets previously obtained by the host.

  * To avoid restarting you can also execute the command "klist purge" as SYSTEM.

.. _activating_HTTPS_certificate_verification:

********************************************************
Activating the verification of the SSL / TLS certificate
********************************************************

.. important::
 
  When configuring any type of certificate (PKI, commercial, or self-signed), **always verify the expiration date**.

  - If **the certificate is due to expire soon**, you can prepare in advance by :ref:`following this procedure <ca_ssl/tls_renewal_before_expiration>`.

  - If **the certificate has already expired**, there are only two ways to regain control of your environment:

    - Using Group Policy Objects (GPOs)—though GPOs have limitations and may not guarantee full validation of successful deployment.
    - Manually connecting a USB device to each machine under your responsibility.
  
    More information :ref:`here <ca_ssl/tls_renewal_after_expiration>`.


When running the WAPT Server post-configuration script, the script will generate a self-signed certificate in order to enable HTTPS communications.

The WAPT Agent checks the WAPT HTTPS Server certificate according to the ``verify_cert`` value in section ``[global]`` in :file:`C:\\Program Files (x86)\\wapt\\wapt-get.ini`.

.. list-table:: Options for ``verify_cert``
  :header-rows: 1
  :widths: auto

  * - Options for ``verify_cert``
    - Working principle of the WAPT Agent
  * - ``verify_cert`` = 0
    - the WAPT Agent will not check the WAPT Server HTTPS certificate.
  * - ``verify_cert`` = 1
    - the WAPT Agent will check the WAPT Server HTTPS certificate using the certificate bundle.
      :file:`C:\\Program Files (x86)\\wapt\\lib\\site-packages\\certifi\\cacert.pem`
  * - ``verify_cert`` = C:\\Program Files (x86)\\wapt\\ssl\\srvwapt.mydomain.lan.crt
    - the WAPT Agent will check the WAPT Server HTTPS certificate with the certificate bundle.
      :file:`C:\\Program Files (x86)\\wapt\\ssl\\srvwapt.mydomain.lan.crt`

.. hint::

   To quickly and easily enable verification of the HTTPS certificate, you can use the *Pinning* method.

.. _pinning_certificate:

Pinning the certificate
=======================

The *pinning of certificate* consists of verifying the SSL/ TLS certificate with a well defined and restricted bundle.

.. danger::

  This method is the easiest when using a self-signed certificate.

  But **Never pin a commercial certificate** : Pinning commercial certificates can lead to serious renewal failures.

For this, you need to launch the following commands in the Windows :program:`cmd.exe` shell (with elevated privileges if :abbr:`UAC (User Account Control)` is active).

If you already have a Windows :program:`cmd.exe` shell open, close it and open a new shell so to take into account the updated environment variables:

.. code-block:: bash

  wapt-get enable-check-certificate
  wapt-get restart-waptservice

Validate the certificate with :command:`wapt-get update`

When you have executed the :command:`update` command, make sure that everything has gone well, and if in doubt check :ref:`error_run_check_cert`.

.. attention::

  If `wapt-get enable-check-certificate` returns an error, remove the :mimetype:`.crt` with same name on :file:`C:\\Program Files (x86)\\wapt\\ssl\server`

.. note::

  * The command :command:`enable-check-certificate` downloads the certificate
    :file:`srvwapt.mydomain.lan.crt` in the folder
    :file:`C:\\Program Files (x86)\\WAPT\\ssl\\server`.

  * It then modifies the file :file:`wapt-get.ini` to specify the value ``verify_cert`` = :file:`C:\\Program Files (x86)\\wapt\\ssl\\server\\srvwapt.mydomain.lan.crt`.

  * The WAPT Agent will now verify certificates using the pinned certificate.

.. attention::

  If you use the *certificate pinning* method, **BE REMINDED** to archive the :file:`/opt/wapt/waptserver/ssl` folder on your WAPT Server.

  The file will have to be restored on your WAPT Server if you migrate or upgrade your WAPT Server, if you want the WAPT Agents to continue to be able to establish trusted HTTPS connections with the WAPT Server.

How to use a commercial certificate or certificates provided by your Organization?
==================================================================================

If the pinning method does not suit you, you can replace the self-signed certificate generated during the installation of :program:`WAPT`.

Replace the old certificate with the new one in the folder :file:`/opt/wapt/waptserver/ssl/` (Linux) or :file:`C:\\wapt\\waptserver\\ssl\\` (Windows).

**The new key pair MUST be in PEM encoded Base64 format**.

.. note::

  **Special case where your certificate has been signed by an internal Certificate Authority**

  Certificates issued by an internal :term:`Certificate Authority` **MUST** have the complete certificate chain of the :term:`Certificate Authority`.

  You can manually add the certificate chain of the Certificate Authority to the certificate that will be used by :program:`Nginx`.

  Example: :code:`echo srvwapt.mydomain.lan.crt ca.crt > cert.pem`

* For Linux servers it is also necessary to reset the :abbr:`ACLs (Access Control List)`, if you are with RedHat based OS with selinux, please fix rights with :program:`restorecon` :

.. tabs::

  .. code-tab:: bash Debian and derivatives

    chown root:www-data /opt/wapt/waptserver/ssl/*.pem

  .. code-tab:: bash RedHat and derivatives
    
    chown root:nginx /opt/wapt/waptserver/ssl/*.pem
    restorecon -v -R /opt/wapt/waptserver/ssl/


* Restart :program:`Nginx` to take into account the new certificates.

.. tabs::

  .. code-tab:: bash Linux
    
    systemctl restart nginx

  .. code-tab:: bash Windows:
    
    net stop waptnginx
    net start waptnginx

Configuring the WAPT Agent
--------------------------

For a commercial certificate you can set ``verify_cert = 1`` in :file:`wapt-get.ini`.

For a certificate issued by an internal Certificate Authority, you **MUST** place the Certificate Authority in the :file:`C:\\Program Files (x86)\\wapt\\ssl\\server\\ca.crt` folder and specify the certificate path with ``verify_cert`` in the :file:`wapt-get.ini` file of the WAPT Agent.

To apply the new configuration to your entire fleet:

* Regenerate a WAPT Agent with the appropriate settings.

* Use a `WAPT package <https://wapt.tranquil.it/store/tis-wapt-conf-policy>`_ to modify :file:`wapt-get.ini` and push the certificate.

Verifying the certificate in the WAPT Console
=============================================

When the WAPT Console first starts, it reads the content of :file:`C:\\Program Files (x86)\\WAPT\\wapt-get.ini` and it builds its configuration file :file:`C:\\Users\\admin\\AppData\\Local\\waptconsole\\waptconsole.ini`.

This properly sets the ``verify_cert`` attribute for the HTTPS communication between the WAPT Console and the WAPT Server.

.. _configure_ad_auth:

*****************************************************************************
Configuring user authentication against Active Directory |enterprise_feature|
*****************************************************************************

By default, the WAPT Server is configured with a single :term:`SuperAdmin` account whose password is setup during initial post-configuration.

**On large and security-minded networks, the SuperAdmin account should not be used since it cannot provide the necessary traceability for administrative actions that are done on the network assets**.

It is thus necessary to configure authentication against the Active Directory for the WAPT Console users; this will allow to use named accounts for tasks.

.. note::

  * Active Directory authentication is used to authenticate access to the inventory via the WAPT Console.

  * However, all actions on the WAPT equipped remote devices are based on X.509 signatures, so an :term:`Administrator` will need both an Active Directory login **AND** a private key whose certificate is recognized by the remote devices that the Administrator manages using WAPT.

  * Only the :term:`SuperAdmin` account and the members of the Active Directory security group **waptadmins** will be allowed to upload packages on the main repository (authentication mode by login and password).

.. _ldap_authentication:

Enabling Active Directory authentication
========================================

.. warning::
  
  We strongly recommend that you use :ref:`*Kerberos authentication* <configuring_kerberos_authentication>` instead of LDAP. However, it is possible to configure a secure LDAP connection.

* To enable authentication of the WAPT Server with Active Directory, configure the file :file:`waptserver.ini` as follows.

.. note::

  The WAPT Server configuration file on GNU/ Linux and macOS systems is found in :file:`/opt/wapt/conf/waptserver.ini` or in :file:`/opt/wapt/waptserver/waptserver.ini`.

  The WAPT Server configuration file on Windows systems is found in :file:`C:\\wapt\\conf\\waptserver.ini`.


Most secure : LDAP SASL Bind over GSSAPI
-----------------------------------------

* Network Requirements : DNS (53 TDP), Kerberos (88 TDP), LDAP/CLDAP (389 TDP/UDP) from WAPT Server to Domain Controller.

.. code-block:: ini

  #waptserver.ini

  wapt_admin_group=waptadmins      # parameter wapt_admin_group_dn is deprecated since WAPT 2.6
  ad_domain_name=mydomain.lan

You must remove all properties starting with "ldap\_*" if existing.

Now you can set the following configuration in /etc/krb5.conf (mandatory capital letters for Kerberos Realm):


.. code-block:: ini

  [libdefaults]
    default_realm = MYDOMAIN.LAN
    dns_lookup_kdc = true
    dns_lookup_realm = true

If the DNS Lookup does not work, you can set the configuration file as follows (mandatory capital letters for Kerberos Realm).

.. code-block:: ini

  [libdefaults]
    default_realm = MYDOMAIN.LAN
    dns_lookup_kdc = false
    dns_lookup_realm = false
  [realms]
    MYDOMAIN.LAN = {                
    kdc = 192.168.1.13        # KDC IP equals to Domain Controller IP
    kdc = 192.168.1.12
    }


LDAPS connection
--------------------

This method is less secure than LDAP SASL Bind over GSSAPI

* Network Requirements : DNS (53 TDP), LDAP (389 TDP) from WAPT Server to Domain Controller.

.. code-block:: ini

  #waptserver.ini

  wapt_admin_group=waptadmins      # parameter wapt_admin_group_dn is deprecated since WAPT 2.6
  ldap_auth_server=ldaps://ldapserver.mydomain.lan:636

.. note::

  If your certificate isn't recognized, you can modify the verify_cert at false, in the :file:`waptserver.ini`.

  .. code-block::

    verify_cert = False


.. list-table:: Available authentication options
  :header-rows: 1
  :widths: auto
  :align: center

  * - Options (Default Value)
    - Description
    - Example
  * - :code:`wapt_admin_group` (default [])
    - Defines the sAMAccountName of the Active Directory User Group allowed to connect to WAPT Console, it is a list that can contain several groups.
      You can use this option over ``wapt_admin_group_dn``, but **DO NOT** use both attributes at the same time.
    - wapt_admin_group = waptadmins, wapttech
  * - :code:`ldap_auth_server` (default ``None``)
    - Defines the LDAP authentication server. If not specified, a cldap query will be used with the ad_domain_name option to find the best domain controller based on the site and Active Directory service.
    - ldap_auth_server = srvads.mydomain.lan
  * - :code:`ldap_auth_base_dn` (default ``None``)
    - Defines the LDAP authentication base DN. If not specified, The root will be used
    - ldap_auth_base_dn = dc=domain,dc=lan
  * - :code:`ad_domain_name` (default ``None``)
    - Defines the domain name. 
    - ad_domain_name = mydomain.lan

* Restart :program:`waptserver` service.



Enabling Single Sign On (SSO) for the WAPT Console and the self-service
=======================================================================

.. warning::

  This configuration is only available for WAPT Servers running on WAPT supported Linux distributions.

You can use Kerberos to authenticate yourself on the :program:`waptconsole` and the :program:`selfservice`.
This way, users do not need to enter their password.

It is not necessary to register the WAPT Agent using kerberos in order to use the kerberos :abbr:`SSO (Single Sign-On)` on the WAPT Console and in the Self-Service.

Preparing the WAPT Server for Kerberos Single Sign On
-----------------------------------------------------

.. attention::

  To enable Kerberos on the WAPT Server with :code:`use_kerberos` = ``True`` option, launch the :ref:`WAPT Server postconf script <wapt_postconf>`.
  
  .. code-block:: bash

    /opt/wapt/waptserver/scripts/postconf.sh

  Please, refer to :ref:`the documentation on configuring kerberos for authentication <configuring_kerberos_authentication>` beforehand.

  If you do not want to use Kerberos for Client registration, set the option :code:`allow_unauthenticated_registration` to ``True``.

  Finally, restart the waptserver and wapttasks services.

  .. code-block:: bash

    systemctl restart waptserver wapttasks


You will need to modify the :ref:`waptserver.ini <waptserver_ini_file_options>`.


* Then, you will need to add these options in the :file:`waptserver.ini`:

  .. code-block:: ini

    ad_domain_name = mydomain.lan
    use_kerberos = True
  
  The :code:`ldap_account_service_login` and :code:`ldap_account_service_password` require a service user account on your Active Directory.

  It is not necessary that the service account had elevated right, just enough rights to read groups and group members.

* Finally, restart services on the WAPT Server:

  .. code-block:: bash
    
    systemctl restart waptserver wapttasks
  
Configuring the WAPT Agent
--------------------------

On the client side, you will have to make sure that theses 2 options are set in the :ref:`wapt-get.ini <wapt_agent_ini_file_options>` of the WAPT Agent:

.. code-block:: ini

  service_auth_type = waptserver-ldap
  use_kerberos = True

It is possible to make changes in :file:`wapt-get.ini` manually or by deploying a WAPT package with the new configuration settings.

An `example package <https://store.wapt.fr/store/tis-wapt-conf-policy>`_ is available from the Tranquil IT repository.

With this configuration, you can launch your WAPT Console or your selfservice without being prompted for a password.

To make this feature work, the Active Directory has to be available.

.. note:: 
  
  The WAPT Console will continue to ask for a login / password.
  It is perfectly normal, this way you can use another user than the current user logged in the underlying desktop session.
  
  Otherwise, you just have to put your login and click on :guilabel:`OK`.

.. _ldap_enable_ssl_tls_support:

Enabling SSL/ TLS support for the LDAP connection to the Active Directory Domain Controller
===========================================================================================

By default, authentication on Active Directory relies on LDAP SSL (default port 636).

SSL / TLS is not enabled by default on Microsoft Active Directory until a SSL certificate has been configured for the Domain Controller.

.. note::

  The WAPT Server uses Certificate Authority *bundles* from the operating system for validating the SSL/ TLS connection to Active Directory.

  If the Active Directory certificate is self-signed or the certificate has been signed by an internal :abbr:`CA (Certificate Authority)`, you will need to add the certificates to the operating system certificate store.

  To do so, just add a :term:`Certificate Authority` in the :file:`/etc/pki/ca-trust/source/anchors/` and update the certificate store.

  .. tabs::

    .. code-tab:: bash Debian and derivatives

      cp cainterne.crt /usr/local/share/ca-certificates/cainterne.crt
      update-ca-certificates

    .. code-tab:: bash RedHat and derivatives

      cp cainterne.crt /etc/pki/ca-trust/source/anchors/cainterne.crt
      update-ca-trust

    .. code-tab:: bash Windows
      
      certutil -addstore -f "ROOT" cainterne.crt

* Once you have setup LDAP SSL/ TLS on your Active Directory (please refer to Microsoft documentation for that), then you can enable support for SSL/TLS security for AD in :file:`waptserver.ini`.

.. code-block:: ini

  ldap_auth_ssl_enabled = True

* Restart :program:`waptserver` service.

.. _client_side_certificate_authentication:

***********************************************************************
Configuring Client-Side Certificate Authentication |enterprise_feature|
***********************************************************************

If your business needs a public WAPT Server on Internet, it can be secured with **Client-Side Certificate Authentication**.

That configuration restricts the visibility of the WAPT Server only to registered WAPT clients.
It is done by relying on the WAPT Agent private key generated during registration.
It works as follows:

* The WAPT Agent sends a :abbr:`CSR (Certificate Signing Request)` to the WAPT Server which the WAPT Server signs and sends back to WAPT Agent.

* Using the signed certificate, the Agent can access protected parts of the :program:`Nginx` web server.

.. note::

  We strongly recommend enabling Kerberos or login / password registration in the WAPT Server post-configuration.

.. warning::

  All actions are to be carried out on the WAPT Server

Enabling Client-Side Certificate Authentication on WAPT Server
==============================================================

.. warning::

  For **Linux** check if the symbolic link in :file:`sites-enabled` exists:

  .. code-block:: bash

    cd /etc/nginx/sites-enabled/
    find . -maxdepth 1 -type l -ls

  The expected result should be:

  .. code-block:: bash

    269091      0 lrwxrwxrwx   1 root     root           36 juil. 22 15:51 ./wapt.conf -> /etc/nginx/sites-available/wapt.conf

  Otherwise use the following command:

  .. code-block:: bash

    ln -s /etc/nginx/sites-available/wapt.conf ./wapt.conf

To enable the authentication, you need to add those parameters on WAPT :ref:`server configuration file <waptserver_ini_file_options>` in the option section:

.. code-block:: ini

  use_ssl_client_auth = True

Relaunch the post-configuring script.

.. attention::

  Please note that as of |date|, WAPT does not support :abbr:`CRL (Certificate Revocation Lists)`, which means that when you delete a host in the WAPT Console, the host will still have access to the WAPT repository.
  
  The WAPT Deployment utility cannot use **https** to retrieve the WAPT Agent, you will have to add this section in the file:

  .. code-block:: ini

    server {
      listen                      80;
      listen                      [::]:80;
      server_name                 _;

      location ~ ^/(wapt/waptsetup-tis.exe|wapt/waptagent.exe|wapt/waptdeploy.exe)$ {
          add_header Cache-Control "store, no-cache, must-revalidate, post-check=0, pre-check=0";
          add_header Pragma "no-cache";
          root "/var/www";
      }

      return 301                  https://$host$request_uri;
    }
