garage/doc/book/src/reference_manual/s3_compatibility.md

# S3 Compatibility status

## Global S3 features

Implemented:

- path-style URLs (`garage.tld/bucket/key`)
- putting and getting objects in buckets
- multipart uploads
- listing objects
- access control on a per-key-per-bucket basis

Not implemented:

- vhost-style URLs (`bucket.garage.tld/key`)
- object-level ACL
- object versioning
- encryption
- most `x-amz-` headers


## Endpoint implementation

All APIs that are not mentionned are not implemented and will return a 400 bad request.

#### AbortMultipartUpload

Implemented.

#### CompleteMultipartUpload

Implemented badly. Garage will not check that all the parts stored correspond to the list given by the client in the request body. This means that the multipart upload might be completed with an invalid size. This is a bug and will be fixed.

#### CopyObject

Implemented.

#### CreateBucket

Garage does not accept creating buckets or giving access using API calls, it has to be done using the CLI tools. CreateBucket will return a 200 if the bucket exists and user has write access, and a 403 Forbidden in all other cases.

#### CreateMultipartUpload

Implemented.

#### DeleteBucket

Garage does not accept deleting buckets using API calls, it has to be done using the CLI tools. This request will return a 403 Forbidden.

#### DeleteObject

Implemented.

#### DeleteObjects

Implemented.

#### GetBucketLocation

Implemented.

#### GetBucketVersioning

Stub implementation (Garage does not yet support versionning so this always returns
"versionning not enabled").

#### GetObject

Implemented.

#### HeadBucket

Implemented.

#### HeadObject

Implemented.

#### ListBuckets

Implemented.

#### ListObjects

Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.

#### ListObjectsV2

Implemented.

#### PutObject

Implemented.

#### UploadPart

Implemented.
Write documentation on configuration file and other improvements 2021-05-28 16:00:59 +00:00			`# S3 Compatibility status`
Add compatibility list 2021-02-19 18:10:23 +00:00
Write documentation on configuration file and other improvements 2021-05-28 16:00:59 +00:00			`## Global S3 features`
Add compatibility list 2021-02-19 18:10:23 +00:00
			`Implemented:`

add precision 2021-02-19 18:11:55 +00:00			- path-style URLs (`garage.tld/bucket/key`)
Add compatibility list 2021-02-19 18:10:23 +00:00			`- putting and getting objects in buckets`
			`- multipart uploads`
			`- listing objects`
			`- access control on a per-key-per-bucket basis`

			`Not implemented:`

add precision 2021-02-19 18:11:55 +00:00			- vhost-style URLs (`bucket.garage.tld/key`)
Add compatibility list 2021-02-19 18:10:23 +00:00			`- object-level ACL`
Updates to documentation 2021-05-31 15:23:35 +00:00			`- object versioning`
Add compatibility list 2021-02-19 18:10:23 +00:00			`- encryption`
			- most `x-amz-` headers


Write documentation on configuration file and other improvements 2021-05-28 16:00:59 +00:00			`## Endpoint implementation`
Add compatibility list 2021-02-19 18:10:23 +00:00
			`All APIs that are not mentionned are not implemented and will return a 400 bad request.`

			`#### AbortMultipartUpload`

			`Implemented.`

			`#### CompleteMultipartUpload`

			`Implemented badly. Garage will not check that all the parts stored correspond to the list given by the client in the request body. This means that the multipart upload might be completed with an invalid size. This is a bug and will be fixed.`

			`#### CopyObject`

			`Implemented.`

			`#### CreateBucket`

			`Garage does not accept creating buckets or giving access using API calls, it has to be done using the CLI tools. CreateBucket will return a 200 if the bucket exists and user has write access, and a 403 Forbidden in all other cases.`

			`#### CreateMultipartUpload`

			`Implemented.`

			`#### DeleteBucket`

			`Garage does not accept deleting buckets using API calls, it has to be done using the CLI tools. This request will return a 403 Forbidden.`

			`#### DeleteObject`

			`Implemented.`

			`#### DeleteObjects`

			`Implemented.`

Updates to documentation 2021-05-31 15:23:35 +00:00			`#### GetBucketLocation`

			`Implemented.`

			`#### GetBucketVersioning`

			`Stub implementation (Garage does not yet support versionning so this always returns`
			`"versionning not enabled").`

Add compatibility list 2021-02-19 18:10:23 +00:00			`#### GetObject`

			`Implemented.`

			`#### HeadBucket`

			`Implemented.`

			`#### HeadObject`

			`Implemented.`

Updates to documentation 2021-05-31 15:23:35 +00:00			`#### ListBuckets`

			`Implemented.`

Add compatibility list 2021-02-19 18:10:23 +00:00			`#### ListObjects`

			Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.

			`#### ListObjectsV2`

			`Implemented.`

			`#### PutObject`

			`Implemented.`

			`#### UploadPart`

			`Implemented.`