help_pages.pki_help_views
=========================

.. py:module:: help_pages.pki_help_views

.. autoapi-nested-parse::

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





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

.. py:class:: BaseHelpView

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


   Base help view that constructs the context.


   .. 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: 'idevid_registration'



   .. py:attribute:: page_category
      :value: 'pki'



   .. py:attribute:: page_name
      :value: 'domains'



   .. py:attribute:: strategy
      :type:  help_pages.base.HelpPageStrategy


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

      Gets the context data and builds the HelpPage.

      :param kwargs: Passed to super().get_context_data().

      :returns: The django context for the detail view.



.. py:class:: OnboardingCmpIdevIdDomainCredentialStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


   Strategy for building the onboarding cmp shared-secret help page.


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: OnboardingCmpIdevidRegistrationHelpView

   Bases: :py:obj:`BaseHelpView`


   Help view for the CMP IDevID Registration, which displays the required OpenSSL commands.


   .. py:attribute:: strategy


.. py:class:: OnboardingEstIdevIdDomainCredentialStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


   Strategy for building the onboarding EST shared-secret help page.


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: OnboardingEstIdevidRegistrationHelpView

   Bases: :py:obj:`BaseHelpView`


   Help view for the EST IDevID Registration, which displays the required OpenSSL commands.


   .. py:attribute:: strategy


.. py:class:: CrlDownloadHelpView

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


   Help view for downloading CRLs via curl commands.


   .. 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: 'ca'



   .. py:attribute:: page_category
      :value: 'pki'



   .. py:attribute:: page_name
      :value: 'issuing_cas'



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

      Gets the context data and builds the HelpPage for CRL download.