class SCHEMA_CLS(BaseSignedDataSchema):
type = fields.EnumCheckedConstant(ManifestType.FILE_MANIFEST,
required=True)
id = EntryIDField(required=True)
parent = EntryIDField(required=True)
# Version 0 means the data is not synchronized
version = fields.Integer(required=True, validate=validate.Range(min=0))
created = fields.DateTime(required=True)
updated = fields.DateTime(required=True)
size = fields.Integer(required=True, validate=validate.Range(min=0))
blocksize = fields.Integer(required=True,
validate=validate.Range(min=8))
blocks = fields.FrozenList(fields.Nested(BlockAccess.SCHEMA_CLS),
required=True)
@pre_load
def fix_legacy(self, data):
# Compatibility with versions <= 1.14
if data["author"] is None:
data["author"] = LOCAL_AUTHOR_LEGACY_PLACEHOLDER
return data
@post_load
def make_obj(self, data):
data.pop("type")
return FileManifest(**data)
class EventsRealmVlobsUpdatedRepSchema(BaseRepSchema):
event = fields.EnumCheckedConstant(APIEvent.REALM_VLOBS_UPDATED,
required=True)
realm_id = fields.UUID(required=True)
checkpoint = fields.Integer(required=True)
src_id = fields.UUID(required=True)
src_version = fields.Integer(required=True)
class SCHEMA_CLS(BaseSchema):
id = BlockIDField(required=True)
key = fields.SecretKey(required=True)
offset = fields.Integer(required=True, validate=validate.Range(min=0))
size = fields.Integer(required=True, validate=validate.Range(min=0))
digest = fields.HashDigest(required=True)
@post_load
def make_obj(self, data):
return BlockAccess(**data)
class SCHEMA_CLS(BaseSchema):
id = ChunkIDField(required=True)
start = fields.Integer(required=True, validate=validate.Range(min=0))
stop = fields.Integer(required=True, validate=validate.Range(min=1))
raw_offset = fields.Integer(required=True,
validate=validate.Range(min=0))
raw_size = fields.Integer(required=True,
validate=validate.Range(min=1))
access = fields.Nested(BlockAccess.SCHEMA_CLS,
required=True,
allow_none=True)
@post_load
def make_obj(self, data):
return Chunk(**data)
class RealmStartReencryptionMaintenanceReqSchema(BaseReqSchema):
realm_id = fields.UUID(required=True)
encryption_revision = fields.Integer(required=True)
timestamp = fields.DateTime(required=True)
per_participant_message = fields.Map(UserIDField(),
fields.Bytes(required=True),
required=True)
class SCHEMA_CLS(BaseSignedDataSchema):
type = fields.EnumCheckedConstant(ManifestType.WORKSPACE_MANIFEST,
required=True)
id = EntryIDField(required=True)
# Version 0 means the data is not synchronized
version = fields.Integer(required=True, validate=validate.Range(min=0))
created = fields.DateTime(required=True)
updated = fields.DateTime(required=True)
children = fields.FrozenMap(
EntryNameField(validate=validate.Length(min=1, max=256)),
EntryIDField(required=True),
required=True,
)
@pre_load
def fix_legacy(self, data):
# Compatibility with versions <= 1.14
if data["author"] is None:
data["author"] = LOCAL_AUTHOR_LEGACY_PLACEHOLDER
return data
@post_load
def make_obj(self, data):
data.pop("type")
return WorkspaceManifest(**data)
class SCHEMA_CLS(BaseSchema):
type = fields.EnumCheckedConstant(
LocalManifestType.LOCAL_FILE_MANIFEST, required=True)
base = fields.Nested(RemoteFileManifest.SCHEMA_CLS, required=True)
need_sync = fields.Boolean(required=True)
updated = fields.DateTime(required=True)
size = fields.Integer(required=True, validate=validate.Range(min=0))
blocksize = fields.Integer(required=True,
validate=validate.Range(min=8))
blocks = fields.FrozenList(fields.FrozenList(
fields.Nested(Chunk.SCHEMA_CLS)),
required=True)
@post_load
def make_obj(self, data):
data.pop("type")
return LocalFileManifest(**data)
class VlobCreateReqSchema(BaseReqSchema):
realm_id = fields.UUID(required=True)
encryption_revision = fields.Integer(required=True)
vlob_id = fields.UUID(required=True)
# If blob contains a signed message, it timestamp cannot be directly enforced
# by the backend (given the message is probably also encrypted).
# Hence the timestamp is passed in clear so backend can reject the message
# if it considers the timestamp invalid. On top of that each client asking
# for the message will receive the declared timestamp to check against
# the actual timestamp within the message.
timestamp = fields.DateTime(required=True)
blob = fields.Bytes(required=True)
class SCHEMA_CLS(OneOfSchema, BaseSignedDataSchema):
type_field = "type"
version = fields.Integer(required=True, validate=validate.Range(min=0))
@property
def type_schemas(self):
return {
ManifestType.FILE_MANIFEST: FileManifest.SCHEMA_CLS,
ManifestType.FOLDER_MANIFEST: FolderManifest.SCHEMA_CLS,
ManifestType.WORKSPACE_MANIFEST: WorkspaceManifest.SCHEMA_CLS,
ManifestType.USER_MANIFEST: UserManifest.SCHEMA_CLS,
}
def get_obj_type(self, obj):
return obj["type"]
class SCHEMA_CLS(BaseSignedDataSchema):
type = fields.EnumCheckedConstant(ManifestType.USER_MANIFEST,
required=True)
id = EntryIDField(required=True)
# Version 0 means the data is not synchronized
version = fields.Integer(required=True, validate=validate.Range(min=0))
created = fields.DateTime(required=True)
updated = fields.DateTime(required=True)
last_processed_message = fields.Integer(required=True,
validate=validate.Range(min=0))
workspaces = fields.List(fields.Nested(WorkspaceEntry.SCHEMA_CLS),
required=True)
@pre_load
def fix_legacy(self, data):
# Compatibility with versions <= 1.14
if data["author"] is None:
data["author"] = LOCAL_AUTHOR_LEGACY_PLACEHOLDER
return data
@post_load
def make_obj(self, data):
data.pop("type")
return UserManifest(**data)
class SCHEMA_CLS(BaseSchema):
type = fields.EnumCheckedConstant(
LocalManifestType.LOCAL_USER_MANIFEST, required=True)
base = fields.Nested(RemoteUserManifest.SCHEMA_CLS, required=True)
need_sync = fields.Boolean(required=True)
updated = fields.DateTime(required=True)
last_processed_message = fields.Integer(required=True,
validate=validate.Range(min=0))
workspaces = fields.FrozenList(fields.Nested(
WorkspaceEntry.SCHEMA_CLS),
required=True)
@post_load
def make_obj(self, data):
data.pop("type")
return LocalUserManifest(**data)
class SCHEMA_CLS(BaseSignedDataSchema):
type = fields.EnumCheckedConstant(MessageContentType.SHARING_GRANTED,
required=True)
name = fields.String(required=True)
author = DeviceIDField(required=True, allow_none=False)
id = EntryIDField(required=True)
encryption_revision = fields.Integer(required=True)
encrypted_on = fields.DateTime(required=True)
key = fields.SecretKey(required=True)
# Don't include role given the only reliable way to get this information
# is to fetch the realm role certificate from the backend.
# Besides, we will also need the message sender's realm role certificate
# to make sure he is an owner.
@post_load
def make_obj(self, data):
data.pop("type")
return SharingGrantedMessageContent(**data)
class VlobReadRepSchema(BaseRepSchema):
version = fields.Integer(required=True, validate=_validate_version)
blob = fields.Bytes(required=True)
author = DeviceIDField(required=True)
timestamp = fields.DateTime(required=True)
class VlobReadReqSchema(BaseReqSchema):
encryption_revision = fields.Integer(required=True)
vlob_id = fields.UUID(required=True)
version = fields.Integer(validate=lambda n: n is None or _validate_version(n), missing=None)
timestamp = fields.DateTime(allow_none=True, missing=None)
class RealmFinishReencryptionMaintenanceReqSchema(BaseReqSchema):
realm_id = fields.UUID(required=True)
encryption_revision = fields.Integer(required=True)
class VlobMaintenanceSaveReencryptionBatchRepSchema(BaseRepSchema):
total = fields.Integer(required=True)
done = fields.Integer(required=True)
class VlobMaintenanceSaveReencryptionBatchReqSchema(BaseReqSchema):
realm_id = fields.UUID(required=True)
encryption_revision = fields.Integer(required=True)
batch = fields.List(fields.Nested(ReencryptionBatchEntrySchema), required=True)
class MessageGetReqSchema(BaseReqSchema):
offset = fields.Integer(required=True, validate=lambda n: n >= 0)
class VlobPollChangesRepSchema(BaseRepSchema):
changes = fields.Map(fields.UUID(), fields.Integer(required=True), required=True)
current_checkpoint = fields.Integer(required=True)
class APIV1_UserFindRepSchema(BaseRepSchema):
results = fields.List(UserIDField())
page = fields.Int(validate=lambda n: n > 0)
per_page = fields.Integer(validate=lambda n: 0 < n <= 100)
total = fields.Int(validate=lambda n: n >= 0)
class APIV1_UserFindReqSchema(BaseReqSchema):
query = fields.String(missing=None)
omit_revoked = fields.Boolean(missing=False)
page = fields.Int(missing=1, validate=lambda n: n > 0)
per_page = fields.Integer(missing=100, validate=lambda n: 0 < n <= 100)
class HumanFindRepSchema(BaseRepSchema):
results = fields.List(fields.Nested(HumanFindResultItemSchema, required=True))
page = fields.Int(validate=lambda n: n > 0)
per_page = fields.Integer(validate=lambda n: 0 < n <= 100)
total = fields.Int(validate=lambda n: n >= 0)
class RealmStatusRepSchema(BaseRepSchema):
in_maintenance = fields.Boolean(required=True)
maintenance_type = MaintenanceTypeField(allow_none=True)
maintenance_started_on = fields.DateTime(required=True, allow_none=True)
maintenance_started_by = DeviceIDField(required=True, allow_none=True)
encryption_revision = fields.Integer(required=True)
class RealmStatsRepSchema(BaseRepSchema):
blocks_size = fields.Integer(required=True)
vlobs_size = fields.Integer(required=True)
class VlobUpdateReqSchema(BaseReqSchema):
encryption_revision = fields.Integer(required=True)
vlob_id = fields.UUID(required=True)
timestamp = fields.DateTime(required=True)
version = fields.Integer(required=True, validate=_validate_version)
blob = fields.Bytes(required=True)
class VlobMaintenanceGetReencryptionBatchReqSchema(BaseReqSchema):
realm_id = fields.UUID(required=True)
encryption_revision = fields.Integer(required=True)
size = fields.Integer(required=True, validate=validate.Range(min=0, max=1000))
class VlobPollChangesReqSchema(BaseReqSchema):
realm_id = fields.UUID(required=True)
last_checkpoint = fields.Integer(required=True)
class ReencryptionBatchEntrySchema(BaseSchema):
vlob_id = fields.UUID(required=True)
version = fields.Integer(required=True, validate=validate.Range(min=0))
blob = fields.Bytes(required=True)
class VlobListVersionsRepSchema(BaseRepSchema):
versions = fields.Map(
fields.Integer(required=True),
fields.Tuple(fields.DateTime(required=True), DeviceIDField(required=True)),
required=True,
)
class MessageSchema(BaseSchema):
count = fields.Integer(required=True)
sender = DeviceIDField(required=True)
timestamp = fields.DateTime(required=True)
body = fields.Bytes(required=True)
