devices.forms

Forms exclusively used in the device application.

Attributes

PASSWORD_MIN_LENGTH
OTP_SPLIT_PARTS
ONBOARDING_PROTOCOLS_ALLOWED_FOR_FORMS
APP_CERT_PROFILES

Classes

CredentialDownloadForm	Form to download a credential.
BaseCredentialForm	Base form for issuing credentials.
BaseServerCredentialForm	Base form for issuing server credentials.
IssueDomainCredentialForm	Form to issue a new domain credential.
IssueTlsClientCredentialForm	Form to issue a new TLS client credential.
IssueTlsServerCredentialForm	Form to issue a new TLS server credential.
ApplicationUriFormMixin	Adds a application_uri field to the form.
IssueOpcUaClientCredentialForm	Form to issue a new OPC UA client credential.
IssueOpcUaServerCredentialForm	Form to issue a new OPC UA server credential.
BrowserLoginForm	Form for the browser login via OTP for remote credential download.
RevokeIssuedCredentialForm	Form to revoke a specific issued credential.
RevokeDevicesForm	Form to revoke a issued credentials associated with a specific device.
DeleteDevicesForm	Form to delete the requested devices.
NoOnboardingCreateForm	Form for device or OPC UA GDS object creation without onboarding.
OnboardingCreateForm	Form for device or OPC UA GDS object creation with onboarding.
ClmDeviceModelOnboardingForm	CLM Device Model form for devices that use onboarding.
ClmDeviceModelNoOnboardingForm	CLM Device Model form for devices that do not use onboarding.
ApplicationCertProfileSelectForm	Allows to select the certificate profile.

Functions

_get_secret([number_of_symbols])

Generates a secret with the number of symbols provided.

Module Contents

devices.forms.PASSWORD_MIN_LENGTH = 12

devices.forms.OTP_SPLIT_PARTS = 2

devices.forms.ONBOARDING_PROTOCOLS_ALLOWED_FOR_FORMS

devices.forms._get_secret(number_of_symbols=16)

Generates a secret with the number of symbols provided.

Parameters:

number_of_symbols (int) – Number of symbols of the generated secret. Defaults to 16.

Returns:

The generated secret.

Return type:

str

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)

Bases: django.forms.Form

Form to download a credential.

password

confirm_password

clean()

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

Return type:

dict[str, Any]

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

Bases: django.forms.Form

Base form for issuing credentials.

Parameters:

• args (Any)

• device (devices.models.DeviceModel)

• kwargs (Any)

common_name

pseudonym

domain_component

serial_number

validity

device

clean_common_name()

Checks the common name.

Return type:

str

clean_validity()

Checks the validity.

Return type:

int

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

Bases: BaseCredentialForm

Base form for issuing server credentials.

Parameters:

• args (Any)

• device (devices.models.DeviceModel)

• kwargs (Any)

ipv4_addresses

ipv6_addresses

domain_names

clean_ipv4_addresses()

Checks the IPv4 addresses.

Return type:

list[ipaddress.IPv4Address]

clean_ipv6_addresses()

Checks the IPv6 addresses.

Return type:

list[ipaddress.IPv6Address]

clean_domain_names()

Checks the domain names.

Return type:

list[str]

clean()

Ensures at least one SAN entry is set.

Return type:

dict[str, Any]

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

Bases: BaseCredentialForm

Form to issue a new domain credential.

Parameters:

• args (Any)

• device (devices.models.DeviceModel)

• kwargs (Any)

class devices.forms.IssueTlsClientCredentialForm(*args, device, **kwargs)

Bases: BaseCredentialForm

Form to issue a new TLS client credential.

Parameters:

• args (Any)

• device (devices.models.DeviceModel)

• kwargs (Any)

class devices.forms.IssueTlsServerCredentialForm(*args, device, **kwargs)

Bases: BaseServerCredentialForm

Form to issue a new TLS server credential.

Parameters:

• args (Any)

• device (devices.models.DeviceModel)

• kwargs (Any)

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)

Bases: django.forms.Form

Adds a application_uri field to the form.

application_uri

clean_application_uri()

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)

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)

Bases: ApplicationUriFormMixin, BaseServerCredentialForm

Form to issue a new OPC UA server credential.

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)

Bases: django.forms.Form

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

otp

clean()

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

Return type:

dict[str, Any]

class devices.forms.RevokeIssuedCredentialForm

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

Form to revoke a specific issued credential.

class Meta

Meta class configuration.

model

fields = ('revocation_reason',)

class devices.forms.RevokeDevicesForm

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

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

class Meta

Meta class configuration.

model

fields = ('revocation_reason',)

pks

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)

Bases: django.forms.Form

Form to delete the requested devices.

pks

class devices.forms.NoOnboardingCreateForm(*args, **kwargs)

Bases: django.forms.Form

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

Parameters:

• args (Any)

• kwargs (Any)

common_name

serial_number

domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel]

domain

no_onboarding_pki_protocols

helper

clean_common_name()

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)

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)

Bases: django.forms.Form

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

Parameters:

• args (Any)

• kwargs (Any)

common_name

serial_number

domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel]

domain

onboarding_protocol

onboarding_pki_protocols

helper

clean_common_name()

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)

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.ClmDeviceModelOnboardingForm(*args, **kwargs)

Bases: django.forms.Form

CLM Device Model form for devices that use onboarding.

Parameters:

• args (Any)

• kwargs (Any)

common_name

serial_number

domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel]

domain

onboarding_protocol

onboarding_status

pki_protocol_cmp

pki_protocol_est

instance: devices.models.DeviceModel

helper

save(onboarding_protocol)

Saves the changes to DB.

Parameters:

onboarding_protocol (devices.models.OnboardingProtocol)

Return type:

None

class devices.forms.ClmDeviceModelNoOnboardingForm(*args, **kwargs)

Bases: django.forms.Form

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

Parameters:

• args (Any)

• kwargs (Any)

common_name

serial_number

domain_queryset: django.db.models.query.QuerySet[pki.models.domain.DomainModel]

domain

pki_protocol_cmp

pki_protocol_est

pki_protocol_manual

instance: devices.models.DeviceModel

helper

save()

Saves the changes to DB.

Return type:

None

devices.forms.APP_CERT_PROFILES = [('tls-client', 'TLS-Client Certificate'), ('tls-server', 'TLS-Server Certificate'),...

class devices.forms.ApplicationCertProfileSelectForm(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)

Bases: django.forms.Form

Allows to select the certificate profile.

app_cert_profiles