management.views.tls

TLS setting specific views.

Module Contents

class management.views.tls.TlsSettingsContextMixin

Mixin which adds data to the context for the TLS settings application.

page_category: str = 'management'

page_name: str = 'tls'

get_context_data(**kwargs)

Add page_category and page_name to context.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

class management.views.tls.TlsView

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

View to display certificate details, including Subject Alternative Name (SAN) and associated IP addresses.

template_name = 'management/tls.html'

form_class

success_url

get_form_kwargs()

Pass additional arguments (e.g., SAN IPs) to the form.

Return type:

dict[str, Any]

get_context_data(**kwargs)

Add certificate information, including SAN data and issuer details, to the context for display.

Parameters:

kwargs (dict[str, Any])

Return type:

dict[str, Any]

form_valid(form)

Handle valid form submissions.

Parameters:

form (management.forms.IPv4AddressForm)

Return type:

django.http.HttpResponse

form_invalid(form)

Handle invalid form submissions.

Parameters:

form (management.forms.IPv4AddressForm)

Return type:

django.http.HttpResponse

get_san_ips()

Fetches IPv4 addresses from the Subject Alternative Name (SAN) extension of the active TLS certificate.

Returns:

A list of IPv4 addresses (as strings) or an empty list if none are found.

Return type:

list[str]

class management.views.tls.TlsAddMethodSelectView(**kwargs)

Bases: django.views.generic.TemplateView

View to select the method to add a TLS Certificate.

template_name = 'management/tls/method_select.html'

success_url

class management.views.tls.GenerateTlsCertificateView

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. 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 = 'management/tls/generate_tls.html'

form_class

success_url

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 management.views.tls.TlsAddFileImportPkcs12View

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

View to import an TLS-Server Credential from a PKCS12 file.

template_name = 'management/tls/file_import.html'

form_class

success_url

form_valid(form)

Handle the case where the form is valid.

Parameters:

form (management.forms.TlsAddFileImportPkcs12Form)

Return type:

django.http.HttpResponse

class management.views.tls.TlsAddFileImportSeparateFilesView

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

View to import an Issuing CA from separate PEM files.

template_name = 'management/tls/file_import.html'

form_class

success_url

form_valid(form)

Handle the case where the form is valid.

Parameters:

form (management.forms.TlsAddFileImportSeparateFilesForm)

Return type:

django.http.HttpResponse

class management.views.tls.TlsBulkDeleteConfirmView

Bases: TlsSettingsContextMixin, trustpoint.views.base.BulkDeleteView

View to confirm the deletion of multiple TLS certificates.

model

success_url

ignore_url

template_name = 'management/tls/confirm_delete.html'

context_object_name = 'certificates'

get(request, *args, **kwargs)

Handle GET requests.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

form_valid(_form)

Attempt to delete tls certificates if the form is valid.

Parameters:

_form (django.forms.Form)

Return type:

django.http.HttpResponse

class management.views.tls.ActivateTlsServerView(**kwargs)

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

Activate a TLS server certificate.

post(request, *args, **kwargs)

Handle a valid form submission for TLS Server Credential activation.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (dict[str, Any])

Return type:

django.http.HttpResponse

class management.views.tls.TlsViewSet(**kwargs)

Bases: rest_framework.viewsets.ModelViewSet[Any]

ViewSet for managing Backup instances.

Supports standard CRUD operations such as list, retrieve, create, update, and delete.

queryset

serializer_class

permission_classes

filter_backends

filterset_fields: ClassVar = ['credential_type']

search_fields: ClassVar = ['certificates']

ordering_fields: ClassVar = ['created_at']