pki.views.domains

Views for managing Domains.

Module Contents

class pki.views.domains.DomainContextMixin

Bases: trustpoint.views.base.ContextDataMixin

Mixin which adds context_data for the PKI -> Issuing CAs pages.

context_page_category = 'pki'

context_page_name = 'domains'

class pki.views.domains.DomainTableView

Bases: DomainContextMixin, trustpoint.views.base.SortableTableMixin[pki.models.DomainModel], django.views.generic.list.ListView[pki.models.DomainModel]

Domain Table View.

model

template_name = 'pki/domains/domain.html'

context_object_name = 'domain-new'

paginate_by = 50

default_sort_param = 'unique_name'

class pki.views.domains.DomainCreateView

Bases: DomainContextMixin, django.views.generic.edit.CreateView[pki.models.DomainModel, django.forms.BaseModelForm[pki.models.DomainModel]]

View to create a new domain.

model

fields = '__all__'

template_name = 'pki/domains/add.html'

success_url

ignore_url

get_form(_form_class=None)

Override get_form to filter out keyless CAs and autogen root CAs.

Only issuing CAs (those with credentials that can sign certificates) should be assignable to domains.

Parameters:

_form_class (Any)

Return type:

Any

form_valid(form)

Handle the case where the form is valid.

Parameters:

form (django.forms.BaseModelForm[pki.models.DomainModel])

Return type:

django.http.HttpResponse

class pki.views.domains.DomainDevIdRegistrationTableMixin

Bases: trustpoint.views.base.SortableTableMixin[pki.models.DevIdRegistration], trustpoint.views.base.ListInDetailView

Mixin to add a table of DevID Registrations to the domain config view.

model

paginate_by = 50

context_object_name = 'devid_registrations'

default_sort_param = 'unique_name'

get_queryset()

Gets the queryset for the DevID Registration table.

Return type:

django.db.models.QuerySet[pki.models.DevIdRegistration]

class pki.views.domains.DomainConfigView

Bases: DomainContextMixin, DomainDevIdRegistrationTableMixin, trustpoint.views.base.ListInDetailView

View to configure a domain, allows adding DevID registration patterns.

detail_model

template_name = 'pki/domains/config.html'

detail_context_object_name = 'domain'

success_url

get_context_data(**kwargs)

Adds additional context data.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

post(request, *args, **kwargs)

Handle config form submission.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

class pki.views.domains.DomainDetailView

Bases: DomainContextMixin, DomainDevIdRegistrationTableMixin, trustpoint.views.base.ListInDetailView

View to display domain details.

detail_model

template_name = 'pki/domains/details.html'

detail_context_object_name = 'domain'

class pki.views.domains.DomainCaBulkDeleteConfirmView

Bases: DomainContextMixin, trustpoint.views.base.BulkDeleteView

View to confirm the deletion of multiple Domains.

model

success_url

ignore_url

template_name = 'pki/domains/confirm_delete.html'

context_object_name = 'domains'

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 domains if the form is valid.

Parameters:

form (django.forms.Form)

Return type:

django.http.HttpResponse

class pki.views.domains.DevIdRegistrationCreateView

Bases: DomainContextMixin, django.views.generic.edit.FormView[pki.forms.DevIdRegistrationForm]

View to create a new DevID Registration.

http_method_names = ('get', 'post')

template_name = 'pki/devid_registration/add.html'

form_class

get_context_data(**kwargs)

Add additional context data.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

get_initial()

Initialize the form with default values.

Return type:

dict[str, Any]

get_form_kwargs()

Provide additional arguments to the form.

Return type:

dict[str, Any]

get_domain()

Get domain from URL pk (GET) or form data (POST).

Return type:

pki.models.DomainModel | None

get_truststore(truststore_id)

Fetch the truststore based on the primary key passed in the URL.

Parameters:

truststore_id (int)

Return type:

pki.models.truststore.TruststoreModel

form_valid(form)

Handle the case where the form is valid.

Parameters:

form (pki.forms.DevIdRegistrationForm)

Return type:

django.http.HttpResponse

get_success_url()

Return the URL to redirect to upon successful form submission.

Return type:

str

class pki.views.domains.DevIdRegistrationDeleteView

Bases: DomainContextMixin, django.views.generic.DeleteView[pki.models.DevIdRegistration, Any]

View to delete a DevID Registration.

model

template_name = 'pki/devid_registration/confirm_delete.html'

success_url

delete(request, *args, **kwargs)

Override delete method to add a success message.

Parameters:

• request (django.http.HttpRequest)

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

class pki.views.domains.DevIdMethodSelectView

Bases: DomainContextMixin, django.views.generic.edit.FormView[pki.forms.DevIdAddMethodSelectForm]

View to select the method to add a DevID Registration pattern.

template_name = 'pki/devid_registration/method_select.html'

form_class

get_context_data(**kwargs)

Add additional context data.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

form_valid(form)

Redirect to the view for the selected method.

Parameters:

form (pki.forms.DevIdAddMethodSelectForm)

Return type:

django.http.HttpResponseRedirect

class pki.views.domains.IssuedCertificatesView

Bases: trustpoint.views.base.ContextDataMixin, django.views.generic.list.ListView[pki.models.CertificateModel]

View to list certificates issued by a specific Issuing CA for a Domain.

model

template_name = 'pki/domains/issued_certificates.html'

context_object_name = 'issued_certificates'

get_queryset()

Return only certificates associated with the domain’s issued credentials.

Return type:

django.db.models.QuerySet[pki.models.CertificateModel]

get_domain()

Get the domain object based on the URL parameter.

Return type:

pki.models.DomainModel

get_context_data(**kwargs)

Pass additional context data to the template.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

class pki.views.domains.OnboardingMethodSelectIdevidHelpView

Bases: DomainContextMixin, django.views.generic.detail.DetailView[pki.models.DevIdRegistration]

View to select the protocol for IDevID enrollment.

template_name = 'pki/domains/idevid_method_select.html'

context_object_name = 'devid_registration'

model

get_context_data(**kwargs)

Add the required context for the template.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

class pki.views.domains.DomainViewSet(**kwargs)

Bases: rest_framework.viewsets.ModelViewSet[pki.models.DomainModel]

ViewSet for managing Domain instances.

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

queryset

serializer_class