help_pages.devices_help_views
=============================

.. py:module:: help_pages.devices_help_views

.. autoapi-nested-parse::

   This module contains all views concerning the help pages used within the devices app.



Classes
-------

.. autoapisummary::

   help_pages.devices_help_views.ApplicationCertificateProfileData
   help_pages.devices_help_views.ApplicationCertificateProfile
   help_pages.devices_help_views.GetRedirectMixin
   help_pages.devices_help_views.AbstractNoOnboardingCmpSharedSecretHelpView
   help_pages.devices_help_views.DeviceNoOnboardingCmpSharedSecretHelpView
   help_pages.devices_help_views.OpcUaGdsNoOnboardingCmpSharedSecretHelpView
   help_pages.devices_help_views.AbstractNoOnboardingEstUsernamePasswordHelpView
   help_pages.devices_help_views.DeviceNoOnboardingEstUsernamePasswordHelpView
   help_pages.devices_help_views.OpcUaGdsNoOnboardingEstUsernamePasswordHelpView
   help_pages.devices_help_views.AbstractOnboardingDomainCredentialCmpSharedSecretHelpView
   help_pages.devices_help_views.DeviceOnboardingDomainCredentialCmpSharedSecretHelpView
   help_pages.devices_help_views.OpcUaGdsOnboardingDomainCredentialCmpSharedSecretHelpView
   help_pages.devices_help_views.AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView
   help_pages.devices_help_views.DeviceOnboardingDomainCredentialEstUsernamePasswordHelpView
   help_pages.devices_help_views.OpcUaGdsOnboardingDomainCredentialEstUsernamePasswordHelpView
   help_pages.devices_help_views.AbstractOnboardingCmpDomainCredentialHelpView
   help_pages.devices_help_views.DeviceOnboardingCmpDomainCredentialHelpView
   help_pages.devices_help_views.OpcUaGdsOnboardingCmpDomainCredentialHelpView
   help_pages.devices_help_views.AbstractDeviceOnboardingEstDomainCredentialHelpView
   help_pages.devices_help_views.DeviceOnboardingEstDomainCredentialHelpView
   help_pages.devices_help_views.OpcUaGdsOnboardingEstDomainCredentialHelpView


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

.. py:class:: ApplicationCertificateProfileData

   The application certificate profile data class that holds both value an label.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: label
      :type:  str


.. py:class:: ApplicationCertificateProfile(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Allowed application credential profiles.


   .. py:attribute:: TLS_CLIENT


   .. py:attribute:: TLS_SERVER


   .. py:attribute:: OPC_UA_CLIENT


   .. py:attribute:: OPC_UA_SERVER


   .. py:property:: name
      :type: str


      Return the name of the profile.

      :returns: The name of the profile.


   .. py:property:: label
      :type: str


      Return the label of the profile.

      :returns: The label of the profile.


   .. py:method:: from_name(name)
      :classmethod:


      Gets the ApplicationCertificateProfile matching the name.

      :returns: The matching ApplicationCertificateProfile.

      :raises ValueError: If no matching ApplicationCertifiateProfile is found for the name provided.



   .. py:method:: from_label(label)
      :classmethod:


      Gets the ApplicationCertificateProfile matching the label.

      :returns: The matching ApplicationCertificateProfile.

      :raises ValueError: If no matching ApplicationCertifiateProfile is found for the label provided.



.. py:class:: GetRedirectMixin

   Provides a get method that redirects to the ULR returned by get_redirect_url.


   .. py:attribute:: get_redirect_url
      :type:  collections.abc.Callable[Ellipsis, str]


   .. py:method:: get(request, *args, **kwargs)

      Pro.

      :param request: The django HttpRequest object.
      :param \*args: Positional arguments are passed to self.get_redirect.url()
      :param \*\*kwargs: Keyword arguments are passed to self.get_redirect.url()

      :returns: The corresponding redirect.



.. py:class:: AbstractNoOnboardingCmpSharedSecretHelpView

   Bases: :py:obj:`trustpoint.page_context.PageContextMixin`, :py:obj:`django.views.generic.detail.DetailView`\ [\ :py:obj:`devices.models.DeviceModel`\ ]


   Abstract help view for the case of no onboarding using CMP shared-secret.


   .. py:attribute:: template_name
      :value: 'help/help_page.html'



   .. py:attribute:: pki_protocol


   .. py:attribute:: http_method_names
      :value: ('get',)



   .. py:attribute:: model


   .. py:attribute:: context_object_name
      :value: 'device'



   .. py:attribute:: page_category
      :value: 'devices'



   .. py:attribute:: page_name
      :type:  str


   .. py:attribute:: no_onboarding_config
      :type:  devices.models.NoOnboardingConfigModel


   .. py:attribute:: certificate_profile
      :type:  str


   .. py:attribute:: host
      :type:  str


   .. py:method:: get_context_data(**kwargs)

      Adds information about the required OpenSSL commands to the context.

      :param \*\*kwargs: Keyword arguments passed to super().get_context_data.

      :returns: The context to render the page.



   .. py:method:: _get_certificate_profile_select_section()


   .. py:method:: _get_cmp_tls_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_tls_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_summary_section()


   .. py:method:: _get_cert_profile_select_input()


   .. py:method:: _get_key_generation_section()


   .. py:method:: _get_key_gen_command()


   .. py:method:: _get_shared_secret()


.. py:class:: DeviceNoOnboardingCmpSharedSecretHelpView

   Bases: :py:obj:`AbstractNoOnboardingCmpSharedSecretHelpView`


   Help view for the case of no onboarding using CMP shared-secret for generic devices.


   .. py:attribute:: page_name
      :value: 'devices'



.. py:class:: OpcUaGdsNoOnboardingCmpSharedSecretHelpView

   Bases: :py:obj:`AbstractNoOnboardingCmpSharedSecretHelpView`


   Help view for the case of no onboarding using CMP shared-secret for generic devices.


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



.. py:class:: AbstractNoOnboardingEstUsernamePasswordHelpView

   Bases: :py:obj:`trustpoint.page_context.PageContextMixin`, :py:obj:`django.views.generic.detail.DetailView`\ [\ :py:obj:`devices.models.DeviceModel`\ ]


   Abstract help view for the case of no onboarding using CMP shared-secret.


   .. py:attribute:: template_name
      :value: 'help/help_page.html'



   .. py:attribute:: pki_protocol


   .. py:attribute:: http_method_names
      :value: ('get',)



   .. py:attribute:: model


   .. py:attribute:: context_object_name
      :value: 'device'



   .. py:attribute:: page_category
      :value: 'devices'



   .. py:attribute:: page_name
      :type:  str


   .. py:attribute:: no_onboarding_config
      :type:  devices.models.NoOnboardingConfigModel


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


   .. py:attribute:: certificate_profile
      :type:  str


   .. py:attribute:: host
      :type:  str


   .. py:method:: get_context_data(**kwargs)

      Adds information about the required OpenSSL commands to the context.

      :param \*\*kwargs: Keyword arguments passed to super().get_context_data.

      :returns: The context to render the page.



   .. py:method:: _get_conversion_der_to_pem_section()


   .. py:method:: _get_certificate_profile_select_section()


   .. py:method:: _get_enroll_row(certificate_profile)


   .. py:method:: _get_cmp_tls_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_tls_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_summary_section()


   .. py:method:: _get_cert_profile_select_input()


   .. py:method:: _get_key_generation_section()


   .. py:method:: _get_key_gen_command()


   .. py:method:: _get_shared_secret()


   .. py:method:: _get_download_tls_trust_store_section()


   .. py:method:: _get_tls_server_root_ca_pk()


.. py:class:: DeviceNoOnboardingEstUsernamePasswordHelpView

   Bases: :py:obj:`AbstractNoOnboardingEstUsernamePasswordHelpView`


   Help view for the case of no onboarding using CMP shared-secret for generic devices.


   .. py:attribute:: page_name
      :value: 'devices'



.. py:class:: OpcUaGdsNoOnboardingEstUsernamePasswordHelpView

   Bases: :py:obj:`AbstractNoOnboardingEstUsernamePasswordHelpView`


   Help view for the case of no onboarding using CMP shared-secret for generic devices.


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



.. py:class:: AbstractOnboardingDomainCredentialCmpSharedSecretHelpView

   Bases: :py:obj:`trustpoint.page_context.PageContextMixin`, :py:obj:`django.views.generic.detail.DetailView`\ [\ :py:obj:`devices.models.DeviceModel`\ ]


   Abstract help view for the case of no onboarding using CMP shared-secret.


   .. py:attribute:: template_name
      :value: 'help/help_page.html'



   .. py:attribute:: http_method_names
      :value: ('get',)



   .. py:attribute:: model


   .. py:attribute:: context_object_name
      :value: 'device'



   .. py:attribute:: onboarding_protocol


   .. py:attribute:: page_category
      :value: 'devices'



   .. py:attribute:: page_name
      :type:  str


   .. py:attribute:: onboarding_config
      :type:  devices.models.OnboardingConfigModel


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


   .. py:attribute:: host
      :type:  str


   .. py:method:: get_context_data(**kwargs)

      Adds information about the required OpenSSL commands to the context.

      :param \*\*kwargs: Keyword arguments passed to super().get_context_data.

      :returns: The context to render the page.



   .. py:method:: _get_certificate_profile_select_section()


   .. py:method:: _get_cmp_domain_credential_cmd_section(*, hidden = False)


   .. py:method:: _get_summary_section()


   .. py:method:: _get_cert_profile_select_input()


   .. py:method:: _get_key_generation_section()


   .. py:method:: _get_key_gen_command()


   .. py:method:: _get_shared_secret()


.. py:class:: DeviceOnboardingDomainCredentialCmpSharedSecretHelpView

   Bases: :py:obj:`AbstractOnboardingDomainCredentialCmpSharedSecretHelpView`


   abc.


   .. py:attribute:: page_name
      :value: 'devices'



.. py:class:: OpcUaGdsOnboardingDomainCredentialCmpSharedSecretHelpView

   Bases: :py:obj:`AbstractOnboardingDomainCredentialCmpSharedSecretHelpView`


   abc.


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



.. py:class:: AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView

   Bases: :py:obj:`trustpoint.page_context.PageContextMixin`, :py:obj:`django.views.generic.detail.DetailView`\ [\ :py:obj:`devices.models.DeviceModel`\ ]


   Abstract help view for the case of no onboarding using CMP shared-secret.


   .. py:attribute:: template_name
      :value: 'help/help_page.html'



   .. py:attribute:: pki_protocol


   .. py:attribute:: http_method_names
      :value: ('get',)



   .. py:attribute:: model


   .. py:attribute:: context_object_name
      :value: 'device'



   .. py:attribute:: page_category
      :value: 'devices'



   .. py:attribute:: page_name
      :type:  str


   .. py:attribute:: onboarding_config
      :type:  devices.models.OnboardingConfigModel


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


   .. py:attribute:: certificate_profile
      :type:  str


   .. py:attribute:: host
      :type:  str


   .. py:method:: get_context_data(**kwargs)

      Adds information about the required OpenSSL commands to the context.

      :param \*\*kwargs: Keyword arguments passed to super().get_context_data.

      :returns: The context to render the page.



   .. py:method:: _get_conversion_der_to_pem_section()


   .. py:method:: _get_enroll_row(certificate_profile)


   .. py:method:: _get_est_domain_cred_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_summary_section()


   .. py:method:: _get_key_generation_section()


   .. py:method:: _get_key_gen_command()


   .. py:method:: _get_download_tls_trust_store_section()


   .. py:method:: _get_tls_server_root_ca_pk()


.. py:class:: DeviceOnboardingDomainCredentialEstUsernamePasswordHelpView

   Bases: :py:obj:`AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView`


   abc.


   .. py:attribute:: page_name
      :value: 'devices'



.. py:class:: OpcUaGdsOnboardingDomainCredentialEstUsernamePasswordHelpView

   Bases: :py:obj:`AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView`


   abc.


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



.. py:class:: AbstractOnboardingCmpDomainCredentialHelpView

   Bases: :py:obj:`trustpoint.page_context.PageContextMixin`, :py:obj:`django.views.generic.detail.DetailView`\ [\ :py:obj:`devices.models.DeviceModel`\ ]


   Abstract help view for the case of onboarding using CMP shared-secret.


   .. py:attribute:: template_name
      :value: 'help/help_page.html'



   .. py:attribute:: pki_protocol


   .. py:attribute:: http_method_names
      :value: ('get',)



   .. py:attribute:: model


   .. py:attribute:: context_object_name
      :value: 'device'



   .. py:attribute:: page_category
      :value: 'devices'



   .. py:attribute:: page_name
      :type:  str


   .. py:attribute:: onboarding_config
      :type:  devices.models.OnboardingConfigModel


   .. py:attribute:: certificate_profile
      :type:  str


   .. py:attribute:: host
      :type:  str


   .. py:method:: get_context_data(**kwargs)

      Adds information about the required OpenSSL commands to the context.

      :param \*\*kwargs: Keyword arguments passed to super().get_context_data.

      :returns: The context to render the page.



   .. py:method:: _get_certificate_profile_select_section()


   .. py:method:: _get_cmp_tls_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_tls_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_summary_section()


   .. py:method:: _get_cert_profile_select_input()


   .. py:method:: _get_key_generation_section()


   .. py:method:: _get_key_gen_command()


   .. py:method:: _get_cmp_issuer_root_ca_pk()


   .. py:method:: _get_download_cmp_signer_trust_store_section()


.. py:class:: DeviceOnboardingCmpDomainCredentialHelpView

   Bases: :py:obj:`AbstractOnboardingCmpDomainCredentialHelpView`


   Help view for the case of no onboarding using CMP shared-secret for generic devices.


   .. py:attribute:: page_name
      :value: 'devices'



.. py:class:: OpcUaGdsOnboardingCmpDomainCredentialHelpView

   Bases: :py:obj:`AbstractOnboardingCmpDomainCredentialHelpView`


   Help view for the case of no onboarding using CMP shared-secret for generic devices.


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



.. py:class:: AbstractDeviceOnboardingEstDomainCredentialHelpView

   Bases: :py:obj:`trustpoint.page_context.PageContextMixin`, :py:obj:`django.views.generic.detail.DetailView`\ [\ :py:obj:`devices.models.DeviceModel`\ ]


   Abstract help view for the case of no onboarding using CMP shared-secret.


   .. py:attribute:: template_name
      :value: 'help/help_page.html'



   .. py:attribute:: pki_protocol


   .. py:attribute:: http_method_names
      :value: ('get',)



   .. py:attribute:: model


   .. py:attribute:: context_object_name
      :value: 'device'



   .. py:attribute:: page_category
      :value: 'devices'



   .. py:attribute:: page_name
      :type:  str


   .. py:attribute:: onboarding_config
      :type:  devices.models.OnboardingConfigModel


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


   .. py:attribute:: certificate_profile
      :type:  str


   .. py:attribute:: host
      :type:  str


   .. py:method:: get_context_data(**kwargs)

      Adds information about the required OpenSSL commands to the context.

      :param \*\*kwargs: Keyword arguments passed to super().get_context_data.

      :returns: The context to render the page.



   .. py:method:: _get_conversion_der_to_pem_section()


   .. py:method:: _get_certificate_profile_select_section()


   .. py:method:: _get_enroll_row(certificate_profile)


   .. py:method:: _get_cmp_tls_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_tls_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_client_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_cmp_opc_ua_server_profile_cmd_section(*, hidden = False)


   .. py:method:: _get_summary_section()


   .. py:method:: _get_cert_profile_select_input()


   .. py:method:: _get_key_generation_section()


   .. py:method:: _get_key_gen_command()


   .. py:method:: _get_download_tls_trust_store_section()


   .. py:method:: _get_tls_server_root_ca_pk()


.. py:class:: DeviceOnboardingEstDomainCredentialHelpView

   Bases: :py:obj:`AbstractDeviceOnboardingEstDomainCredentialHelpView`


   abc.


   .. py:attribute:: page_name
      :value: 'devices'



.. py:class:: OpcUaGdsOnboardingEstDomainCredentialHelpView

   Bases: :py:obj:`AbstractDeviceOnboardingEstDomainCredentialHelpView`


   abc.


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'