workflows.models

Workflow models: definitions, scopes, instances, and enrollment requests.

Attributes

StatusBadge	Tuple of (label, bootstrap_badge_class).
BADGE_MAP

Classes

State	Workflow and enrollment states.
WorkflowDefinition	Blueprint of a workflow: event, steps, transitions.
WorkflowScope	Assign a workflow to CAs, domains, or devices (NULL = any).
DeviceRequest	Represents a device lifecycle request (creation, deletion, onboarding).
EnrollmentRequest	A single logical certificate enrollment attempt (EST simpleenroll fan-out parent).
WorkflowInstance	An initialized workflows.

Functions

get_status_badge(raw)

Return a badge (label, CSS class) for a workflow/enrollment state.

Module Contents

class workflows.models.State(*args, **kwds)

Bases: django.db.models.TextChoices

Workflow and enrollment states.

RUNNING = ('Running', 'Running')

AWAITING = ('AwaitingApproval', 'AwaitingApproval')

APPROVED = ('Approved', 'Approved')

PASSED = ('Passed', 'Passed')

FINALIZED = ('Finalized', 'Finalized')

REJECTED = ('Rejected', 'Rejected')

FAILED = ('Failed', 'Failed')

ABORTED = ('Aborted', 'Aborted')

workflows.models.StatusBadge

Tuple of (label, bootstrap_badge_class).

workflows.models.BADGE_MAP: dict[str, StatusBadge]

workflows.models.get_status_badge(raw)

Return a badge (label, CSS class) for a workflow/enrollment state.

Parameters:

raw (str | State | None)

Return type:

StatusBadge

class workflows.models.WorkflowDefinition(*args, **kwargs)

Bases: django.db.models.Model

Blueprint of a workflow: event, steps, transitions.

id

name

version

published

definition

created_at

updated_at

class Meta

Database configuration for workflow definitions.

db_table = 'workflow_definitions'

ordering = ('-created_at',)

__str__()

Return human-readable representation with version.

Return type:

str

class workflows.models.WorkflowScope(*args, **kwargs)

Bases: django.db.models.Model

Assign a workflow to CAs, domains, or devices (NULL = any).

id

workflow

ca_id

domain_id

device_id

class Meta

Database configuration for Workflow Scope.

db_table = 'workflow_scopes'

unique_together = (('workflow', 'ca_id', 'domain_id', 'device_id'),)

__str__()

Return human-readable representation.

Return type:

str

class workflows.models.DeviceRequest(*args, **kwargs)

Bases: django.db.models.Model

Represents a device lifecycle request (creation, deletion, onboarding).

id

UUID primary key.

device

Target device.

domain

Domain at the time of event (may be null).

ca

CA for domain (if applicable).

action

Device action type (“created”, “onboarded”, “deleted”).

payload

Raw event payload from the handler.

aggregated_state

Aggregate state over all workflow instances.

finalized

True if all workflow instances have reached terminal states.

created_at

Request creation timestamp.

updated_at

Last update timestamp.

id

device

domain

ca

action

payload

aggregated_state

finalized

created_at

updated_at

class Meta

Database configuration for device workflow parent.

ordering = ('-created_at',)

__str__()

Return a human-readable representation of the device request.

Return type:

str

recompute_and_save()

Recompute the aggregate final state from instances.

Return type:

None

property badge_class: str

Return the CSS class for the aggregated state badge.

Return type:

str

class workflows.models.EnrollmentRequest(*args, **kwargs)

Bases: django.db.models.Model

A single logical certificate enrollment attempt (EST simpleenroll fan-out parent).

• Aggregates all child WorkflowInstances that must approve/reject this attempt.

• Identity tuple groups repeated polls for the same CSR until a terminal outcome.

• We keep request-level states distinct from instance-level strings to avoid confusion.

id

protocol

operation

device

domain

ca

fingerprint

template

aggregated_state

finalized

created_at

updated_at

class Meta

Database configuration for enrollment request.

db_table = 'enrollment_requests'

indexes

__str__()

Return human-readable representation.

Return type:

str

property badge_label: str

Return the human-readable badge label for the aggregated state.

Return type:

str

property badge_class: str

Return the CSS class for the aggregated state badge.

Return type:

str

recompute_status()

Compute aggregate status from child instances.

Returns:

The new aggregated state derived from child instance states.

Return type:

State

is_valid()

Return True if the enrollment request is in a successful terminal state.

Return type:

bool

recompute_and_save()

Recalculate the aggregated state and persist changes if it changed.

Returns:

The (possibly unchanged) aggregated state.

Return type:

State

finalize(final_status=None)

Finalize this request and all non-finalized child workflow instances.

Parameters:

final_status (str | State | None) – Optional final aggregated state to set for the request.

Return type:

None

abort()

Abort this request and all non-finalized child workflow instances.

Return type:

None

class workflows.models.WorkflowInstance(*args, **kwargs)

Bases: django.db.models.Model

An initialized workflows.

id

definition

enrollment_request

device_request

current_step

state

payload

step_contexts

finalized

created_at

updated_at

class Meta

Database configuration and indexes for workflow instances.

db_table = 'workflow_instances'

indexes

__str__()

Return a short identifier containing definition name, PK, and state.

Return type:

str

property badge_label: str

Return the human-readable badge label for this instance’s state.

Return type:

str

property badge_class: str

Return the CSS class for this instance’s state badge.

Return type:

str

finalize(state=None)

Mark this instance as fully done and optionally set a final state.

Parameters:

state (str | State | None) – Optional final state to set before marking as finalized.

Return type:

None

get_steps()

Return the ordered list of steps from the workflow definition.

Returns:

List of step dictionaries from the workflow definition JSON.

Return type:

list[dict[str, Any]]

get_current_step_index()

Return the index of self.current_step in the steps list, or raise.

Return type:

int

get_next_step()

Return the step-ID of the next step, or None if at the end.

Returns:

Step ID string of the next step, or None if there is no next step.

Return type:

str | None

is_last_approval_step()

Return True if the current step is the last Approval step in the workflow.

Return type:

bool