help_pages.base
===============

.. py:module:: help_pages.base

.. autoapi-nested-parse::

   This module contains classes and functions used by all help pages.







Module Contents
---------------

.. py:class:: HelpPageStrategy

   Bases: :py:obj:`abc.ABC`


   Abstract base class for help page strategies.


   .. py:method:: build_sections(help_context)
      :abstractmethod:


      Builds the required sections.



.. py:class:: HelpContext

   Holds shared context data.


   .. py:attribute:: domain
      :type:  pki.models.domain.DomainModel


   .. py:attribute:: domain_unique_name
      :type:  str


   .. py:attribute:: allowed_app_profiles
      :type:  list[pki.models.domain.DomainAllowedCertificateProfileModel]


   .. py:attribute:: public_key_info
      :type:  trustpoint_core.oid.PublicKeyInfo


   .. py:attribute:: host_base
      :type:  str


   .. py:attribute:: host_cmp_path
      :type:  str


   .. py:attribute:: host_est_path
      :type:  str


   .. py:attribute:: cred_count
      :type:  int


   .. py:attribute:: device
      :type:  None | devices.models.DeviceModel
      :value: None



   .. py:attribute:: devid_registration
      :type:  None | pki.models.DevIdRegistration
      :value: None



   .. py:method:: get_device_or_http_404()

      Gets the device or throws an HTTP404 error.

      :raises Http404: If the device does not exist.

      :returns: The DeviceModel.



   .. py:method:: get_devid_registration_or_http_404()

      Gets the DevidRegistration or throws an HTTP404 error.

      :raises Http404: If the DevidRegistration does not exist.

      :returns: The DevidRegistration.



.. py:function:: build_keygen_section(help_context, file_name)

   Builds the key-generation section.

   :param help_context: The help context which will
   :param file_name: The file_name to use if the default shall not be used. Defaults to None.

   :returns: The key-generation section.


.. py:function:: build_profile_select_section(app_cert_profiles)

   Builds the profile select section.

   :returns: The profile select section.


.. py:function:: build_tls_trust_store_section()

   Builds the TLS trust-store section.

   :raises Http404: If no active Trustpoint TLS-server credential is found or the root CA cert is missing.

   :returns: The TLS trust-store section.


.. py:function:: build_cmp_signer_trust_store_section(domain)

   Builds the CMP-signer trust-store section.

   :returns: The CMP-signer trust-store section.


.. py:function:: build_issuing_ca_cert_section(domain)

   Builds the Issuing CA Certificate section.

   :returns: The Issuing CA Certificate section.


.. py:function:: build_extract_files_from_p12_section()

   Builds the extract files form P12 section.

   :returns: The extract files form P12 section.