onboarding.models¶

This module contains models related to onboarding configurations.

Module Contents¶

class onboarding.models.AbstractPkiProtocolModel[source]¶

Extends a model for IntegerChoices stored as bitwise flags.

pki_protocol_class: type[AbstractPkiProtocolModel.T][source]¶

add_pki_protocol(pki_protocol)[source]¶

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)[source]¶

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()[source]¶

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

Return type:: None

has_pki_protocol(pki_protocol)[source]¶

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()[source]¶

Gets all allowed PkiProtocols.

Returns:: Retruns the allowed PkiProtocols as list.
Return type:: list[T]

set_pki_protocols(pki_protocols)[source]¶

Sets all allowed PkiProtocols exactly matching the provided list.

Parameters:: pki_protocols (list[T])
Return type:: None

class onboarding.models.OnboardingConfigModel(*args, **kwargs)[source]¶

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

Onboarding Configuration Model.

pki_protocol_class[source]¶

pki_protocols[source]¶

onboarding_status[source]¶

onboarding_protocol[source]¶

est_password[source]¶

cmp_shared_secret[source]¶

opc_user[source]¶

opc_password[source]¶

idevid_trust_store[source]¶

trust_store[source]¶

opc_trust_store[source]¶

save(*args, **kwargs)[source]¶

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()[source]¶

Validation before saving the model.

Return type:: None

class onboarding.models.NoOnboardingConfigModel(*args, **kwargs)[source]¶

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

No Onboarding Configuration Model.

pki_protocol_class[source]¶

pki_protocols[source]¶

est_password[source]¶

cmp_shared_secret[source]¶

trust_store[source]¶