pki.views.truststores

This module contains all views concerning the PKI -> Truststore section.

Attributes

DeviceModel
OID_MAP

Classes

TruststoresRedirectView	View that redirects to the index of the PKI Truststores application: Truststores.
TruststoresContextMixin	Mixin which adds some extra context for the PKI Views.
TruststoreTableView	Truststore Table View.
TruststoreCreateView	View for creating a new Truststore.
TruststoreDetailView	The truststore detail view.
TruststoreDownloadView	View for downloading a single truststore.
TruststoreMultipleDownloadView	View for downloading multiple truststores at once as archived files.
TruststoreBulkDeleteConfirmView	View for confirming the deletion of multiple truststores.
TruststoreViewSet	ViewSet for managing Truststore instances.

Module Contents

pki.views.truststores.DeviceModel = None

class pki.views.truststores.TruststoresRedirectView(**kwargs)

Bases: django.views.generic.base.RedirectView

View that redirects to the index of the PKI Truststores application: Truststores.

permanent = False

pattern_name = 'pki:truststores'

class pki.views.truststores.TruststoresContextMixin

Bases: trustpoint.page_context.PageContextMixin

Mixin which adds some extra context for the PKI Views.

page_category = 'pki'

page_name = 'truststores'

class pki.views.truststores.TruststoreTableView

Bases: TruststoresContextMixin, trustpoint.views.base.SortableTableMixin[pki.models.truststore.TruststoreModel], django.views.generic.list.ListView[pki.models.truststore.TruststoreModel]

Truststore Table View.

model

template_name = 'pki/truststores/truststores.html'

context_object_name = 'truststores'

paginate_by = 50

default_sort_param = 'unique_name'

filterset_class

apply_filters(qs)

Applies the TruststoreFilter to the given queryset.

Parameters:

qs (django.db.models.QuerySet[pki.models.truststore.TruststoreModel]) – The base queryset to filter.

Returns:

The filtered queryset according to GET parameters.

Return type:

django.db.models.QuerySet[pki.models.truststore.TruststoreModel]

get_queryset()

Filter queryset to only include truststores filtered by UI filters.

Returns:

Returns a queryset of all TruststoreModels, filtered by UI filters.

Return type:

django.db.models.QuerySet[pki.models.truststore.TruststoreModel]

get_context_data(**kwargs)

Adds the filter to the context.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data.

Returns:

The context to use for rendering the truststores page.

Return type:

dict[str, Any]

class pki.views.truststores.TruststoreCreateView

Bases: TruststoresContextMixin, django.views.generic.edit.FormView[pki.forms.TruststoreAddForm]

View for creating a new Truststore.

model

form_class

template_name = 'pki/truststores/add/file_import.html'

ignore_url

dispatch(request, *args, **kwargs)

Set context flags based on URL.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

form_valid(form)

If the form is valid, redirect to Truststore overview.

Parameters:

form (pki.forms.TruststoreAddForm)

Return type:

django.http.HttpResponseRedirect

get_success_url()

You could still use a success URL here if needed.

Return type:

str

get_context_data(**kwargs)

Include domain in context only if pk is present.

Parameters:

kwargs (dict[str, Any])

Return type:

dict[str, Any]

pki.views.truststores.OID_MAP

class pki.views.truststores.TruststoreDetailView

Bases: TruststoresContextMixin, django.views.generic.detail.DetailView[pki.models.truststore.TruststoreModel]

The truststore detail view.

model

success_url

ignore_url

template_name = 'pki/truststores/details.html'

context_object_name = 'truststore'

get_context_data(**kwargs)

Adding map of attribute and its oid with its values.

Parameters:

**kwargs (Any) – Keyword arguments passed to super().get_context_data().

Returns:

The context data.

Return type:

dict

class pki.views.truststores.TruststoreDownloadView

Bases: TruststoresContextMixin, django.views.generic.detail.DetailView[pki.models.truststore.TruststoreModel]

View for downloading a single truststore.

model

success_url

ignore_url

template_name = 'pki/truststores/download.html'

context_object_name = 'truststore'

get(request, pk=None, file_format=None, *args, **kwargs)

HTTP GET Method.

If only the certificate primary key are passed in the url, the download summary will be displayed. If value for file_format is also provided, a file download will be performed.

Compare the re_path regex in the pki.urls package.

Parameters:

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

• pk (str | None) – A string containing the certificate primary key.

• file_format (str | None) – The format of the certificate to download.

• *args (tuple[Any]) – Positional arguments.

• **kwargs (dict[str, Any]) – Keyword arguments.

Returns:

The HTTP response with either the download summary or a file download.

Return type:

HttpResponse

Raises:

Http404 –

class pki.views.truststores.TruststoreMultipleDownloadView

Bases: TruststoresContextMixin, trustpoint.views.base.PrimaryKeyListFromPrimaryKeyString, django.views.generic.list.ListView[pki.models.truststore.TruststoreModel]

View for downloading multiple truststores at once as archived files.

model

success_url

ignore_url

template_name = 'pki/truststores/download_multiple.html'

context_object_name = 'truststores'

get_context_data(*args, **kwargs)

Adding the part of the url to the context, that contains the truststores primary keys.

This is used for the {% url }% tags in the template to download files.

Parameters:

• *args (Any) – Positional arguments, unused.

• **kwargs (dict[str, Any]) – Keyword arguments passed to super().get_context_data().

Returns:

The context data.

Return type:

dict

get(request, pks=None, file_format=None, archive_format=None, *args, **kwargs)

HTTP GET Method.

If only certificate primary keys are passed in the url, the download summary will be displayed. If value for file_format and archive_format are also provided, a file download will be performed.

Compare the re_path regex in the pki.urls package.

Parameters:

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

• pks (str | None) – A string containing the certificate primary keys, e.g. 1/2/3/4/5

• file_format (None | str) – The format of the archived certificate files.

• archive_format (None | str) – The archive format that will be provided as download.

• *args (tuple[Any]) – Positional arguments.

• **kwargs (dict[str, Any]) – Keyword arguments.

Returns:

The HTTP response with either the download summary or a file download.

Return type:

HttpResponse

Raises:

Http404 –

class pki.views.truststores.TruststoreBulkDeleteConfirmView

Bases: TruststoresContextMixin, trustpoint.views.base.BulkDeleteView

View for confirming the deletion of multiple truststores.

model

success_url

ignore_url

template_name = 'pki/truststores/confirm_delete.html'

context_object_name = 'truststores'

get(request, *args, **kwargs)

Handle GET requests.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

form_valid(form)

Attempts to delete the selected truststores on valid form.

Parameters:

form (django.forms.Form)

Return type:

django.http.HttpResponse

class pki.views.truststores.TruststoreViewSet(**kwargs)

Bases: rest_framework.viewsets.ModelViewSet[pki.models.truststore.TruststoreModel]

ViewSet for managing Truststore instances.

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

queryset

serializer_class

permission_classes

filter_backends

filterset_fields: ClassVar = ['intended_usage']

search_fields: ClassVar = ['unique_name']

ordering_fields: ClassVar = ['unique_name', 'created_at']

create(request, *args, **_kwargs)

API endpoint to create truststore.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• _kwargs (Any)

Return type:

django.http.HttpResponse

list(request, *args, **_kwargs)

API endpoint to get all truststores.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• _kwargs (Any)

Return type:

django.http.HttpResponse