help_pages.commands
===================

.. py:module:: help_pages.commands

.. autoapi-nested-parse::

   This module contains cli commands which are displayed in the help pages.



Classes
-------

.. autoapisummary::

   help_pages.commands.KeyGenCommandBuilder
   help_pages.commands.CmpSharedSecretCommandBuilder
   help_pages.commands.EstUsernamePasswordCommandBuilder
   help_pages.commands.CmpClientCertificateCommandBuilder
   help_pages.commands.EstClientCertificateCommandBuilder


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

.. py:class:: KeyGenCommandBuilder

   Gets key-generation commands.


   .. py:method:: get_key_gen_command(public_key_info, cred_number, key_name = '')
      :staticmethod:


      Gets the key generation command corresponding to the provided type.

      :param public_key_info: Key type information.
      :param cred_number: The credential number to use.
      :param key_name: Custom key file name, will default to key-{ cred_number }.pem otherwise.

      :raises ValueError: If the public key information is inconsistent or key type is not supported.

      :returns: The key generation command as string.



.. py:class:: CmpSharedSecretCommandBuilder

   Builds CMP shared-secret commands for different certificate profiles.


   .. py:method:: get_tls_client_profile_command(host, pk, shared_secret, cred_number)
      :staticmethod:



   .. py:method:: get_tls_server_profile_command(host, pk, shared_secret, cred_number)
      :staticmethod:



   .. py:method:: get_opc_ua_client_profile_command(host, pk, shared_secret, cred_number)
      :staticmethod:



   .. py:method:: get_opc_ua_server_profile_command(host, pk, shared_secret, cred_number)
      :staticmethod:



   .. py:method:: get_domain_credential_profile_command(host, pk, shared_secret, domain_name)
      :staticmethod:



.. py:class:: EstUsernamePasswordCommandBuilder

   Builds EST username-password commands for different certificate profiles.


   .. py:method:: get_tls_client_profile_command(cred_number)
      :staticmethod:



   .. py:method:: get_tls_server_profile_command(cred_number)
      :staticmethod:



   .. py:method:: get_opc_ua_client_profile_command(cred_number)
      :staticmethod:



   .. py:method:: get_opc_ua_server_profile_command(cred_number)
      :staticmethod:



   .. py:method:: get_curl_enroll_command(est_username, est_password, host, cred_number)
      :staticmethod:



   .. py:method:: get_conversion_der_pem_command(cred_number)
      :staticmethod:



   .. py:method:: get_domain_credential_profile_command()
      :staticmethod:



   .. py:method:: get_curl_enroll_domain_credential_command(est_username, est_password, host)
      :staticmethod:



   .. py:method:: get_domain_credential_conversion_der_pem_command()
      :staticmethod:



.. py:class:: CmpClientCertificateCommandBuilder

   .. py:method:: get_tls_client_profile_command(host, cred_number)
      :staticmethod:



   .. py:method:: get_tls_server_profile_command(host, cred_number)
      :staticmethod:



   .. py:method:: get_opc_ua_client_profile_command(host, cred_number)
      :staticmethod:



   .. py:method:: get_opc_ua_server_profile_command(host, cred_number)
      :staticmethod:



.. py:class:: EstClientCertificateCommandBuilder

   Builds EST username-password commands for different certificate profiles.


   .. py:method:: get_domain_credential_profile_command()
      :staticmethod:



   .. py:method:: get_curl_enroll_application_credential(cred_number, host)
      :staticmethod: