mirror of
https://github.com/minio/minio.git
synced 2024-12-24 22:25:54 -05:00
ba5fb2365c
When enabled, it is possible to list/get files inside a zip file without uncompressing it. Signed-off-by: Anis Elleuch <anis@min.io>
507 lines
16 KiB
Go
507 lines
16 KiB
Go
// Copyright (c) 2015-2021 MinIO, Inc.
|
||
//
|
||
// This file is part of MinIO Object Storage stack
|
||
//
|
||
// This program is free software: you can redistribute it and/or modify
|
||
// it under the terms of the GNU Affero General Public License as published by
|
||
// the Free Software Foundation, either version 3 of the License, or
|
||
// (at your option) any later version.
|
||
//
|
||
// This program is distributed in the hope that it will be useful
|
||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
// GNU Affero General Public License for more details.
|
||
//
|
||
// You should have received a copy of the GNU Affero General Public License
|
||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
||
package cmd
|
||
|
||
import (
|
||
"bytes"
|
||
"context"
|
||
"errors"
|
||
"fmt"
|
||
"io"
|
||
stdioutil "io/ioutil"
|
||
"net/http"
|
||
"sort"
|
||
"strings"
|
||
|
||
"github.com/minio/minio/internal/crypto"
|
||
"github.com/minio/minio/internal/ioutil"
|
||
"github.com/minio/minio/internal/logger"
|
||
xnet "github.com/minio/minio/internal/net"
|
||
"github.com/minio/pkg/bucket/policy"
|
||
"github.com/minio/zipindex"
|
||
)
|
||
|
||
const (
|
||
archiveType = "zip"
|
||
archiveExt = "." + archiveType // ".zip"
|
||
archiveSeparator = "/"
|
||
archivePattern = archiveExt + archiveSeparator // ".zip/"
|
||
archiveTypeMetadataKey = ReservedMetadataPrefixLower + "archive-type" // "x-minio-internal-archive-type"
|
||
archiveInfoMetadataKey = ReservedMetadataPrefixLower + "archive-info" // "x-minio-internal-archive-info"
|
||
|
||
// Peek into a zip archive
|
||
xMinIOExtract = "x-minio-extract"
|
||
)
|
||
|
||
// splitZipExtensionPath splits the S3 path to the zip file and the path inside the zip:
|
||
// e.g /path/to/archive.zip/backup-2021/myimage.png => /path/to/archive.zip, backup/myimage.png
|
||
func splitZipExtensionPath(input string) (zipPath, object string, err error) {
|
||
idx := strings.Index(input, archivePattern)
|
||
if idx < 0 {
|
||
// Should never happen
|
||
return "", "", errors.New("unable to parse zip path")
|
||
}
|
||
return input[:idx+len(archivePattern)-1], input[idx+len(archivePattern):], nil
|
||
}
|
||
|
||
// getObjectInArchiveFileHandler - GET Object in the archive file
|
||
func (api objectAPIHandlers) getObjectInArchiveFileHandler(ctx context.Context, objectAPI ObjectLayer, bucket, object string, w http.ResponseWriter, r *http.Request) {
|
||
if crypto.S3.IsRequested(r.Header) || crypto.S3KMS.IsRequested(r.Header) { // If SSE-S3 or SSE-KMS present -> AWS fails with undefined error
|
||
writeErrorResponse(ctx, w, errorCodes.ToAPIErr(ErrBadRequest), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
if _, ok := crypto.IsRequested(r.Header); !objectAPI.IsEncryptionSupported() && ok {
|
||
writeErrorResponse(ctx, w, errorCodes.ToAPIErr(ErrBadRequest), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
zipPath, object, err := splitZipExtensionPath(object)
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
// get gateway encryption options
|
||
opts, err := getOpts(ctx, r, bucket, zipPath)
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
getObjectInfo := objectAPI.GetObjectInfo
|
||
if api.CacheAPI() != nil {
|
||
getObjectInfo = api.CacheAPI().GetObjectInfo
|
||
}
|
||
|
||
// Check for auth type to return S3 compatible error.
|
||
// type to return the correct error (NoSuchKey vs AccessDenied)
|
||
if s3Error := checkRequestAuthType(ctx, r, policy.GetObjectAction, bucket, zipPath); s3Error != ErrNone {
|
||
if getRequestAuthType(r) == authTypeAnonymous {
|
||
// As per "Permission" section in
|
||
// https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html
|
||
// If the object you request does not exist,
|
||
// the error Amazon S3 returns depends on
|
||
// whether you also have the s3:ListBucket
|
||
// permission.
|
||
// * If you have the s3:ListBucket permission
|
||
// on the bucket, Amazon S3 will return an
|
||
// HTTP status code 404 ("no such key")
|
||
// error.
|
||
// * if you don’t have the s3:ListBucket
|
||
// permission, Amazon S3 will return an HTTP
|
||
// status code 403 ("access denied") error.`
|
||
if globalPolicySys.IsAllowed(policy.Args{
|
||
Action: policy.ListBucketAction,
|
||
BucketName: bucket,
|
||
ConditionValues: getConditionValues(r, "", "", nil),
|
||
IsOwner: false,
|
||
}) {
|
||
_, err = getObjectInfo(ctx, bucket, zipPath, opts)
|
||
if toAPIError(ctx, err).Code == "NoSuchKey" {
|
||
s3Error = ErrNoSuchKey
|
||
}
|
||
}
|
||
}
|
||
writeErrorResponse(ctx, w, errorCodes.ToAPIErr(s3Error), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
// Validate pre-conditions if any.
|
||
opts.CheckPrecondFn = func(oi ObjectInfo) bool {
|
||
if objectAPI.IsEncryptionSupported() {
|
||
if _, err := DecryptObjectInfo(&oi, r); err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return true
|
||
}
|
||
}
|
||
|
||
return checkPreconditions(ctx, w, r, oi, opts)
|
||
}
|
||
|
||
zipObjInfo, err := getObjectInfo(ctx, bucket, zipPath, opts)
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
var zipInfo []byte
|
||
|
||
if z, ok := zipObjInfo.UserDefined[archiveInfoMetadataKey]; ok {
|
||
zipInfo = []byte(z)
|
||
} else {
|
||
zipInfo, err = updateObjectMetadataWithZipInfo(ctx, objectAPI, bucket, zipPath, opts)
|
||
}
|
||
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
file, err := zipindex.FindSerialized(zipInfo, object)
|
||
if err != nil {
|
||
if err == io.EOF {
|
||
writeErrorResponse(ctx, w, errorCodes.ToAPIErr(ErrNoSuchKey), r.URL, guessIsBrowserReq(r))
|
||
} else {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
}
|
||
return
|
||
}
|
||
|
||
// New object info
|
||
fileObjInfo := ObjectInfo{
|
||
Bucket: bucket,
|
||
Name: object,
|
||
Size: int64(file.UncompressedSize64),
|
||
ModTime: zipObjInfo.ModTime,
|
||
}
|
||
|
||
var rc io.ReadCloser
|
||
|
||
if file.UncompressedSize64 > 0 {
|
||
rs := &HTTPRangeSpec{Start: file.Offset, End: file.Offset + int64(file.UncompressedSize64) - 1}
|
||
gr, err := objectAPI.GetObjectNInfo(ctx, bucket, zipPath, rs, nil, readLock, opts)
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
defer gr.Close()
|
||
rc, err = file.Open(gr)
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
} else {
|
||
rc = stdioutil.NopCloser(bytes.NewReader([]byte{}))
|
||
}
|
||
|
||
defer rc.Close()
|
||
|
||
if err = setObjectHeaders(w, fileObjInfo, nil, opts); err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
setHeadGetRespHeaders(w, r.URL.Query())
|
||
|
||
httpWriter := ioutil.WriteOnClose(w)
|
||
|
||
// Write object content to response body
|
||
if _, err = io.Copy(httpWriter, rc); err != nil {
|
||
if !httpWriter.HasWritten() {
|
||
// write error response only if no data or headers has been written to client yet
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
if !xnet.IsNetworkOrHostDown(err, true) { // do not need to log disconnected clients
|
||
logger.LogIf(ctx, fmt.Errorf("Unable to write all the data to client %w", err))
|
||
}
|
||
return
|
||
}
|
||
|
||
if err = httpWriter.Close(); err != nil {
|
||
if !httpWriter.HasWritten() { // write error response only if no data or headers has been written to client yet
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
if !xnet.IsNetworkOrHostDown(err, true) { // do not need to log disconnected clients
|
||
logger.LogIf(ctx, fmt.Errorf("Unable to write all the data to client %w", err))
|
||
}
|
||
return
|
||
}
|
||
}
|
||
|
||
// listObjectsV2InArchive generates S3 listing result ListObjectsV2Info from zip file, all parameters are already validated by the caller.
|
||
func listObjectsV2InArchive(ctx context.Context, objectAPI ObjectLayer, bucket, prefix, token, delimiter string, maxKeys int, fetchOwner bool, startAfter string) (ListObjectsV2Info, error) {
|
||
zipPath, _, err := splitZipExtensionPath(prefix)
|
||
if err != nil {
|
||
// Return empty listing
|
||
return ListObjectsV2Info{}, nil
|
||
}
|
||
|
||
zipObjInfo, err := objectAPI.GetObjectInfo(ctx, bucket, zipPath, ObjectOptions{})
|
||
if err != nil {
|
||
// Return empty listing
|
||
return ListObjectsV2Info{}, nil
|
||
}
|
||
|
||
var zipInfo []byte
|
||
|
||
if z, ok := zipObjInfo.UserDefined[archiveInfoMetadataKey]; ok {
|
||
zipInfo = []byte(z)
|
||
} else {
|
||
// Always update the latest version
|
||
zipInfo, err = updateObjectMetadataWithZipInfo(ctx, objectAPI, bucket, zipPath, ObjectOptions{})
|
||
}
|
||
|
||
if err != nil {
|
||
return ListObjectsV2Info{}, err
|
||
}
|
||
|
||
files, err := zipindex.DeserializeFiles(zipInfo)
|
||
if err != nil {
|
||
return ListObjectsV2Info{}, err
|
||
}
|
||
|
||
sort.Slice(files, func(i, j int) bool {
|
||
return files[i].Name < files[j].Name
|
||
})
|
||
|
||
var (
|
||
count int
|
||
isTruncated bool
|
||
nextToken string
|
||
listObjectsInfo ListObjectsV2Info
|
||
)
|
||
|
||
// Always set this
|
||
listObjectsInfo.ContinuationToken = token
|
||
|
||
// Open and iterate through the files in the archive.
|
||
for _, file := range files {
|
||
objName := zipObjInfo.Name + archiveSeparator + file.Name
|
||
if objName <= startAfter || objName <= token {
|
||
continue
|
||
}
|
||
if strings.HasPrefix(objName, prefix) {
|
||
if count == maxKeys {
|
||
isTruncated = true
|
||
break
|
||
}
|
||
if delimiter != "" {
|
||
i := strings.Index(objName[len(prefix):], delimiter)
|
||
if i >= 0 {
|
||
commonPrefix := objName[:len(prefix)+i+1]
|
||
if len(listObjectsInfo.Prefixes) == 0 || commonPrefix != listObjectsInfo.Prefixes[len(listObjectsInfo.Prefixes)-1] {
|
||
listObjectsInfo.Prefixes = append(listObjectsInfo.Prefixes, commonPrefix)
|
||
count++
|
||
}
|
||
goto next
|
||
}
|
||
}
|
||
listObjectsInfo.Objects = append(listObjectsInfo.Objects, ObjectInfo{
|
||
Bucket: bucket,
|
||
Name: objName,
|
||
Size: int64(file.UncompressedSize64),
|
||
ModTime: zipObjInfo.ModTime,
|
||
})
|
||
count++
|
||
}
|
||
next:
|
||
nextToken = objName
|
||
}
|
||
|
||
if isTruncated {
|
||
listObjectsInfo.IsTruncated = true
|
||
listObjectsInfo.NextContinuationToken = nextToken
|
||
}
|
||
|
||
return listObjectsInfo, nil
|
||
}
|
||
|
||
// getFilesFromZIPObject reads a partial stream of a zip file to build the zipindex.Files index
|
||
func getFilesListFromZIPObject(ctx context.Context, objectAPI ObjectLayer, bucket, object string, opts ObjectOptions) (zipindex.Files, ObjectInfo, error) {
|
||
var size = 1 << 20
|
||
var objSize int64
|
||
for {
|
||
rs := &HTTPRangeSpec{IsSuffixLength: true, Start: int64(-size)}
|
||
gr, err := objectAPI.GetObjectNInfo(ctx, bucket, object, rs, nil, readLock, opts)
|
||
if err != nil {
|
||
return nil, ObjectInfo{}, err
|
||
}
|
||
b, err := stdioutil.ReadAll(gr)
|
||
if err != nil {
|
||
gr.Close()
|
||
return nil, ObjectInfo{}, err
|
||
}
|
||
gr.Close()
|
||
if size > len(b) {
|
||
size = len(b)
|
||
}
|
||
|
||
// Calculate the object real size if encrypted
|
||
if _, ok := crypto.IsEncrypted(gr.ObjInfo.UserDefined); ok {
|
||
objSize, err = gr.ObjInfo.DecryptedSize()
|
||
if err != nil {
|
||
return nil, ObjectInfo{}, err
|
||
}
|
||
} else {
|
||
objSize = gr.ObjInfo.Size
|
||
}
|
||
|
||
files, err := zipindex.ReadDir(b[len(b)-size:], objSize, nil)
|
||
if err == nil {
|
||
return files, gr.ObjInfo, nil
|
||
}
|
||
var terr zipindex.ErrNeedMoreData
|
||
if errors.As(err, &terr) {
|
||
size = int(terr.FromEnd)
|
||
if size <= 0 || size > 100<<20 {
|
||
return nil, ObjectInfo{}, errors.New("zip directory too large")
|
||
}
|
||
} else {
|
||
return nil, ObjectInfo{}, err
|
||
}
|
||
}
|
||
}
|
||
|
||
// headObjectInArchiveFileHandler - HEAD Object in an archive file
|
||
func (api objectAPIHandlers) headObjectInArchiveFileHandler(ctx context.Context, objectAPI ObjectLayer, bucket, object string, w http.ResponseWriter, r *http.Request) {
|
||
if crypto.S3.IsRequested(r.Header) || crypto.S3KMS.IsRequested(r.Header) { // If SSE-S3 or SSE-KMS present -> AWS fails with undefined error
|
||
writeErrorResponseHeadersOnly(w, errorCodes.ToAPIErr(ErrBadRequest))
|
||
return
|
||
}
|
||
if _, ok := crypto.IsRequested(r.Header); !objectAPI.IsEncryptionSupported() && ok {
|
||
writeErrorResponse(ctx, w, errorCodes.ToAPIErr(ErrBadRequest), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
zipPath, object, err := splitZipExtensionPath(object)
|
||
if err != nil {
|
||
writeErrorResponseHeadersOnly(w, toAPIError(ctx, err))
|
||
return
|
||
}
|
||
|
||
getObjectInfo := objectAPI.GetObjectInfo
|
||
if api.CacheAPI() != nil {
|
||
getObjectInfo = api.CacheAPI().GetObjectInfo
|
||
}
|
||
|
||
opts, err := getOpts(ctx, r, bucket, zipPath)
|
||
if err != nil {
|
||
writeErrorResponseHeadersOnly(w, toAPIError(ctx, err))
|
||
return
|
||
}
|
||
|
||
if s3Error := checkRequestAuthType(ctx, r, policy.GetObjectAction, bucket, zipPath); s3Error != ErrNone {
|
||
if getRequestAuthType(r) == authTypeAnonymous {
|
||
// As per "Permission" section in
|
||
// https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectHEAD.html
|
||
// If the object you request does not exist,
|
||
// the error Amazon S3 returns depends on
|
||
// whether you also have the s3:ListBucket
|
||
// permission.
|
||
// * If you have the s3:ListBucket permission
|
||
// on the bucket, Amazon S3 will return an
|
||
// HTTP status code 404 ("no such key")
|
||
// error.
|
||
// * if you don’t have the s3:ListBucket
|
||
// permission, Amazon S3 will return an HTTP
|
||
// status code 403 ("access denied") error.`
|
||
if globalPolicySys.IsAllowed(policy.Args{
|
||
Action: policy.ListBucketAction,
|
||
BucketName: bucket,
|
||
ConditionValues: getConditionValues(r, "", "", nil),
|
||
IsOwner: false,
|
||
}) {
|
||
_, err = getObjectInfo(ctx, bucket, zipPath, opts)
|
||
if toAPIError(ctx, err).Code == "NoSuchKey" {
|
||
s3Error = ErrNoSuchKey
|
||
}
|
||
}
|
||
}
|
||
writeErrorResponseHeadersOnly(w, errorCodes.ToAPIErr(s3Error))
|
||
return
|
||
}
|
||
|
||
var rs *HTTPRangeSpec
|
||
|
||
// Validate pre-conditions if any.
|
||
opts.CheckPrecondFn = func(oi ObjectInfo) bool {
|
||
return checkPreconditions(ctx, w, r, oi, opts)
|
||
}
|
||
|
||
zipObjInfo, err := getObjectInfo(ctx, bucket, zipPath, opts)
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
var zipInfo []byte
|
||
|
||
if z, ok := zipObjInfo.UserDefined[archiveInfoMetadataKey]; ok {
|
||
zipInfo = []byte(z)
|
||
} else {
|
||
zipInfo, err = updateObjectMetadataWithZipInfo(ctx, objectAPI, bucket, zipPath, opts)
|
||
}
|
||
if err != nil {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
return
|
||
}
|
||
|
||
file, err := zipindex.FindSerialized(zipInfo, object)
|
||
if err != nil {
|
||
if err == io.EOF {
|
||
writeErrorResponse(ctx, w, errorCodes.ToAPIErr(ErrNoSuchKey), r.URL, guessIsBrowserReq(r))
|
||
} else {
|
||
writeErrorResponse(ctx, w, toAPIError(ctx, err), r.URL, guessIsBrowserReq(r))
|
||
}
|
||
return
|
||
}
|
||
|
||
objInfo := ObjectInfo{
|
||
Bucket: bucket,
|
||
Name: file.Name,
|
||
Size: int64(file.UncompressedSize64),
|
||
ModTime: zipObjInfo.ModTime,
|
||
}
|
||
|
||
// Set standard object headers.
|
||
if err = setObjectHeaders(w, objInfo, nil, opts); err != nil {
|
||
writeErrorResponseHeadersOnly(w, toAPIError(ctx, err))
|
||
return
|
||
}
|
||
|
||
// Set any additional requested response headers.
|
||
setHeadGetRespHeaders(w, r.URL.Query())
|
||
|
||
// Successful response.
|
||
if rs != nil {
|
||
w.WriteHeader(http.StatusPartialContent)
|
||
} else {
|
||
w.WriteHeader(http.StatusOK)
|
||
}
|
||
}
|
||
|
||
// Update the passed zip object metadata with the zip contents info, file name, modtime, size, etc..
|
||
func updateObjectMetadataWithZipInfo(ctx context.Context, objectAPI ObjectLayer, bucket, object string, opts ObjectOptions) ([]byte, error) {
|
||
files, srcInfo, err := getFilesListFromZIPObject(ctx, objectAPI, bucket, object, opts)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
files.OptimizeSize()
|
||
zipInfo, err := files.Serialize()
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
|
||
srcInfo.UserDefined[archiveTypeMetadataKey] = archiveType
|
||
srcInfo.UserDefined[archiveInfoMetadataKey] = string(zipInfo)
|
||
srcInfo.metadataOnly = true
|
||
|
||
// Always update the same version id & modtime
|
||
|
||
// Passing opts twice as source & destination options will update the metadata
|
||
// of the same object version to avoid creating a new version.
|
||
_, err = objectAPI.CopyObject(ctx, bucket, object, bucket, object, srcInfo, opts, opts)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
|
||
return zipInfo, nil
|
||
}
|