1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
|
import datetime
import time
import boto3
import pytest
from botocore.client import ClientError
from botocore.config import Config
from moto import mock_aws
from moto.core.utils import utcnow
from moto.s3.responses import DEFAULT_REGION_NAME
from tests import allow_aws_request
from tests.test_s3 import generate_content_md5, s3_aws_verified
from tests.test_s3.test_s3 import enable_versioning
@s3_aws_verified
@pytest.mark.aws_verified
def test_put_object_lock_on_non_versioned_bucket(bucket_name=None):
s3_client = boto3.client("s3", DEFAULT_REGION_NAME)
with pytest.raises(ClientError) as exc:
s3_client.put_object_lock_configuration(
Bucket=bucket_name,
ObjectLockConfiguration={
"ObjectLockEnabled": "Enabled",
"Rule": {"DefaultRetention": {"Mode": "COMPLIANCE", "Days": 1}},
},
)
err = exc.value.response["Error"]
assert err["Code"] == "InvalidBucketState"
assert (
err["Message"]
== "Versioning must be 'Enabled' on the bucket to apply a Object Lock configuration"
)
@s3_aws_verified
@pytest.mark.aws_verified
def test_put_object_lock_misconfiguration(bucket_name=None):
s3_client = boto3.client("s3", DEFAULT_REGION_NAME)
enable_versioning(bucket_name, s3_client)
with pytest.raises(ClientError) as exc:
s3_client.put_object_lock_configuration(Bucket=bucket_name)
err = exc.value.response["Error"]
assert err["Code"] == "MissingRequestBodyError"
assert err["Message"] == "Request Body is empty"
with pytest.raises(ClientError) as exc:
s3_client.put_object_lock_configuration(
Bucket=bucket_name, ObjectLockConfiguration={}
)
err = exc.value.response["Error"]
assert err["Code"] == "MalformedXML"
@s3_aws_verified
@pytest.mark.aws_verified
@pytest.mark.parametrize(
"bypass_governance_retention",
[True, False, None],
ids=["bypass", "no_bypass", "unspecified"],
)
def test_locked_object_governance_mode(bypass_governance_retention, bucket_name=None):
s3_client = boto3.client("s3", DEFAULT_REGION_NAME)
key_name = "file.txt"
seconds_lock = 10
enable_versioning(bucket_name, s3_client)
s3_client.put_object_lock_configuration(
Bucket=bucket_name,
ObjectLockConfiguration={
"ObjectLockEnabled": "Enabled",
"Rule": {"DefaultRetention": {"Mode": "GOVERNANCE", "Days": 1}},
},
)
until = utcnow() + datetime.timedelta(seconds=seconds_lock)
s3_client.put_object(
Bucket=bucket_name,
Body=b"test",
Key=key_name,
ObjectLockMode="GOVERNANCE",
ObjectLockRetainUntilDate=until,
ContentMD5=generate_content_md5(b"test"),
)
versions_response = s3_client.list_object_versions(Bucket=bucket_name)
initial_version_id = versions_response["Versions"][0]["VersionId"]
with pytest.raises(ClientError) as exc:
s3_client.delete_object(
Bucket=bucket_name, Key=key_name, VersionId=initial_version_id
)
err = exc.value.response["Error"]
assert err["Code"] == "AccessDenied"
kwargs = {}
if bypass_governance_retention in [True, False]:
kwargs["BypassGovernanceRetention"] = bypass_governance_retention
# Delete the object without VersionId always succeeds
response = s3_client.delete_objects(
Bucket=bucket_name,
Delete={
"Objects": [
{"Key": key_name},
],
},
**kwargs,
)
assert response["Deleted"][0]["Key"] == key_name
deleted_version_id = response["Deleted"][0]["DeleteMarkerVersionId"]
# Delete any version id only succeeds if BypassGovernanceRetention=true
response = s3_client.delete_objects(
Bucket=bucket_name,
Delete={
"Objects": [
{"Key": key_name, "VersionId": initial_version_id},
],
},
**kwargs,
)
if bypass_governance_retention:
assert "Deleted" in response
deleted_version_id = response["Deleted"][0]["VersionId"]
response = s3_client.delete_objects(
Bucket=bucket_name,
Delete={
"Objects": [
{"Key": key_name, "VersionId": deleted_version_id},
],
},
**kwargs,
)
assert response["Deleted"] == [
{"Key": key_name, "VersionId": deleted_version_id}
]
else:
# BypassGovernanceMode is either unspecified or False
assert "Errors" in response
assert response["Errors"][0]["Code"] == "AccessDenied"
assert response["Errors"][0]["Key"] == key_name
assert (
response["Errors"][0]["Message"]
== "Access Denied because object protected by object lock."
)
# We know we couldn't delete the initial version ID
# Can we delete the DeleteVersion
response = s3_client.delete_objects(
Bucket=bucket_name,
Delete={
"Objects": [
{"Key": key_name, "VersionId": deleted_version_id},
],
},
**kwargs,
)
@s3_aws_verified
@pytest.mark.aws_verified
def test_put_locked_object_with_checksum_algorithm(bucket_name=None):
s3_resource = boto3.resource("s3", DEFAULT_REGION_NAME)
s3_client = s3_resource.meta.client
key_name = "file.txt"
seconds_lock = 10
enable_versioning(bucket_name, s3_client)
s3_client.put_object_lock_configuration(
Bucket=bucket_name,
ObjectLockConfiguration={
"ObjectLockEnabled": "Enabled",
"Rule": {"DefaultRetention": {"Mode": "GOVERNANCE", "Days": 1}},
},
)
until = utcnow() + datetime.timedelta(seconds=seconds_lock)
import base64
import hashlib
sha = hashlib.sha256(b"test")
checksum = base64.b64encode(sha.digest()).decode("utf-8")
s3_client.put_object(
Bucket=bucket_name,
Body=b"test",
Key=key_name,
ObjectLockMode="GOVERNANCE",
ObjectLockRetainUntilDate=until,
ChecksumAlgorithm="SHA256",
ChecksumSHA256=checksum,
)
versions_response = s3_client.list_object_versions(Bucket=bucket_name)
version_id = versions_response["Versions"][0]["VersionId"]
version = s3_resource.ObjectVersion(bucket_name, key_name, version_id)
response = version.head(ChecksumMode="ENABLED")
assert (
response["ResponseMetadata"]["HTTPHeaders"]["x-amz-checksum-sha256"] == checksum
)
@s3_aws_verified
@pytest.mark.aws_verified
@pytest.mark.parametrize(
"bypass_governance_retention",
[True, False, None],
ids=["bypass", "no_bypass", "unspecified"],
)
def test_locked_object_compliance_mode(bypass_governance_retention, bucket_name=None):
s3_client = boto3.client("s3", DEFAULT_REGION_NAME)
key_name = "file.txt"
seconds_lock = 5 if allow_aws_request() else 2
enable_versioning(bucket_name, s3_client)
s3_client.put_object_lock_configuration(
Bucket=bucket_name,
ObjectLockConfiguration={
"ObjectLockEnabled": "Enabled",
"Rule": {"DefaultRetention": {"Mode": "GOVERNANCE", "Days": 1}},
},
)
until = utcnow() + datetime.timedelta(seconds=seconds_lock)
s3_client.put_object(
Bucket=bucket_name,
Body=b"test",
Key=key_name,
ObjectLockMode="COMPLIANCE",
ObjectLockRetainUntilDate=until,
ContentMD5=generate_content_md5(b"test"),
)
versions_response = s3_client.list_object_versions(Bucket=bucket_name)
initial_version_id = versions_response["Versions"][0]["VersionId"]
kwargs = {}
if bypass_governance_retention in [True, False]:
kwargs["BypassGovernanceRetention"] = bypass_governance_retention
# Delete the object without VersionId always succeeds
response = s3_client.delete_objects(
Bucket=bucket_name,
Delete={
"Objects": [
{"Key": key_name},
],
},
**kwargs,
)
assert response["Deleted"][0]["Key"] == key_name
# Delete any version id never succeeds in COMPLIANCE mode
response = s3_client.delete_objects(
Bucket=bucket_name,
Delete={
"Objects": [
{"Key": key_name, "VersionId": initial_version_id},
],
},
**kwargs,
)
assert "Errors" in response
assert response["Errors"][0]["Code"] == "AccessDenied"
assert response["Errors"][0]["Key"] == key_name
assert (
response["Errors"][0]["Message"]
== "Access Denied because object protected by object lock."
)
time.sleep(seconds_lock)
@mock_aws
def test_fail_locked_object():
bucket_name = "locked-bucket2"
key_name = "file.txt"
seconds_lock = 2
s3_client = boto3.client("s3", DEFAULT_REGION_NAME)
s3_client.create_bucket(Bucket=bucket_name, ObjectLockEnabledForBucket=False)
until = utcnow() + datetime.timedelta(0, seconds_lock)
failed = False
try:
s3_client.put_object(
Bucket=bucket_name,
Body=b"test",
Key=key_name,
ObjectLockMode="COMPLIANCE",
ObjectLockRetainUntilDate=until,
ContentMD5=generate_content_md5(b"test"),
)
except ClientError as exc:
assert exc.response["Error"]["Code"] == "InvalidRequest"
failed = True
assert failed is True
s3_client.delete_bucket(Bucket=bucket_name)
@mock_aws
def test_put_object_lock():
s3_client = boto3.client("s3", config=Config(region_name=DEFAULT_REGION_NAME))
bucket_name = "put-lock-bucket-test"
key_name = "file.txt"
seconds_lock = 1
s3_client.create_bucket(Bucket=bucket_name, ObjectLockEnabledForBucket=True)
s3_client.put_object(Bucket=bucket_name, Body=b"test", Key=key_name)
versions_response = s3_client.list_object_versions(Bucket=bucket_name)
version_id = versions_response["Versions"][0]["VersionId"]
until = utcnow() + datetime.timedelta(0, seconds_lock)
s3_client.put_object_retention(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id,
Retention={"Mode": "COMPLIANCE", "RetainUntilDate": until},
)
with pytest.raises(ClientError) as exc:
s3_client.delete_object(Bucket=bucket_name, Key=key_name, VersionId=version_id)
assert exc.value.response["Error"]["Code"] == "AccessDenied"
# cleaning
time.sleep(seconds_lock)
s3_client.delete_object(Bucket=bucket_name, Key=key_name, VersionId=version_id)
s3_client.delete_bucket(Bucket=bucket_name)
@s3_aws_verified
@pytest.mark.aws_verified
def test_put_object_legal_hold(bucket_name=None):
s3_client = boto3.client("s3", DEFAULT_REGION_NAME)
key_name = "file.txt"
s3_client.create_bucket(Bucket=bucket_name)
enable_versioning(bucket_name, s3_client)
s3_client.put_object_lock_configuration(
Bucket=bucket_name,
ObjectLockConfiguration={
"ObjectLockEnabled": "Enabled",
"Rule": {"DefaultRetention": {"Mode": "GOVERNANCE", "Days": 1}},
},
)
s3_client.put_object(
Bucket=bucket_name,
Body=b"test",
Key=key_name,
ContentMD5=generate_content_md5(b"test"),
)
versions_response = s3_client.list_object_versions(Bucket=bucket_name)
version_id = versions_response["Versions"][0]["VersionId"]
s3_client.put_object_legal_hold(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id,
LegalHold={"Status": "ON"},
ContentMD5=generate_content_md5(
b'<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Status>ON</Status></LegalHold>'
),
)
with pytest.raises(ClientError) as exc:
s3_client.delete_object(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id,
BypassGovernanceRetention=True,
)
err = exc.value.response["Error"]
assert err["Code"] == "AccessDenied"
# Deletion works when LegalHold is OFF
s3_client.put_object_legal_hold(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id,
LegalHold={"Status": "OFF"},
ContentMD5=generate_content_md5(
b'<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Status>OFF</Status></LegalHold>'
),
)
s3_client.delete_object(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id,
BypassGovernanceRetention=True,
)
@mock_aws
def test_put_default_lock():
# do not run this test in aws, it will block the deletion for a whole day
s3_client = boto3.client("s3", config=Config(region_name=DEFAULT_REGION_NAME))
bucket_name = "put-default-lock-bucket"
key_name = "file.txt"
days = 1
mode = "COMPLIANCE"
enabled = "Enabled"
s3_client.create_bucket(Bucket=bucket_name, ObjectLockEnabledForBucket=True)
s3_client.put_object_lock_configuration(
Bucket=bucket_name,
ObjectLockConfiguration={
"ObjectLockEnabled": enabled,
"Rule": {"DefaultRetention": {"Mode": mode, "Days": days}},
},
)
s3_client.put_object(
Bucket=bucket_name,
Body=b"test",
Key=key_name,
ContentMD5=generate_content_md5(b"test"),
)
deleted = False
versions_response = s3_client.list_object_versions(Bucket=bucket_name)
version_id = versions_response["Versions"][0]["VersionId"]
try:
s3_client.delete_object(Bucket=bucket_name, Key=key_name, VersionId=version_id)
deleted = True
except ClientError as exc:
assert exc.response["Error"]["Code"] == "AccessDenied"
assert deleted is False
response = s3_client.get_object_lock_configuration(Bucket=bucket_name)
assert response["ObjectLockConfiguration"]["ObjectLockEnabled"] == enabled
assert (
response["ObjectLockConfiguration"]["Rule"]["DefaultRetention"]["Mode"] == mode
)
assert (
response["ObjectLockConfiguration"]["Rule"]["DefaultRetention"]["Days"] == days
)
@mock_aws
def test_put_object_legal_hold_with_versions():
s3_client = boto3.client("s3", config=Config(region_name=DEFAULT_REGION_NAME))
bucket_name = "put-legal-bucket"
key_name = "file.txt"
s3_client.create_bucket(Bucket=bucket_name, ObjectLockEnabledForBucket=True)
put_obj_1 = s3_client.put_object(Bucket=bucket_name, Body=b"test", Key=key_name)
version_id_1 = put_obj_1["VersionId"]
# lock the object with the version, locking the version 1
s3_client.put_object_legal_hold(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id_1,
LegalHold={"Status": "ON"},
)
# put an object on the same key, effectively creating a version 2 of the object
put_obj_2 = s3_client.put_object(Bucket=bucket_name, Body=b"test", Key=key_name)
version_id_2 = put_obj_2["VersionId"]
# also lock the version 2 of the object
s3_client.put_object_legal_hold(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id_2,
LegalHold={"Status": "ON"},
)
# assert that the version 1 is locked
head_obj_1 = s3_client.head_object(
Bucket=bucket_name, Key=key_name, VersionId=version_id_1
)
assert head_obj_1["ObjectLockLegalHoldStatus"] == "ON"
# remove the lock from the version 1 of the object
s3_client.put_object_legal_hold(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id_1,
LegalHold={"Status": "OFF"},
)
# assert that you can now delete the version 1 of the object
s3_client.delete_object(Bucket=bucket_name, Key=key_name, VersionId=version_id_1)
with pytest.raises(ClientError) as exc:
s3_client.head_object(Bucket=bucket_name, Key=key_name, VersionId=version_id_1)
assert exc.value.response["Error"]["Code"] == "404"
# cleaning
s3_client.put_object_legal_hold(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id_2,
LegalHold={"Status": "OFF"},
)
s3_client.delete_object(Bucket=bucket_name, Key=key_name, VersionId=version_id_2)
s3_client.delete_bucket(Bucket=bucket_name)
@mock_aws
def test_put_object_lock_with_versions():
s3_client = boto3.client("s3", config=Config(region_name=DEFAULT_REGION_NAME))
bucket_name = "put-lock-bucket-test"
key_name = "file.txt"
seconds_lock = 2
s3_client.create_bucket(Bucket=bucket_name, ObjectLockEnabledForBucket=True)
put_obj_1 = s3_client.put_object(Bucket=bucket_name, Body=b"test", Key=key_name)
version_id_1 = put_obj_1["VersionId"]
put_obj_2 = s3_client.put_object(Bucket=bucket_name, Body=b"test", Key=key_name)
version_id_2 = put_obj_2["VersionId"]
until = utcnow() + datetime.timedelta(seconds=seconds_lock)
s3_client.put_object_retention(
Bucket=bucket_name,
Key=key_name,
VersionId=version_id_1,
Retention={"Mode": "COMPLIANCE", "RetainUntilDate": until},
)
# assert that you can delete the locked version 1 of the object
deleted = False
try:
s3_client.delete_object(
Bucket=bucket_name, Key=key_name, VersionId=version_id_1
)
deleted = True
except ClientError as exc:
assert exc.response["Error"]["Code"] == "AccessDenied"
assert deleted is False
# assert that you can delete the version 2 of the object, not concerned by the lock
s3_client.delete_object(Bucket=bucket_name, Key=key_name, VersionId=version_id_2)
with pytest.raises(ClientError) as exc:
s3_client.head_object(Bucket=bucket_name, Key=key_name, VersionId=version_id_2)
assert exc.value.response["Error"]["Code"] == "404"
# cleaning
time.sleep(seconds_lock)
s3_client.delete_object(Bucket=bucket_name, Key=key_name, VersionId=version_id_1)
s3_client.delete_bucket(Bucket=bucket_name)
|