request.request_context ======================= .. py:module:: request.request_context .. autoapi-nested-parse:: This module contains the RequestContext class for managing request-specific named attributes. Module Contents --------------- .. py:data:: RCT .. py:class:: BaseRequestContext Bases: :py:obj:`trustpoint.logger.LoggerMixin` Base class for all specific request context classes. .. py:attribute:: operation :type: str | None :value: None .. py:attribute:: protocol :type: str | None :value: None .. py:attribute:: parsed_message :type: cryptography.x509.CertificateSigningRequest | pyasn1_modules.rfc4210.PKIMessage | None :value: None .. py:attribute:: domain_str :type: str | None :value: None .. py:attribute:: domain :type: pki.models.DomainModel | None :value: None .. py:attribute:: device :type: devices.models.DeviceModel | None :value: None .. py:attribute:: owner_credential :type: pki.models.CredentialModel | None :value: None .. py:attribute:: issuer_credential :type: pki.models.CredentialModel | None :value: None .. py:attribute:: client_certificate :type: cryptography.x509.Certificate | None :value: None .. py:attribute:: client_intermediate_certificate :type: list[cryptography.x509.Certificate] | None :value: None .. py:attribute:: event :type: workflows.events.Event | None :value: None .. py:method:: error(ext_msg, http_status = None, cmp_code = None) Set an error message in the context. .. py:method:: to_dict() Serialize the context to a dictionary. .. py:method:: to_http_response() Convert the context's HTTP response attributes to a Django HttpResponse. .. py:method:: narrow(child_cls, **extra) Create a new request context of a more specific subclass, copying existing attributes. .. py:method:: clear() Reset all attributes to None. .. py:class:: BaseCertificateRequestContext Bases: :py:obj:`BaseRequestContext` Shared context for all certificate request operations. .. py:attribute:: cert_requested :type: cryptography.x509.CertificateSigningRequest | cryptography.x509.base.CertificateBuilder | None :value: None .. py:attribute:: cert_profile_str :type: str | None :value: None .. py:attribute:: cert_requested_profile_validated :type: cryptography.x509.base.CertificateBuilder | None :value: None .. py:attribute:: issued_certificate :type: cryptography.x509.Certificate | None :value: None .. py:attribute:: issued_certificate_chain :type: list[cryptography.x509.Certificate] | None :value: None .. py:attribute:: certificate_profile_model :type: pki.models.CertificateProfileModel | None :value: None .. py:attribute:: allow_ca_certificate_request :type: bool :value: False .. py:attribute:: request_data :type: dict[str, Any] | None :value: None .. py:attribute:: validated_request_data :type: dict[str, Any] | None :value: None .. py:attribute:: enrollment_request :type: workflows.models.EnrollmentRequest | None :value: None .. py:attribute:: event :type: workflows.events.Event | None :value: None .. py:class:: BaseCredentialRequestContext Bases: :py:obj:`BaseCertificateRequestContext` Shared context for all credential request (keypair generated by Trustpoint) operations. .. py:attribute:: private_key :type: trustpoint_core.serializer.PrivateKeySerializer | None :value: None .. py:attribute:: issued_credential :type: pki.models.IssuedCredentialModel | None :value: None .. py:class:: BaseRevocationRequestContext Bases: :py:obj:`BaseRequestContext` Shared context for all revocation request operations. .. py:attribute:: cert_serial_number :type: str | None :value: None .. py:attribute:: credential_to_revoke :type: pki.models.IssuedCredentialModel | None :value: None .. py:attribute:: revocation_reason :type: cryptography.x509.ReasonFlags .. py:class:: HttpBaseRequestContext Bases: :py:obj:`BaseRequestContext` Shared context for all protocols that use HTTP(s) for message transfer. .. py:attribute:: raw_message :type: django.http.HttpRequest | None :value: None .. py:attribute:: http_response_status :type: int | None :value: None .. py:attribute:: http_response_headers :type: dict[str, str] | None :value: None .. py:attribute:: http_response_content :type: bytes | str | None :value: None .. py:attribute:: http_response_content_type :type: str | None :value: None .. py:class:: EstBaseRequestContext Bases: :py:obj:`HttpBaseRequestContext` Shared context for all EST requests. Supports both EST server functionality (receiving requests) and EST client functionality (sending requests to external EST servers). .. py:attribute:: parsed_message :type: cryptography.x509.CertificateSigningRequest | None :value: None .. py:attribute:: est_encoding :type: str | None :value: None .. py:attribute:: est_username :type: str | None :value: None .. py:attribute:: est_password :type: str | None :value: None .. py:attribute:: est_server_host :type: str | None :value: None .. py:attribute:: est_server_port :type: int | None :value: None .. py:attribute:: est_server_path :type: str | None :value: None .. py:attribute:: est_server_truststore :type: pki.models.TruststoreModel | None :value: None .. py:attribute:: est_client_cert_pem :type: str | None :value: None .. py:attribute:: est_client_key_pem :type: str | None :value: None .. py:class:: CmpBaseRequestContext Bases: :py:obj:`HttpBaseRequestContext` Shared context for all CMP requests. Supports both CMP server functionality (receiving requests) and CMP client functionality (sending requests to external CMP servers). .. py:attribute:: parsed_message :type: pyasn1_modules.rfc4210.PKIMessage | None :value: None .. py:attribute:: cmp_shared_secret :type: str | None :value: None .. py:attribute:: error_code :type: cmp.util.PKIFailureInfo | None :value: None .. py:attribute:: error_details :type: str | None :value: None .. py:attribute:: cmp_server_host :type: str | None :value: None .. py:attribute:: cmp_server_port :type: int | None :value: None .. py:attribute:: cmp_server_path :type: str | None :value: None .. py:attribute:: cmp_server_truststore :type: pki.models.TruststoreModel | None :value: None .. py:class:: RestBaseRequestContext Bases: :py:obj:`HttpBaseRequestContext` Shared context for all REST API requests. .. py:class:: ManualBaseRequestContext Bases: :py:obj:`BaseRequestContext` Shared context for all manually triggered requests (e.g., from the web UI). .. py:attribute:: protocol :type: str :value: 'manual' .. py:class:: EstCertificateRequestContext Bases: :py:obj:`EstBaseRequestContext`, :py:obj:`BaseCertificateRequestContext` EST context for certificate enrollment requests. .. py:class:: EstRevocationRequestContext Bases: :py:obj:`EstBaseRequestContext`, :py:obj:`BaseRevocationRequestContext` EST context for certificate revocation requests. .. py:class:: CmpCertificateRequestContext Bases: :py:obj:`CmpBaseRequestContext`, :py:obj:`BaseCertificateRequestContext` CMP context for certificate enrollment requests (IR/CR). .. py:class:: CmpRevocationRequestContext Bases: :py:obj:`CmpBaseRequestContext`, :py:obj:`BaseRevocationRequestContext` CMP context for certificate revocation requests (RR). .. py:class:: ManualCredentialRequestContext Bases: :py:obj:`ManualBaseRequestContext`, :py:obj:`BaseCredentialRequestContext` Manual context for credential requests triggered from the web UI.