Object Locking and Immutability
AIStor Object Locking (“Object Retention”) enforces Write-Once Read-Many (WORM) immutability to protect versioned objects from deletion. AIStor supports both duration based object retention and indefinite legal hold retention.
AIStor Object Locking provides key data retention compliance and meets SEC17a-4(f), FINRA 4511(C), and CFTC 1.31(c)-(d) requirements as per Cohasset Associates.
Overview
AIStor versioning preserves the full history of object mutations. However, applications can explicitly delete specific object versions.
Applying a default 30 Day WORM lock to objects in the bucket ensures a minimum period of retention and protection for all object versions.
Delete operations follow normal behavior in versioned buckets, where AIStor creates a DeleteMarker
for the object.
However, non-Delete Marker versions of the object remain under the retention rules and are protected from any specific deletion or overwrite attempts.
AIStor blocks any attempt to delete a specific object version held under WORM lock. The earliest possible time after which a client may delete the version is when the lock expires.
AIStor object locking is feature and API compatible with AWS S3. This page summarizes Object Locking / Retention concepts as implemented by MinIO. See the AWS S3 documentation on How S3 Object Lock works for additional resources.
You can only enable object locking during bucket creation as per S3 behavior. You cannot enable object locking on a bucket created without locking enabled. You can then configure object retention rules at any time. Object locking requires versioning and enables the feature implicitly.
Interaction with versioning
Objects held under WORM lock are immutable until the lock expires or is explicitly lifted. Locking is per-object version, where each version is independently immutable.
If an application performs an unversioned delete operation on a locked object, the operation produces a delete marker. Attempts to explicitly delete any WORM-locked object fail with an error. Delete Markers are not eligible for protection under WORM locking. See the S3 documentation on Managing delete markers and object lifecycles for more information.
For example, consider the following bucket with GOVERNANCE Mode locking enabled by default:
$ mc ls --versions play/locking-guide
[DATETIME] 29B 62429eb1-9cb7-4dc5-b507-9cc23d0cc691 v3 PUT data.csv
[DATETIME] 32B 78b3105a-02a1-4763-8054-e66add087710 v2 PUT data.csv
[DATETIME] 23B c6b581ca-2883-41e2-9905-0a1867b535b8 v1 PUT data.csv
Attempting to perform a delete on a specific version of data.csv
fails due to the object locking settings:
$ mc rm --version-id 62429eb1-9cb7-4dc5-b507-9cc23d0cc691 play/data.csv
Removing `play/locking-guide/data.csv` (versionId=62429eb1-9cb7-4dc5-b507-9cc23d0cc691).
mc: <ERROR> Failed to remove `play/locking-guide/data.csv`.
Object, 'data.csv (Version ID=62429eb1-9cb7-4dc5-b507-9cc23d0cc691)' is
WORM protected and cannot be overwritten
Attempting to perform an unversioned delete on data.csv
succeeds and creates a new DeleteMarker
for the object:
$ mc rm play/locking-guide/data.csv
[DATETIME] 0B acce329f-ad32-46d9-8649-5fe8bf4ec6e0 v4 DEL data.csv
[DATETIME] 29B 62429eb1-9cb7-4dc5-b507-9cc23d0cc691 v3 PUT data.csv
[DATETIME] 32B 78b3105a-02a1-4763-8054-e66add087710 v2 PUT data.csv
[DATETIME] 23B c6b581ca-2883-41e2-9905-0a1867b535b8 v1 PUT data.csv
Interaction with lifecycle management
AIStor object expiration respects any active object lock and retention settings for objects covered by the expiration rule.
- For expiration rules operating on only the current object version, AIStor creates a Delete Marker for the locked object.
- For expiration rules operating on non-current object versions, AIStor can only expire the non-current versions after the retention period has passed or has been explicitly lifted (e.g. legal holds).
For example, consider the following bucket with GOVERNANCE Mode locking enabled by default for 45 days:
$ mc ls --versions play/locking-guide
[7D] 29B 62429eb1-9cb7-4dc5-b507-9cc23d0cc691 v3 PUT data.csv
[30D] 32B 78b3105a-02a1-4763-8054-e66add087710 v2 PUT data.csv
[60D] 23B c6b581ca-2883-41e2-9905-0a1867b535b8 v1 PUT data.csv
Creating an expiration rule for current objects older than 7 days results in a Delete Marker for the object:
$ mc ls --versions play/locking-guide
[0D] 0B acce329f-ad32-46d9-8649-5fe8bf4ec6e0 v4 DEL data.csv
[7D] 29B 62429eb1-9cb7-4dc5-b507-9cc23d0cc691 v3 PUT data.csv
[30D] 32B 78b3105a-02a1-4763-8054-e66add087710 v2 PUT data.csv
[60D] 23B c6b581ca-2883-41e2-9905-0a1867b535b8 v1 PUT data.csv
However, an expiration rule for non-current objects older than 7 days would only take effect after the configured WORM lock expires.
Since the bucket has a 45 day GOVERNANCE
retention set, only the v1
version of data.csv
is unlocked and therefore eligible for deletion.
Tutorials
Create bucket with object locking enabled
You must enable object locking during bucket creation as per S3 behavior.
You can create a bucket with object locking enabled using the AIStor Console, the AIStor mc
CLI, or using an S3-compatible SDK.
Configure bucket-default object retention
You can configure object locking rules (“object retention”) using the AIStor Console, the AIStor mc
CLI, or using an S3-compatible SDK.
AIStor supports setting both bucket-default and per-object retention rules.
The following examples set bucket-default retention. For per-object retention settings, defer to the documentation for the PUT
operation used by your preferred SDK.
Enable Legal Hold Retention
You can enable or disable indefinite legal hold retention for an object using the AIStor Console, the AIStor mc
CLI, or using an S3-compatible SDK.
You can place a legal hold on an object already held under a COMPLIANCE or GOVERNANCE lock. The object remains WORM locked under the legal hold even when the retention lock expires. You or another user with the necessary permissions must explicitly lift the legal hold to remove the WORM lock.
Object Retention Modes
AIStor implements the following S3 Object Locking Modes:
Mode | Summary |
---|---|
GOVERNANCE Mode | Prevents any operation that would mutate or modify the object or its locking settings by non-privileged users. Users with the s3:BypassGovernanceRetention permission on the bucket or object can modify the object or its locking settings.AIStor lifts the lock automatically after the configured retention rule duration has passed. |
COMPLIANCE Mode | Prevents any operation that would mutate or modify the object or its locking settings. No AIStor user can modify the object or its settings, including the AIStor root user. AIStor lifts the lock automatically after the configured retention rule duration has passed. |
GOVERNANCE Mode
An object under GOVERNANCE
lock is protected from write operations by non-privileged users.
GOVERNANCE
locked objects enforce managed-immutability for locked objects, where users with the s3:BypassGovernanceRetention
action can modify the locked object, change the retention duration, or lift the lock entirely.
Bypassing GOVERNANCE
retention also requires setting the x-amz-bypass-governance-retention:true
header as part of the request.
The AIStor GOVERNANCE
lock is functionally identical to the S3 GOVERNANCE mode.
COMPLIANCE Mode
An object under COMPLIANCE
lock is protected from write operations by all users, including the AIStor root user.
COMPLIANCE
locked objects enforce complete immutability for locked objects.
You cannot change or remove the lock before the configured retention duration has passed.
The AIStor COMPLIANCE
lock is functionally identical to the S3 COMPLIANCE mode.
Legal Hold
An object under legal hold is protected from write operations by all users, including the AIStor root user.
Legal holds are indefinite and enforce complete immutability for locked objects.
Only privileged users with the s3:PutObjectLegalHold
permission can set or lift the legal hold.
Legal holds apply at the object level. If you enable legal hold for a group of objects, such as the contents of a bucket, subsequently created objects in that bucket are not affected.
Legal holds are complementary to both GOVERNANCE Mode and COMPLIANCE Mode retention settings.
An object held under both legal hold and a GOVERNANCE/COMPLIANCE
retention rule remains WORM locked until the legal hold is lifted and the rule expires.
For GOVERNANCE
locked objects, the legal hold prevents mutating the object even if the user has the necessary privileges to bypass retention.