setup_wizard.views

Views for the users application.

Attributes

APACHE_PATH
APACHE_KEY_PATH
APACHE_CERT_PATH
APACHE_CERT_CHAIN_PATH
STATE_FILE_DIR
SCRIPT_WIZARD_INITIAL
SCRIPT_WIZARD_TLS_SERVER_CREDENTIAL_APPLY
SCRIPT_WIZARD_TLS_SERVER_CREDENTIAL_APPLY_CANCEL
SCRIPT_WIZARD_DEMO_DATA
SCRIPT_WIZARD_CREATE_SUPER_USER
SCRIPT_WIZARD_RESTORE
logger

Exceptions

TrustpointWizardError	Custom exception for Trustpoint wizard-related issues.
TrustpointTlsServerCredentialError	Custom exception for errors related to Trustpoint TLS Server Credentials.

Classes

StartupWizardRedirect	Handles redirection logic based on the current state of the setup wizard.
SetupWizardInitialView	View for the initial step of the setup wizard.
SetupWizardOptionsView	View for the restore option during initialization.
BackupRestoreView	Upload a dump file and restore the database from it.
SetupWizardGenerateTlsServerCredentialView	View for generating TLS Server Credentials in the setup wizard.
SetupWizardImportTlsServerCredentialView	View for handling the import of TLS Server Credentials.
SetupWizardTlsServerCredentialApplyView	View for handling the application of TLS Server Credentials in the setup wizard.
SetupWizardTlsServerCredentialApplyCancelView	View for handling the cancellation of TLS Server Credential application.
SetupWizardDemoDataView	View for handling the demo data setup during the setup wizard.
SetupWizardCreateSuperUserView	View for handling the creation of a superuser during the setup wizard.

Functions

execute_shell_script(script)

Execute a shell script.

Module Contents

setup_wizard.views.APACHE_PATH

setup_wizard.views.APACHE_KEY_PATH

setup_wizard.views.APACHE_CERT_PATH

setup_wizard.views.APACHE_CERT_CHAIN_PATH

setup_wizard.views.STATE_FILE_DIR

setup_wizard.views.SCRIPT_WIZARD_INITIAL

setup_wizard.views.SCRIPT_WIZARD_TLS_SERVER_CREDENTIAL_APPLY

setup_wizard.views.SCRIPT_WIZARD_TLS_SERVER_CREDENTIAL_APPLY_CANCEL

setup_wizard.views.SCRIPT_WIZARD_DEMO_DATA

setup_wizard.views.SCRIPT_WIZARD_CREATE_SUPER_USER

setup_wizard.views.SCRIPT_WIZARD_RESTORE

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)

Execute a shell script.

Parameters:

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

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.SetupWizardInitialView(**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/initial.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.SetupWizardOptionsView(**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/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.BackupRestoreView(**kwargs)

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

Upload a dump file and restore the database from it.

post(request)

Parameters:

request (django.http.HttpRequest)

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.

_get_error_message_from_return_code(return_code)

Maps return codes to error messages.

Parameters:

return_code (int)

Return type:

str

class setup_wizard.views.SetupWizardImportTlsServerCredentialView(**kwargs)

Bases: django.views.generic.View

View for handling the import of TLS Server Credentials.

http_method_names = ('get',)

get()

Handle GET requests for importing TLS Server Credentials.

Returns:

A redirect to the initial setup wizard page if the

import feature is not implemented or the wizard state is incorrect.

Return type:

HttpResponse

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'

success_url

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

_raise_tls_credential_error(message)

Raise a TrustpointTlsServerCredentialError with a given message.

Parameters:

message (str) – The error message to include in the exception.

Return type:

None

_map_exit_code_to_message(return_code)

Maps shell script exit codes to user-friendly error messages.

Parameters:

return_code (int)

Return type:

str

_generate_trust_store_response(file_format)

Generate a response containing the trust store in the requested format.

Parameters:

file_format (str) – The desired file format for the trust store (e.g., ‘pem’, ‘pkcs7_der’, ‘pkcs7_pem’).

Returns:

A response with the trust store content or an error message.

Return type:

HttpResponse

static _get_trust_store_and_content_type(file_format, certificate_serializer)

Tries to get the certificate in the requested format and adds the corresponding content type.

Parameters:

• file_format (str) – The file format requested.

• certificate_serializer (trustpoint_core.serializer.CertificateSerializer) – The certificate serializer.

Returns:

The tuple of the certificate in the requested format and the content type.

Return type:

tuple[str | bytes, str]

static _write_pem_files(credential_model)

Writes the private key, certificate, and trust store PEM files to disk.

Parameters:

credential_model (CredentialModel) – The credential model instance containing the keys and certificates.

Return type:

None

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

_clear_credential_and_certificate_data_and_execute(request)

Clear the credential and certificate data and executes the corresponding action suing a shell script.

Parameters:

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

Return type:

django.http.HttpResponse

_clear_credential_and_certificate_data()

Clears all credential and certificate data if canceled in the ‘WIZARD_TLS_SERVER_CREDENTIAL_APPLY’ state.

Return type:

None

_map_exit_code_to_message(return_code)

Maps shell script exit codes to user-friendly error messages.

Parameters:

return_code (int)

Return type:

str

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

_add_demo_data()

Add demo data to the database.

Return type:

None

_execute_notifications()

Creating notifications.

Return type:

None

static _map_exit_code_to_message(return_code)

Map script exit codes to meaningful error messages.

Parameters:

return_code (int) – The exit code returned by the script.

Returns:

A descriptive error message corresponding to the exit code.

Return type:

str

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

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

static _map_exit_code_to_message(return_code)

Map script exit codes to meaningful error messages.

Parameters:

return_code (int)

Return type:

str