onboarding.models

This module contains models related to onboarding configurations.

Classes

OnboardingStatus	The onboarding status.
OnboardingProtocol	Choices of onboarding protocols.
OnboardingPkiProtocol	Choices for onboarding pki protocols.
NoOnboardingPkiProtocol	Choices for no onboarding pki protocols.
AbstractPkiProtocolModel	Extends a model for IntegerChoices stored as bitwise flags.
OnboardingConfigModel	Onboarding Configuration Model.
NoOnboardingConfigModel	No Onboarding Configuration Model.

Module Contents

class onboarding.models.OnboardingStatus(*args, **kwds)

Bases: django.db.models.IntegerChoices

The onboarding status.

PENDING

ONBOARDED

class onboarding.models.OnboardingProtocol(*args, **kwds)

Bases: django.db.models.IntegerChoices

Choices of onboarding protocols.

MANUAL

CMP_IDEVID

CMP_SHARED_SECRET

EST_IDEVID

EST_USERNAME_PASSWORD

AOKI

BRSKI

OPC_GDS_PUSH

class onboarding.models.OnboardingPkiProtocol(*args, **kwds)

Bases: django.db.models.IntegerChoices

Choices for onboarding pki protocols.

CMP

EST

OPC_GDS_PUSH

class onboarding.models.NoOnboardingPkiProtocol(*args, **kwds)

Bases: django.db.models.IntegerChoices

Choices for no onboarding pki protocols.

CMP_SHARED_SECRET

EST_USERNAME_PASSWORD

MANUAL

class onboarding.models.AbstractPkiProtocolModel

Extends a model for IntegerChoices stored as bitwise flags.

pki_protocol_class: type[AbstractPkiProtocolModel.T]

add_pki_protocol(pki_protocol)

Adds the provided PkiProtocol to the allowed protocols for onboarded devices.

Parameters:

pki_protocol (T) – The PkiProtocol to allow.

Return type:

None

remove_pki_protocol(pki_protocol)

Removes the provided PkiProtocol from the allowed protocols if it is allowed..

Parameters:

pki_protocol (T) – The PkiProtocol to forbid.

Return type:

None

clear_pki_protocols()

Clears all allowed PkiProtocols, that is, it deactivates application certificate issuance.

Return type:

None

has_pki_protocol(pki_protocol)

Checks if the provided PkiProtocol is allowed.

Parameters:

pki_protocol (T) – The PkiProtocol that is checked against the allowed ones.

Returns:

Returns True if the provided PkiProtocol is allowed, False otherwise.

Return type:

bool

get_pki_protocols()

Gets all allowed PkiProtocols.

Returns:

Retruns the allowed PkiProtocols as list.

Return type:

list[T]

set_pki_protocols(pki_protocols)

Sets all allowed PkiProtocols exactly matching the provided list.

Parameters:

pki_protocols (list[T])

Return type:

None

class onboarding.models.OnboardingConfigModel(*args, **kwargs)

Bases: AbstractPkiProtocolModel[OnboardingPkiProtocol], django.db.models.Model

Onboarding Configuration Model.

pki_protocol_class

pki_protocols

onboarding_status

onboarding_protocol

est_password

cmp_shared_secret

opc_user

opc_password

idevid_trust_store

opc_trust_store

__str__()

Gets the model instance as human-readable string.

Return type:

str

save(*args, **kwargs)

Executes full_clean() before saving.

Parameters:

• *args (Any) – Positional arguments are passed to super().save().

• **kwargs (Any) – Keyword arguments are passed to super().save().

Return type:

None

clean()

Validation before saving the model.

Return type:

None

_validate_case_opc_gds_push_onboarding()

Validates case OnboardingProtocol.OPC_GDS_PUSH.

Parameters:

error_messages – The container that gathers all error messages.

Returns:

The error_messages gathered.

Return type:

dict[str, str]

_validate_case_manual_onboarding()

Validates case OnboardingProtocol.MANUAL.

Parameters:

error_messages – The container that gathers all error messages.

Returns:

The error_messages gathered.

Return type:

dict[str, str]

_validate_case_cmp_idevid_onboarding()

Validates case OnboardingProtocol.CMP_IDEVID.

Parameters:

error_messages – The container that gathers all error messages.

Returns:

The error_messages gathered.

Return type:

dict[str, str]

_validate_case_cmp_shared_secret_onboarding()

Validates case OnboardingProtocol.CMP_SHARED_SECRET.

Parameters:

error_messages – The container that gathers all error messages.

Returns:

The error_messages gathered.

Return type:

dict[str, str]

_validate_case_est_idevid_onboarding()

Validates case OnboardingProtocol.EST_IDEVID.

Parameters:

error_messages – The container that gathers all error messages.

Returns:

The error_messages gathered.

Return type:

dict[str, str]

_validate_case_est_username_password_onboarding()

Validates case OnboardingProtocol.EST_USERNAME_PASSWORD.

Parameters:

error_messages – The container that gathers all error messages.

Returns:

The error_messages gathered.

Return type:

dict[str, str]

class onboarding.models.NoOnboardingConfigModel(*args, **kwargs)

Bases: AbstractPkiProtocolModel[NoOnboardingPkiProtocol], django.db.models.Model

No Onboarding Configuration Model.

pki_protocol_class

pki_protocols

est_password

cmp_shared_secret

__str__()

Gets the model instance as human-readable string.

Return type:

str

save(*args, **kwargs)

Executes full_clean() before saving.

Parameters:

• *args (Any) – Positional arguments are passed to super().save().

• **kwargs (Any) – Keyword arguments are passed to super().save().

Return type:

None

clean()

Validation before saving the model.

Return type:

None