b2sdk.sync.encryption_provider

class b2sdk.sync.encryption_provider.AbstractSyncEncryptionSettingsProvider

Object which provides an appropriate EncryptionSetting object for sync, i.e. complex operations with multiple sources and destinations

abstract get_setting_for_upload(bucket: b2sdk.bucket.Bucket, b2_file_name: str, file_info: Optional[dict], length: int) → Optional[b2sdk.encryption.setting.EncryptionSetting]

Return an EncryptionSetting for uploading an object or None if server should decide.

WARNING: the signature of this method is not final yet and not part of the public interface

abstract get_source_setting_for_copy(bucket: b2sdk.bucket.Bucket, source_file_version_info: b2sdk.file_version.FileVersionInfo) → Optional[b2sdk.encryption.setting.EncryptionSetting]

Return an EncryptionSetting for a source of copying an object or None if not required

WARNING: the signature of this method is not final yet and not part of the public interface

abstract get_destination_setting_for_copy(bucket: b2sdk.bucket.Bucket, dest_b2_file_name: str, source_file_version_info: b2sdk.file_version.FileVersionInfo, target_file_info: Optional[dict] = None) → Optional[b2sdk.encryption.setting.EncryptionSetting]

Return an EncryptionSetting for a destination for copying an object or None if server should decide

WARNING: the signature of this method is not final yet and not part of the public interface

abstract get_setting_for_download(bucket: b2sdk.bucket.Bucket, file_version_info: b2sdk.file_version.FileVersionInfo) → Optional[b2sdk.encryption.setting.EncryptionSetting]

Return an EncryptionSetting for downloading an object from, or None if not required

WARNING: the signature of this method is not final yet and not part of the public interface

class b2sdk.sync.encryption_provider.ServerDefaultSyncEncryptionSettingsProvider

Encryption settings provider which assumes setting-less reads and a bucket default for writes.

get_setting_for_upload(*args, **kwargs) → None

Return an EncryptionSetting for uploading an object or None if server should decide.

WARNING: the signature of this method is not final yet and not part of the public interface

get_source_setting_for_copy(*args, **kwargs) → None

Return an EncryptionSetting for a source of copying an object or None if not required

WARNING: the signature of this method is not final yet and not part of the public interface

get_destination_setting_for_copy(*args, **kwargs) → None

Return an EncryptionSetting for a destination for copying an object or None if server should decide

WARNING: the signature of this method is not final yet and not part of the public interface

get_setting_for_download(*args, **kwargs) → None

Return an EncryptionSetting for downloading an object from, or None if not required

WARNING: the signature of this method is not final yet and not part of the public interface

class b2sdk.sync.encryption_provider.BasicSyncEncryptionSettingsProvider(read_bucket_settings: Dict[str, Optional[b2sdk.encryption.setting.EncryptionSetting]], write_bucket_settings: Dict[str, Optional[b2sdk.encryption.setting.EncryptionSetting]])

Basic encryption setting provider that supports exactly one encryption setting per bucket for reading and one encryption setting per bucket for writing

WARNING: This class can be used by B2CLI for SSE-B2, but it’s still in development

get_setting_for_upload(bucket, *args, **kwargs) → Optional[b2sdk.encryption.setting.EncryptionSetting]

Return an EncryptionSetting for uploading an object or None if server should decide.

WARNING: the signature of this method is not final yet and not part of the public interface

get_source_setting_for_copy(bucket, *args, **kwargs) → None

Return an EncryptionSetting for a source of copying an object or None if not required

WARNING: the signature of this method is not final yet and not part of the public interface

get_destination_setting_for_copy(bucket, *args, **kwargs) → Optional[b2sdk.encryption.setting.EncryptionSetting]

Return an EncryptionSetting for a destination for copying an object or None if server should decide

WARNING: the signature of this method is not final yet and not part of the public interface

get_setting_for_download(bucket, *args, **kwargs) → None

Return an EncryptionSetting for downloading an object from, or None if not required

WARNING: the signature of this method is not final yet and not part of the public interface