devices.views

This module contains all views concerning the devices application.

Module Contents

devices.views.DeviceWithoutDomainErrorMsg

devices.views.NamedCurveMissingForEccErrorMsg

devices.views.ActiveTrustpointTlsServerCredentialModelMissingErrorMsg

devices.views.PublicKeyInfoMissingErrorMsg

class devices.views.AbstractDeviceTableView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.list.ListView[devices.models.DeviceModel], abc.ABC

Device Table View.

http_method_names = ('get',)

model

context_object_name = 'devices'

paginate_by = 50

default_sort_param = 'common_name'

filterset_class

page_category = 'devices'

page_name: str

apply_filters(qs)

Applies the DeviceFilter to the given queryset.

Parameters:

qs (django.db.models.QuerySet[devices.models.DeviceModel]) – The base queryset to filter.

Returns:

The filtered queryset according to GET parameters.

Return type:

django.db.models.QuerySet[devices.models.DeviceModel]

get(request, *args, **kwargs)

Adds the object model to the instance and forwards to super().get().

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• *args (Any) – Positional arguments passed to super().get().

• **kwargs (Any) – Keyword arguments passed to super().get().

Returns:

The HttpResponse object returned by super().get().

Return type:

django.http.HttpResponse

abstractmethod get_queryset()

Filter queryset to only include devices which are of generic type.

Returns:

Returns a queryset of all DeviceModels which are of generic type.

Return type:

django.db.models.QuerySet[devices.models.DeviceModel]

get_context_data(**kwargs)

Adds the clm and revoke buttons to the context.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the devices page.

Return type:

dict[str, Any]

get_ordering()

Returns the sort parameters as a list.

Returns:

The sort parameters, if any. Otherwise the default sort parameter.

Return type:

str | collections.abc.Sequence[str] | None

class devices.views.DeviceTableView

Bases: AbstractDeviceTableView

Device Table View.

template_name = 'devices/devices.html'

page_name = 'devices'

get_queryset()

Filter queryset to include all device types (Generic, OPC UA GDS Push) and filtered by UI filters.

Returns:

Returns a queryset of all DeviceModels (excluding OPC UA GDS), filtered by UI filters.

Return type:

django.db.models.QuerySet[devices.models.DeviceModel]

class devices.views.OpcUaGdsTableView

Bases: DeviceTableView

Table View for devices where opc_ua_gds is True.

template_name = 'devices/opc_ua_gds.html'

page_name = 'opc_ua_gds'

get_queryset()

Filter queryset to only include devices which are of OPC-UA GDS type and filtered by UI filters.

Returns:

Returns a queryset of all DeviceModels which are of OPC-UA GDS type, filtered by UI filters.

Return type:

django.db.models.QuerySet[devices.models.DeviceModel]

class devices.views.AbstractCreateChooseOnboaringView(**kwargs)

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.base.TemplateView

Abstract view for choosing if the new device shall be onboarded or not.

http_method_names = ('get',)

template_name = 'devices/create_choose_onboarding.html'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds the cancel url href according to the subcategory.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the devices page.

Return type:

dict[str, Any]

class devices.views.DeviceCreateChooseOnboardingView(**kwargs)

Bases: AbstractCreateChooseOnboaringView

View for choosing if the new device shall be onboarded or not.

page_name = 'devices'

get_context_data(**kwargs)

Adds the cancel url href according to the subcategory.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the devices page.

Return type:

dict[str, Any]

class devices.views.OpcUaGdsCreateChooseOnboardingView(**kwargs)

Bases: AbstractCreateChooseOnboaringView

View for choosing if the new OPC UA GDS shall be onboarded or not.

page_name = 'opc_ua_gds'

get_context_data(**kwargs)

Adds the cancel url href according to the subcategory.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the devices page.

Return type:

dict[str, Any]

class devices.views.OpcUaGdsPushCreateChooseOnboardingView(**kwargs)

Bases: django.views.generic.base.RedirectView

Deprecated: Redirects to standard devices create page.

permanent = True

pattern_name = 'devices:devices_create'

class devices.views.AbstractCreateAddOnboardingTypeView(**kwargs)

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.base.TemplateView

Abstract view for choosing how new device shall be added.

http_method_names = ('get',)

template_name = 'devices/add_onboarding_type.html'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds the cancel url href according to the subcategory.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the devices page.

Return type:

dict[str, Any]

class devices.views.DeviceCreateAddOnboardingTypeView(**kwargs)

Bases: AbstractCreateAddOnboardingTypeView

View for choosing how new device shall be added.

page_name = 'devices'

class devices.views.AbstractCreateNoOnboardingView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.edit.FormView[devices.forms.NoOnboardingCreateForm]

asdfds.

http_method_names = ('get', 'post')

form_class

template_name = 'devices/create.html'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds the cancel url href according to the subcategory.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the devices page.

Return type:

dict[str, Any]

form_valid(form)

Saves the form / creates the device model object.

Parameters:

form (devices.forms.NoOnboardingCreateForm) – The valid form.

Returns:

The HTTP Response to be returned.

Return type:

django.http.HttpResponse

get_success_url()

Gets the success url to redirect to after successful processing of the POST data following a form submit.

Returns:

The success url to redirect to after successful processing of the POST data following a form submit.

Return type:

str

class devices.views.DeviceCreateNoOnboardingView

Bases: AbstractCreateNoOnboardingView

Create form view for the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsCreateNoOnboardingView

Bases: AbstractCreateNoOnboardingView

Create form view for the devices section.

page_name = 'opc_ua_gds'

class devices.views.AbstractCreateOnboardingView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.edit.FormView[django.forms.Form]

asdfds.

http_method_names = ('get', 'post')

form_class: type[django.forms.Form]

template_name = 'devices/create.html'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds the cancel url href according to the subcategory.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the devices page.

Return type:

dict[str, Any]

form_valid(form)

Saves the form / creates the device model object.

Parameters:

form (django.forms.Form) – The valid form.

Returns:

The HTTP Response to be returned.

Return type:

django.http.HttpResponse

get_success_url()

Gets the success url to redirect to after successful processing of the POST data following a form submit.

Returns:

The success url to redirect to after successful processing of the POST data following a form submit.

Return type:

str

class devices.views.DeviceCreateOnboardingView

Bases: AbstractCreateOnboardingView

Create form view for the devices section.

page_name = 'devices'

class devices.views.DeviceCreateOpcUaGdsPushView

Bases: AbstractCreateOnboardingView

Create form view for OPC UA GDS Push devices in the devices section.

form_class

page_name = 'devices'

dispatch(request, *args, **kwargs)

Check if SOFTWARE storage is configured before allowing GDS Push creation.

Parameters:

• request (django.http.request.HttpRequest) – The HTTP request object.

• *args (Any) – Variable length argument list.

• **kwargs (Any) – Arbitrary keyword arguments.

Returns:

The response object.

Return type:

HttpResponseBase

form_valid(form)

Saves the form / creates the device model object as OPC UA GDS Push type.

Parameters:

form (django.forms.Form) – The valid form.

Returns:

The HTTP Response to be returned.

Return type:

django.http.HttpResponse

class devices.views.OpcUaGdsCreateOnboardingView

Bases: AbstractCreateOnboardingView

Create form view for the devices section.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushCreateOnboardingView(**kwargs)

Bases: django.views.generic.base.RedirectView

Deprecated: Redirects to standard devices OPC UA GDS Push create page.

permanent = True

pattern_name = 'devices:devices_create_opc_ua_gds_push'

class devices.views.AbstractCertificateLifecycleManagementSummaryView

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

This is the CLM summary view in the devices section.

http_method_names = ('get', 'post')

model

template_name = 'devices/credentials/certificate_lifecycle_management.html'

context_object_name = 'device'

default_sort_param = 'common_name'

issued_creds_qs: django.db.models.QuerySet[pki.models.IssuedCredentialModel]

remote_issued_creds_qs: django.db.models.QuerySet[pki.models.RemoteIssuedCredentialModel]

domain_credentials_qs: django.db.models.QuerySet[pki.models.IssuedCredentialModel] | django.db.models.QuerySet[pki.models.RemoteIssuedCredentialModel]

application_credentials_qs: django.db.models.QuerySet[pki.models.IssuedCredentialModel] | django.db.models.QuerySet[pki.models.RemoteIssuedCredentialModel]

page_category = 'devices'

page_name: str

get_issued_creds_qs()

Gets a sorted queryset of all IssuedCredentialModels.

Returns:

Sorted queryset of all IssuedCredentialModels.

Return type:

django.db.models.QuerySet[pki.models.IssuedCredentialModel]

get_remote_issued_creds_qs()

Gets a sorted queryset of all RemoteIssuedCredentialModels for RA-issued certs.

Return type:

django.db.models.QuerySet[pki.models.RemoteIssuedCredentialModel]

get_domain_credentials_qs()

Gets domain credentials — from RemoteIssuedCredentialModel for RA domains, otherwise IssuedCredentialModel.

self.get_issued_creds_qs() or self.get_remote_issued_creds_qs() must be called first!

Returns:

Sorted queryset of domain credentials.

Return type:

django.db.models.QuerySet[pki.models.IssuedCredentialModel] | django.db.models.QuerySet[pki.models.RemoteIssuedCredentialModel]

get_application_credentials_qs()

Gets application credentials — from RemoteIssuedCredentialModel for RA domains.

self.get_issued_creds_qs() or self.get_remote_issued_creds_qs() must be called first!

Returns:

Sorted queryset of application credentials.

Return type:

django.db.models.QuerySet[pki.models.IssuedCredentialModel] | django.db.models.QuerySet[pki.models.RemoteIssuedCredentialModel]

get_context_data(**kwargs)

Adds the paginator and credential details to the context.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

get_onboarding_initial()

Gets the initial values for onboarding.

Returns:

Initial values for onboarding.

Return type:

dict[str, Any]

get_no_onboarding_initial()

Gets the initial values for no onboarding.

Returns:

Initial values for no onboarding.

Return type:

dict[str, Any]

get_onboarding_form()

Gets the form for onboarding.

Returns:

The onboarding form.

Return type:

django.forms.Form

get_no_onboarding_form()

Gets the form for no onboarding.

Returns:

The no onboarding form.

Return type:

devices.forms.ClmDeviceModelNoOnboardingForm

get_device_form()

Gets the device Form for onboarding or no onboarding.

Returns:

The required form.

Return type:

django.forms.Form

post(request, *_args, **kwargs)

Handles the POST request used for device form submission.

Parameters:

• request (django.http.request.HttpRequest) – The django request object.

• _args (Any) – Positional arguments are discarded.

• kwargs (Any) – Keyword arguments are passed to get_context_data.

Returns:

The HttpResponse.

Return type:

django.http.HttpResponse

class devices.views.DeviceCertificateLifecycleManagementSummaryView

Bases: AbstractCertificateLifecycleManagementSummaryView

Certificate Lifecycle Management Summary View for devices.

page_name = 'devices'

dispatch(request, *args, **kwargs)

Redirect OPC UA GDS Push devices to their specific view if GDS Push is the only protocol.

Parameters:

• request (django.http.request.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

class devices.views.OpcUaGdsCertificateLifecycleManagementSummaryView

Bases: AbstractCertificateLifecycleManagementSummaryView

Certificate Lifecycle Management Summary View for OPC UA Devcies.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushCertificateLifecycleManagementSummaryView

Bases: AbstractCertificateLifecycleManagementSummaryView

Certificate Lifecycle Management Summary View for OPC UA GDS Push devices.

page_name = 'devices'

get_context_data(**kwargs)

Add OPC UA GDS Push specific context.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data(**kwargs).

Returns:

The context data for the view.

Return type:

dict[str, Any]

get_onboarding_initial()

Gets the initial values for onboarding for GDS Push.

Returns:

Initial values for onboarding.

Return type:

dict[str, Any]

get_onboarding_form()

Gets the form for GDS Push onboarding.

Returns:

The GDS Push onboarding form.

Return type:

devices.forms.ClmDeviceModelOpcUaGdsPushOnboardingForm

post(request, *_args, **kwargs)

Handles the POST request used for device form submission.

Parameters:

• request (django.http.request.HttpRequest) – The django request object.

• _args (Any) – Positional arguments are discarded.

• kwargs (Any) – Keyword arguments are passed to get_context_data.

Returns:

The HttpResponse.

Return type:

django.http.HttpResponse

class devices.views.AbstractNoOnboardingIssueNewApplicationCredentialView

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

abc.

http_method_names = ('get',)

model

context_object_name = 'device'

template_name = 'devices/credentials/issue_credential.html'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Add the sections to the context.

Parameters:

**kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data for the view.

Return type:

dict[str, Any]

get(request, *_args, **_kwargs)

Adds checks if the device is configured for no-onboarding and has a domain set.

Parameters:

• request (django.http.request.HttpRequest) – The django request object.

• *_args (Any) – Positional arguments are discarded.

• **_kwargs (Any) – Keyword arguments are discarded.

Returns:

The HttpResponse Or HttpRedirect to the CLM page.

Return type:

django.http.HttpResponse

class devices.views.DeviceNoOnboardingIssueNewApplicationCredentialView

Bases: AbstractNoOnboardingIssueNewApplicationCredentialView

abc.

page_name = 'devices'

class devices.views.OpcUaGdsNoOnboardingIssueNewApplicationCredentialView

Bases: AbstractNoOnboardingIssueNewApplicationCredentialView

abc.

page_name = 'opc_ua_gds'

class devices.views.AbstractSelectCertificateProfileNewApplicationCredentialView

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

abc.

http_method_names = ('get',)

model

context_object_name = 'device'

template_name = 'devices/credentials/profile_select.html'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Add the sections to the context.

Parameters:

**kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data for the view.

Return type:

dict[str, Any]

class devices.views.DeviceSelectCertificateProfileNewApplicationCredentialView

Bases: AbstractSelectCertificateProfileNewApplicationCredentialView

abc.

page_name = 'devices'

class devices.views.OpcUaGdsSelectCertificateProfileNewApplicationCredentialView

Bases: AbstractSelectCertificateProfileNewApplicationCredentialView

abc.

page_name = 'opc_ua_gds'

class devices.views.AbstractOnboardingIssueNewApplicationCredentialView

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

abc.

http_method_names = ('get',)

model

context_object_name = 'device'

template_name = 'devices/credentials/issue_credential.html'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Add the sections to the context.

Parameters:

**kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data for the view.

Return type:

dict[str, Any]

class devices.views.DeviceOnboardingIssueNewApplicationCredentialView

Bases: AbstractOnboardingIssueNewApplicationCredentialView

abc.

page_name = 'devices'

class devices.views.OpcUaGdsOnboardingIssueNewApplicationCredentialView

Bases: AbstractOnboardingIssueNewApplicationCredentialView

abc.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushOnboardingIssueNewApplicationCredentialView

Bases: AbstractOnboardingIssueNewApplicationCredentialView

View for issuing application credentials for OPC UA GDS Push devices - redirects directly to help page.

page_name = 'devices'

get(request, *_args, **_kwargs)

Redirect directly to the GDS Push application certificate help page if GDS Push is the only protocol.

Parameters:

• request (django.http.request.HttpRequest)

• _args (Any)

• _kwargs (Any)

Return type:

django.http.HttpResponse

class devices.views.AbstractIssueCredentialView

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

Base view for all credential issuance views.

http_method_names = ('get', 'post')

model

context_object_name = 'device'

template_name = 'devices/credentials/issue_application_credential.html'

form_class: type[django.forms.Form]

issuer_class: type[AbstractIssueCredentialView.IssuerClass]

friendly_name: str

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Add the form to the context.

Parameters:

**kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data for the view.

Return type:

dict[str, Any]

get_form_kwargs()

This method adds the concerning device model to the form kwargs and returns them.

Returns:

The form kwargs including the concerning device model.

Return type:

dict[str, Any]

abstractmethod issue_credential(device, form)

Abstract method to issue a credential.

Parameters:

• device (devices.models.DeviceModel) – The device to be associated with the new credential.

• form (django.forms.Form) – The form instance containing the validated data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

pki.models.IssuedCredentialModel

post(request, *_args, **_kwargs)

Adds the object model to the instance and forwards to super().post().

Parameters:

• request (django.http.request.HttpRequest) – The Django request object is only used implicitly through self.

• *_args (Any) – Positional arguments are discarded.

• **_kwargs (Any) – Keyword arguments are discarded.

Returns:

The HttpResponseBase object returned by super().post().

Return type:

django.http.HttpResponse

class devices.views.AbstractIssueDomainCredentialView

Bases: AbstractIssueCredentialView[devices.forms.IssueDomainCredentialForm, devices.issuer.LocalDomainCredentialIssuer]

Base view for issuing domain credentials.

form_class: type[devices.forms.BaseCredentialForm]

template_name = 'devices/credentials/issue_domain_credential.html'

issuer_class

friendly_name = 'Domain Credential'

issue_credential(device, _form)

Issue a domain credential for the device.

Parameters:

• device (devices.models.DeviceModel) – The device to issue the credential for.

• _form (django.forms.Form) – The form instance containing the validated data.

Returns:

The issued credential model.

Return type:

pki.models.IssuedCredentialModel

class devices.views.DeviceIssueDomainCredentialView

Bases: AbstractIssueDomainCredentialView

View for issuing domain credentials for devices.

page_name = 'devices'

class devices.views.OpcUaGdsIssueDomainCredentialView

Bases: AbstractIssueDomainCredentialView

View for issuing domain credentials for OPC-UA GDS devices.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushIssueDomainCredentialView

Bases: AbstractIssueDomainCredentialView

View for issuing domain credentials for OPC-UA GDS Push devices.

form_class

page_name = 'devices'

issue_credential(device, form)

Issues a domain credential for the device with OPC UA specific extensions.

Parameters:

• device (devices.models.DeviceModel) – The device to be associated with the new credential.

• form (django.forms.Form) – The form instance containing the validated data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

pki.models.IssuedCredentialModel

post(request, *_args, **_kwargs)

Handle the POST request with custom redirect to truststore association.

Parameters:

• request (django.http.request.HttpRequest)

• _args (Any)

• _kwargs (Any)

Return type:

django.http.HttpResponse

class devices.views.OpcUaGdsPushDiscoverServerView

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

View to discover OPC UA server information without authentication.

http_method_names = ('post',)

model

context_object_name = 'device'

page_name = 'devices'

post(request, *_args, **_kwargs)

Handle the POST request to discover server information.

Parameters:

• request (django.http.request.HttpRequest)

• _args (Any)

• _kwargs (Any)

Return type:

django.http.HttpResponse

class devices.views.OpcUaGdsPushTruststoreAssociationView

Bases: trustpoint.logger.LoggerMixin, trustpoint.page_context.PageContextMixin, django.views.generic.edit.FormView[devices.forms.OpcUaGdsPushTruststoreAssociationForm]

View for associating a truststore with an OPC UA GDS Push device’s onboarding configuration.

form_class

template_name = 'devices/truststore_association.html'

page_name = 'devices'

get_form_kwargs()

Add the device instance to the form kwargs.

Return type:

dict[str, Any]

get_device()

Get the device from the URL parameters.

Return type:

devices.models.DeviceModel

get_context_data(**kwargs)

Add the device and import form to the context.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

post(request, *args, **kwargs)

Handle both association and import form submissions.

Parameters:

• request (django.http.request.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

form_valid(form)

Handle successful form submission.

Parameters:

form (devices.forms.OpcUaGdsPushTruststoreAssociationForm)

Return type:

django.http.HttpResponseRedirect

class devices.views.AbstractIssueProfileCredentialView

Bases: AbstractIssueCredentialView[pki.forms.cert_profiles.CertificateIssuanceForm, devices.issuer.BaseTlsCredentialIssuer]

View to issue a new certificate profile credential.

issuer_class

friendly_name = 'Certificate Profile Credential'

page_name: str

template_name = 'pki/cert_profiles/issuance.html'

form_class

dispatch(request, *args, **kwargs)

Dispatch the request, ensuring the profile exists.

Parameters:

• request (django.http.request.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

get_form_kwargs()

Get form kwargs, including the profile.

Return type:

dict[str, Any]

get_context_data(**kwargs)

Add additional context data.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

form_invalid(form)

Handle the case where the form is invalid.

Parameters:

form (django.forms.Form)

Return type:

django.http.HttpResponse

form_valid(form)

Handle the case where the form is valid.

Parameters:

form (django.forms.Form)

Return type:

django.http.HttpResponse

issue_credential(device, form)

Issues a credential based on the selected certificate profile.

Parameters:

• device (devices.models.DeviceModel) – The device to be associated with the new credential.

• form (django.forms.Form) – The form instance containing the validated data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

pki.models.IssuedCredentialModel

class devices.views.DeviceIssueProfileCredentialView

Bases: AbstractIssueProfileCredentialView

Issue a new certificate profile credential within the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsIssueProfileCredentialView

Bases: AbstractIssueProfileCredentialView

Issue a new certificate profile credential within the devices section.

page_name = 'opc_ua_gds'

class devices.views.DownloadTokenRequiredAuthenticationMixin

Mixin which checks the token included in the URL for browser download views.

credential_download: devices.models.RemoteDeviceCredentialDownloadModel

dispatch(request, *args, **kwargs)

Checks the validity of the token included in the URL for browser download views and redirects if invalid.

Parameters:

• request (django.http.request.HttpRequest) – The django request object.

• *args (Any) – Positional arguments passed to super().dispatch().

• **kwargs (Any) – Keyword arguments passed to super().dispatch().

Returns:

A Django HttpResponseBase object.

Return type:

django.http.HttpResponseBase

class devices.views.AbstractDownloadPageDispatcherView(**kwargs)

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.base.RedirectView

Redirects depending on the type of credential, that is if a private key is available or not.

http_method_names = ('get',)

model: type[pki.models.IssuedCredentialModel]

permanent = False

page_category = 'devices'

page_name: str

get_redirect_url(*_args, **kwargs)

Gets the redirection URL depending on the type credential, that is if a private key is available or not.

Parameters:

• *_args (Any) – Positional arguments are discarded.

• **kwargs (Any) – The pk parameter is retrieved and expected to be there.

Returns:

The redirect URL.

Return type:

str

class devices.views.DeviceDownloadPageDispatcherView(**kwargs)

Bases: AbstractDownloadPageDispatcherView

Download dispatcher view for the device pages.

page_name = 'devices'

class devices.views.OpcUaGdsDownloadPageDispatcherView(**kwargs)

Bases: AbstractDownloadPageDispatcherView

Download dispatcher view for the OPC UA GDS pages.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushDownloadPageDispatcherView(**kwargs)

Bases: AbstractDownloadPageDispatcherView

Download dispatcher view for the OPC UA GDS Push pages.

page_name = 'devices'

class devices.views.AbstractCertificateDownloadView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[pki.models.IssuedCredentialModel]

View for downloading certificates.

http_method_names = ('get',)

model: type[pki.models.IssuedCredentialModel]

template_name = 'devices/credentials/certificate_download.html'

context_object_name = 'issued_credential'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Add the clm_url to the context.

Parameters:

**kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data for the view.

Return type:

dict[str, Any]

class devices.views.DeviceCertificateDownloadView

Bases: AbstractCertificateDownloadView

Certificate download view for the device pages.

page_name = 'devices'

class devices.views.OpcUaGdsCertificateDownloadView

Bases: AbstractCertificateDownloadView

Certificate download view for the OPC UA GDS pages.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushCertificateDownloadView

Bases: AbstractCertificateDownloadView

Certificate download view for the OPC UA GDS Push pages.

page_name = 'devices'

class devices.views.OpcUaGdsPushUpdateTrustlistView

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

View to update the trustlist on an OPC UA GDS Push device.

http_method_names = ('post',)

model

page_name = 'devices'

page_category = 'devices'

post(request, *_args, **_kwargs)

Handle the POST request to update the trustlist.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• _args (Any) – Positional arguments are discarded.

• kwargs – Keyword arguments are passed to get_object().

• _kwargs (Any)

Returns:

HttpResponse redirecting back to the help page.

Return type:

django.http.HttpResponse

class devices.views.OpcUaGdsPushUpdateServerCertificateView

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

View to update the server certificate on an OPC UA GDS Push device.

http_method_names = ('post',)

model

page_name = 'devices'

page_category = 'devices'

post(request, *_args, **_kwargs)

Handle the POST request to update the server certificate.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• _args (Any) – Positional arguments are discarded.

• kwargs – Keyword arguments are passed to get_object().

• _kwargs (Any)

Returns:

HttpResponse redirecting back to the help page.

Return type:

django.http.HttpResponse

class devices.views.OpcUaGdsPushCertRenewalSettingsView

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

View to save the periodic server certificate and trustlist renewal settings for an OPC UA GDS Push device.

http_method_names = ('post',)

model

page_name = 'devices'

page_category = 'devices'

post(request, *_args, **_kwargs)

Handle the POST request to update the renewal settings.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• _args (Any) – Positional arguments are discarded.

• _kwargs (Any) – Keyword arguments are discarded.

Returns:

HttpResponse redirecting back to the help page.

Return type:

django.http.HttpResponse

class devices.views.TrustBundleDownloadView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[pki.models.ca.CaModel]

View to download the trust bundle (CA certificates and CRLs) for a given Issuing CA.

http_method_names = ('get',)

model

get(request, *args, **kwargs)

Handle the GET request to download the trust bundle.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• *args (Any) – Additional positional arguments.

• **kwargs (Any) – Additional keyword arguments.

Returns:

FileResponse with the trust bundle zip file.

Return type:

django.http.HttpResponse

class devices.views.AbstractDeviceBaseCredentialDownloadView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[pki.models.IssuedCredentialModel]

View to download a password protected application credential in the desired format.

Inherited by the domain and application credential download views. It is not intended for direct use.

http_method_names = ('get', 'post')

model

template_name = 'devices/credentials/credential_download.html'

context_object_name = 'credential'

form_class

is_browser_download = False

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds information about the credential to the context.

Parameters:

**kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data for the view.

Return type:

dict[str, Any]

post(_request, *_args, **_kwargs)

Processing the valid form data.

This will use the contained form data to start the download process of the desired file.

Parameters:

• _request (django.http.request.HttpRequest) – The django request object.

• *_args (Any) – Positional arguments are discarded.

• **_kwargs (Any) – Keyword arguments are discarded.

Returns:

If successful, this will start the file download. Otherwise, a Http404 will be raised and displayed.

Return type:

django.http.HttpResponse

class devices.views.DeviceManualCredentialDownloadView

Bases: AbstractDeviceBaseCredentialDownloadView

View to download a password protected domain or application credential in the desired format.

page_name = 'devices'

class devices.views.DeviceBrowserCredentialDownloadView

Bases: DownloadTokenRequiredAuthenticationMixin, AbstractDeviceBaseCredentialDownloadView

View to download a password protected domain or app credential in the desired format from a remote client.

is_browser_download = True

class devices.views.AbstractBrowserOnboardingOTPView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[pki.models.IssuedCredentialModel]

View to display the OTP for remote credential download (aka. browser onboarding).

http_method_names = ('get',)

model

template_name = 'devices/credentials/onboarding/browser/otp_view.html'

redirection_view = 'devices:devices'

context_object_name = 'credential'

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds information about the credential and otp for the browser download process.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to render the page.

Return type:

dict[str, Any]

class devices.views.DeviceBrowserOnboardingOTPView

Bases: AbstractBrowserOnboardingOTPView

The browser onboarding OTP view for the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsBrowserOnboardingOTPView

Bases: AbstractBrowserOnboardingOTPView

The browser onboarding OTP view for the OPC UA GDS section.

page_name = 'opc_ua_gds'

class devices.views.AbstractBrowserOnboardingCancelView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[pki.models.IssuedCredentialModel]

View to cancel the browser onboarding process and delete the associated RemoteDeviceCredentialDownloadModel.

http_method_names = ('get',)

model

context_object_name = 'credential'

permanent = False

page_category = 'devices'

page_name: str

get(request, *_args, **_kwargs)

Cancels the browser onboarding process and deletes the associated RemoteDeviceCredentialDownloadModel.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• *_args (Any) – Positional arguments are discarded.

• **_kwargs (Any) – Keyword arguments are discarded.

Returns:

The HttpResponseBase object with the desired redirection URL.

Return type:

django.http.HttpResponse

class devices.views.DeviceBrowserOnboardingCancelView

Bases: AbstractBrowserOnboardingCancelView

Cancels the browser onboarding for the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsBrowserOnboardingCancelView

Bases: AbstractBrowserOnboardingCancelView

Cancels the browser onboarding for the OPC UA GDS section.

page_name = 'opc_ua_gds'

class devices.views.DeviceOnboardingBrowserLoginView

Bases: django.views.generic.edit.FormView[devices.forms.BrowserLoginForm]

View to handle certificate download requests.

http_method_names = ('get', 'post')

template_name = 'devices/credentials/onboarding/browser/login.html'

form_class

cleaned_data: dict[str, Any]

get_success_url()

Gets the success url to redirect to after successful processing of the POST data following a form submit.

Returns:

The success url to redirect to after successful processing of the POST data following a form submit.

Return type:

str

form_invalid(form)

Adds an error message in the case of an invalid OTP.

Parameters:

form (devices.forms.BrowserLoginForm) – The corresponding form object.

Returns:

The Django HttpResponse object.

Return type:

django.http.HttpResponse

form_valid(form)

Performed if the form was validated successfully and adds the cleaned data to the instance.

Parameters:

form (devices.forms.BrowserLoginForm) – The corresponding form object.

Returns:

The Django HttpResponse object.

Return type:

django.http.HttpResponse

class devices.views.AbstractIssuedCredentialRevocationView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[pki.models.IssuedCredentialModel]

Revokes a specific issued credential.

http_method_names = ('get', 'post')

model

template_name = 'devices/confirm_revoke.html'

context_object_name = 'issued_credential'

pk_url_kwarg = 'pk'

form_class

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds the primary keys to the context.

Parameters:

kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data.

Return type:

dict[str, Any]

post(_request, *_args, **_kwargs)

Will try to revoke the requested issued credential.

Parameters:

• request – The Django request object.

• *_args (Any) – Positional arguments are discarded.

• **_kwargs (Any) – Keyword arguments are discarded.

• _request (django.http.request.HttpRequest)

• *_args

• **_kwargs

Returns:

Redirect to the devices summary.

Return type:

django.http.HttpResponse

class devices.views.DeviceIssuedCredentialRevocationView

Bases: AbstractIssuedCredentialRevocationView

abc.

page_name = 'devices'

class devices.views.OpcUaGdsIssuedCredentialRevocationView

Bases: AbstractIssuedCredentialRevocationView

abc.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushIssuedCredentialRevocationView

Bases: AbstractIssuedCredentialRevocationView

abc.

page_name = 'devices'

class devices.views.AbstractBulkRevokeView

Bases: trustpoint.logger.LoggerMixin, trustpoint.page_context.PageContextMixin, django.views.generic.list.ListView[devices.models.DeviceModel]

View to confirm the deletion of multiple Devices.

model

template_name = 'devices/confirm_bulk_revoke.html'

context_object_name = 'devices'

missing: str = ''

pks: str = ''

queryset: django.db.models.QuerySet[devices.models.DeviceModel]

form_class

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds the primary keys to the context.

Parameters:

kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data.

Return type:

dict[str, Any]

get_queryset()

Gets the queryset of DeviceModel objects that are requested to be revoked.

Returns:

The queryset of DeviceModel objects that are requested to be revoked.

Return type:

django.db.models.QuerySet[devices.models.DeviceModel]

get(request, *args, **kwargs)

HTTP GET processing.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• *args (Any) – Positional arguments passed to super().get().

• **kwargs (Any) – Keyword arguments passed to super().get().

Returns:

The device deletion view or a redirect to the devices view if one or more pks were not found.

Return type:

django.http.HttpResponse

post(request, *_args, **_kwargs)

Will try to revoke all certificate assiciated with the requested DeviceModel records.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• *_args (Any) – Positional arguments are discarded.

• **_kwargs (Any) – Keyword arguments are discarded.

Returns:

Redirect to the devices summary.

Return type:

django.http.HttpResponse

class devices.views.DeviceBulkRevokeView

Bases: AbstractBulkRevokeView

abc.

page_name = 'devices'

class devices.views.OpcUaGdsBulkRevokeView

Bases: AbstractBulkRevokeView

abc.

page_name = 'devices'

class devices.views.OpcUaGdsPushBulkRevokeView

Bases: AbstractBulkRevokeView

abc.

page_name = 'devices'

class devices.views.AbstractBulkDeleteView

Bases: trustpoint.logger.LoggerMixin, trustpoint.page_context.PageContextMixin, django.views.generic.list.ListView[devices.models.DeviceModel]

View to confirm the deletion of multiple Devices.

model

template_name = 'devices/confirm_delete.html'

context_object_name = 'devices'

missing: str = ''

pks: str = ''

queryset: django.db.models.QuerySet[devices.models.DeviceModel]

form_class

page_category = 'devices'

page_name: str

get_context_data(**kwargs)

Adds the primary keys to the context.

Parameters:

kwargs (Any) – Keyword arguments are passed to super().get_context_data(**kwargs).

Returns:

The context data.

Return type:

dict[str, Any]

get_queryset()

Gets the queryset of DeviceModel objects that are requested to be deleted.

Returns:

The queryset of DeviceModel objects that are requested to be deleted.

Return type:

django.db.models.QuerySet[devices.models.DeviceModel]

get(request, *args, **kwargs)

HTTP GET processing.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• *args (Any) – Positional arguments passed to super().get().

• **kwargs (Any) – Keyword arguments passed to super().get().

Returns:

The device deletion view or a redirect to the devices view if one or more pks were not found.

Return type:

django.http.HttpResponse

post(request, *_args, **_kwargs)

HTTP POST processing which will try to delete all requested DeviceModel records.

Parameters:

• request (django.http.request.HttpRequest) – The Django request object.

• *_args (Any) – Positional arguments are discarded.

• **_kwargs (Any) – Keyword arguments are discarded.

Returns:

Redirect to the devices summary.

Return type:

django.http.HttpResponse

class devices.views.DeviceBulkDeleteView

Bases: AbstractBulkDeleteView

abc.

page_name = 'devices'

class devices.views.OpcUaGdsBulkDeleteView

Bases: AbstractBulkDeleteView

abc.

page_name = 'opc_ua_gds'

class devices.views.OpcUaGdsPushBulkDeleteView

Bases: AbstractBulkDeleteView

abc.

page_name = 'devices'

class devices.views.DeviceViewSet(**kwargs)

Bases: rest_framework.viewsets.ModelViewSet[devices.models.DeviceModel]

ViewSet for managing Device instances.

Supports standard CRUD operations such as list, retrieve, create, update, and delete.

queryset

serializer_class

action_descriptions: ClassVar[dict[str, str]]

get_view_description(html=False)

Return a description for the given action.

Parameters:

html (bool)

Return type:

str