.. _licensing-principles:

*************************************
Licensing
*************************************

.. rubric:: In this chapter:

.. contents::
   :local:


Licensing Principles
==========================

The FindFace licensing is granted using the following criteria: 

#. The overall number of extracted feature vectors.

   .. note::
      The feature vectors are extracted from objects detected in the video, from images in the record index, and user photos, and when building so-called cluster centroids.

   The licensing scheme is the following:

   * Events: 1 event of video object detection = 1 object in a license.
   * Record Index: 1 photo in a record = 1 object in a license.
   * Clusters: 1 person = 1 object in a license.
   * Users: 1 photo of a user = 1 object in a license. 

#. The number of video sources currently in use (i.e., active video processing jobs for video files).
#. The number of model instances in use in the ``findface-extraction-api`` component.

You can choose between the following licensing methods: 

* The online licensing is provided by interaction with the NtechLab Global License Manager ``license.ntechlab.com`` and requires a stable internet connection, DNS, and open port 443 TCP. Upon being disconnected from the internet, the system will continue working off-grid for 4 hours. 

.. note::
   It is possible to prolongate the off-grid period for up to 2 days. Inform your manager if you need that.
 
* The offline licensing via a USB dongle requires a USB port on the physical server with the ``findface-ntls`` component (license server in the :ref:`FindFace core <architecture>`).
* The offline licensing via hardware fingerprint requires Sentinel drivers installed on the physical server with the ``findface-ntls`` component.

.. important::
   For the system to function, a single instance of ``findface-ntls`` should be enough. If your system requires more license servers, contact your NtechLab manager beforehand to prevent your system from being blocked. 

.. _upload-license:

View and Update License
================================

After installing FindFace, upload the license file you obtained from the manager into the system. To do so, navigate to :menuselection:`Settings -> License`. 

    |license_en|

     .. |license_en| image:: /_static/license_en.png
        :scale: 45%

     .. |license_ru| image:: /_static/license_ru.png
        :scale: 45%

Use the same tab to consult current licensing information and upgrade your license.

.. _sentinel:

Offline Licensing via Hardware Fingerprint
================================================

.. note::
   Sentinel is a type of offline licenses that, unlike guardant licenses, do not require any physical media for its work.

   Glossary:

   * Sentinel is a software protection and licensing system by `Thales <https://cpl.thalesgroup.com/>`_. It allows you to implement offline licensing without access to a global server.
   * The C2V file is a file, containing data about a hardware fingerprint of the client’s machine, for binding the license only to this machine. This file is generated by the sentinel library. The C2V file is generated on the client’s machine where the license key will be installed later.

To implement the fingerprint licensing to your system, do the following:

#. Inform your manager that you intend to apply this licensing method and request your unique license id. 
#. Install the Sentinel drivers on the physical server with the ``findface-ntls`` component.

   Do the following:
 
      #. Download `Sentinel drivers <https://supportportal.gemalto.com/csm?id=kb_article_view&sysparm_article=KB0018315#>`_ from the official website.

      #. Unzip the downloaded archive and browse to it.

         .. code::
   
            tar -xvzf Sentinel_LDK_Linux_Runtime_Installer_script.tar.gz
            cd Sentinel_LDK_Linux_Runtime_Installer_script/

      #. There is another archive ``aksusbd-8.31.1.tar.gz`` inside the archive. Unzip it and browse to the resulting directory.

         .. code::

            tar -xvzf aksusbd-8.31.1.tar.gz
            cd aksusbd-8.31.1/

      #. Run the installation command.
   
         .. code::

            sudo ./dinst

      #. Run and check the statuses of the Sentinel services.
   
         .. code::
   
            sudo systemctl start aksusbd.service hasplmd.service
            sudo systemctl status aksusbd.service hasplmd.service


#. Put the ``findface-sentinel-lib_*.deb`` package received from your manager into some directory on the same host. Install the package.

   .. code::

      sudo dpkg -i /path/to/findface-sentinel-lib_*.deb

#. In the FindFace web interface, navigate to :menuselection:`Preferences -> License`. Take a hardware fingerprint (C2V file) by clicking the :guilabel:`Download C2V for activation` button.

   .. tip::
      If you prefer working with the console, you can send the following API request to ``findface-ntls`` instead:

      .. code::
      
         curl 'http://<findface-ntls-server-ip>/ntls/c2v' >my_pc.c2v


#. Send the License ID and the C2V file to your manager and receive your license file in return.
#. Upload the license file on the :guilabel:`License` tab.