class SCHEMA_CLS(BaseSignedDataSchema):
# Override author field to allow for None value if signed by the root key
author = DeviceIDField(required=True, allow_none=True)
type = fields.CheckedConstant("device_certificate", required=True)
device_id = DeviceIDField(required=True)
# Device label can be none in case of redacted certificate
device_label = fields.String(allow_none=True, missing=None)
verify_key = fields.VerifyKey(required=True)
@post_load
def make_obj(self, data: Dict[str, Any]) -> "DeviceCertificateContent":
data.pop("type")
return DeviceCertificateContent(**data)
class SCHEMA_CLS(BaseSignedDataSchema):
# Override author field to allow for None value if signed by the root key
author = DeviceIDField(required=True, allow_none=True)
type = fields.CheckedConstant("user_certificate", required=True)
user_id = UserIDField(required=True)
# Human handle can be none in case of redacted certificate
human_handle = HumanHandleField(allow_none=True, missing=None)
public_key = fields.PublicKey(required=True)
# `profile` replaces `is_admin` field (which is still required for backward
# compatibility), hence `None` is not allowed
is_admin = fields.Boolean(required=True)
profile = UserProfileField(allow_none=False)
@post_load
def make_obj(self, data: Dict[str, Any]) -> "UserCertificateContent":
data.pop("type")
# Handle legacy `is_admin` field
default_profile = UserProfile.ADMIN if data.pop("is_admin") else UserProfile.STANDARD
try:
profile = data["profile"]
except KeyError:
data["profile"] = default_profile
else:
if default_profile == UserProfile.ADMIN and profile != UserProfile.ADMIN:
raise ValidationError(
"Fields `profile` and `is_admin` have incompatible values"
)
return UserCertificateContent(**data)
class SCHEMA_CLS(BaseSchema):
organization_addr = BackendOrganizationAddrField(required=True)
device_id = DeviceIDField(required=True)
device_label = fields.String(allow_none=True, missing=None)
human_handle = HumanHandleField(allow_none=True, missing=None)
signing_key = fields.SigningKey(required=True)
private_key = fields.PrivateKey(required=True)
# `profile` replaces `is_admin` field (which is still required for backward
# compatibility), hence `None` is not allowed
is_admin = fields.Boolean(required=True)
profile = UserProfileField(allow_none=False)
user_manifest_id = EntryIDField(required=True)
user_manifest_key = fields.SecretKey(required=True)
local_symkey = fields.SecretKey(required=True)
@post_load
def make_obj(self, data):
# Handle legacy `is_admin` field
default_profile = UserProfile.ADMIN if data.pop(
"is_admin") else UserProfile.STANDARD
try:
profile = data["profile"]
except KeyError:
data["profile"] = default_profile
else:
if default_profile == UserProfile.ADMIN and profile != UserProfile.ADMIN:
raise ValidationError(
"Fields `profile` and `is_admin` have incompatible values"
)
return LocalDevice(**data)
class DeviceCreatedSchema(BaseSchema):
__id__ = fields.String(required=True)
__signal__ = fields.EnumCheckedConstant(BackendEvent.DEVICE_CREATED,
required=True)
organization_id = OrganizationIDField(required=True)
device_id = DeviceIDField(required=True)
device_certificate = fields.Bytes(required=True)
encrypted_answer = fields.Bytes(required=True)
class MessageReceivedSchema(BaseSchema):
__id__ = fields.String(required=True)
__signal__ = fields.EnumCheckedConstant(BackendEvent.MESSAGE_RECEIVED,
required=True)
organization_id = OrganizationIDField(required=True)
author = DeviceIDField(required=True)
recipient = UserIDField(required=True)
index = fields.Integer(required=True)
class RealmMaintenanceStartedSchema(BaseSchema):
__id__ = fields.String(required=True)
__signal__ = fields.EnumCheckedConstant(
BackendEvent.REALM_MAINTENANCE_STARTED, required=True)
organization_id = OrganizationIDField(required=True)
author = DeviceIDField(required=True)
realm_id = RealmIDField(required=True)
encryption_revision = fields.Integer(required=True)
class RealmRolesUpdatedSchema(BaseSchema):
__id__ = fields.String(required=True)
__signal__ = fields.EnumCheckedConstant(BackendEvent.REALM_ROLES_UPDATED,
required=True)
organization_id = OrganizationIDField(required=True)
author = DeviceIDField(required=True)
realm_id = RealmIDField(required=True)
user = UserIDField(required=True)
role = RealmRoleField(required=True, allow_none=True)
class SCHEMA_CLS(BaseSignedDataSchema):
type = fields.CheckedConstant("device_certificate", required=True)
device_id = DeviceIDField(required=True)
verify_key = fields.VerifyKey(required=True)
@post_load
def make_obj(self, data):
data.pop("type")
return DeviceCertificateContent(**data)
class UserCreatedSchema(BaseSchema):
__id__ = fields.String(required=True)
__signal__ = fields.EnumCheckedConstant(BackendEvent.USER_CREATED,
required=True)
organization_id = OrganizationIDField(required=True)
user_id = UserIDField(required=True)
user_certificate = fields.Bytes(required=True)
first_device_id = DeviceIDField(required=True)
first_device_certificate = fields.Bytes(required=True)
class RealmVlobsUpdatedSchema(BaseSchema):
__id__ = fields.String(required=True)
__signal__ = fields.EnumCheckedConstant(BackendEvent.REALM_VLOBS_UPDATED,
required=True)
organization_id = OrganizationIDField(required=True)
author = DeviceIDField(required=True)
realm_id = RealmIDField(required=True)
checkpoint = fields.Integer(required=True)
src_id = VlobIDField(required=True)
src_version = fields.Integer(required=True)
class SCHEMA_CLS(BaseSchema):
type = fields.CheckedConstant("device_claim", required=True)
token = fields.String(required=True)
device_id = DeviceIDField(required=True)
verify_key = fields.VerifyKey(required=True)
answer_public_key = fields.PublicKey(required=True)
@post_load
def make_obj(self, data):
data.pop("type")
return DeviceClaimContent(**data)
class SCHEMA_CLS(BaseSignedDataSchema):
type = fields.CheckedConstant("device_certificate", required=True)
device_id = DeviceIDField(required=True)
verify_key = fields.VerifyKey(required=True)
# Device label can be none in case of redacted certificate
device_label = fields.String(allow_none=True, missing=None)
@post_load
def make_obj(self, data):
data.pop("type")
return DeviceCertificateContent(**data)
class SCHEMA_CLS(BaseSchema):
type = fields.CheckedConstant("invite_user_confirmation", required=True)
device_id = DeviceIDField(required=True)
device_label = fields.String(allow_none=True, missing=None)
human_handle = HumanHandleField(allow_none=True, missing=None)
profile = UserProfileField(required=True)
root_verify_key = fields.VerifyKey(required=True)
@post_load
def make_obj(self, data):
data.pop("type")
return InviteUserConfirmation(**data)
class DeviceFileSchema(LegacyDeviceFileSchema):
"""Schema for device files that does not rely on the filename for complementary information."""
# Override those fields to make them required (although `None` is still valid)
human_handle = HumanHandleField(required=True, allow_none=True)
device_label = fields.String(required=True, allow_none=True)
# Store device ID, organization ID and slug in the device file
# For legacy versions, this information is available in the file name
device_id = DeviceIDField(required=True)
organization_id = OrganizationIDField(required=True)
slug = fields.String(required=True)
class SCHEMA_CLS(BaseSchema):
type = fields.CheckedConstant("user_claim", required=True)
token = fields.String(required=True)
# Note claiming user also imply creating a first device
device_id = DeviceIDField(required=True)
public_key = fields.PublicKey(required=True)
verify_key = fields.VerifyKey(required=True)
@post_load
def make_obj(self, data: Dict[str, Any]) -> "APIV1_UserClaimContent": # type: ignore[misc]
data.pop("type")
return APIV1_UserClaimContent(**data)
class SCHEMA_CLS(BaseSchema):
type = fields.CheckedConstant("device_claim", required=True)
token = fields.String(required=True)
device_id = DeviceIDField(required=True)
verify_key = fields.VerifyKey(required=True)
answer_public_key = fields.PublicKey(required=True)
@post_load
def make_obj( # type: ignore[misc]
self, data: Dict[str, Any]
) -> "APIV1_DeviceClaimContent":
data.pop("type")
return APIV1_DeviceClaimContent(**data)
class SCHEMA_CLS(BaseSchema):
type = fields.CheckedConstant("pki_enrollment_answer_payload",
required=True)
device_id = DeviceIDField(required=True)
device_label = DeviceLabelField(allow_none=True, required=True)
human_handle = HumanHandleField(allow_none=True, required=True)
profile = UserProfileField(required=True)
root_verify_key = fields.VerifyKey(required=True)
@post_load
def make_obj(self, data: Dict[str,
Any]) -> "PkiEnrollmentAcceptPayload":
data.pop("type")
return PkiEnrollmentAcceptPayload(**data)
class SCHEMA_CLS(BaseSchema):
organization_addr = BackendOrganizationAddrField(required=True)
device_id = DeviceIDField(required=True)
signing_key = fields.SigningKey(required=True)
private_key = fields.PrivateKey(required=True)
is_admin = fields.Boolean(required=True)
user_manifest_id = EntryIDField(required=True)
user_manifest_key = fields.SecretKey(required=True)
local_symkey = fields.SecretKey(required=True)
human_handle = HumanHandleField(allow_none=True, missing=None)
@post_load
def make_obj(self, data):
return LocalDevice(**data)
class SCHEMA_CLS(BaseSchema):
type = fields.CheckedConstant("invite_user_confirmation",
required=True)
device_id = DeviceIDField(required=True)
device_label = DeviceLabelField(required=True, allow_none=True)
human_handle = HumanHandleField(required=True, allow_none=True)
profile = UserProfileField(required=True)
root_verify_key = fields.VerifyKey(required=True)
@post_load
def make_obj(
self, data: Dict[str, Any]
) -> "InviteUserConfirmation": # type: ignore[misc]
data.pop("type")
return InviteUserConfirmation(**data)
class SCHEMA_CLS(BaseSchema):
type = fields.CheckedConstant("invite_device_confirmation",
required=True)
device_id = DeviceIDField(required=True)
device_label = fields.String(allow_none=True, missing=None)
human_handle = HumanHandleField(allow_none=True, missing=None)
profile = UserProfileField(required=True)
private_key = fields.PrivateKey(required=True)
user_manifest_id = EntryIDField(required=True)
user_manifest_key = fields.SecretKey(required=True)
root_verify_key = fields.VerifyKey(required=True)
@post_load
def make_obj( # type: ignore[misc]
self, data: Dict[str, Any]) -> "InviteDeviceConfirmation":
data.pop("type")
return InviteDeviceConfirmation(**data)
class BaseSignedDataSchema(BaseSchema):
author = DeviceIDField(required=True, allow_none=False)
timestamp = fields.DateTime(required=True)
class PingedSchema(BaseSchema):
__id__ = fields.String(required=True)
__signal__ = fields.EnumCheckedConstant(BackendEvent.PINGED, required=True)
organization_id = OrganizationIDField(required=True)
author = DeviceIDField(required=True)
ping = fields.String(required=True)
