components-contrib/bindings/aws/s3/s3.go

350 lines
8.7 KiB
Go

/*
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 (
"bytes"
"context"
"crypto/tls"
b64 "encoding/base64"
"encoding/json"
"fmt"
"net/http"
"os"
"strconv"
"github.com/aws/aws-sdk-go/aws"
"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"
aws_auth "github.com/dapr/components-contrib/authentication/aws"
"github.com/dapr/components-contrib/bindings"
"github.com/dapr/kit/logger"
)
const (
metadataDecodeBase64 = "decodeBase64"
metadataEncodeBase64 = "encodeBase64"
metadataFilePath = "filePath"
metadataKey = "key"
maxResults = 1000
)
// 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 {
Region string `json:"region"`
Endpoint string `json:"endpoint"`
AccessKey string `json:"accessKey"`
SecretKey string `json:"secretKey"`
SessionToken string `json:"sessionToken"`
Bucket string `json:"bucket"`
DecodeBase64 bool `json:"decodeBase64,string"`
EncodeBase64 bool `json:"encodeBase64,string"`
ForcePathStyle bool `json:"forcePathStyle,string"`
DisableSSL bool `json:"disableSSL,string"`
InsecureSSL bool `json:"insecureSSL,string"`
FilePath string
}
type createResponse struct {
Location string `json:"location"`
VersionID *string `json:"versionID"`
}
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) *AWSS3 {
return &AWSS3{logger: logger}
}
// Init does metadata parsing and connection creation.
func (s *AWSS3) Init(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.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,
}
}
func (s *AWSS3) create(req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
metadata, err := s.metadata.mergeWithRequestMetadata(req)
if err != nil {
return nil, fmt.Errorf("s3 binding error. error merge metadata : %w", err)
}
var key string
if val, ok := req.Metadata[metadataKey]; ok && val != "" {
key = val
} else {
key = uuid.New().String()
s.logger.Debugf("key not found. generating key %s", key)
}
d, err := strconv.Unquote(string(req.Data))
if err == nil {
req.Data = []byte(d)
}
if metadata.DecodeBase64 {
decoded, decodeError := b64.StdEncoding.DecodeString(string(req.Data))
if decodeError != nil {
return nil, fmt.Errorf("s3 binding error. decode : %w", decodeError)
}
req.Data = decoded
}
var data []byte
if metadata.FilePath != "" {
data, err = os.ReadFile(metadata.FilePath)
if err != nil {
return nil, fmt.Errorf("s3 file read error: %s", err)
}
} else {
data = req.Data
}
r := bytes.NewReader(data)
resultUpload, err := s.uploader.Upload(&s3manager.UploadInput{
Bucket: aws.String(metadata.Bucket),
Key: aws.String(key),
Body: r,
})
if err != nil {
return nil, fmt.Errorf("s3 binding error. Uploading: %w", err)
}
jsonResponse, err := json.Marshal(createResponse{
Location: resultUpload.Location,
VersionID: resultUpload.VersionID,
})
if err != nil {
return nil, fmt.Errorf("s3 binding error. Error marshalling create response: %w", err)
}
return &bindings.InvokeResponse{
Data: jsonResponse,
}, nil
}
func (s *AWSS3) get(req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
metadata, err := s.metadata.mergeWithRequestMetadata(req)
if err != nil {
return nil, fmt.Errorf("s3 binding error. error merge metadata : %w", err)
}
var key string
if val, ok := req.Metadata[metadataKey]; ok && val != "" {
key = val
} else {
return nil, fmt.Errorf("s3 binding error: can't read key value")
}
buff := &aws.WriteAtBuffer{}
_, err = s.downloader.Download(buff,
&s3.GetObjectInput{
Bucket: aws.String(s.metadata.Bucket),
Key: aws.String(key),
})
if err != nil {
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(req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
var key string
if val, ok := req.Metadata[metadataKey]; ok && val != "" {
key = val
} else {
return nil, fmt.Errorf("s3 binding error: can't read key value")
}
_, err := s.s3Client.DeleteObject(
&s3.DeleteObjectInput{
Bucket: aws.String(s.metadata.Bucket),
Key: aws.String(key),
})
return nil, err
}
func (s *AWSS3) list(req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
var payload listPayload
err := json.Unmarshal(req.Data, &payload)
if err != nil {
return nil, err
}
if payload.MaxResults == int32(0) {
payload.MaxResults = maxResults
}
input := &s3.ListObjectsInput{
Bucket: aws.String(s.metadata.Bucket),
MaxKeys: aws.Int64(int64(payload.MaxResults)),
Marker: aws.String(payload.Marker),
Prefix: aws.String(payload.Prefix),
Delimiter: aws.String(payload.Delimiter),
}
result, err := s.s3Client.ListObjects(input)
if err != nil {
return nil, fmt.Errorf("s3 binding error. list operation. cannot marshal blobs to json: %w", err)
}
jsonResponse, err := json.Marshal(result)
if err != nil {
return nil, fmt.Errorf("s3 binding error. list operation. cannot marshal blobs 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(req)
case bindings.GetOperation:
return s.get(req)
case bindings.DeleteOperation:
return s.delete(req)
case bindings.ListOperation:
return s.list(req)
default:
return nil, fmt.Errorf("s3 binding error. unsupported operation %s", req.Operation)
}
}
func (s *AWSS3) parseMetadata(metadata bindings.Metadata) (*s3Metadata, error) {
b, err := json.Marshal(metadata.Properties)
if err != nil {
return nil, err
}
var m s3Metadata
err = json.Unmarshal(b, &m)
if err != nil {
return nil, err
}
return &m, nil
}
func (s *AWSS3) getSession(metadata *s3Metadata) (*session.Session, error) {
sess, err := aws_auth.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 != "" {
valBool, err := strconv.ParseBool(val)
if err != nil {
return merged, err
}
merged.DecodeBase64 = valBool
}
if val, ok := req.Metadata[metadataEncodeBase64]; ok && val != "" {
valBool, err := strconv.ParseBool(val)
if err != nil {
return merged, err
}
merged.EncodeBase64 = valBool
}
if val, ok := req.Metadata[metadataFilePath]; ok && val != "" {
merged.FilePath = val
}
return merged, nil
}