setup_wizard.views

Views for the users application.

Module Contents

setup_wizard.views.logger

exception setup_wizard.views.TrustpointWizardError

Bases: Exception

Custom exception for Trustpoint wizard-related issues.

exception setup_wizard.views.TrustpointTlsServerCredentialError(message='Trustpoint TLS Server Credential error occurred.')

Bases: Exception

Custom exception for errors related to Trustpoint TLS Server Credentials.

This exception is raised when specific issues with the TLS Server Credentials occur, such as missing credentials.

Parameters:

message (str)

setup_wizard.views.execute_shell_script(script, *args)

Execute a shell script with optional arguments.

Parameters:

• script (Path) – The path to the shell script to execute.

• *args (str) – Additional arguments to pass to the script.

Raises:

• FileNotFoundError – If the script does not exist.

• ValueError – If the script path is not a valid file.

• subprocess.CalledProcessError – If the script fails to execute.

Return type:

None

class setup_wizard.views.StartupWizardRedirect

Handles redirection logic based on the current state of the setup wizard.

This class provides a static method for determining the appropriate redirection URL based on the wizard’s state, ensuring users are guided through the setup process.

static redirect_by_state(wizard_state)

Redirects the user to the appropriate setup wizard page based on the current state.

Parameters:

wizard_state (SetupWizardState) – The current state of the setup wizard.

Returns:

A redirection response to the appropriate page.

Return type:

HttpResponseRedirect

Raises:

ValueError – If the wizard state is unrecognized or invalid.

class setup_wizard.views.HsmSetupMixin

Bases: trustpoint.logger.LoggerMixin

Mixin that provides common HSM setup functionality for both initial setup and auto restore.

request: django.http.HttpRequest

form_valid(form)

Handle form submission for HSM setup.

Parameters:

form (setup_wizard.forms.HsmSetupForm)

Return type:

django.http.HttpResponse

get_setup_type()

Return the setup type for the HSM script.

Return type:

str

get_error_redirect_url()

Return the URL to redirect to on error.

Return type:

str

get_success_context()

Return context string for success messages.

Return type:

str

get_expected_wizard_state()

Return the expected wizard state for this view.

Return type:

setup_wizard.SetupWizardState

class setup_wizard.views.SetupWizardCryptoStorageView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[management.forms.KeyStorageConfigForm]

View for handling crypto storage setup during the setup wizard.

http_method_names = ('get', 'post')

template_name = 'setup_wizard/crypto_storage_setup.html'

form_class

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

form_valid(form)

Handle valid form submission and determine next step based on storage type.

Parameters:

form (management.forms.KeyStorageConfigForm)

Return type:

django.http.HttpResponse

form_invalid(form)

Handle invalid form submission.

Parameters:

form (management.forms.KeyStorageConfigForm)

Return type:

django.http.HttpResponse

class setup_wizard.views.SetupWizardHsmSetupView

Bases: HsmSetupMixin, django.views.generic.FormView[setup_wizard.forms.HsmSetupForm]

View for handling HSM setup during the setup wizard.

form_class

template_name = 'setup_wizard/hsm_setup.html'

http_method_names = ('get', 'post')

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

get_form(form_class=None)

Return a form instance with appropriate defaults based on HSM type.

Parameters:

form_class (type[setup_wizard.forms.HsmSetupForm] | None)

Return type:

setup_wizard.forms.HsmSetupForm

get_context_data(**kwargs)

Add HSM type to template context.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

get_setup_type()

Return the setup type for the HSM script.

Return type:

str

get_success_url()

Return the success URL after HSM setup.

Return type:

str

get_error_redirect_url()

Return the URL to redirect to on error.

Return type:

str

get_success_context()

Return context string for success messages.

Return type:

str

get_expected_wizard_state()

Return the expected wizard state for this view.

Return type:

setup_wizard.SetupWizardState

class setup_wizard.views.SetupWizardSetupModeView(**kwargs)

Bases: django.views.generic.TemplateView

View for the initial step of the setup wizard.

This view is responsible for displaying the initial setup wizard page. It ensures that the application is running in a Docker container and that the setup wizard is in the initial state. If either condition is not met, the user is redirected to the appropriate page, such as the login page or the next setup step.

http_method_names

List of HTTP methods allowed for this view.

Type:

ClassVar[list[str]]

template_name

Path to the template used for rendering the initial page.

Type:

str

http_method_names = ('get',)

template_name = 'setup_wizard/setup_mode.html'

get(*args, **kwargs)

Handle GET requests for the setup mode wizard page.

This method validates the current state of the setup wizard and redirects the user to the appropriate page. If the application is not running in a Docker container, the user is redirected to the login page.

Parameters:

• *args (Any) – Additional positional arguments.

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

Returns:

A redirect response to the appropriate setup wizard page

or the login page if the setup is not in a Docker container.

Return type:

HttpResponse

class setup_wizard.views.SetupWizardSelectTlsServerCredentialView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[setup_wizard.forms.EmptyForm]

View for selecting the TLS server credential during setup.

http_method_names = ('get', 'post')

template_name = 'setup_wizard/select_tls_server_credential.html'

form_class

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

get(*args, **kwargs)

Handle GET requests for the TLS server credential selection page.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

form_valid(_)

Handle form submission for TLS server credential selection.

Parameters:

_ (setup_wizard.forms.EmptyForm)

Return type:

django.http.HttpResponse

class setup_wizard.views.SetupWizardRestoreOptionsView(**kwargs)

Bases: django.views.generic.TemplateView

View for the restore option during initialization.

http_method_names

List of HTTP methods allowed for this view.

Type:

ClassVar[list[str]]

template_name

Path to the template used for rendering the initial page.

Type:

str

http_method_names = ('get',)

template_name = 'setup_wizard/restore_options.html'

get(*args, **kwargs)

Handle GET requests for the initial setup wizard page.

This method validates the current state of the setup wizard and redirects the user to the appropriate page. If the application is not running in a Docker container, the user is redirected to the login page.

Parameters:

• *args (Any) – Additional positional arguments.

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

Returns:

A redirect response to the appropriate setup wizard page

or the login page if the setup is not in a Docker container.

Return type:

HttpResponse

class setup_wizard.views.SetupWizardBackupPasswordView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[setup_wizard.forms.BackupPasswordForm]

View for setting up backup password for PKCS#11 token during the setup wizard.

This view allows users to set a backup password that can be used to recover the DEK (Data Encryption Key) in case the HSM becomes unavailable. The password is used to derive a BEK (Backup Encryption Key) using Argon2.

http_method_names = ('get', 'post')

template_name = 'setup_wizard/backup_password.html'

success_url

form_class

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

get_context_data(**kwargs)

Add password requirements to the context.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

form_valid(form)

Handle valid form submission.

Parameters:

form (setup_wizard.forms.BackupPasswordForm)

Return type:

django.http.HttpResponse

form_invalid(form)

Handle invalid form submission.

Parameters:

form (setup_wizard.forms.BackupPasswordForm)

Return type:

django.http.HttpResponse

class setup_wizard.views.BackupPasswordRecoveryMixin

Bases: trustpoint.logger.LoggerMixin

Mixin that provides backup password recovery functionality.

request: django.http.HttpRequest

handle_backup_password_recovery(backup_password)

Handle DEK recovery using backup password.

This method handles two scenarios: 1. Standard recovery: KEK exists, use it to wrap the recovered DEK 2. New KEK scenario: No KEK or KEK doesn’t match, generate new KEK first

Parameters:

backup_password (str) – The backup password provided by user

Returns:

True if recovery was successful, False otherwise

Return type:

bool

class setup_wizard.views.AutoRestoreHsmSetupView

Bases: HsmSetupMixin, django.views.generic.FormView[setup_wizard.forms.HsmSetupForm]

View for handling HSM setup during auto restore process.

This view initializes the SoftHSM token when restoring to a new HSM installation where the old KEK is lost. It uses the wizard_setup_hsm.sh script with ‘auto_restore_setup’ mode.

form_class

template_name = 'setup_wizard/hsm_setup.html'

http_method_names = ('get', 'post')

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

get_form(form_class=None)

Return a form instance with appropriate defaults based on HSM type.

Parameters:

form_class (type[setup_wizard.forms.HsmSetupForm] | None)

Return type:

setup_wizard.forms.HsmSetupForm

get_context_data(**kwargs)

Add HSM type to template context.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

get_setup_type()

Return the setup type for the HSM script (auto_restore_setup).

Return type:

str

get_success_url()

Return the success URL after HSM setup.

Return type:

str

get_error_redirect_url()

Return the URL to redirect to on error.

Return type:

str

get_success_context()

Return context string for success messages.

Return type:

str

get_expected_wizard_state()

Return the expected wizard state for this view.

Return type:

setup_wizard.SetupWizardState

class setup_wizard.views.BackupRestoreView(**kwargs)

Bases: BackupPasswordRecoveryMixin, trustpoint.logger.LoggerMixin, django.views.generic.View

Upload a dump file and restore the database from it with optional backup password.

post(request)

Handle POST requests to upload a backup file and restore the database.

Parameters:

request (django.http.HttpRequest)

Return type:

django.http.HttpResponse

class setup_wizard.views.BackupAutoRestorePasswordView

Bases: BackupPasswordRecoveryMixin, trustpoint.logger.LoggerMixin, django.views.generic.FormView[setup_wizard.forms.PasswordAutoRestoreForm]

View for handling backup password entry during auto restore process.

This view allows users to enter the backup password needed to recover the DEK (Data Encryption Key) during the auto restore process. It validates the current wizard state and processes the password recovery.

http_method_names = ('get', 'post')

template_name = 'setup_wizard/auto_restore_password.html'

success_url

form_class

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

get_context_data(**kwargs)

Add additional context data.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

form_valid(form)

Handle valid form submission.

Parameters:

form (setup_wizard.forms.PasswordAutoRestoreForm)

Return type:

django.http.HttpResponse

form_invalid(form)

Handle invalid form submission.

Parameters:

form (setup_wizard.forms.PasswordAutoRestoreForm)

Return type:

django.http.HttpResponse

class setup_wizard.views.SetupWizardGenerateTlsServerCredentialView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[setup_wizard.forms.StartupWizardTlsCertificateForm]

View for generating TLS Server Credentials in the setup wizard.

This view handles the generation of TLS Server Credentials as part of the setup wizard. It provides a form for the user to input necessary information such as IP addresses and domain names, and processes the data to generate the required TLS certificates.

http_method_names

HTTP methods allowed for this view.

Type:

ClassVar[list[str]]

template_name

Path to the template used for rendering the form.

Type:

str

form_class

The form class used to validate user input.

Type:

Form

success_url

The URL to redirect to upon successful credential generation.

Type:

str

http_method_names = ('get', 'post')

template_name = 'setup_wizard/generate_tls_server_credential.html'

form_class

success_url

dispatch(request, *args, **kwargs)

Override the dispatch method to enforce wizard state validation.

This method ensures that the user is redirected appropriately based on the current wizard state. If the application is not running in a Docker container, the user is redirected to the login page.

Parameters:

• request (HttpRequest) – The incoming HTTP request.

• *args (Any) – Additional positional arguments.

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

Returns:

A redirect response to the appropriate page or

the next handler in the dispatch chain.

Return type:

HttpResponse

form_valid(form)

Handle a valid form submission for TLS Server Credential generation.

Parameters:

form (setup_wizard.forms.StartupWizardTlsCertificateForm) – The validated form containing user input for generating the TLS Server Credential.

Returns:

Redirect to the success URL upon successful

credential generation, or an error page if an exception occurs.

Return type:

HttpResponseRedirect

Raises:

• TrustpointTlsServerCredentialError – If no TLS server credential is found.

• subprocess.CalledProcessError – If the associated shell script fails.

class setup_wizard.views.SetupWizardImportTlsServerCredentialMethodSelectView(**kwargs)

Bases: django.views.generic.TemplateView

View for selecting the import method for TLS Server Credentials.

http_method_names = ('get',)

template_name = 'setup_wizard/import_method_select.html'

dispatch(request, *args, **kwargs)

Override the dispatch method to enforce wizard state validation.

Parameters:

• request (HttpRequest) – The incoming HTTP request.

• *args (Any) – Additional positional arguments.

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

Returns:

A redirect response to the appropriate page or

the next handler in the dispatch chain.

Return type:

HttpResponse

class setup_wizard.views.SetupWizardImportTlsServerCredentialPkcs12View

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[management.forms.TlsAddFileImportPkcs12Form]

View for importing TLS Server Credentials using a PKCS#12 file in the setup wizard.

http_method_names = ('get', 'post')

template_name = 'setup_wizard/import_tls_server_credential.html'

form_class

success_url

dispatch(request, *args, **kwargs)

Override the dispatch method to enforce wizard state validation.

Parameters:

• request (HttpRequest) – The incoming HTTP request.

• *args (Any) – Additional positional arguments.

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

Returns:

A redirect response to the appropriate page or

the next handler in the dispatch chain.

Return type:

HttpResponse

form_valid(form)

Handle a valid form submission for TLS Server Credential import.

Parameters:

form (management.forms.TlsAddFileImportPkcs12Form) – The validated form containing the uploaded PKCS#12 file.

Returns:

Redirect to the success URL upon successful

credential import, or an error page if an exception occurs.

Return type:

HttpResponseRedirect

class setup_wizard.views.SetupWizardImportTlsServerCredentialSeparateFilesView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[management.forms.TlsAddFileImportSeparateFilesForm]

View for importing TLS Server Credentials using separate files in the setup wizard.

http_method_names = ('get', 'post')

template_name = 'setup_wizard/import_tls_server_credential.html'

form_class

success_url

dispatch(request, *args, **kwargs)

Override the dispatch method to enforce wizard state validation.

Parameters:

• request (HttpRequest) – The incoming HTTP request.

• *args (Any) – Additional positional arguments.

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

Returns:

A redirect response to the appropriate page or

the next handler in the dispatch chain.

Return type:

HttpResponse

form_valid(form)

Handle a valid form submission for TLS Server Credential import.

Parameters:

form (management.forms.TlsAddFileImportSeparateFilesForm) – The validated form containing the uploaded certificate files.

Returns:

Redirect to the success URL upon successful

credential import, or an error page if an exception occurs.

Return type:

HttpResponseRedirect

class setup_wizard.views.SetupWizardTlsServerCredentialApplyView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[setup_wizard.forms.EmptyForm]

View for handling the application of TLS Server Credentials in the setup wizard.

http_method_names

Allowed HTTP methods for this view (‘get’ and ‘post’).

Type:

list[str]

form_class

The form used for processing TLS Server Credential application.

Type:

Form

template_name

The template used to render the view.

Type:

str

success_url

The URL to redirect to upon successful form submission.

Type:

str

http_method_names = ('get', 'post')

form_class

template_name = 'setup_wizard/tls_server_credential_apply.html'

get_success_url()

Return the success URL based on storage type.

Return type:

str

get(request, *args, **kwargs)

Handle GET requests for the TLS Server Credential application view.

Parameters:

• request (HttpRequest) – The HTTP request object.

• *args (Any) – Positional arguments passed to the method.

• **kwargs (Any) – Keyword arguments passed to the method.

Returns:

A redirect response to the appropriate wizard state or the requested page.

Return type:

HttpResponse

post(*args, **kwargs)

Handle POST requests for the TLS Server Credential application view.

Parameters:

• *args (Any) – Positional arguments passed to the method.

• **kwargs (Any) – Keyword arguments passed to the method.

Returns:

A redirect response to the appropriate page based on the wizard state.

Return type:

HttpResponse

form_valid(form)

Process a valid form submission during the TLS Server Credential application.

Parameters:

form (setup_wizard.forms.EmptyForm) – The form instance containing the submitted data.

Returns:

Redirect to the next step or an error page based on the outcome.

Return type:

HttpResponseRedirect

class setup_wizard.views.SetupWizardTlsServerCredentialApplyCancelView(**kwargs)

Bases: trustpoint.logger.LoggerMixin, django.views.generic.View

View for handling the cancellation of TLS Server Credential application.

http_method_names

Allowed HTTP methods for this view.

http_method_names = ('get',)

get(request)

Handle GET requests for the TLS Server Credential import view.

Parameters:

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

Returns:

A redirect to the next step or an error response.

Return type:

HttpResponse

class setup_wizard.views.SetupWizardDemoDataView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[setup_wizard.forms.EmptyForm]

View for handling the demo data setup during the setup wizard.

This view allows the user to either add demo data to the database or proceed without it. It validates the current wizard state and transitions to the next state upon successful completion.

http_method_names = ('get', 'post')

form_class

template_name = 'setup_wizard/demo_data.html'

success_url

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

form_valid(form)

Handle form submission for demo data setup.

Parameters:

form (setup_wizard.forms.EmptyForm)

Return type:

django.http.HttpResponse

class setup_wizard.views.SetupWizardCreateSuperUserView

Bases: trustpoint.logger.LoggerMixin, django.views.generic.FormView[django.contrib.auth.forms.UserCreationForm[django.contrib.auth.models.User]]

View for handling the creation of a superuser during the setup wizard.

This view is part of the setup wizard process. It allows an admin to create a superuser account, ensuring that the application has at least one administrative user configured. The view validates the input using the UserCreationForm and transitions the wizard state upon successful completion.

http_method_names = ('get', 'post')

form_class: type[django.contrib.auth.forms.UserCreationForm[django.contrib.auth.models.User]]

template_name = 'setup_wizard/create_super_user.html'

success_url

dispatch(request, *args, **kwargs)

Handle request dispatch and wizard state validation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponseBase

form_valid(form)

Handle form submission for creating a superuser.

Parameters:

form (django.contrib.auth.forms.UserCreationForm[django.contrib.auth.models.User]) – The form containing the data for the superuser creation.

Returns:

Redirect to the next step or login page.

Return type:

HttpResponseRedirect