Files
versitygw/tests/integration/PutObject.go
T
niksis02 d21828ea71 fix: store posix object keys with Windows-invalid characters under encoded names on Windows
Fixes #2513

On Windows the posix backend stored a key as `bucket/key` verbatim, but Windows rejects `" * : < > ? \ |` and control characters in file names, so such a PUT failed with `ERROR_INVALID_NAME`, which `isErrNameTooLong` reported as a misleading `KeyTooLongError`. The same mapping did worse elsewhere: `\` acted as a path separator, so `a\b` aliased `a/b` and `..\..\x` resolved outside the bucket because `IsObjectNameValid` only splits on `/`; `a:b` wrote an NTFS alternate data stream; Win32 strips a trailing dot or space, so `foo.` overwrote `foo`; and device names such as `CON` or `nul.txt` opened the device and silently discarded the data.

With `encodeKeys`, enabled by default only on Windows, `encodeKey` stores each key segment under a name Windows accepts: every invalid character, a trailing dot or space, and the first letter of a device name are stored as the private use character `U+F000` plus the character code, the convention Cygwin and WSL use for invalid characters. A key character in `U+F000`-`U+F07F` is stored after `U+F000`, so every stored name belongs to exactly one key. Device names are checked with `filepath.IsLocal`, which asks the system, so `CON.txt` stays a plain file on Windows 11 where it is valid. Keys that need no encoding keep their names, so existing data is unaffected, and nothing changes on other platforms.

Public backend methods keep taking raw keys and encode them once for every path, metadata, version-hash and publish-lock use, while responses, errors and the multipart `objname` attribute keep the raw key and multipart upload directories keep hashing it. Listings walk `bucketFS`, which decodes the entry names, sorts them in key byte order to match S3 and skips names no key is stored under. `HeadObject` passes the raw key to `GetObjectLegalHold` and `GetObjectRetention` to avoid encoding twice, and `NormalizeObjectKey` resolves the encoded key, so policy resources see `a\b` as one literal key.
2026-10-13 18:32:56 +02:00

1987 lines
64 KiB
Go

// Copyright 2023 Versity Software
// This file is licensed under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package integration
import (
"bytes"
"context"
"crypto/md5"
"encoding/base64"
"fmt"
"net/http"
"sort"
"strings"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
v4 "github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/versity/versitygw/s3err"
"golang.org/x/sync/errgroup"
)
func PutObject_non_existing_bucket(s *S3Conf) error {
testName := "PutObject_non_existing_bucket"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
_, err := putObjects(s3client, []string{"my-obj"}, "non-existing-bucket")
if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrNoSuchBucket)); err != nil {
return err
}
return nil
})
}
func PutObject_special_chars(s *S3Conf) error {
testName := "PutObject_special_chars"
objnames := []string{
"my!key", "my-key", "my_key", "my.key", "my'key", "my(key", "my)key",
"my&key", "my@key", "my=key", "my;key", "my:key", "my key", "my,key",
"my?key", "my^key", "my{}key", "my%key", "my`key",
"my[]key", "my~key", "my<>key", "my|key", "my#key",
}
if !s.azureTests {
// azure cannot handle backslashes in object names
objnames = append(objnames, "my\\key")
}
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
objs, err := putObjects(s3client, objnames, bucket)
if err != nil {
return err
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := s3client.ListObjectsV2(ctx, &s3.ListObjectsV2Input{
Bucket: &bucket,
})
cancel()
if err != nil {
return err
}
if !compareObjects(objs, res.Contents) {
return fmt.Errorf("expected the objects to be %vß, instead got %v",
objStrings(objs), objStrings(res.Contents))
}
return nil
})
}
func PutObject_tagging(s *S3Conf) error {
testName := "PutObject_tagging"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
testTagging := func(object, taggging string, result map[string]string, expectedErr error) error {
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &object,
Tagging: &taggging,
})
cancel()
if err == nil && expectedErr != nil {
return fmt.Errorf("expected err %w, instead got nil", expectedErr)
}
if err != nil {
if expectedErr == nil {
return err
}
switch eErr := expectedErr.(type) {
case s3err.S3Error:
return checkApiErr(err, eErr)
default:
return fmt.Errorf("invalid err provided: %w", expectedErr)
}
}
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
res, err := s3client.GetObjectTagging(ctx, &s3.GetObjectTaggingInput{
Bucket: &bucket,
Key: &object,
})
cancel()
if err != nil {
return err
}
if len(res.TagSet) != len(result) {
return fmt.Errorf("tag lengths are not equal: (expected): %v, (got): %v", len(result), len(res.TagSet))
}
for _, tag := range res.TagSet {
val, ok := result[getString(tag.Key)]
if !ok {
return fmt.Errorf("tag key not found: %v", getString(tag.Key))
}
if val != getString(tag.Value) {
return fmt.Errorf("expected the %v tag value to be %v, instead got %v", getString(tag.Key), val, getString(tag.Value))
}
}
return nil
}
fileObj, dirObj := "file-object", "dir-object/"
elevenTags := make([]string, 0, 11)
for i := range 11 {
elevenTags = append(elevenTags, fmt.Sprintf("key%v=val", i))
}
for i, el := range []struct {
tagging string
result map[string]string
expectedErr error
}{
// success cases
{"&", map[string]string{}, nil},
{"&&&", map[string]string{}, nil},
{"key", map[string]string{"key": ""}, nil},
{"key&", map[string]string{"key": ""}, nil},
{"key=&", map[string]string{"key": ""}, nil},
{"key=val&", map[string]string{"key": "val"}, nil},
{"key1&key2", map[string]string{"key1": "", "key2": ""}, nil},
{"key1=val1&key2=val2", map[string]string{"key1": "val1", "key2": "val2"}, nil},
{"key@=val@", map[string]string{"key@": "val@"}, nil},
// invalid url-encoded
{"=", nil, s3err.GetInvalidArgumentErr(s3err.InvalidArgURLEncodedTagging, "=")},
{"key%", nil, s3err.GetInvalidArgumentErr(s3err.InvalidArgURLEncodedTagging, "key%")},
// duplicate keys
{"key=val&key=val", nil, s3err.GetInvalidArgumentErr(s3err.InvalidArgURLEncodedTagging, "key=val&key=val")},
// the length limits apply to the unescaped key and value
{strings.Repeat("k", 126) + "%41%41=val", map[string]string{strings.Repeat("k", 126) + "AA": "val"}, nil},
{strings.Repeat("k", 127) + "%41%41=val", nil, s3err.GetAPIError(s3err.ErrInvalidTagKey)},
{"key=" + strings.Repeat("v", 254) + "%41%41", map[string]string{"key": strings.Repeat("v", 254) + "AA"}, nil},
{"key=" + strings.Repeat("v", 255) + "%41%41", nil, s3err.GetAPIError(s3err.ErrInvalidTagValue)},
// tag count limit
{strings.Join(elevenTags, "&"), nil, s3err.GetAPIError(s3err.ErrObjectTaggingLimited)},
// invalid tag keys
{"key?=val", nil, s3err.GetAPIError(s3err.ErrInvalidTagKey)},
{"key(=val", nil, s3err.GetAPIError(s3err.ErrInvalidTagKey)},
{"key*=val", nil, s3err.GetAPIError(s3err.ErrInvalidTagKey)},
{"key$=val", nil, s3err.GetAPIError(s3err.ErrInvalidTagKey)},
{"key#=val", nil, s3err.GetAPIError(s3err.ErrInvalidTagKey)},
{"key!=val", nil, s3err.GetAPIError(s3err.ErrInvalidTagKey)},
// invalid tag values
{"key=val?", nil, s3err.GetAPIError(s3err.ErrInvalidTagValue)},
{"key=val(", nil, s3err.GetAPIError(s3err.ErrInvalidTagValue)},
{"key=val*", nil, s3err.GetAPIError(s3err.ErrInvalidTagValue)},
{"key=val$", nil, s3err.GetAPIError(s3err.ErrInvalidTagValue)},
{"key=val#", nil, s3err.GetAPIError(s3err.ErrInvalidTagValue)},
{"key=val!", nil, s3err.GetAPIError(s3err.ErrInvalidTagValue)},
// success special chars
{"key-key_key.key/key=value-value_value.value/value", map[string]string{"key-key_key.key/key": "value-value_value.value/value"}, nil},
// should handle supported encoded characters
{"key%2E=value%2F", map[string]string{"key.": "value/"}, nil},
{"key%2D=value%2B", map[string]string{"key-": "value+"}, nil},
{"key++key=value++value", map[string]string{"key key": "value value"}, nil},
{"key%20key=value%20value", map[string]string{"key key": "value value"}, nil},
{"key%5Fkey=value%5Fvalue", map[string]string{"key_key": "value_value"}, nil},
} {
if s.azureTests {
// azure doesn't support '@' character
if strings.Contains(el.tagging, "@") {
continue
}
}
// once test for file object
err := testTagging(fileObj, el.tagging, el.result, el.expectedErr)
if err != nil {
return fmt.Errorf("test case %v failed for file object: %w", i+1, err)
}
// the test for directory object
err = testTagging(dirObj, el.tagging, el.result, el.expectedErr)
if err != nil {
return fmt.Errorf("test case %v failed for directory object: %w", i+1, err)
}
}
return nil
})
}
func PutObject_tagging_invalid_argument_value(s *S3Conf) error {
testName := "PutObject_tagging_invalid_argument_value"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
// the error echoes the whole header, not only the failing tag
for i, tagging := range []string{"=val", "key=val&=val", "key=a&key=b", "key=val&key%=val"} {
req, err := createSignedReq(http.MethodPut, s.endpoint, fmt.Sprintf("%v/my-obj", bucket), s.awsID, s.awsSecret, "s3", s.awsRegion, "", nil, time.Now(), map[string]string{
"x-amz-tagging": tagging,
})
if err != nil {
return fmt.Errorf("test %v: err signing the request: %w", i+1, err)
}
resp, err := s.httpClient.Do(req)
if err != nil {
return fmt.Errorf("test %v: err sending request: %w", i+1, err)
}
if err := checkHTTPResponseApiErr(resp, s3err.GetInvalidArgumentErr(s3err.InvalidArgURLEncodedTagging, tagging)); err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
}
return nil
})
}
func PutObject_missing_object_lock_retention_config(s *S3Conf) error {
testName := "PutObject_missing_object_lock_retention_config"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
key := "my-obj"
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &key,
ObjectLockMode: types.ObjectLockModeCompliance,
})
cancel()
if err := checkSdkApiErr(err, "InvalidArgument"); err != nil {
return err
}
// client sdk regression issue prevents getting full error message,
// change back to below once this is fixed:
// https://github.com/aws/aws-sdk-go-v2/issues/2921
// if err := checkApiErr(err, s3err.GetInvalidArgumentErr(s3err.InvalidArgMissingObjectLockRetainDate, "")); err != nil {
// return err
// }
retainDate := time.Now().Add(time.Hour * 48)
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
_, err = s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &key,
ObjectLockRetainUntilDate: &retainDate,
})
cancel()
if err := checkSdkApiErr(err, "InvalidArgument"); err != nil {
return err
}
// client sdk regression issue prevents getting full error message,
// change back to below once this is fixed:
// https://github.com/aws/aws-sdk-go-v2/issues/2921
// if err := checkApiErr(err, s3err.GetInvalidArgumentErr(s3err.InvalidArgMissingObjectLockMode, "")); err != nil {
// return err
// }
return nil
})
}
func PutObject_with_object_lock(s *S3Conf) error {
testName := "PutObject_with_object_lock"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
retainUntilDate := time.Now().Add(complianceTestRetention)
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumAlgorithm: types.ChecksumAlgorithmCrc32,
ObjectLockLegalHoldStatus: types.ObjectLockLegalHoldStatusOn,
ObjectLockMode: types.ObjectLockModeCompliance,
ObjectLockRetainUntilDate: &retainUntilDate,
}, s3client)
if err != nil {
return err
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
out, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
if out.ObjectLockMode != types.ObjectLockModeCompliance {
return fmt.Errorf("expected object lock mode to be %v, instead got %v", types.ObjectLockModeCompliance, out.ObjectLockMode)
}
if out.ObjectLockLegalHoldStatus != types.ObjectLockLegalHoldStatusOn {
return fmt.Errorf("expected object lock mode to be %v, instead got %v", types.ObjectLockLegalHoldStatusOn, out.ObjectLockLegalHoldStatus)
}
return cleanupLockedObjects(s3client, bucket, []objToDelete{{key: obj, removeLegalHold: true, isCompliance: true}})
}, withLock())
}
func PutObject_missing_bucket_lock(s *S3Conf) error {
testName := "PutObject_missing_bucket_lock"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
// with retention
_, err := putObjectWithData(3, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("my-object"),
ObjectLockMode: types.ObjectLockModeGovernance,
ObjectLockRetainUntilDate: getPtr(time.Now().AddDate(0, 0, 2)),
}, s3client)
if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrMissingObjectLockConfigurationNoSpaces)); err != nil {
return err
}
// with legal hold, of either status
for _, status := range []types.ObjectLockLegalHoldStatus{
types.ObjectLockLegalHoldStatusOn,
types.ObjectLockLegalHoldStatusOff,
} {
_, err = putObjectWithData(2, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("my-object"),
ObjectLockLegalHoldStatus: status,
}, s3client)
if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrMissingObjectLockConfigurationNoSpaces)); err != nil {
return fmt.Errorf("legal hold %s: %w", status, err)
}
}
return nil
})
}
func PutObject_invalid_legal_hold(s *S3Conf) error {
testName := "PutObject_invalid_legal_hold"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("foo"),
ObjectLockLegalHoldStatus: types.ObjectLockLegalHoldStatus("invalid_status"),
}, s3client)
return checkApiErr(err, s3err.GetInvalidArgumentErr(s3err.InvalidArgLegalHoldStatus, "invalid_status"))
}, withLock())
}
func PutObject_invalid_object_lock_mode(s *S3Conf) error {
testName := "PutObject_invalid_object_lock_mode"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
rDate := time.Now().Add(time.Hour * 10)
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("foo"),
ObjectLockRetainUntilDate: &rDate,
ObjectLockMode: types.ObjectLockMode("invalid_mode"),
}, s3client)
return checkApiErr(err, s3err.GetInvalidArgumentErr(s3err.InvalidArgObjectLockMode, "invalid_mode"))
}, withLock())
}
// PutObject_object_lock_checksum_required covers uploads carrying Object
// Lock parameters, which need an integrity check of their body: a legal
// hold of either status or a retention sent with neither Content-MD5 nor a
// checksum is rejected, and a legal hold sent with either is stored.
func PutObject_object_lock_checksum_required(s *S3Conf) error {
testName := "PutObject_object_lock_checksum_required"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
retainUntilDate := time.Now().Add(time.Hour)
for _, test := range []struct {
name string
input s3.PutObjectInput
}{
{
name: "legal hold ON",
input: s3.PutObjectInput{ObjectLockLegalHoldStatus: types.ObjectLockLegalHoldStatusOn},
},
{
name: "legal hold OFF",
input: s3.PutObjectInput{ObjectLockLegalHoldStatus: types.ObjectLockLegalHoldStatusOff},
},
{
name: "retention",
input: s3.PutObjectInput{
ObjectLockMode: types.ObjectLockModeGovernance,
ObjectLockRetainUntilDate: &retainUntilDate,
},
},
} {
input := test.input
input.Bucket = &bucket
input.Key = getPtr("my-obj")
_, err := putObjectWithData(10, &input, s3client)
if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrObjectLockChecksumRequired)); err != nil {
return fmt.Errorf("%s without an integrity check: %w", test.name, err)
}
}
data := []byte("data")
md5sum := md5.Sum(data)
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
md5Res, err := s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("with-md5"),
Body: bytes.NewReader(data),
ContentMD5: getPtr(base64.StdEncoding.EncodeToString(md5sum[:])),
ObjectLockLegalHoldStatus: types.ObjectLockLegalHoldStatusOn,
})
cancel()
if err != nil {
return fmt.Errorf("legal hold with Content-MD5: %w", err)
}
checksumRes, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("with-checksum"),
ObjectLockLegalHoldStatus: types.ObjectLockLegalHoldStatusOn,
}, s3client, withPutObjectChecksumAlgo(types.ChecksumAlgorithmCrc32))
if err != nil {
return fmt.Errorf("legal hold with a checksum: %w", err)
}
return cleanupLockedObjects(s3client, bucket, []objToDelete{
{key: "with-md5", versionId: getString(md5Res.VersionId), removeLegalHold: true},
{key: "with-checksum", versionId: getString(checksumRes.res.VersionId), removeLegalHold: true},
})
}, withLock())
}
// PutObject_default_retention_checksum_required covers uploads to a bucket
// with a default retention rule, which gives every object written to it
// Object Lock parameters: even a plain upload, an empty one included, then
// needs an integrity check of its body.
func PutObject_default_retention_checksum_required(s *S3Conf) error {
testName := "PutObject_default_retention_checksum_required"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := s3client.PutObjectLockConfiguration(ctx, &s3.PutObjectLockConfigurationInput{
Bucket: &bucket,
ObjectLockConfiguration: &types.ObjectLockConfiguration{
ObjectLockEnabled: types.ObjectLockEnabledEnabled,
Rule: &types.ObjectLockRule{
DefaultRetention: &types.DefaultRetention{
Mode: types.ObjectLockRetentionModeGovernance,
Days: getPtr(int32(1)),
},
},
},
})
cancel()
if err != nil {
return err
}
for _, size := range []int64{10, 0} {
_, err := putObjectWithData(size, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("my-obj"),
}, s3client)
if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrObjectLockChecksumRequired)); err != nil {
return fmt.Errorf("%d byte upload without an integrity check: %w", size, err)
}
}
_, err = putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("my-obj"),
}, s3client, withPutObjectChecksumAlgo(types.ChecksumAlgorithmCrc32))
return err
}, withLock())
}
func PutObject_past_retain_until_date(s *S3Conf) error {
testName := "PutObject_past_retain_until_date"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
rDate := time.Now().AddDate(-1, 0, 0)
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("my-object"),
ObjectLockMode: types.ObjectLockModeGovernance,
ObjectLockRetainUntilDate: &rDate,
}, s3client)
return checkApiErr(err, s3err.GetInvalidArgumentErr(s3err.InvalidArgPastObjectLockRetainDate, rDate.Format(time.RFC3339)))
}, withLock())
}
// PutObject_object_lock_headers_validation covers invalid Object Lock
// headers, checked in the order S3 checks them: the mode and the date set
// together, then the legal hold, the date and the mode values. A header sent
// empty is invalid.
func PutObject_object_lock_headers_validation(s *S3Conf) error {
testName := "PutObject_object_lock_headers_validation"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
date := time.Now().UTC().Add(time.Hour).Format(time.RFC3339)
past := "2020-01-01T00:00:00Z"
for _, test := range []struct {
name string
headers map[string]string
expected s3err.S3Error
}{
{
name: "mode without a date",
headers: map[string]string{"x-amz-object-lock-mode": "GOVERNANCE", "x-amz-object-lock-legal-hold": "INVALID"},
expected: s3err.GetInvalidArgumentErr(s3err.InvalidArgMissingObjectLockRetainDate, ""),
},
{
name: "invalid legal hold before a past date",
headers: map[string]string{"x-amz-object-lock-mode": "INVALID", "x-amz-object-lock-retain-until-date": past, "x-amz-object-lock-legal-hold": "on"},
expected: s3err.GetInvalidArgumentErr(s3err.InvalidArgLegalHoldStatus, "on"),
},
{
name: "empty legal hold",
headers: map[string]string{"x-amz-object-lock-legal-hold": ""},
expected: s3err.GetInvalidArgumentErr(s3err.InvalidArgLegalHoldStatus, ""),
},
{
name: "past date before an invalid mode",
headers: map[string]string{"x-amz-object-lock-mode": "INVALID", "x-amz-object-lock-retain-until-date": past},
expected: s3err.GetInvalidArgumentErr(s3err.InvalidArgPastObjectLockRetainDate, past),
},
{
name: "empty mode",
headers: map[string]string{"x-amz-object-lock-mode": "", "x-amz-object-lock-retain-until-date": date},
expected: s3err.GetInvalidArgumentErr(s3err.InvalidArgObjectLockMode, ""),
},
} {
req, err := createSignedReq(http.MethodPut, s.endpoint, bucket+"/my-obj", s.awsID, s.awsSecret,
"s3", s.awsRegion, "", nil, time.Now(), test.headers)
if err != nil {
return err
}
resp, err := s.httpClient.Do(req)
if err != nil {
return err
}
if err := checkHTTPResponseApiErr(resp, test.expected); err != nil {
return fmt.Errorf("%s: %w", test.name, err)
}
}
return nil
}, withLock())
}
func PutObject_invalid_retain_until_date(s *S3Conf) error {
testName := "PutObject_invalid_retain_until_date"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
req, err := createSignedReq(
http.MethodPut,
s.endpoint,
fmt.Sprintf("%s/my-object", bucket),
s.awsID,
s.awsSecret,
"s3",
s.awsRegion,
"",
nil,
time.Now(),
map[string]string{
"x-amz-object-lock-retain-until-date": "invalid_date",
"x-amz-object-lock-mode": "GOVERNANCE",
},
)
if err != nil {
return err
}
resp, err := s.httpClient.Do(req)
if err != nil {
return err
}
return checkHTTPResponseApiErr(resp, s3err.GetInvalidArgumentErr(s3err.InvalidArgRetainUntilDate, "invalid_date"))
}, withLock())
}
func PutObject_conditional_writes(s *S3Conf) error {
testName := "PutObject_conditional_writes"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
res, err := putObjectWithData(0, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
Body: bytes.NewReader([]byte("dummy")),
}, s3client)
if err != nil {
return err
}
etag := res.res.ETag
etagTrimmed := strings.Trim(*etag, `"`)
incorrectEtag := getPtr("incorrect_etag")
errPrecond := s3err.GetAPIError(s3err.ErrPreconditionFailed)
errNoSuchKey := s3err.GetAPIError(s3err.ErrNoSuchKey)
errNotImplemented := s3err.GetAPIError(s3err.ErrNotImplemented)
for i, test := range []struct {
obj string
ifMatch *string
ifNoneMatch *string
err error
}{
{obj, etag, nil, nil},
{obj, etag, etag, errNotImplemented},
{obj, etag, incorrectEtag, errNotImplemented},
{obj, incorrectEtag, incorrectEtag, errNotImplemented},
{obj, incorrectEtag, etag, errNotImplemented},
{obj, incorrectEtag, nil, errPrecond},
{obj, nil, incorrectEtag, errNotImplemented},
{obj, nil, etag, errNotImplemented},
{obj, nil, getPtr("*"), errPrecond},
{obj, etag, getPtr("*"), errNotImplemented},
{obj, getPtr("*"), nil, errNotImplemented},
{obj, getPtr("*"), getPtr("*"), errNotImplemented},
{obj, nil, nil, nil},
// precondition headers without quotes
{obj, &etagTrimmed, nil, nil},
{obj, &etagTrimmed, &etagTrimmed, errNotImplemented},
{obj, &etagTrimmed, incorrectEtag, errNotImplemented},
{obj, incorrectEtag, &etagTrimmed, errNotImplemented},
{obj, nil, &etagTrimmed, errNotImplemented},
// object deson't exist tests
{"obj-1", incorrectEtag, etag, errNotImplemented},
{"obj-2", etag, etag, errNotImplemented},
{"obj-3", etag, nil, errNoSuchKey},
{"obj-4", etag, incorrectEtag, errNotImplemented},
{"obj-5", incorrectEtag, nil, errNoSuchKey},
{"obj-6", nil, etag, errNotImplemented},
{"obj-7", nil, getPtr("*"), nil},
{"obj-8", etag, getPtr("*"), errNotImplemented},
{"obj-9", getPtr("*"), nil, errNotImplemented},
} {
res, err := putObjectWithData(0, &s3.PutObjectInput{
Bucket: &bucket,
Key: &test.obj,
Body: bytes.NewReader([]byte("dummy")),
IfMatch: test.ifMatch,
IfNoneMatch: test.ifNoneMatch,
}, s3client)
if err == nil {
// azure blob storage generates different ETags for
// the exact same data.
// to avoid ETag collision reassign the etag value
*etag = *res.res.ETag
etagTrimmed = strings.Trim(*res.res.ETag, `"`)
}
if test.err == nil && err != nil {
return fmt.Errorf("test case %v: expected no error, instead got %w", i, err)
}
if test.err != nil {
apierr, ok := test.err.(s3err.APIError)
if !ok {
return fmt.Errorf("test case %v: invalid error type: %w", i, test.err)
}
if err := checkApiErr(err, apierr); err != nil {
return fmt.Errorf("test case %v: %w", i, err)
}
}
}
return nil
})
}
func PutObject_should_combine_metadata(s *S3Conf) error {
testName := "PutObject_should_combine_metadata"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-object"
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
req, err := http.NewRequestWithContext(ctx, http.MethodPut, fmt.Sprintf("%s/%s/%s", s.endpoint, bucket, obj), strings.NewReader("dummy data"))
if err != nil {
return err
}
req.Header.Set("x-amz-content-sha256", "UNSIGNED-PAYLOAD")
req.Header.Add("x-amz-meta-key", "value-1")
req.Header.Add("x-amz-meta-key", "value-2")
req.Header.Add("x-amz-meta-key", "value-3")
req.Header.Add("x-amz-meta-Key", "value-4")
req.Header.Add("x-amz-meta-keY", "value-5")
req.Header.Add("x-amz-meta-foo", "bar")
req.Header.Add("x-amz-meta-baz", "abc")
req.Header.Add("x-amz-meta-xyzz", "xxx-3")
req.Header.Add("x-amz-meta-Xyzz", "xxx-1")
req.Header.Add("x-amz-meta-xyzz", "xxx-2")
req.Header.Add("x-amz-meta-hello", "world")
req.Header.Add("x-amz-meta-boo", "bar")
req.Header.Add("x-amz-meta-asdf", "ghk")
signer := v4.NewSigner()
err = signer.SignHTTP(req.Context(), aws.Credentials{AccessKeyID: s.awsID, SecretAccessKey: s.awsSecret}, req, "UNSIGNED-PAYLOAD", "s3", s.awsRegion, time.Now())
if err != nil {
return fmt.Errorf("failed to sign the request: %w", err)
}
resp, err := s.httpClient.Do(req)
cancel()
if err != nil {
return fmt.Errorf("send request: %w", err)
}
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("expected the response status code to be %v, instead got %v", http.StatusOK, resp.StatusCode)
}
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
out, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
expectedMeta := map[string]string{
"key": "value-1,value-2,value-3,value-4,value-5",
"foo": "bar",
"baz": "abc",
"xyzz": "xxx-3,xxx-1,xxx-2",
"hello": "world",
"boo": "bar",
"asdf": "ghk",
}
if !areMapsSame(expectedMeta, out.Metadata) {
return fmt.Errorf("expected the object metadata to be %v, instead got %v", expectedMeta, out.Metadata)
}
return nil
})
}
func PutObject_long_metadata(s *S3Conf) error {
testName := "PutObject_long_metadata"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("obj"),
Metadata: map[string]string{
"key": "value",
"foo": "bar",
"baz": "quxx",
"something_long": strings.Repeat("a", 2048),
},
}, s3client)
return checkApiErr(err, s3err.GetAPIError(s3err.ErrMetadataTooLarge))
})
}
func PutObject_with_metadata(s *S3Conf) error {
testName := "PutObject_with_metadata"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
inputMeta := map[string]string{
"Key": "Val",
"X-Test": "Example",
"UPPERCASE": "should-remain",
"MiXeD-CaSe": "normalize-to-lower",
"with-number-123": "numeric-test",
"123numeric-prefix": "value123",
"key_with_underscore": "underscore-ok",
"key-with-dash": "dash-ok",
"key.with.dot": "dot-ok",
"KeyURL": "https://example.com/test?query=1",
"EmptyValue": "",
strings.Repeat("a", 256): "some long metadata value to ensure nothing breaks at higher header sizes",
"WhitespaceKey ": " trailing-key",
}
expectedMeta := map[string]string{
"key": "Val",
"x-test": "Example",
"uppercase": "should-remain",
"mixed-case": "normalize-to-lower",
"with-number-123": "numeric-test",
"123numeric-prefix": "value123",
"key_with_underscore": "underscore-ok",
"key-with-dash": "dash-ok",
"key.with.dot": "dot-ok",
"keyurl": "https://example.com/test?query=1",
"emptyvalue": "",
strings.Repeat("a", 256): "some long metadata value to ensure nothing breaks at higher header sizes",
"whitespacekey": "trailing-key",
}
for i, test := range []struct {
obj string
dataLength int64
}{
// test for file object
{"file-object", 100},
// test for directory object
{"dir-object/", 0},
} {
_, err := putObjectWithData(test.dataLength, &s3.PutObjectInput{
Bucket: &bucket,
Key: &test.obj,
Metadata: inputMeta,
}, s3client)
if err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &test.obj,
})
cancel()
if err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
if !areMapsSame(expectedMeta, res.Metadata) {
return fmt.Errorf("test %v failed: expected the object metadata to be %v, instead got %v", i+1, expectedMeta, res.Metadata)
}
}
return nil
})
}
func PutObject_invalid_website_redirect_location(s *S3Conf) error {
testName := "PutObject_invalid_website_redirect_location"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
WebsiteRedirectLocation: getPtr("ftp://example.com"),
}, s3client)
return checkApiErr(err, s3err.GetAPIError(s3err.ErrInvalidRedirectLocation))
})
}
func PutObject_md5(s *S3Conf) error {
testName := "PutObject_md5"
return actionHandler(s, testName, func(_ *s3.Client, bucket string) error {
body := []byte("dummy data")
sum := md5.Sum(body)
contentMd5 := base64.StdEncoding.EncodeToString(sum[:])
for i, test := range []struct {
name string
md5 string
err s3err.S3Error
}{
{"empty_md5", "", s3err.GetInvalidDigestErr("")},
{"invalid_md5", "invalid_md5", s3err.GetInvalidDigestErr("invalid_md5")},
// valid base64, but invalid md5
{"invalid_md5_length", "aGVsbCBzLGRham5mamFuc2Y=", s3err.GetInvalidDigestErr("aGVsbCBzLGRham5mamFuc2Y=")},
// valid md5, but incorrect
{"incorrect_md5", "XrY7u+Ae7tCTyyK7j1rNww==", s3err.GetBadDigestErr(contentMd5, base64ToHexString("XrY7u+Ae7tCTyyK7j1rNww=="))},
{"success", contentMd5, nil},
} {
req, err := createSignedReq(http.MethodPut, s.endpoint, fmt.Sprintf("%s/obj-%d", bucket, i), s.awsID, s.awsSecret, "s3", s.awsRegion, "", body, time.Now(), map[string]string{
"Content-Md5": test.md5,
})
if err != nil {
return err
}
resp, err := s.httpClient.Do(req)
if err != nil {
return err
}
if test.err == nil {
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("test %q failed: expected response status code to be %v, instead got %v", test.name, http.StatusOK, resp.StatusCode)
}
continue
}
if err := checkHTTPResponseApiErr(resp, test.err); err != nil {
return fmt.Errorf("test %q failed: %w", test.name, err)
}
}
return nil
})
}
func PutObject_checksum_algorithm_and_header_mismatch(s *S3Conf) error {
testName := "PutObject_checksum_algorithm_and_header_mismatch"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumAlgorithm: types.ChecksumAlgorithmCrc32,
ChecksumCRC32C: getPtr("m0cB1Q=="),
})
cancel()
// FIXME: The error message for PutObject is not properly serialized by the sdk
// References to aws sdk issue https://github.com/aws/aws-sdk-go-v2/issues/2921
// if err := checkApiErr(err, s3err.GetInvalidChecksumHeaderErr("x-amz-sdk-checksum-algorithm"); err != nil {
// return err
// }
if err := checkSdkApiErr(err, "InvalidRequest"); err != nil {
return err
}
return nil
})
}
func PutObject_multiple_checksum_headers(s *S3Conf) error {
testName := "PutObject_multiple_checksum_headers"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumSHA1: getPtr("Kq5sNclPz7QV2+lfQIuc6R7oRu0="),
ChecksumCRC32C: getPtr("m0cB1Q=="),
}, s3client)
// FIXME: The error message for PutObject is not properly serialized by the sdk
// References to aws sdk issue https://github.com/aws/aws-sdk-go-v2/issues/2921
// if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrMultipleChecksumHeaders)); err != nil {
// return err
// }
if err := checkSdkApiErr(err, "InvalidRequest"); err != nil {
return err
}
// Empty checksums case
_, err = putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumSHA1: getPtr(""),
ChecksumCRC32C: getPtr(""),
}, s3client)
// FIXME: The error message for PutObject is not properly serialized by the sdk
// References to aws sdk issue https://github.com/aws/aws-sdk-go-v2/issues/2921
// if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrMultipleChecksumHeaders)); err != nil {
// return err
// }
if err := checkSdkApiErr(err, "InvalidRequest"); err != nil {
return err
}
return nil
})
}
func PutObject_invalid_checksum_header(s *S3Conf) error {
testName := "PutObject_invalid_checksum_header"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
i := 0
for _, algo := range types.ChecksumAlgorithmCrc32.Values() {
// tests against:
// - empty string
// - invalid base64
// - valid base64, but invalid checksum
for _, checksum := range []string{"", "invalid_base64!", "c2RhZnNhZGZzZGFm"} {
input := &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}
setPutObjectChecksum(input, algo, getPtr(checksum))
_, err := putObjectWithData(int64((i+1)*100), input, s3client)
i++
// FIXME: The error message for PutObject is not properly serialized by the sdk
// References to aws sdk issue https://github.com/aws/aws-sdk-go-v2/issues/2921
// if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrMultipleChecksumHeaders)); err != nil {
// return err
// }
if err := checkSdkApiErr(err, "InvalidRequest"); err != nil {
return err
}
}
}
return nil
})
}
func PutObject_incorrect_checksums(s *S3Conf) error {
testName := "PutObject_incorrect_checksums"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
dirObj := "dir-object/"
for i, algo := range types.ChecksumAlgorithmCrc32.Values() {
wrongChecksum, err := wrongChecksumForAlgorithm(algo)
if err != nil {
return err
}
// test for file object
input := &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}
setPutObjectChecksum(input, algo, &wrongChecksum)
_, err = putObjectWithData(int64((i+1)*100), input, s3client)
if err := checkApiErr(err, s3err.GetChecksumBadDigestErr(algo)); err != nil {
return err
}
// test for directory object
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
input = &s3.PutObjectInput{
Bucket: &bucket,
Key: &dirObj,
}
setPutObjectChecksum(input, algo, &wrongChecksum)
_, err = s3client.PutObject(ctx, input)
cancel()
if err := checkApiErr(err, s3err.GetChecksumBadDigestErr(algo)); err != nil {
return err
}
}
return nil
})
}
func PutObject_default_checksum(s *S3Conf) error {
testName := "PutObject_default_checksum"
return actionHandler(s, testName, func(_ *s3.Client, bucket string) error {
customClient := s3.NewFromConfig(s.Config(), func(o *s3.Options) {
o.RequestChecksumCalculation = aws.RequestChecksumCalculationUnset
})
obj := "my-obj"
out, err := putObjectWithData(100, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}, customClient)
if err != nil {
return err
}
if out.res.ChecksumCRC64NVME == nil {
return fmt.Errorf("expected non nil default crc64nvme checksum")
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := customClient.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumMode: types.ChecksumModeEnabled,
})
cancel()
if err != nil {
return err
}
if getString(res.ChecksumCRC64NVME) != getString(out.res.ChecksumCRC64NVME) {
return fmt.Errorf("expected the object crc64nvme checksum to be %v, instead got %v", getString(res.ChecksumCRC64NVME), getString(out.res.ChecksumCRC64NVME))
}
return nil
})
}
func PutObject_data_integrity_etag(s *S3Conf) error {
testName := "PutObject_data_integrity_etag"
return actionHandler(s, testName, func(_ *s3.Client, bucket string) error {
customClient := s3.NewFromConfig(s.Config(), func(o *s3.Options) {
o.RequestChecksumCalculation = aws.RequestChecksumCalculationUnset
})
obj := "my-obj"
out, err := putObjectWithData(256, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}, customClient)
if err != nil {
return err
}
if out.res.ChecksumCRC64NVME == nil {
return fmt.Errorf("expected non nil crc64nvme checksum in PutObject response")
}
expectedETag := fmt.Sprintf("\"CRC64NVME-%s\"", getString(out.res.ChecksumCRC64NVME))
if got := getString(out.res.ETag); got != expectedETag {
return fmt.Errorf("expected PutObject ETag to be %s, instead got %s", expectedETag, got)
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
head, err := customClient.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumMode: types.ChecksumModeEnabled,
})
cancel()
if err != nil {
return err
}
if got := getString(head.ETag); got != expectedETag {
return fmt.Errorf("expected HeadObject ETag to be %s, instead got %s", expectedETag, got)
}
if got := getString(head.ChecksumCRC64NVME); got != getString(out.res.ChecksumCRC64NVME) {
return fmt.Errorf("expected HeadObject checksum to be %s, instead got %s", getString(out.res.ChecksumCRC64NVME), got)
}
return nil
})
}
func PutObject_dir_object_data_integrity_etag(s *S3Conf) error {
testName := "PutObject_dir_object_data_integrity_etag"
return actionHandler(s, testName, func(_ *s3.Client, bucket string) error {
customClient := s3.NewFromConfig(s.Config(), func(o *s3.Options) {
o.RequestChecksumCalculation = aws.RequestChecksumCalculationUnset
})
obj := "dir/obj/"
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := customClient.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
if res.ChecksumCRC64NVME == nil {
return fmt.Errorf("expected non nil crc64nvme checksum in PutObject response")
}
expectedETag := fmt.Sprintf("\"CRC64NVME-%s\"", getString(res.ChecksumCRC64NVME))
if got := getString(res.ETag); got != expectedETag {
return fmt.Errorf("expected PutObject ETag to be %s, instead got %s", expectedETag, got)
}
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
head, err := customClient.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumMode: types.ChecksumModeEnabled,
})
cancel()
if err != nil {
return err
}
if got := getString(head.ETag); got != expectedETag {
return fmt.Errorf("expected HeadObject ETag to be %s, instead got %s", expectedETag, got)
}
if got := getString(head.ChecksumCRC64NVME); got != getString(res.ChecksumCRC64NVME) {
return fmt.Errorf("expected HeadObject checksum to be %s, instead got %s", getString(res.ChecksumCRC64NVME), got)
}
return nil
})
}
func PutObject_dir_object_default_checksum(s *S3Conf) error {
testName := "PutObject_dir_object_default_checksum"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "dir/obj/"
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}, func(o *s3.Options) {
o.RequestChecksumCalculation = aws.RequestChecksumCalculationUnset
})
cancel()
if err != nil {
return err
}
if res.ChecksumType != types.ChecksumTypeFullObject {
return fmt.Errorf("expected the object checksum type to be %s, instead got %s", types.ChecksumTypeFullObject, res.ChecksumType)
}
expectedcrc64nvme := "AAAAAAAAAAA="
if getString(res.ChecksumCRC64NVME) != expectedcrc64nvme {
return fmt.Errorf("expected the crc64nvme checksum to be %s, instead got %s", expectedcrc64nvme, getString(res.ChecksumCRC64NVME))
}
return nil
})
}
func PutObject_dir_object_checksums_success(s *S3Conf) error {
testName := "PutObject_dir_object_checksums_success"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
for i, test := range []struct {
algo types.ChecksumAlgorithm
checksumValue string
}{
{types.ChecksumAlgorithmCrc32, "AAAAAA=="},
{types.ChecksumAlgorithmCrc32c, "AAAAAA=="},
{types.ChecksumAlgorithmCrc64nvme, "AAAAAAAAAAA="},
{types.ChecksumAlgorithmSha1, "2jmj7l5rSw0yVb/vlWAYkK/YBwk="},
{types.ChecksumAlgorithmSha256, "47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU="},
{types.ChecksumAlgorithmSha512, "z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg=="},
{types.ChecksumAlgorithmMd5, "1B2M2Y8AsgTpgAmY7PhCfg=="},
{types.ChecksumAlgorithmXxhash64, "70bbN1HY6Zk="},
{types.ChecksumAlgorithmXxhash3, "LQaABTjTlMI="},
{types.ChecksumAlgorithmXxhash128, "maoG0wFHmNhgAcMkRo1Jfw=="},
} {
input := &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr(fmt.Sprintf("obj-%v/", i)),
ChecksumAlgorithm: test.algo,
}
setPutObjectChecksum(input, test.algo, &test.checksumValue)
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := s3client.PutObject(ctx, input)
cancel()
if err != nil {
return err
}
if res.ChecksumType != types.ChecksumTypeFullObject {
return fmt.Errorf("expected the checksum type to be %s, instead got %s", types.ChecksumTypeFullObject, res.ChecksumType)
}
if got := getString(getPutObjectChecksum(res, test.algo)); got != test.checksumValue {
return fmt.Errorf("expected the %s checksum value to be %s, instead got %s", test.algo, test.checksumValue, got)
}
}
return nil
})
}
func PutObject_checksums_success(s *S3Conf) error {
testName := "PutObject_checksums_success"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
for i, algo := range types.ChecksumAlgorithmCrc32.Values() {
res, err := putObjectWithData(int64(i*200), &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
ChecksumAlgorithm: algo,
}, s3client, withPutObjectChecksumAlgo(algo))
if err != nil {
return err
}
if res.res.ChecksumType != types.ChecksumTypeFullObject {
return fmt.Errorf("expected the object checksum type to be %v, instead got %v", types.ChecksumTypeFullObject, res.res.ChecksumType)
}
if getPutObjectChecksum(res.res, algo) == nil {
return fmt.Errorf("expected non empty %s checksum in the response", algo)
}
}
return nil
})
}
func PutObject_racey_success(s *S3Conf) error {
testName := "PutObject_racey_success"
runF(testName)
bucket, obj, lockStatus := getBucketName(), "my-obj", true
client := s.GetClient()
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := client.CreateBucket(ctx, &s3.CreateBucketInput{
Bucket: &bucket,
ObjectLockEnabledForBucket: &lockStatus,
})
cancel()
if err != nil {
failF("%v: %v", testName, err)
return fmt.Errorf("%v: %w", testName, err)
}
eg := errgroup.Group{}
for range 10 {
eg.Go(func() error {
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
return err
})
}
err = eg.Wait()
if err != nil {
failF("%v: %v", testName, err)
return fmt.Errorf("%v: %w", testName, err)
}
err = teardown(s, bucket)
if err != nil {
failF("%v: %v", testName, err)
return fmt.Errorf("%v: %w", testName, err)
}
passF(testName)
return nil
}
func PutObject_success(s *S3Conf) error {
testName := "PutObject_success"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
lgth := int64(100)
res, err := putObjectWithData(lgth, &s3.PutObjectInput{
Bucket: &bucket,
Key: getPtr("my-obj"),
}, s3client)
if err != nil {
return err
}
// skip the ETag check for azure tests
if !s.azureTests {
etag, err := calculateEtag(res.data)
if err != nil {
return err
}
if getString(res.res.ETag) != etag {
return fmt.Errorf("expected ETag to be %s, intead got %s", getString(res.res.ETag), etag)
}
}
if res.res.Size == nil {
return fmt.Errorf("unexpected nil object Size")
}
if *res.res.Size != lgth {
return fmt.Errorf("expected the object size to be %v, instead got %v", lgth, *res.res.Size)
}
return nil
})
}
func PutObject_default_content_type(s *S3Conf) error {
testName := "PutObject_default_content_type"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
key := "my-object"
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: &key,
ContentType: nil,
}, s3client)
if err != nil {
return err
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &key,
})
cancel()
if err != nil {
return err
}
if getString(res.ContentType) != defaultContentType {
return fmt.Errorf("expected default %s Content-Type, instead got %s", defaultContentType, getString(res.ContentType))
}
return nil
})
}
func PutObject_overwrite_resets_attributes(s *S3Conf) error {
testName := "PutObject_overwrite_resets_attributes"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
expires := time.Now().Add(time.Hour)
_, err := putObjectWithData(10, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
ContentType: getPtr("text/plain"),
ContentEncoding: getPtr("gzip"),
ContentDisposition: getPtr("inline"),
ContentLanguage: getPtr("en"),
CacheControl: getPtr("no-cache"),
Expires: &expires,
WebsiteRedirectLocation: getPtr("/redirect"),
Metadata: map[string]string{"foo": "bar"},
Tagging: getPtr("key=val"),
}, s3client)
if err != nil {
return err
}
_, err = putObjectWithData(20, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}, s3client)
if err != nil {
return err
}
// the object holds none of the replaced object's attributes
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
out, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
if getString(out.ContentType) != defaultContentType {
return fmt.Errorf("expected default %s Content-Type, instead got %s",
defaultContentType, getString(out.ContentType))
}
for _, hdr := range []struct {
name string
value *string
}{
{"Content-Encoding", out.ContentEncoding},
{"Content-Disposition", out.ContentDisposition},
{"Content-Language", out.ContentLanguage},
{"Cache-Control", out.CacheControl},
{"Expires", out.ExpiresString},
{"x-amz-website-redirect-location", out.WebsiteRedirectLocation},
} {
if hdr.value != nil {
return fmt.Errorf("expected nil %s, instead got %s", hdr.name, *hdr.value)
}
}
if len(out.Metadata) != 0 {
return fmt.Errorf("expected empty metadata, instead got %v", out.Metadata)
}
if out.TagCount != nil {
return fmt.Errorf("expected nil tag count, instead got %v", *out.TagCount)
}
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
tagging, err := s3client.GetObjectTagging(ctx, &s3.GetObjectTaggingInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
if len(tagging.TagSet) != 0 {
return fmt.Errorf("expected empty tag set, instead got %v", tagging.TagSet)
}
return nil
})
}
func PutObject_overwrite_multipart_object(s *S3Conf) error {
testName := "PutObject_overwrite_multipart_object"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-obj"
mp, err := createMp(s3client, bucket, obj)
if err != nil {
return err
}
parts, _, err := uploadParts(s3client, 100, 1, bucket, obj, *mp.UploadId)
if err != nil {
return err
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err = s3client.CompleteMultipartUpload(ctx, &s3.CompleteMultipartUploadInput{
Bucket: &bucket,
Key: &obj,
UploadId: mp.UploadId,
MultipartUpload: &types.CompletedMultipartUpload{
Parts: []types.CompletedPart{
{
ETag: parts[0].ETag,
PartNumber: parts[0].PartNumber,
},
},
},
})
cancel()
if err != nil {
return err
}
dataLen := int64(10)
_, err = putObjectWithData(dataLen, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}, s3client)
if err != nil {
return err
}
// the new object isn't a multipart upload: its only part is the
// whole object
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
out, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
PartNumber: getPtr(int32(1)),
})
cancel()
if err != nil {
return err
}
if out.PartsCount != nil {
return fmt.Errorf("expected nil parts count, instead got %v", *out.PartsCount)
}
if out.ContentLength == nil {
return fmt.Errorf("expected non nil ContentLength")
}
if *out.ContentLength != dataLen {
return fmt.Errorf("expected the content length to be %v, instead got %v",
dataLen, *out.ContentLength)
}
return nil
})
}
func PutObject_dir_object_overwrite_resets_attributes(s *S3Conf) error {
testName := "PutObject_dir_object_overwrite_resets_attributes"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-dir/"
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
Tagging: getPtr("key1=val1&key2=val2"),
Metadata: map[string]string{"foo": "bar"},
WebsiteRedirectLocation: getPtr("/some/redirect"),
})
cancel()
if err != nil {
return err
}
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
_, err = s3client.PutObject(ctx, &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
// the object holds none of the replaced object's attributes
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
out, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
if len(out.Metadata) != 0 {
return fmt.Errorf("expected empty metadata, instead got %v", out.Metadata)
}
if out.WebsiteRedirectLocation != nil {
return fmt.Errorf("expected nil website-redirect-location, instead got %v",
*out.WebsiteRedirectLocation)
}
if out.TagCount != nil {
return fmt.Errorf("expected nil tag count, instead got %v", *out.TagCount)
}
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
tagging, err := s3client.GetObjectTagging(ctx, &s3.GetObjectTaggingInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
if len(tagging.TagSet) != 0 {
return fmt.Errorf("expected empty tag set, instead got %v", tagging.TagSet)
}
return nil
})
}
func PutObject_invalid_credentials(s *S3Conf) error {
testName := "PutObject_invalid_credentials"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
newconf := *s
newconf.awsSecret = newconf.awsSecret + "badpassword"
client := newconf.GetClient()
_, err := putObjects(client, []string{"my-obj"}, bucket)
return checkApiErr(err, s3err.GetAPIError(s3err.ErrSignatureDoesNotMatch))
})
}
func PutObject_invalid_object_names(s *S3Conf) error {
testName := "PutObject_invalid_object_names"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
for _, obj := range []string{
".",
"..",
"./",
"/.",
"//",
"../",
"/..",
"/..",
"../.",
"../../../.",
"../../../etc/passwd",
"../../../../tmp/foo",
"for/../../bar/",
"a/a/a/../../../../../etc/passwd",
"/a/../../b/../../c/../../../etc/passwd",
} {
_, err := putObjects(s3client, []string{obj}, bucket)
if err := checkApiErr(err, s3err.GetAPIError(s3err.ErrBadRequest)); err != nil {
return err
}
}
return nil
})
}
func PutObject_object_acl_not_supported(s *S3Conf) error {
testName := "PutObject_object_acl_not_supported"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "my-object"
testuser := getUser("user")
err := createUsers(s, []user{testuser})
if err != nil {
return err
}
for i, modifyInput := range []func(*s3.PutObjectInput){
func(poi *s3.PutObjectInput) { poi.ACL = types.ObjectCannedACLPublicRead },
func(poi *s3.PutObjectInput) { poi.GrantFullControl = &testuser.access },
func(poi *s3.PutObjectInput) { poi.GrantRead = &testuser.access },
func(poi *s3.PutObjectInput) { poi.GrantReadACP = &testuser.access },
func(poi *s3.PutObjectInput) { poi.GrantWriteACP = &testuser.access },
} {
input := &s3.PutObjectInput{
Bucket: &bucket,
Key: &obj,
}
modifyInput(input)
_, err := putObjectWithData(0, input, s3client)
if err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
}
return nil
})
}
func PutObject_false_negative_object_names(s *S3Conf) error {
testName := "PutObject_false_negative_object_names"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
objs := []string{
"%252e%252e%252fetc/passwd", // double encoding
"%2e%2e/%2e%2e/%2e%2e/.ssh/id_rsa", // double URL-encoded
"%u002e%u002e/%u002e%u002e/etc/passwd", // unicode escape
"..%2f..%2f..%2fsecret/file.txt", // URL-encoded
"..%c0%af..%c0%afetc/passwd", // UTF-8 overlong trick
"dir/%c0%ae%c0%ae/%c0%ae%c0%ae/etc/passwd", // overlong UTF-8 encoding
".../.../.../target.txt",
"dir/%20../file.txt", // encoded space
"..\\u2215..\\u2215etc/passwd", // Unicode division slash
"logs/latest -> /etc/passwd", // symlink attacks
//TODO: add this test case in advanced routing
// "/etc/passwd" // absolute path injection
}
sort.Strings(objs)
_, err := putObjects(s3client, objs, bucket)
if err != nil {
return err
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
res, err := s3client.ListObjects(ctx, &s3.ListObjectsInput{
Bucket: &bucket,
})
cancel()
if err != nil {
return err
}
if len(res.Contents) != len(objs) {
return fmt.Errorf("expected %v objects, instead got %v", len(objs), len(res.Contents))
}
for i, obj := range res.Contents {
if *obj.Key != objs[i] {
return fmt.Errorf("expected the %vth object name to be %s, instead got %s", i+1, objs[i], *obj.Key)
}
}
return nil
})
}
// abortedBodyReader yields `sent` bytes and then fails, so the transport tears
// the connection down mid-body. That is what a client that dies or cancels
// looks like on the wire.
type abortedBodyReader struct {
remaining int
}
func (r *abortedBodyReader) Read(p []byte) (int, error) {
if r.remaining <= 0 {
return 0, fmt.Errorf("connection aborted by test")
}
n := len(p)
if n > r.remaining {
n = r.remaining
}
for i := 0; i < n; i++ {
p[i] = 'a'
}
r.remaining -= n
return n, nil
}
// putObjectAborted announces `declared` bytes, sends `sent`, then drops the
// connection. It returns no error: the request is expected to fail.
func putObjectAborted(s *S3Conf, bucket, obj string, declared, sent int, extra map[string]string) {
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
defer cancel()
req, err := http.NewRequestWithContext(ctx, http.MethodPut,
fmt.Sprintf("%s/%s/%s", s.endpoint, bucket, obj), &abortedBodyReader{remaining: sent})
if err != nil {
return
}
req.ContentLength = int64(declared)
req.Header.Set("x-amz-content-sha256", "UNSIGNED-PAYLOAD")
for k, v := range extra {
req.Header.Set(k, v)
}
signer := v4.NewSigner()
if err := signer.SignHTTP(req.Context(),
aws.Credentials{AccessKeyID: s.awsID, SecretAccessKey: s.awsSecret},
req, "UNSIGNED-PAYLOAD", "s3", s.awsRegion, time.Now()); err != nil {
return
}
resp, err := s.httpClient.Do(req)
if err == nil && resp != nil {
resp.Body.Close()
}
}
// PutObject_aborted_plain_body checks that a plain (non-aws-chunked) PUT whose
// body ends before Content-Length does not become a readable object.
//
// Real S3 rejects the request and the key stays absent. The posix backend used
// to truncate the object to the bytes received and link it into place, so the
// aborted upload showed up as a complete - but shorter - object.
func PutObject_aborted_plain_body(s *S3Conf) error {
testName := "PutObject_aborted_plain_body"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "aborted-plain"
putObjectAborted(s, bucket, obj, 65536, 20000, nil)
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err == nil {
return fmt.Errorf("expected the aborted upload to leave no object, but %v exists", obj)
}
return nil
})
}
// PutObject_plain_body_with_decoded_length checks that a COMPLETE plain upload
// still succeeds when it happens to carry X-Amz-Decoded-Content-Length.
//
// AWS S3 ignores that header on a plain body and stores Content-Length bytes.
// The length check must therefore use Content-Length, not the decoded value -
// otherwise a complete upload is rejected with IncompleteBody.
func PutObject_plain_body_with_decoded_length(s *S3Conf) error {
testName := "PutObject_plain_body_with_decoded_length"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
obj := "plain-with-decoded-length"
data := "hello world"
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
req, err := http.NewRequestWithContext(ctx, http.MethodPut,
fmt.Sprintf("%s/%s/%s", s.endpoint, bucket, obj), strings.NewReader(data))
if err != nil {
cancel()
return err
}
req.Header.Set("x-amz-content-sha256", "UNSIGNED-PAYLOAD")
// Larger than Content-Length on purpose: this is the shape that used to
// be rejected once the body was checked against the decoded value.
req.Header.Set("X-Amz-Decoded-Content-Length", "99999")
signer := v4.NewSigner()
if err := signer.SignHTTP(req.Context(),
aws.Credentials{AccessKeyID: s.awsID, SecretAccessKey: s.awsSecret},
req, "UNSIGNED-PAYLOAD", "s3", s.awsRegion, time.Now()); err != nil {
cancel()
return fmt.Errorf("failed to sign the request: %w", err)
}
resp, err := s.httpClient.Do(req)
cancel()
if err != nil {
return fmt.Errorf("send request: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("expected the response status code to be %v, instead got %v",
http.StatusOK, resp.StatusCode)
}
ctx, cancel = context.WithTimeout(context.Background(), shortTimeout)
out, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &obj,
})
cancel()
if err != nil {
return err
}
if out.ContentLength == nil || *out.ContentLength != int64(len(data)) {
return fmt.Errorf("expected the stored object to be %v bytes, instead got %v",
len(data), out.ContentLength)
}
return nil
})
}
// PutObject_plain_stores_aws_chunked_content_encoding checks that aws-chunked
// is stored as sent when the request wasn't framed in it.
//
// The token is transport only where x-amz-content-sha256 names a streaming
// payload type. On a plain PUT it is a coding the client chose, and S3 keeps it
// like any other.
func PutObject_plain_stores_aws_chunked_content_encoding(s *S3Conf) error {
testName := "PutObject_plain_stores_aws_chunked_content_encoding"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
for i, contentEncoding := range []string{"aws-chunked", "gzip,aws-chunked"} {
object := fmt.Sprintf("plain-obj-%v", i)
req, err := createSignedReq(http.MethodPut, s.endpoint, fmt.Sprintf("%s/%s", bucket, object),
s.awsID, s.awsSecret, "s3", s.awsRegion, "", []byte("hello world"), time.Now(),
map[string]string{"Content-Encoding": contentEncoding})
if err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
resp, err := s.httpClient.Do(req)
if err != nil {
return fmt.Errorf("test %v failed to send the request: %w", i+1, err)
}
resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("test %v: expected the response status code to be %v, instead got %v",
i+1, http.StatusOK, resp.StatusCode)
}
stored, err := getStoredContentEncoding(s3client, bucket, object)
if err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
if stored != contentEncoding {
return fmt.Errorf("test %v: expected the stored content encoding to be %q, instead got %q",
i+1, contentEncoding, stored)
}
}
return nil
})
}
func PutObject_unsigned_payload_with_aws_chunked_content_encoding(s *S3Conf) error {
testName := "PutObject_unsigned_payload_with_aws_chunked_content_encoding"
return actionHandler(s, testName, func(s3client *s3.Client, bucket string) error {
object := "my-obj"
for i, contentEncoding := range []string{
"aws-chunked",
"aws-chunked,gzip",
"gzip, aws-chunked",
"AWS-Chunked",
} {
req, err := createSignedReq(http.MethodPut, s.endpoint, fmt.Sprintf("%s/%s", bucket, object),
s.awsID, s.awsSecret, "s3", s.awsRegion, "UNSIGNED-PAYLOAD", []byte("hello world"), time.Now(),
map[string]string{"Content-Encoding": contentEncoding})
if err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
resp, err := s.httpClient.Do(req)
if err != nil {
return fmt.Errorf("test %v failed to send the request: %w", i+1, err)
}
// the error names the offending header and reports the token
// alone, not the whole header value
err = checkHTTPResponseApiErr(resp,
s3err.GetInvalidArgumentErr(s3err.InvalidArgAwsChunkedUnsignedPayload, "aws-chunked"))
if err != nil {
return fmt.Errorf("test %v failed: %w", i+1, err)
}
}
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
_, err := s3client.HeadObject(ctx, &s3.HeadObjectInput{
Bucket: &bucket,
Key: &object,
})
cancel()
if err == nil {
return fmt.Errorf("expected the rejected uploads to leave no object, but %v exists", object)
}
return nil
})
}