/* Copyright 2021 The Dapr Authors 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 s3 import ( "context" "crypto/tls" b64 "encoding/base64" "encoding/json" "errors" "fmt" "io" "net/http" "os" "reflect" "strings" "time" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/awserr" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/s3" "github.com/aws/aws-sdk-go/service/s3/s3manager" "github.com/google/uuid" "github.com/dapr/components-contrib/bindings" awsAuth "github.com/dapr/components-contrib/common/authentication/aws" commonutils "github.com/dapr/components-contrib/common/utils" "github.com/dapr/components-contrib/metadata" "github.com/dapr/kit/logger" kitmd "github.com/dapr/kit/metadata" "github.com/dapr/kit/ptr" "github.com/dapr/kit/utils" ) const ( metadataDecodeBase64 = "decodeBase64" metadataEncodeBase64 = "encodeBase64" metadataFilePath = "filePath" metadataPresignTTL = "presignTTL" metatadataContentType = "Content-Type" metadataKey = "key" defaultMaxResults = 1000 presignOperation = "presign" ) // AWSS3 is a binding for an AWS S3 storage bucket. type AWSS3 struct { metadata *s3Metadata s3Client *s3.S3 uploader *s3manager.Uploader downloader *s3manager.Downloader logger logger.Logger } type s3Metadata struct { // Ignored by metadata parser because included in built-in authentication profile AccessKey string `json:"accessKey" mapstructure:"accessKey" mdignore:"true"` SecretKey string `json:"secretKey" mapstructure:"secretKey" mdignore:"true"` SessionToken string `json:"sessionToken" mapstructure:"sessionToken" mdignore:"true"` Region string `json:"region" mapstructure:"region"` Endpoint string `json:"endpoint" mapstructure:"endpoint"` Bucket string `json:"bucket" mapstructure:"bucket"` DecodeBase64 bool `json:"decodeBase64,string" mapstructure:"decodeBase64"` EncodeBase64 bool `json:"encodeBase64,string" mapstructure:"encodeBase64"` ForcePathStyle bool `json:"forcePathStyle,string" mapstructure:"forcePathStyle"` DisableSSL bool `json:"disableSSL,string" mapstructure:"disableSSL"` InsecureSSL bool `json:"insecureSSL,string" mapstructure:"insecureSSL"` FilePath string `json:"filePath" mapstructure:"filePath" mdignore:"true"` PresignTTL string `json:"presignTTL" mapstructure:"presignTTL" mdignore:"true"` } type createResponse struct { Location string `json:"location"` VersionID *string `json:"versionID"` PresignURL string `json:"presignURL,omitempty"` } type presignResponse struct { PresignURL string `json:"presignURL"` } type listPayload struct { Marker string `json:"marker"` Prefix string `json:"prefix"` MaxResults int32 `json:"maxResults"` Delimiter string `json:"delimiter"` } // NewAWSS3 returns a new AWSS3 instance. func NewAWSS3(logger logger.Logger) bindings.OutputBinding { return &AWSS3{logger: logger} } // Init does metadata parsing and connection creation. func (s *AWSS3) Init(_ context.Context, metadata bindings.Metadata) error { m, err := s.parseMetadata(metadata) if err != nil { return err } session, err := s.getSession(m) if err != nil { return err } cfg := aws.NewConfig(). WithS3ForcePathStyle(m.ForcePathStyle). WithDisableSSL(m.DisableSSL) // Use a custom HTTP client to allow self-signed certs if m.InsecureSSL { customTransport := http.DefaultTransport.(*http.Transport).Clone() customTransport.TLSClientConfig = &tls.Config{ //nolint:gosec InsecureSkipVerify: true, } client := &http.Client{ Transport: customTransport, } cfg = cfg.WithHTTPClient(client) s.logger.Infof("aws s3: you are using 'insecureSSL' to skip server config verify which is unsafe!") } s.metadata = m s.s3Client = s3.New(session, cfg) s.downloader = s3manager.NewDownloaderWithClient(s.s3Client) s.uploader = s3manager.NewUploaderWithClient(s.s3Client) return nil } func (s *AWSS3) Close() error { return nil } func (s *AWSS3) Operations() []bindings.OperationKind { return []bindings.OperationKind{ bindings.CreateOperation, bindings.GetOperation, bindings.DeleteOperation, bindings.ListOperation, presignOperation, } } func (s *AWSS3) create(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) { metadata, err := s.metadata.mergeWithRequestMetadata(req) if err != nil { return nil, fmt.Errorf("s3 binding error: error merging metadata: %w", err) } key := req.Metadata[metadataKey] if key == "" { var u uuid.UUID u, err = uuid.NewRandom() if err != nil { return nil, fmt.Errorf("s3 binding error: failed to generate UUID: %w", err) } key = u.String() s.logger.Debugf("s3 binding error: key not found. generating key %s", key) } var contentType *string contentTypeStr := strings.TrimSpace(req.Metadata[metatadataContentType]) if contentTypeStr != "" { contentType = &contentTypeStr } var r io.Reader if metadata.FilePath != "" { r, err = os.Open(metadata.FilePath) if err != nil { return nil, fmt.Errorf("s3 binding error: file read error: %w", err) } } else { r = strings.NewReader(commonutils.Unquote(req.Data)) } if metadata.DecodeBase64 { r = b64.NewDecoder(b64.StdEncoding, r) } resultUpload, err := s.uploader.UploadWithContext(ctx, &s3manager.UploadInput{ Bucket: ptr.Of(metadata.Bucket), Key: ptr.Of(key), Body: r, ContentType: contentType, }) if err != nil { return nil, fmt.Errorf("s3 binding error: uploading failed: %w", err) } var presignURL string if metadata.PresignTTL != "" { url, presignErr := s.presignObject(metadata.Bucket, key, metadata.PresignTTL) if presignErr != nil { return nil, fmt.Errorf("s3 binding error: %s", presignErr) } presignURL = url } jsonResponse, err := json.Marshal(createResponse{ Location: resultUpload.Location, VersionID: resultUpload.VersionID, PresignURL: presignURL, }) if err != nil { return nil, fmt.Errorf("s3 binding error: error marshalling create response: %w", err) } return &bindings.InvokeResponse{ Data: jsonResponse, Metadata: map[string]string{ metadataKey: key, }, }, nil } func (s *AWSS3) presign(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) { metadata, err := s.metadata.mergeWithRequestMetadata(req) if err != nil { return nil, fmt.Errorf("s3 binding error: error merging metadata: %w", err) } key := req.Metadata[metadataKey] if key == "" { return nil, fmt.Errorf("s3 binding error: required metadata '%s' missing", metadataKey) } if metadata.PresignTTL == "" { return nil, fmt.Errorf("s3 binding error: required metadata '%s' missing", metadataPresignTTL) } url, err := s.presignObject(metadata.Bucket, key, metadata.PresignTTL) if err != nil { return nil, fmt.Errorf("s3 binding error: %w", err) } jsonResponse, err := json.Marshal(presignResponse{ PresignURL: url, }) if err != nil { return nil, fmt.Errorf("s3 binding error: error marshalling presign response: %w", err) } return &bindings.InvokeResponse{ Data: jsonResponse, }, nil } func (s *AWSS3) presignObject(bucket, key, ttl string) (string, error) { d, err := time.ParseDuration(ttl) if err != nil { return "", fmt.Errorf("s3 binding error: cannot parse duration %s: %w", ttl, err) } objReq, _ := s.s3Client.GetObjectRequest(&s3.GetObjectInput{ Bucket: ptr.Of(bucket), Key: ptr.Of(key), }) url, err := objReq.Presign(d) if err != nil { return "", fmt.Errorf("s3 binding error: failed to presign URL: %w", err) } return url, nil } func (s *AWSS3) get(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) { metadata, err := s.metadata.mergeWithRequestMetadata(req) if err != nil { return nil, fmt.Errorf("s3 binding error: error merging metadata : %w", err) } key := req.Metadata[metadataKey] if key == "" { return nil, fmt.Errorf("s3 binding error: required metadata '%s' missing", metadataKey) } buff := &aws.WriteAtBuffer{} _, err = s.downloader.DownloadWithContext(ctx, buff, &s3.GetObjectInput{ Bucket: ptr.Of(s.metadata.Bucket), Key: ptr.Of(key), }, ) if err != nil { var awsErr awserr.Error if errors.As(err, &awsErr) && awsErr.Code() == s3.ErrCodeNoSuchKey { return nil, fmt.Errorf("object not found") } return nil, fmt.Errorf("s3 binding error: error downloading S3 object: %w", err) } var data []byte if metadata.EncodeBase64 { encoded := b64.StdEncoding.EncodeToString(buff.Bytes()) data = []byte(encoded) } else { data = buff.Bytes() } return &bindings.InvokeResponse{ Data: data, Metadata: nil, }, nil } func (s *AWSS3) delete(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) { key := req.Metadata[metadataKey] if key == "" { return nil, fmt.Errorf("s3 binding error: required metadata '%s' missing", metadataKey) } _, err := s.s3Client.DeleteObjectWithContext( ctx, &s3.DeleteObjectInput{ Bucket: ptr.Of(s.metadata.Bucket), Key: ptr.Of(key), }, ) if err != nil { var awsErr awserr.Error if errors.As(err, &awsErr) && awsErr.Code() == s3.ErrCodeNoSuchKey { return nil, fmt.Errorf("object not found") } return nil, fmt.Errorf("s3 binding error: delete operation failed: %w", err) } return nil, nil } func (s *AWSS3) list(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) { payload := listPayload{} if req.Data != nil { if err := json.Unmarshal(req.Data, &payload); err != nil { return nil, fmt.Errorf("s3 binding (List Operation) - unable to parse Data property - %v", err) } } if payload.MaxResults < 1 { payload.MaxResults = defaultMaxResults } result, err := s.s3Client.ListObjectsWithContext(ctx, &s3.ListObjectsInput{ Bucket: ptr.Of(s.metadata.Bucket), MaxKeys: ptr.Of(int64(payload.MaxResults)), Marker: ptr.Of(payload.Marker), Prefix: ptr.Of(payload.Prefix), Delimiter: ptr.Of(payload.Delimiter), }) if err != nil { return nil, fmt.Errorf("s3 binding error: list operation failed: %w", err) } jsonResponse, err := json.Marshal(result) if err != nil { return nil, fmt.Errorf("s3 binding error: list operation: cannot marshal list to json: %w", err) } return &bindings.InvokeResponse{ Data: jsonResponse, }, nil } func (s *AWSS3) Invoke(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) { switch req.Operation { case bindings.CreateOperation: return s.create(ctx, req) case bindings.GetOperation: return s.get(ctx, req) case bindings.DeleteOperation: return s.delete(ctx, req) case bindings.ListOperation: return s.list(ctx, req) case presignOperation: return s.presign(ctx, req) default: return nil, fmt.Errorf("s3 binding error: unsupported operation %s", req.Operation) } } func (s *AWSS3) parseMetadata(md bindings.Metadata) (*s3Metadata, error) { var m s3Metadata err := kitmd.DecodeMetadata(md.Properties, &m) if err != nil { return nil, err } return &m, nil } func (s *AWSS3) getSession(metadata *s3Metadata) (*session.Session, error) { sess, err := awsAuth.GetClient(metadata.AccessKey, metadata.SecretKey, metadata.SessionToken, metadata.Region, metadata.Endpoint) if err != nil { return nil, err } return sess, nil } // Helper to merge config and request metadata. func (metadata s3Metadata) mergeWithRequestMetadata(req *bindings.InvokeRequest) (s3Metadata, error) { merged := metadata if val, ok := req.Metadata[metadataDecodeBase64]; ok && val != "" { merged.DecodeBase64 = utils.IsTruthy(val) } if val, ok := req.Metadata[metadataEncodeBase64]; ok && val != "" { merged.EncodeBase64 = utils.IsTruthy(val) } if val, ok := req.Metadata[metadataFilePath]; ok && val != "" { merged.FilePath = val } if val, ok := req.Metadata[metadataPresignTTL]; ok && val != "" { merged.PresignTTL = val } return merged, nil } // GetComponentMetadata returns the metadata of the component. func (s *AWSS3) GetComponentMetadata() (metadataInfo metadata.MetadataMap) { metadataStruct := s3Metadata{} metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.BindingType) return }