devices.views

This module contains all views concerning the devices application.

Attributes

DeviceWithoutDomainErrorMsg
NamedCurveMissingForEccErrorMsg
ActiveTrustpointTlsServerCredentialModelMissingErrorMsg
PublicKeyInfoMissingErrorMsg
ALLOWED_APP_CRED_PROFILES

Classes

AbstractDeviceTableView	Device Table View.
DeviceTableView	Device Table View.
OpcUaGdsTableView	Table View for devices where opc_ua_gds is True.
AbstractCreateChooseOnboaringView	Abstract view for choosing if the new device shall be onboarded or not.
DeviceCreateChooseOnboardingView	View for choosing if the new device shall be onboarded or not.
OpcUaGdsCreateChooseOnboardingView	View for choosing if the new OPC UA GDS shall be onboarded or not.
AbstractCreateNoOnboardingView	asdfds.
DeviceCreateNoOnboardingView	Create form view for the devices section.
OpcUaGdsCreateNoOnboardingView	Create form view for the devices section.
AbstractCreateOnboardingView	asdfds.
DeviceCreateOnboardingView	Create form view for the devices section.
OpcUaGdsCreateOnboardingView	Create form view for the devices section.
AbstractCertificateLifecycleManagementSummaryView	This is the CLM summary view in the devices section.
DeviceCertificateLifecycleManagementSummaryView	Certificate Lifecycle Management Summary View for devices.
OpcUaGdsCertificateLifecycleManagementSummaryView	Certificate Lifecycle Management Summary View for OPC UA Devcies.
AbstractNoOnboardingIssueNewApplicationCredentialView	abc.
DeviceNoOnboardingIssueNewApplicationCredentialView	abc.
OpcUaGdsNoOnboardingIssueNewApplicationCredentialView	abc.
AbstractSelectCertificateProfileNewApplicationCredentialView	abc.
DeviceSelectCertificateProfileNewApplicationCredentialView	abc.
OpcUaGdsSelectCertificateProfileNewApplicationCredentialView	abc.
AbstractOnboardingIssueNewApplicationCredentialView	abc.
DeviceOnboardingIssueNewApplicationCredentialView	abc.
OpcUaGdsOnboardingIssueNewApplicationCredentialView	abc.
AbstractIssueCredentialView	Base view for all credential issuance views.
AbstractIssueDomainCredentialView	Base view for issuing domain credentials.
DeviceIssueDomainCredentialView	View for issuing domain credentials for devices.
OpcUaGdsIssueDomainCredentialView	View for issuing domain credentials for OPC-UA GDS devices.
AbstractIssueTlsClientCredentialView	View to issue a new TLS client credential.
DeviceIssueTlsClientCredentialView	Issue a new TLS client credential within the devices section.
OpcUaGdsIssueTlsClientCredentialView	Issue a new TLS client credential within the devices section.
AbstractIssueTlsServerCredentialView	View to issue a new TLS server credential.
DeviceIssueTlsServerCredentialView	Issues a TLS server credenital within the devices section.
OpcUaGdsIssueTlsServerCredentialView	Issues a TLS server credenital within the devices section.
AbstractIssueOpcUaClientCredentialView	View to issue a new OPC UA client credential.
DeviceIssueOpcUaClientCredentialView	Issues an OPC UA client credential within the devices section.
OpcUaGdsIssueOpcUaClientCredentialView	Issues an OPC UA client credential within the devices section.
AbstractIssueOpcUaServerCredentialView	View to issue a new OPC UA server credential.
DeviceIssueOpcUaServerCredentialView	Issues an OPC UA server credential within the devices section.
OpcUaGdsIssueOpcUaServerCredentialView	Issues an OPC UA server credential within the devices section.
DownloadTokenRequiredAuthenticationMixin	Mixin which checks the token included in the URL for browser download views.
AbstractDownloadPageDispatcherView	Redirects depending on the type of credential, that is if a private key is available or not.
DeviceDownloadPageDispatcherView	Download dispatcher view for the device pages.
OpcUaGdsDownloadPageDispatcherView	Download dispatcher view for the OPC UA GDS pages.
AbstractCertificateDownloadView	View for downloading certificates.
DeviceCertificateDownloadView	Certificate download view for the device pages.
OpcUaGdsCertificateDownloadView	Certificate download view for the OPC UA GDS pages.
AbstractDeviceBaseCredentialDownloadView	View to download a password protected application credential in the desired format.
DeviceManualCredentialDownloadView	View to download a password protected domain or application credential in the desired format.
DeviceBrowserCredentialDownloadView	View to download a password protected domain or app credential in the desired format from a remote client.
AbstractBrowserOnboardingOTPView	View to display the OTP for remote credential download (aka. browser onboarding).
DeviceBrowserOnboardingOTPView	The browser onboarding OTP view for the devices section.
OpcUaGdsBrowserOnboardingOTPView	The browser onboarding OTP view for the OPC UA GDS section.
AbstractBrowserOnboardingCancelView	View to cancel the browser onboarding process and delete the associated RemoteDeviceCredentialDownloadModel.
DeviceBrowserOnboardingCancelView	Cancels the browser onboarding for the devices section.
OpcUaGdsBrowserOnboardingCancelView	Cancels the browser onboarding for the OPC UA GDS section.
DeviceOnboardingBrowserLoginView	View to handle certificate download requests.
AbstractIssuedCredentialRevocationView	Revokes a specific issued credential.
DeviceIssuedCredentialRevocationView	abc.
OpcUaGdsIssuedCredentialRevocationView	abc.
AbstractBulkRevokeView	View to confirm the deletion of multiple Devices.
DeviceBulkRevokeView	abc.
OpcUaGdsBulkRevokeView	abc.
AbstractBulkDeleteView	View to confirm the deletion of multiple Devices.
DeviceBulkDeleteView	abc.
OpcUaGdsBulkDeleteView	abc.

Module Contents

devices.views.DeviceWithoutDomainErrorMsg

devices.views.NamedCurveMissingForEccErrorMsg

devices.views.ActiveTrustpointTlsServerCredentialModelMissingErrorMsg

devices.views.PublicKeyInfoMissingErrorMsg

devices.views.ALLOWED_APP_CRED_PROFILES

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

_get_clm_button_html(record)

Gets the HTML for the CLM button in the devices table.

Parameters:

record (devices.models.DeviceModel) – The corresponding DeviceModel.

Returns:

The HTML of the hyperlink for the CLM button.

Return type:

django.utils.safestring.SafeString

_get_pki_protocols(record)

Parameters:

record (devices.models.DeviceModel)

Return type:

str

class devices.views.DeviceTableView

Bases: AbstractDeviceTableView

Device Table View.

template_name = 'devices/devices.html'

page_name = 'devices'

get_queryset()

Filter queryset to only include devices which are of generic type and filtered by filtered by UI filters.

Returns:

Returns a queryset of all DeviceModels, 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'

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'

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[devices.forms.OnboardingCreateForm]

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.OnboardingCreateForm) – 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.OpcUaGdsCreateOnboardingView

Bases: AbstractCreateOnboardingView

Create form view for the devices section.

page_name = 'opc_ua_gds'

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[devices.models.IssuedCredentialModel]

domain_credentials_qs: django.db.models.QuerySet[devices.models.IssuedCredentialModel]

application_credentials_qs: django.db.models.QuerySet[devices.models.IssuedCredentialModel]

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[devices.models.IssuedCredentialModel]

get_domain_credentials_qs()

Gets a sorted queryset of all IssuedCredentialModels that are domain credentials.

self.get_issued_creds_qs() must be called first!

Returns:

Sorted queryset of all IssuedCredentialModels that are domain credentials

Return type:

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

get_application_credentials_qs()

Gets a sorted queryset of all IssuedCredentialModels that are application credentials.

self.get_issued_creds_qs() must be called first!

Returns:

Sorted queryset of all IssuedCredentialModels that are application credentials.

Return type:

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

get_context_data(**kwargs)

Adds the paginator and credential details to the context.

Parameters:

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

Returns:

The context to use for rendering the clm summary page.

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:

devices.forms.ClmDeviceModelOnboardingForm

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:

devices.forms.ClmDeviceModelOnboardingForm | devices.forms.ClmDeviceModelNoOnboardingForm

static _get_expires_in(record)

Gets the remaining time until the credential expires as human-readable string.

Parameters:

record (devices.models.IssuedCredentialModel) – The corresponding IssuedCredentialModel.

Returns:

The remaining time until the credential expires as human-readable string.

Return type:

str

_get_revoke_button_html(record)

Gets the HTML for the revoke button in the devices table.

Parameters:

record (devices.models.IssuedCredentialModel) – The corresponding DeviceModel.

Returns:

The HTML of the hyperlink for the revoke button.

Return type:

str

_get_pki_protocols(record)

Parameters:

record (devices.models.DeviceModel)

Return type:

str

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'

class devices.views.OpcUaGdsCertificateLifecycleManagementSummaryView

Bases: AbstractCertificateLifecycleManagementSummaryView

Certificate Lifecycle Management Summary View for OPC UA Devcies.

page_name = 'opc_ua_gds'

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_redirect_url()

Return type:

django.http.HttpResponseRedirect

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.AbstractIssueCredentialView

Bases: trustpoint.page_context.PageContextMixin, 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[AbstractIssueCredentialView.FormClass]

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 ads 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, cleaned_data)

Abstract method to issue a credential.

Parameters:

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

• cleaned_data (dict[str, Any]) – The validated form data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

devices.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

template_name = 'devices/credentials/issue_domain_credential.html'

issuer_class

friendly_name = 'Domain Credential'

issue_credential(device, _cleaned_data)

Issue a domain credential for the device.

Parameters:

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

• _cleaned_data (dict[str, Any]) – The validated form data is discarded.

Returns:

The issued credential model.

Return type:

devices.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.AbstractIssueTlsClientCredentialView

Bases: AbstractIssueCredentialView[devices.forms.IssueTlsClientCredentialForm, devices.issuer.LocalTlsClientCredentialIssuer]

View to issue a new TLS client credential.

form_class

issuer_class

friendly_name = 'TLS client credential'

page_name: str

issue_credential(device, cleaned_data)

Issues an TLS client credential.

Parameters:

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

• cleaned_data (dict[str, Any]) – The validated form data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

devices.models.IssuedCredentialModel

class devices.views.DeviceIssueTlsClientCredentialView

Bases: AbstractIssueTlsClientCredentialView

Issue a new TLS client credential within the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsIssueTlsClientCredentialView

Bases: AbstractIssueTlsClientCredentialView

Issue a new TLS client credential within the devices section.

page_name = 'opc_ua_gds'

class devices.views.AbstractIssueTlsServerCredentialView

Bases: AbstractIssueCredentialView[devices.forms.IssueTlsServerCredentialForm, devices.issuer.LocalTlsServerCredentialIssuer]

View to issue a new TLS server credential.

form_class

issuer_class

friendly_name = 'TLS server credential'

issue_credential(device, cleaned_data)

Issues an TLS server credential.

Parameters:

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

• cleaned_data (dict[str, Any]) – The validated form data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

devices.models.IssuedCredentialModel

class devices.views.DeviceIssueTlsServerCredentialView

Bases: AbstractIssueTlsServerCredentialView

Issues a TLS server credenital within the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsIssueTlsServerCredentialView

Bases: AbstractIssueTlsServerCredentialView

Issues a TLS server credenital within the devices section.

page_name = 'opc_ua_gds'

class devices.views.AbstractIssueOpcUaClientCredentialView

Bases: AbstractIssueCredentialView[devices.forms.IssueOpcUaClientCredentialForm, devices.issuer.OpcUaClientCredentialIssuer]

View to issue a new OPC UA client credential.

form_class

issuer_class

friendly_name = 'OPC UA client credential'

issue_credential(device, cleaned_data)

Issues an OPC UA client credential.

Parameters:

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

• cleaned_data (dict[str, Any]) – The validated form data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

devices.models.IssuedCredentialModel

class devices.views.DeviceIssueOpcUaClientCredentialView

Bases: AbstractIssueOpcUaClientCredentialView

Issues an OPC UA client credential within the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsIssueOpcUaClientCredentialView

Bases: AbstractIssueOpcUaClientCredentialView

Issues an OPC UA client credential within the devices section.

page_name = 'opc_ua_gds'

class devices.views.AbstractIssueOpcUaServerCredentialView

Bases: AbstractIssueCredentialView[devices.forms.IssueOpcUaServerCredentialForm, devices.issuer.OpcUaServerCredentialIssuer]

View to issue a new OPC UA server credential.

form_class

issuer_class

friendly_name = 'OPC UA server credential'

issue_credential(device, cleaned_data)

Issues an OPC UA server credential.

Parameters:

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

• cleaned_data (dict[str, Any]) – The validated form data.

Returns:

The IssuedCredentialModel object that was created and saved.

Return type:

devices.models.IssuedCredentialModel

class devices.views.DeviceIssueOpcUaServerCredentialView

Bases: AbstractIssueOpcUaServerCredentialView

Issues an OPC UA server credential within the devices section.

page_name = 'devices'

class devices.views.OpcUaGdsIssueOpcUaServerCredentialView

Bases: AbstractIssueOpcUaServerCredentialView

Issues an OPC UA server 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[devices.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.AbstractCertificateDownloadView

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

View for downloading certificates.

http_method_names = ('get',)

model: type[devices.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.AbstractDeviceBaseCredentialDownloadView

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[devices.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[devices.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[devices.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[devices.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.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]

_set_queryset(request)

Parameters:

request (django.http.request.HttpRequest)

Return type:

str | None

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.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]

_set_queryset(request)

Parameters:

request (django.http.request.HttpRequest)

Return type:

str | None

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'