request.request_context

This module contains the RequestContext class for managing request-specific named attributes.

Attributes

RCT

Classes

BaseRequestContext	Base class for all specific request context classes.
BaseCertificateRequestContext	Shared context for all certificate request operations.
BaseRevocationRequestContext	Shared context for all revocation request operations.
HttpBaseRequestContext	Shared context for all protocols that use HTTP(s) for message transfer.
EstBaseRequestContext	Shared context for all EST requests.
CmpBaseRequestContext	Shared context for all CMP requests.
RestBaseRequestContext	Shared context for all REST API requests.
EstCertificateRequestContext	EST context for certificate enrollment requests.
EstRevocationRequestContext	EST context for certificate revocation requests.
CmpCertificateRequestContext	CMP context for certificate enrollment requests (IR/CR).
CmpRevocationRequestContext	CMP context for certificate revocation requests (RR).

Module Contents

request.request_context.RCT

class request.request_context.BaseRequestContext

Base class for all specific request context classes.

operation: str | None = None

protocol: str | None = None

parsed_message: cryptography.x509.CertificateSigningRequest | pyasn1_modules.rfc4210.PKIMessage | None = None

domain_str: str | None = None

domain: pki.models.DomainModel | None = None

device: devices.models.DeviceModel | None = None

owner_credential: pki.models.CredentialModel | None = None

issuer_credential: pki.models.CredentialModel | None = None

client_certificate: cryptography.x509.Certificate | None = None

client_intermediate_certificate: list[cryptography.x509.Certificate] | None = None

event: workflows.events.Event | None = None

error(ext_msg, http_status=None, cmp_code=None)

Set an error message in the context.

Parameters:

• ext_msg (str | bytes | None)

• http_status (int | None)

• cmp_code (pyasn1_modules.rfc4210.PKIFailureInfo | None)

Return type:

None

to_dict()

Serialize the context to a dictionary.

Return type:

dict[str, Any]

to_http_response()

Convert the context’s HTTP response attributes to a Django HttpResponse.

Return type:

django.http.HttpResponse

narrow(child_cls, **extra)

Create a new request context of a more specific subclass, copying existing attributes.

Parameters:

• child_cls (type[RCT])

• extra (Any)

Return type:

RCT

clear()

Reset all attributes to None.

Return type:

None

__str__()

String representation showing all context fields.

Return type:

str

__repr__()

Detailed representation for debugging.

Return type:

str

class request.request_context.BaseCertificateRequestContext

Bases: BaseRequestContext

Shared context for all certificate request operations.

cert_requested: cryptography.x509.CertificateSigningRequest | cryptography.x509.base.CertificateBuilder | None = None

cert_profile_str: str | None = None

cert_requested_profile_validated: cryptography.x509.base.CertificateBuilder | None = None

issued_certificate: cryptography.x509.Certificate | None = None

certificate_profile_model: pki.models.CertificateProfileModel | None = None

enrollment_request: workflows.models.EnrollmentRequest | None = None

event: workflows.events.Event | None = None

class request.request_context.BaseRevocationRequestContext

Bases: BaseRequestContext

Shared context for all revocation request operations.

credential_to_revoke: devices.models.IssuedCredentialModel | None = None

class request.request_context.HttpBaseRequestContext

Bases: BaseRequestContext

Shared context for all protocols that use HTTP(s) for message transfer.

raw_message: django.http.HttpRequest | None = None

http_response_status: int | None = None

http_response_content: bytes | str | None = None

http_response_content_type: str | None = None

class request.request_context.EstBaseRequestContext

Bases: HttpBaseRequestContext

Shared context for all EST requests.

parsed_message: cryptography.x509.CertificateSigningRequest | None = None

est_encoding: str | None = None

est_username: str | None = None

est_password: str | None = None

class request.request_context.CmpBaseRequestContext

Bases: HttpBaseRequestContext

Shared context for all CMP requests.

parsed_message: pyasn1_modules.rfc4210.PKIMessage | None = None

cmp_shared_secret: str | None = None

error_code: pyasn1_modules.rfc4210.PKIFailureInfo | None = None

error_details: str | None = None

class request.request_context.RestBaseRequestContext

Bases: HttpBaseRequestContext

Shared context for all REST API requests.

class request.request_context.EstCertificateRequestContext

Bases: EstBaseRequestContext, BaseCertificateRequestContext

EST context for certificate enrollment requests.

class request.request_context.EstRevocationRequestContext

Bases: EstBaseRequestContext, BaseRevocationRequestContext

EST context for certificate revocation requests.

class request.request_context.CmpCertificateRequestContext

Bases: CmpBaseRequestContext, BaseCertificateRequestContext

CMP context for certificate enrollment requests (IR/CR).

class request.request_context.CmpRevocationRequestContext

Bases: CmpBaseRequestContext, BaseRevocationRequestContext

CMP context for certificate revocation requests (RR).