devices.forms

Forms exclusively used in the device application.

Module Contents

class devices.forms.SwitchCheckboxSelectMultiple(attrs=None, choices=())[source]

Bases: django.forms.CheckboxSelectMultiple

Custom CheckboxSelectMultiple widget that renders as Bootstrap switches.

template_name = 'widgets/switch_checkbox_select_multiple.html'[source]
devices.forms.PASSWORD_MIN_LENGTH = 12[source]
devices.forms.OTP_SPLIT_PARTS = 2[source]
devices.forms.ONBOARDING_PROTOCOLS_ALLOWED_FOR_FORMS[source]
class devices.forms.CredentialDownloadForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)[source]

Bases: django.forms.Form

Form to download a credential.

password[source]
static get_suggested_password(length=16)[source]

Generates a secure suggested password.

Parameters:

length (int) – Length of the password to generate. Defaults to 16.

Returns:

A secure random password string.

Return type:

str

clean()[source]

Checks if the passwords match and if the password is long enough.

Return type:

dict[str, Any]

class devices.forms.BaseCredentialForm(*args, device, **kwargs)[source]

Bases: django.forms.Form

Base form for issuing credentials.

Parameters:
common_name[source]
pseudonym[source]
domain_component[source]
serial_number[source]
validity[source]
device[source]
clean_common_name()[source]

Checks the common name.

Return type:

str

clean_validity()[source]

Checks the validity.

Return type:

int

class devices.forms.BaseServerCredentialForm(*args, device, **kwargs)[source]

Bases: BaseCredentialForm

Base form for issuing server credentials.

Parameters:
ipv4_addresses[source]
ipv6_addresses[source]
domain_names[source]
clean_ipv4_addresses()[source]

Checks the IPv4 addresses.

Return type:

list[ipaddress.IPv4Address]

clean_ipv6_addresses()[source]

Checks the IPv6 addresses.

Return type:

list[ipaddress.IPv6Address]

clean_domain_names()[source]

Checks the domain names.

Return type:

list[str]

clean()[source]

Ensures at least one SAN entry is set.

Return type:

dict[str, Any]

class devices.forms.IssueDomainCredentialForm(*args, device, **kwargs)[source]

Bases: BaseCredentialForm

Form to issue a new domain credential.

Parameters:
class devices.forms.IssueTlsClientCredentialForm(*args, device, **kwargs)[source]

Bases: BaseCredentialForm

Form to issue a new TLS client credential.

Parameters:
class devices.forms.IssueTlsServerCredentialForm(*args, device, **kwargs)[source]

Bases: BaseServerCredentialForm

Form to issue a new TLS server credential.

Parameters:
class devices.forms.ApplicationUriFormMixin(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)[source]

Bases: django.forms.Form

Adds a application_uri field to the form.

application_uri[source]
clean_application_uri()[source]

Checks if the application uri was set properly.

Returns:

The application uri.

Return type:

str

class devices.forms.IssueOpcUaClientCredentialForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)[source]

Bases: ApplicationUriFormMixin, BaseCredentialForm

Form to issue a new OPC UA client credential.

class devices.forms.IssueOpcUaServerCredentialForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)[source]

Bases: ApplicationUriFormMixin, BaseServerCredentialForm

Form to issue a new OPC UA server credential.

class devices.forms.IssueOpcUaGdsPushDomainCredentialForm(*args, device, **kwargs)[source]

Bases: ApplicationUriFormMixin, BaseCredentialForm

Form to issue a new OPC UA GDS Push domain credential.

Parameters:
class devices.forms.BrowserLoginForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)[source]

Bases: django.forms.Form

Form for the browser login via OTP for remote credential download.

otp[source]
clean()[source]

Cleans the form data, extracting the credential ID and OTP.

Return type:

dict[str, Any]

class devices.forms.RevokeIssuedCredentialForm[source]

Bases: django.forms.ModelForm[pki.models.certificate.RevokedCertificateModel]

Form to revoke a specific issued credential.

class Meta[source]

Meta class configuration.

model[source]
fields = ('revocation_reason',)[source]
class devices.forms.RevokeDevicesForm[source]

Bases: django.forms.ModelForm[pki.models.certificate.RevokedCertificateModel]

Form to revoke a issued credentials associated with a specific device.

class Meta[source]

Meta class configuration.

model[source]
fields = ('revocation_reason',)[source]
pks[source]
class devices.forms.DeleteDevicesForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)[source]

Bases: django.forms.Form

Form to delete the requested devices.

pks[source]
class devices.forms.NoOnboardingCreateForm(*args, **kwargs)[source]

Bases: django.forms.Form

Form for device or OPC UA GDS object creation without onboarding.

Parameters:

  • args (Any)

  • kwargs (Any)

common_name[source]
serial_number[source]
domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel][source]
domain[source]
no_onboarding_pki_protocols[source]
helper[source]
clean_common_name()[source]

Validates the device name, i.e. checks if it is unique.

Parameters:

common_name – The desired name of the new device.

Returns:

The device name if it passed the checks.

Return type:

str

save(device_type)[source]

Stores the form as devie model object in the db.

Parameters:

device_type (devices.models.DeviceModel.DeviceType) – The device type to set. Defaults to None.

Returns:

_description_

Return type:

devices.models.DeviceModel

class devices.forms.OnboardingCreateForm(*args, **kwargs)[source]

Bases: django.forms.Form

Form for device or OPC UA GDS object creation with onboarding.

Parameters:

  • args (Any)

  • kwargs (Any)

common_name[source]
serial_number[source]
domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel][source]
domain[source]
onboarding_protocol[source]
onboarding_pki_protocols[source]
helper[source]
clean_common_name()[source]

Validates the device name, i.e. checks if it is unique.

Parameters:

common_name – The desired name of the new device.

Returns:

The device name if it passed the checks.

Return type:

str

save(device_type)[source]

Stores the form as device model object in the db.

Parameters:

device_type (devices.models.DeviceModel.DeviceType) – The device type to set. Defaults to None.

Returns:

_description_

Return type:

devices.models.DeviceModel

class devices.forms.OpcUaGdsPushCreateForm(*args, **kwargs)[source]

Bases: django.forms.Form

Form for OPC UA GDS Push device creation with onboarding.

Parameters:

  • args (Any)

  • kwargs (Any)

common_name[source]
serial_number[source]
domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel][source]
domain[source]
ip_address[source]
opc_server_port[source]
opc_user[source]
opc_password[source]
helper[source]
clean_common_name()[source]

Validates the device name, i.e. checks if it is unique.

Parameters:

common_name – The desired name of the new device.

Returns:

The device name if it passed the checks.

Return type:

str

save(device_type)[source]

Stores the form as device model object in the db.

Parameters:

device_type (devices.models.DeviceModel.DeviceType) – The device type to set.

Returns:

The created DeviceModel.

Return type:

devices.models.DeviceModel

class devices.forms.ClmDeviceModelOnboardingForm(*args, **kwargs)[source]

Bases: django.forms.Form

CLM Device Model form for devices that use onboarding.

Parameters:

  • args (Any)

  • kwargs (Any)

common_name[source]
serial_number[source]
domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel][source]
domain[source]
onboarding_protocol[source]
onboarding_status[source]
pki_protocol_cmp[source]
pki_protocol_est[source]
instance: devices.models.DeviceModel[source]
helper[source]
clean_common_name()[source]

Validates the device name, i.e. checks if it is unique.

Returns:

The device name if it passed the checks.

Return type:

str

save(onboarding_protocol)[source]

Saves the changes to DB.

Parameters:

onboarding_protocol (onboarding.models.OnboardingProtocol)

Return type:

None

class devices.forms.ClmDeviceModelOpcUaGdsPushOnboardingForm(*args, **kwargs)[source]

Bases: django.forms.Form

CLM Device Model form for OPC UA GDS Push devices that use onboarding.

Parameters:

  • args (Any)

  • kwargs (Any)

common_name[source]
serial_number[source]
domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel][source]
domain[source]
ip_address[source]
opc_server_port[source]
opc_user[source]
opc_password[source]
truststore_queryset: django.db.models.query.QuerySet[pki.models.truststore.TruststoreModel][source]
opc_trust_store[source]
onboarding_protocol[source]
onboarding_status[source]
pki_protocol_opc_gds_push[source]
instance: devices.models.DeviceModel[source]
helper[source]
save()[source]

Saves the changes to DB.

Return type:

None

class devices.forms.ClmDeviceModelNoOnboardingForm(*args, **kwargs)[source]

Bases: django.forms.Form

CLM Device Model form for devices that do not use onboarding.

Parameters:

  • args (Any)

  • kwargs (Any)

common_name[source]
serial_number[source]
domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel][source]
domain[source]
pki_protocol_cmp[source]
pki_protocol_est[source]
pki_protocol_manual[source]
instance: devices.models.DeviceModel[source]
helper[source]
clean_common_name()[source]

Validates the device name, i.e. checks if it is unique.

Returns:

The device name if it passed the checks.

Return type:

str

save()[source]

Saves the changes to DB.

Return type:

None

class devices.forms.OpcUaGdsPushTruststoreAssociationForm(*args, **kwargs)[source]

Bases: django.forms.Form

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

Parameters:

  • args (Any)

  • kwargs (Any)

truststore_queryset: django.db.models.query.QuerySet[pki.models.truststore.TruststoreModel][source]
opc_trust_store[source]
instance: devices.models.DeviceModel[source]
helper[source]
save()[source]

Saves the truststore association to the device’s onboarding config.

Return type:

None