versitygw/s3api/controllers/object-head.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 controllers

import (
	"fmt"
	"net/http"
	"strings"
	"time"

	"github.com/aws/aws-sdk-go-v2/service/s3"
	"github.com/aws/aws-sdk-go-v2/service/s3/types"
	"github.com/gofiber/fiber/v3"
	"github.com/versity/versitygw/auth"
	"github.com/versity/versitygw/debuglogger"
	"github.com/versity/versitygw/s3api/utils"
	"github.com/versity/versitygw/s3err"
)

func (c S3ApiController) HeadObject(ctx fiber.Ctx) (*Response, error) {
	// context locals
	acct := utils.ContextKeyAccount.Get(ctx).(auth.Account)
	isRoot := utils.ContextKeyIsRoot.Get(ctx).(bool)
	parsedAcl := utils.ContextKeyParsedAcl.Get(ctx).(auth.ACL)
	isPublicBucket := utils.ContextKeyPublicBucket.IsSet(ctx)
	// url values
	bucket := ctx.Params("bucket")
	partNumberQuery := int32(fiber.Query(ctx, "partNumber", -1))
	versionId := ctx.Query("versionId")
	objRange := ctx.Get("Range")
	key := strings.TrimPrefix(ctx.Path(), fmt.Sprintf("/%s/", bucket))

	// Extract response override query parameters
	responseOverrides := map[string]*string{
		"Cache-Control":       utils.GetQueryParam(ctx, "response-cache-control"),
		"Content-Disposition": utils.GetQueryParam(ctx, "response-content-disposition"),
		"Content-Encoding":    utils.GetQueryParam(ctx, "response-content-encoding"),
		"Content-Language":    utils.GetQueryParam(ctx, "response-content-language"),
		"Content-Type":        utils.GetQueryParam(ctx, "response-content-type"),
		"Expires":             utils.GetQueryParam(ctx, "response-expires"),
	}

	// Check if any response override parameters are present
	hasResponseOverrides := false
	for _, override := range responseOverrides {
		if override != nil {
			hasResponseOverrides = true
			break
		}
	}

	// Validate that response override parameters are not used with anonymous requests
	if hasResponseOverrides && isPublicBucket {
		debuglogger.Logf("anonymous access is denied with response override params")
		return &Response{
			MetaOpts: &MetaOptions{
				BucketOwner: parsedAcl.Owner,
			},
		}, s3err.GetAPIError(s3err.ErrAnonymousResponseHeaders)
	}

	if err := utils.ValidateVersionId(ctx); err != nil {
		return &Response{
			MetaOpts: &MetaOptions{
				BucketOwner: parsedAcl.Owner,
			},
		}, err
	}

	action := auth.GetObjectAction
	if ctx.Request().URI().QueryArgs().Has("versionId") {
		action = auth.GetObjectVersionAction
	}

	err := c.verifyAccess(ctx,
		auth.AccessOptions{
			Acl:             parsedAcl,
			AclPermission:   auth.PermissionRead,
			IsRoot:          isRoot,
			Acc:             acct,
			Bucket:          bucket,
			Object:          key,
			Actions:         []auth.Action{action},
			IsPublicRequest: isPublicBucket,
		})
	if err != nil {
		return &Response{
			MetaOpts: &MetaOptions{
				BucketOwner: parsedAcl.Owner,
			},
		}, err
	}

	ssec, err := c.parseSSECHeaders(ctx)
	if err != nil {
		return &Response{
			MetaOpts: &MetaOptions{
				BucketOwner: parsedAcl.Owner,
			},
		}, err
	}

	var partNumber *int32
	if ctx.Request().URI().QueryArgs().Has("partNumber") {
		if partNumberQuery < minPartNumber || partNumberQuery > int32(c.effectiveMpMaxParts()) {
			debuglogger.Logf("invalid part number: %d", partNumberQuery)
			return &Response{
				MetaOpts: &MetaOptions{
					BucketOwner: parsedAcl.Owner,
				},
			}, s3err.GetInvalidArgumentErr(s3err.InvalidArgPartNumber, ctx.Query("partNumber"))
		}

		if objRange != "" {
			debuglogger.Logf("Range and partNumber cannot both be specified")
			return &Response{
				MetaOpts: &MetaOptions{
					BucketOwner: parsedAcl.Owner,
				},
			}, s3err.GetAPIError(s3err.ErrRangeAndPartNumber)
		}

		partNumber = &partNumberQuery
	}

	checksumMode := types.ChecksumMode(strings.ToUpper(ctx.Get("x-amz-checksum-mode")))
	if checksumMode != "" && checksumMode != types.ChecksumModeEnabled {
		debuglogger.Logf("invalid x-amz-checksum-mode header value: %v", checksumMode)
		return &Response{
			MetaOpts: &MetaOptions{
				BucketOwner: parsedAcl.Owner,
			},
		}, s3err.GetInvalidChecksumHeaderErr("x-amz-checksum-mode")
	}

	conditionalHeaders := utils.ParsePreconditionHeaders(ctx)

	res, err := c.be.HeadObject(ctx.RequestCtx(),
		&s3.HeadObjectInput{
			SSECustomerAlgorithm: ssec.Algorithm,
			SSECustomerKey:       ssec.Key,
			SSECustomerKeyMD5:    ssec.KeyMD5,
			Bucket:               &bucket,
			Key:                  &key,
			PartNumber:           partNumber,
			VersionId:            &versionId,
			ChecksumMode:         checksumMode,
			Range:                &objRange,
			IfMatch:              conditionalHeaders.IfMatch,
			IfNoneMatch:          conditionalHeaders.IfNoneMatch,
			IfModifiedSince:      conditionalHeaders.IfModSince,
			IfUnmodifiedSince:    conditionalHeaders.IfUnmodeSince,
		})
	if err != nil {
		var headers map[string]*string
		if res != nil {
			headers = map[string]*string{
				"x-amz-delete-marker": utils.GetStringPtr("true"),
				"Last-Modified":       utils.GetStringPtr(res.LastModified.UTC().Format(timefmt)),
			}
		}
		return &Response{
			Headers: headers,
			MetaOpts: &MetaOptions{
				BucketOwner: parsedAcl.Owner,
			},
		}, err
	}

	// Set the metadata headers
	utils.SetMetaHeaders(ctx, res.Metadata)

	status := http.StatusOK
	if res.ContentRange != nil && *res.ContentRange != "" {
		status = http.StatusPartialContent
	}

	return &Response{
		Headers: map[string]*string{
			"Content-Range":                       res.ContentRange,
			"Content-Disposition":                 utils.ApplyOverride(res.ContentDisposition, responseOverrides["Content-Disposition"]),
			"Content-Encoding":                    utils.ApplyOverride(res.ContentEncoding, responseOverrides["Content-Encoding"]),
			"Content-Language":                    utils.ApplyOverride(res.ContentLanguage, responseOverrides["Content-Language"]),
			"Cache-Control":                       utils.ApplyOverride(res.CacheControl, responseOverrides["Cache-Control"]),
			"Content-Length":                      utils.ConvertPtrToStringPtr(res.ContentLength),
			"Content-Type":                        utils.ApplyOverride(res.ContentType, responseOverrides["Content-Type"]),
			"Expires":                             utils.ApplyOverride(res.ExpiresString, responseOverrides["Expires"]),
			"x-amz-website-redirect-location":     res.WebsiteRedirectLocation,
			"ETag":                                res.ETag,
			"Last-Modified":                       utils.FormatDatePtrToString(res.LastModified, timefmt),
			"x-amz-restore":                       res.Restore,
			"accept-ranges":                       res.AcceptRanges,
			"x-amz-checksum-crc32":                res.ChecksumCRC32,
			"x-amz-checksum-crc64nvme":            res.ChecksumCRC64NVME,
			"x-amz-checksum-crc32c":               res.ChecksumCRC32C,
			"x-amz-checksum-sha1":                 res.ChecksumSHA1,
			"x-amz-checksum-sha256":               res.ChecksumSHA256,
			"x-amz-checksum-sha512":               res.ChecksumSHA512,
			"x-amz-checksum-md5":                  res.ChecksumMD5,
			"x-amz-checksum-xxhash64":             res.ChecksumXXHASH64,
			"x-amz-checksum-xxhash3":              res.ChecksumXXHASH3,
			"x-amz-checksum-xxhash128":            res.ChecksumXXHASH128,
			"x-amz-version-id":                    res.VersionId,
			"x-amz-mp-parts-count":                utils.ConvertPtrToStringPtr(res.PartsCount),
			"x-amz-object-lock-mode":              utils.ConvertToStringPtr(res.ObjectLockMode),
			"x-amz-object-lock-legal-hold":        utils.ConvertToStringPtr(res.ObjectLockLegalHoldStatus),
			"x-amz-storage-class":                 utils.ConvertToStringPtr(res.StorageClass),
			"x-amz-checksum-type":                 utils.ConvertToStringPtr(res.ChecksumType),
			"x-amz-object-lock-retain-until-date": utils.FormatDatePtrToString(res.ObjectLockRetainUntilDate, time.RFC3339),
			"x-amz-tagging-count":                 utils.ConvertPtrToStringPtr(res.TagCount),
			"x-amz-server-side-encryption-customer-algorithm": res.SSECustomerAlgorithm,
			"x-amz-server-side-encryption-customer-key-MD5":   res.SSECustomerKeyMD5,
		},
		MetaOpts: &MetaOptions{
			BucketOwner: parsedAcl.Owner,
			Status:      status,
		},
	}, nil
}