signer.forms
============

.. py:module:: signer.forms

.. autoapi-nested-parse::

   Contains Logic for Form on Add/Edit Signer Page.







Module Contents
---------------

.. py:function:: get_private_key_location_from_config()

   Determine the appropriate PrivateKeyLocation based on KeyStorageConfig.


.. py:class:: SignerAddMethodSelectForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)

   Bases: :py:obj:`django.forms.Form`


   Form for selecting the method to add a Signer.


   .. py:attribute:: method_select


.. py:class:: SignerAddFileTypeSelectForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)

   Bases: :py:obj:`django.forms.Form`


   Form for selecting the file type when importing a Signer.


   .. py:attribute:: method_select


.. py:class:: SignerAddFileImportPkcs12Form(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)

   Bases: :py:obj:`trustpoint.logger.LoggerMixin`, :py:obj:`django.forms.Form`


   Form for importing an Signer using a PKCS#12 file.


   .. py:attribute:: unique_name


   .. py:attribute:: pkcs12_file


   .. py:attribute:: pkcs12_password


   .. py:method:: clean_unique_name()

      Validates the unique name to ensure it is not already in use.



   .. py:method:: clean()

      Cleans and validates the entire form.



.. py:class:: SignerAddFileImportSeparateFilesForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)

   Bases: :py:obj:`trustpoint.logger.LoggerMixin`, :py:obj:`django.forms.Form`


   Form for importing a Signer using separate files.


   .. py:attribute:: unique_name


   .. py:attribute:: signer_certificate


   .. py:attribute:: signer_certificate_chain


   .. py:attribute:: private_key_file


   .. py:attribute:: private_key_file_password


   .. py:method:: clean_private_key_file()

      Validates and parses the uploaded private key file.



   .. py:method:: clean_signer_certificate()

      Validates and parses the uploaded signer certificate file.



   .. py:method:: clean_signer_certificate_chain()

      Validates and parses the uploaded signer certificate chain file.



   .. py:method:: clean()

      Cleans and validates the form data.



.. py:class:: SignHashForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=ErrorList, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)

   Bases: :py:obj:`trustpoint.logger.LoggerMixin`, :py:obj:`django.forms.Form`


   Form for signing a hash value with a selected signer.


   .. py:attribute:: signer


   .. py:attribute:: hash_value


   .. py:method:: clean()

      Validate the hash value format based on the selected signer's hash algorithm.