setup_wizard.forms

This module contains forms for the setup wizard app.

Classes

EmptyForm	A form without any fields.
StartupWizardTlsCertificateForm	The Setup Wizard TLS Certificate Form.
HsmSetupForm	Form for HSM setup configuration.
BackupPasswordForm	Form for setting up backup password for PKCS#11 token.
BackupRestoreForm	Form for restoring from backup with optional backup password.
PasswordAutoRestoreForm	Form for filling the password for auto-restore.

Module Contents

class setup_wizard.forms.EmptyForm(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

A form without any fields.

class setup_wizard.forms.StartupWizardTlsCertificateForm(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

The Setup Wizard TLS Certificate Form.

ipv4_addresses

ipv6_addresses

domain_names

clean_ipv4_addresses()

Splits the IPv4 addresses and returns them as a list of strings.

Returns:

A list of the IPv4 addresses or an empty list.

Raises:

ValidationError – If it contains a term that is not a valid IPv4 address.

Return type:

list[ipaddress.IPv4Address]

clean_ipv6_addresses()

Splits the IPv6 addresses and returns them as a list of strings.

Returns:

A list of the IPv6 addresses or an empty list.

Raises:

ValidationError – If it contains a term that is not a valid IPv6 address.

Return type:

list[ipaddress.IPv6Address]

clean_domain_names()

Splits the domain names and returns them as a list of strings.

Returns:

A list of the domain names or an empty list.

Return type:

list[str]

clean()

Checks that at least one SAN entry is set.

Returns:

The cleaned data.

Raises:

ValidationError – If no SAN entry is set.

Return type:

dict[str, Any]

class setup_wizard.forms.HsmSetupForm(hsm_type='softhsm', *args, **kwargs)

Bases: django.forms.Form

Form for HSM setup configuration.

Parameters:

• hsm_type (str)

• args (Any)

• kwargs (Any)

module_path

slot

label

hsm_type

clean()

Custom validation for the form.

Return type:

dict[str, Any]

clean_label()

Clean token label field.

Return type:

str

clean_slot()

Clean slot number field.

Return type:

int

clean_module_path()

Clean module path field.

Return type:

str

class setup_wizard.forms.BackupPasswordForm(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 setting up backup password for PKCS#11 token.

password

confirm_password

clean_password()

Clean and validate the password field using Django’s password validators.

Returns:

The cleaned password.

Raises:

ValidationError – If password validation fails.

Return type:

str

clean()

Validate the form data.

Returns:

The cleaned data.

Raises:

ValidationError – If validation fails.

Return type:

dict[str, Any]

class setup_wizard.forms.BackupRestoreForm(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 restoring from backup with optional backup password.

MAX_PASSWORD_LENGTH = 128

backup_file

backup_password

clean_backup_file()

Validate the backup file.

Return type:

Any

clean_backup_password()

Clean the backup password field.

Return type:

str

class setup_wizard.forms.PasswordAutoRestoreForm(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 filling the password for auto-restore.

password

clean_password()

Clean and validate the password field using Django’s password validators.

Returns:

The cleaned password.

Raises:

ValidationError – If password validation fails.

Return type:

str