help_pages.devices_help_views¶

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

Classes¶

`ApplicationCertificateProfileData`	The application certificate profile data class that holds both value an label.
`ApplicationCertificateProfile`	Allowed application credential profiles.
`GetRedirectMixin`	Provides a get method that redirects to the ULR returned by get_redirect_url.
`AbstractNoOnboardingCmpSharedSecretHelpView`	Abstract help view for the case of no onboarding using CMP shared-secret.
`DeviceNoOnboardingCmpSharedSecretHelpView`	Help view for the case of no onboarding using CMP shared-secret for generic devices.
`OpcUaGdsNoOnboardingCmpSharedSecretHelpView`	Help view for the case of no onboarding using CMP shared-secret for generic devices.
`AbstractNoOnboardingEstUsernamePasswordHelpView`	Abstract help view for the case of no onboarding using CMP shared-secret.
`DeviceNoOnboardingEstUsernamePasswordHelpView`	Help view for the case of no onboarding using CMP shared-secret for generic devices.
`OpcUaGdsNoOnboardingEstUsernamePasswordHelpView`	Help view for the case of no onboarding using CMP shared-secret for generic devices.
`AbstractOnboardingDomainCredentialCmpSharedSecretHelpView`	Abstract help view for the case of no onboarding using CMP shared-secret.
`DeviceOnboardingDomainCredentialCmpSharedSecretHelpView`	abc.
`OpcUaGdsOnboardingDomainCredentialCmpSharedSecretHelpView`	abc.
`AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView`	Abstract help view for the case of no onboarding using CMP shared-secret.
`DeviceOnboardingDomainCredentialEstUsernamePasswordHelpView`	abc.
`OpcUaGdsOnboardingDomainCredentialEstUsernamePasswordHelpView`	abc.
`AbstractOnboardingCmpDomainCredentialHelpView`	Abstract help view for the case of onboarding using CMP shared-secret.
`DeviceOnboardingCmpDomainCredentialHelpView`	Help view for the case of no onboarding using CMP shared-secret for generic devices.
`OpcUaGdsOnboardingCmpDomainCredentialHelpView`	Help view for the case of no onboarding using CMP shared-secret for generic devices.
`AbstractDeviceOnboardingEstDomainCredentialHelpView`	Abstract help view for the case of no onboarding using CMP shared-secret.
`DeviceOnboardingEstDomainCredentialHelpView`	abc.
`OpcUaGdsOnboardingEstDomainCredentialHelpView`	abc.

Module Contents¶

class help_pages.devices_help_views.ApplicationCertificateProfileData[source]¶

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

name: str[source]¶

label: str[source]¶

class help_pages.devices_help_views.ApplicationCertificateProfile(*args, **kwds)[source]¶

Bases: enum.Enum

Allowed application credential profiles.

TLS_CLIENT[source]¶

TLS_SERVER[source]¶

OPC_UA_CLIENT[source]¶

OPC_UA_SERVER[source]¶

property name: str[source]¶

Return the name of the profile.

Returns:: The name of the profile.
Return type:: str

property label: str[source]¶

Return the label of the profile.

Returns:: The label of the profile.
Return type:: str

classmethod from_name(name)[source]¶

Gets the ApplicationCertificateProfile matching the name.

Returns:: The matching ApplicationCertificateProfile.
Raises:: ValueError – If no matching ApplicationCertifiateProfile is found for the name provided.
Parameters:: name (str)
Return type:: Self

classmethod from_label(label)[source]¶

Gets the ApplicationCertificateProfile matching the label.

Returns:: The matching ApplicationCertificateProfile.
Raises:: ValueError – If no matching ApplicationCertifiateProfile is found for the label provided.
Parameters:: label (str)
Return type:: Self

class help_pages.devices_help_views.GetRedirectMixin[source]¶

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

get_redirect_url: collections.abc.Callable[Ellipsis, str][source]¶

get(request, *args, **kwargs)[source]¶

Pro.

Parameters:

request (django.http.HttpRequest) – The django HttpRequest object.
*args (Any) – Positional arguments are passed to self.get_redirect.url()
**kwargs (Any) – Keyword arguments are passed to self.get_redirect.url()

Returns:

The corresponding redirect.

Return type:

django.http.HttpResponse

class help_pages.devices_help_views.AbstractNoOnboardingCmpSharedSecretHelpView[source]¶

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

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

template_name = 'help/help_page.html'[source]¶

pki_protocol[source]¶

http_method_names = ('get',)[source]¶

model[source]¶

context_object_name = 'device'[source]¶

page_category = 'devices'[source]¶

page_name: str[source]¶

no_onboarding_config: devices.models.NoOnboardingConfigModel[source]¶

certificate_profile: str[source]¶

host: str[source]¶

get_context_data(**kwargs)[source]¶

Adds information about the required OpenSSL commands to the context.

Parameters:: **kwargs (Any) – Keyword arguments passed to super().get_context_data.
Returns:: The context to render the page.
Return type:: dict[str, Any]

_get_certificate_profile_select_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_cmp_tls_client_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_tls_server_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_opc_ua_client_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_opc_ua_server_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_summary_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_cert_profile_select_input()[source]¶

Return type:: django.utils.safestring.SafeString

_get_key_generation_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_key_gen_command()[source]¶

Return type:: str

_get_shared_secret()[source]¶

Return type:: str

class help_pages.devices_help_views.DeviceNoOnboardingCmpSharedSecretHelpView[source]¶

Bases: AbstractNoOnboardingCmpSharedSecretHelpView

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

page_name = 'devices'[source]¶

class help_pages.devices_help_views.OpcUaGdsNoOnboardingCmpSharedSecretHelpView[source]¶

Bases: AbstractNoOnboardingCmpSharedSecretHelpView

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

page_name = 'opc_ua_gds'[source]¶

class help_pages.devices_help_views.AbstractNoOnboardingEstUsernamePasswordHelpView[source]¶

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

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

template_name = 'help/help_page.html'[source]¶

pki_protocol[source]¶

http_method_names = ('get',)[source]¶

model[source]¶

context_object_name = 'device'[source]¶

page_category = 'devices'[source]¶

page_name: str[source]¶

no_onboarding_config: devices.models.NoOnboardingConfigModel[source]¶

domain: pki.models.domain.DomainModel[source]¶

certificate_profile: str[source]¶

host: str[source]¶

get_context_data(**kwargs)[source]¶

Adds information about the required OpenSSL commands to the context.

Parameters:: **kwargs (Any) – Keyword arguments passed to super().get_context_data.
Returns:: The context to render the page.
Return type:: dict[str, Any]

_get_conversion_der_to_pem_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_certificate_profile_select_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_enroll_row(certificate_profile)[source]¶

Parameters:: certificate_profile (str)
Return type:: help_pages.help_section.HelpRow

_get_cmp_tls_client_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_tls_server_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_opc_ua_client_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_opc_ua_server_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_summary_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_cert_profile_select_input()[source]¶

Return type:: django.utils.safestring.SafeString

_get_key_generation_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_key_gen_command()[source]¶

Return type:: str

_get_shared_secret()[source]¶

Return type:: str

_get_download_tls_trust_store_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_tls_server_root_ca_pk()[source]¶

Return type:: None | int

class help_pages.devices_help_views.DeviceNoOnboardingEstUsernamePasswordHelpView[source]¶

Bases: AbstractNoOnboardingEstUsernamePasswordHelpView

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

page_name = 'devices'[source]¶

class help_pages.devices_help_views.OpcUaGdsNoOnboardingEstUsernamePasswordHelpView[source]¶

Bases: AbstractNoOnboardingEstUsernamePasswordHelpView

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

page_name = 'opc_ua_gds'[source]¶

class help_pages.devices_help_views.AbstractOnboardingDomainCredentialCmpSharedSecretHelpView[source]¶

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

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

template_name = 'help/help_page.html'[source]¶

http_method_names = ('get',)[source]¶

model[source]¶

context_object_name = 'device'[source]¶

onboarding_protocol[source]¶

page_category = 'devices'[source]¶

page_name: str[source]¶

onboarding_config: devices.models.OnboardingConfigModel[source]¶

domain: pki.models.domain.DomainModel[source]¶

host: str[source]¶

get_context_data(**kwargs)[source]¶

Adds information about the required OpenSSL commands to the context.

Parameters:: **kwargs (Any) – Keyword arguments passed to super().get_context_data.
Returns:: The context to render the page.
Return type:: dict[str, Any]

_get_certificate_profile_select_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_cmp_domain_credential_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_summary_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_cert_profile_select_input()[source]¶

Return type:: django.utils.safestring.SafeString

_get_key_generation_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_key_gen_command()[source]¶

Return type:: str

_get_shared_secret()[source]¶

Return type:: str

class help_pages.devices_help_views.DeviceOnboardingDomainCredentialCmpSharedSecretHelpView[source]¶

Bases: AbstractOnboardingDomainCredentialCmpSharedSecretHelpView

abc.

page_name = 'devices'[source]¶

class help_pages.devices_help_views.OpcUaGdsOnboardingDomainCredentialCmpSharedSecretHelpView[source]¶

Bases: AbstractOnboardingDomainCredentialCmpSharedSecretHelpView

abc.

page_name = 'opc_ua_gds'[source]¶

class help_pages.devices_help_views.AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView[source]¶

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

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

template_name = 'help/help_page.html'[source]¶

pki_protocol[source]¶

http_method_names = ('get',)[source]¶

model[source]¶

context_object_name = 'device'[source]¶

page_category = 'devices'[source]¶

page_name: str[source]¶

onboarding_config: devices.models.OnboardingConfigModel[source]¶

domain: pki.models.domain.DomainModel[source]¶

certificate_profile: str[source]¶

host: str[source]¶

get_context_data(**kwargs)[source]¶

Adds information about the required OpenSSL commands to the context.

Parameters:: **kwargs (Any) – Keyword arguments passed to super().get_context_data.
Returns:: The context to render the page.
Return type:: dict[str, Any]

_get_conversion_der_to_pem_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_enroll_row(certificate_profile)[source]¶

Parameters:: certificate_profile (str)
Return type:: help_pages.help_section.HelpRow

_get_est_domain_cred_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_summary_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_key_generation_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_key_gen_command()[source]¶

Return type:: str

_get_download_tls_trust_store_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_tls_server_root_ca_pk()[source]¶

Return type:: None | int

class help_pages.devices_help_views.DeviceOnboardingDomainCredentialEstUsernamePasswordHelpView[source]¶

Bases: AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView

abc.

page_name = 'devices'[source]¶

class help_pages.devices_help_views.OpcUaGdsOnboardingDomainCredentialEstUsernamePasswordHelpView[source]¶

Bases: AbstractOnboardingDomainCredentialEstUsernamePasswordHelpView

abc.

page_name = 'opc_ua_gds'[source]¶

class help_pages.devices_help_views.AbstractOnboardingCmpDomainCredentialHelpView[source]¶

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

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

template_name = 'help/help_page.html'[source]¶

pki_protocol[source]¶

http_method_names = ('get',)[source]¶

model[source]¶

context_object_name = 'device'[source]¶

page_category = 'devices'[source]¶

page_name: str[source]¶

onboarding_config: devices.models.OnboardingConfigModel[source]¶

certificate_profile: str[source]¶

host: str[source]¶

get_context_data(**kwargs)[source]¶

Adds information about the required OpenSSL commands to the context.

Parameters:: **kwargs (Any) – Keyword arguments passed to super().get_context_data.
Returns:: The context to render the page.
Return type:: dict[str, Any]

_get_certificate_profile_select_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_cmp_tls_client_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_tls_server_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_opc_ua_client_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_cmp_opc_ua_server_profile_cmd_section(*, hidden=False)[source]¶

Parameters:: hidden (bool)
Return type:: help_pages.help_section.HelpSection

_get_summary_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_cert_profile_select_input()[source]¶

Return type:: django.utils.safestring.SafeString

_get_key_generation_section()[source]¶

Return type:: help_pages.help_section.HelpSection

_get_key_gen_command()[source]¶

Return type:: str

_get_cmp_issuer_root_ca_pk()[source]¶

Return type:: None | int

_get_download_cmp_signer_trust_store_section()[source]¶

Return type:: help_pages.help_section.HelpSection

class help_pages.devices_help_views.DeviceOnboardingCmpDomainCredentialHelpView[source]¶

Bases: AbstractOnboardingCmpDomainCredentialHelpView

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

page_name = 'devices'[source]¶

class help_pages.devices_help_views.OpcUaGdsOnboardingCmpDomainCredentialHelpView[source]¶

Bases: AbstractOnboardingCmpDomainCredentialHelpView

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

page_name = 'opc_ua_gds'[source]¶

class help_pages.devices_help_views.AbstractDeviceOnboardingEstDomainCredentialHelpView[source]¶

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

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

template_name = 'help/help_page.html'[source]¶

pki_protocol[source]¶

http_method_names = ('get',)[source]¶

model[source]¶

context_object_name = 'device'[source]¶

page_category = 'devices'[source]¶

page_name: str[source]¶

onboarding_config: devices.models.OnboardingConfigModel[source]¶

domain: pki.models.domain.DomainModel[source]¶

certificate_profile: str[source]¶

host: str[source]¶

get_context_data(**kwargs)[source]¶

Adds information about the required OpenSSL commands to the context.

Parameters:: **kwargs (Any) – Keyword arguments passed to super().get_context_data.
Returns:: The context to render the page.
Return type:: dict[str, Any]