From c2f14927a08c9b26d1d9b692af34fb2feb33cef7 Mon Sep 17 00:00:00 2001 From: Marina Biryukova Date: Mon, 15 Jul 2024 18:35:54 +0300 Subject: [PATCH] [#422] Support separate container for CORS Signed-off-by: Marina Biryukova --- api/data/info.go | 4 ++- api/layer/cache.go | 6 ++--- api/layer/cors.go | 38 +++++++++++++++++++++-------- api/layer/layer.go | 10 ++++++++ api/layer/object.go | 20 +++++++++++++++ api/layer/system_object.go | 13 +++++++--- cmd/s3-gw/app.go | 50 +++++++++++++++++++++++++++++++++++--- cmd/s3-gw/app_settings.go | 3 +++ config/config.env | 2 ++ config/config.yaml | 4 +++ docs/configuration.md | 13 ++++++++++ internal/logs/logs.go | 1 + 12 files changed, 143 insertions(+), 21 deletions(-) diff --git a/api/data/info.go b/api/data/info.go index 78a124a..686349b 100644 --- a/api/data/info.go +++ b/api/data/info.go @@ -87,7 +87,9 @@ type ( func (b *BucketInfo) SettingsObjectName() string { return bktSettingsObject } // CORSObjectName returns a system name for a bucket CORS configuration file. -func (b *BucketInfo) CORSObjectName() string { return bktCORSConfigurationObject } +func (b *BucketInfo) CORSObjectName() string { + return b.CID.EncodeToString() + bktCORSConfigurationObject +} // VersionID returns object version from ObjectInfo. func (o *ObjectInfo) VersionID() string { return o.ID.EncodeToString() } diff --git a/api/layer/cache.go b/api/layer/cache.go index 0618dee..71520f2 100644 --- a/api/layer/cache.go +++ b/api/layer/cache.go @@ -233,7 +233,7 @@ func (c *Cache) PutSettings(owner user.ID, bktInfo *data.BucketInfo, settings *d } func (c *Cache) GetCORS(owner user.ID, bkt *data.BucketInfo) *data.CORSConfiguration { - key := bkt.Name + bkt.CORSObjectName() + key := bkt.CORSObjectName() if !c.accessCache.Get(owner, key) { return nil @@ -243,7 +243,7 @@ func (c *Cache) GetCORS(owner user.ID, bkt *data.BucketInfo) *data.CORSConfigura } func (c *Cache) PutCORS(owner user.ID, bkt *data.BucketInfo, cors *data.CORSConfiguration) { - key := bkt.Name + bkt.CORSObjectName() + key := bkt.CORSObjectName() if err := c.systemCache.PutCORS(key, cors); err != nil { c.logger.Warn(logs.CouldntCacheCors, zap.String("bucket", bkt.Name), zap.Error(err)) @@ -255,5 +255,5 @@ func (c *Cache) PutCORS(owner user.ID, bkt *data.BucketInfo, cors *data.CORSConf } func (c *Cache) DeleteCORS(bktInfo *data.BucketInfo) { - c.systemCache.Delete(bktInfo.Name + bktInfo.CORSObjectName()) + c.systemCache.Delete(bktInfo.CORSObjectName()) } diff --git a/api/layer/cors.go b/api/layer/cors.go index ce3c0c9..1c27ec1 100644 --- a/api/layer/cors.go +++ b/api/layer/cors.go @@ -37,14 +37,23 @@ func (n *Layer) PutBucketCORS(ctx context.Context, p *PutCORSParams) error { } prm := PrmObjectCreate{ - Container: p.BktInfo.CID, Payload: &buf, Filepath: p.BktInfo.CORSObjectName(), CreationTime: TimeNow(ctx), - CopiesNumber: p.CopiesNumbers, } - _, objID, _, _, err := n.objectPutAndHash(ctx, prm, p.BktInfo) + var corsBkt *data.BucketInfo + if n.corsCnrInfo == nil { + corsBkt = p.BktInfo + prm.CopiesNumber = p.CopiesNumbers + } else { + corsBkt = n.corsCnrInfo + prm.PrmAuth.PrivateKey = &n.gateKey.PrivateKey + } + + prm.Container = corsBkt.CID + + _, objID, _, _, err := n.objectPutAndHash(ctx, prm, corsBkt) if err != nil { return fmt.Errorf("put system object: %w", err) } @@ -56,9 +65,15 @@ func (n *Layer) PutBucketCORS(ctx context.Context, p *PutCORSParams) error { } if !objIDToDeleteNotFound { - if err = n.objectDelete(ctx, p.BktInfo, objIDToDelete); err != nil { + if n.corsCnrInfo == nil { + err = n.objectDelete(ctx, corsBkt, objIDToDelete) + } else { + err = n.objectDeleteWithAuth(ctx, corsBkt, objIDToDelete, PrmAuth{PrivateKey: &n.gateKey.PrivateKey}) + } + + if err != nil { n.reqLogger(ctx).Error(logs.CouldntDeleteCorsObject, zap.Error(err), - zap.String("cnrID", p.BktInfo.CID.EncodeToString()), + zap.String("cnrID", corsBkt.CID.EncodeToString()), zap.String("objID", objIDToDelete.EncodeToString())) } } @@ -71,9 +86,6 @@ func (n *Layer) PutBucketCORS(ctx context.Context, p *PutCORSParams) error { func (n *Layer) GetBucketCORS(ctx context.Context, bktInfo *data.BucketInfo) (*data.CORSConfiguration, error) { cors, err := n.getCORS(ctx, bktInfo) if err != nil { - if errorsStd.Is(err, ErrNodeNotFound) { - return nil, fmt.Errorf("%w: %s", errors.GetAPIError(errors.ErrNoSuchCORSConfiguration), err.Error()) - } return nil, err } @@ -87,8 +99,14 @@ func (n *Layer) DeleteBucketCORS(ctx context.Context, bktInfo *data.BucketInfo) return err } if !objIDNotFound { - if err = n.objectDelete(ctx, bktInfo, objID); err != nil { - return err + if n.corsCnrInfo == nil { + if err = n.objectDelete(ctx, bktInfo, objID); err != nil { + return err + } + } else { + if err = n.objectDeleteWithAuth(ctx, n.corsCnrInfo, objID, PrmAuth{PrivateKey: &n.gateKey.PrivateKey}); err != nil { + return err + } } } diff --git a/api/layer/layer.go b/api/layer/layer.go index c57d3df..d4d370b 100644 --- a/api/layer/layer.go +++ b/api/layer/layer.go @@ -51,6 +51,8 @@ type ( cache *Cache treeService TreeService features FeatureSettings + gateKey *keys.PrivateKey + corsCnrInfo *data.BucketInfo } Config struct { @@ -61,6 +63,8 @@ type ( Resolver BucketResolver TreeService TreeService Features FeatureSettings + GateKey *keys.PrivateKey + CORSCnrInfo *data.BucketInfo } // AnonymousKey contains data for anonymous requests. @@ -233,6 +237,8 @@ func NewLayer(log *zap.Logger, frostFS FrostFS, config *Config) *Layer { cache: config.Cache, treeService: config.TreeService, features: config.Features, + gateKey: config.GateKey, + corsCnrInfo: config.CORSCnrInfo, } } @@ -285,6 +291,10 @@ func (n *Layer) reqLogger(ctx context.Context) *zap.Logger { } func (n *Layer) prepareAuthParameters(ctx context.Context, prm *PrmAuth, bktOwner user.ID) { + if prm.BearerToken != nil || prm.PrivateKey != nil { + return + } + if bd, err := middleware.GetBoxData(ctx); err == nil && bd.Gate.BearerToken != nil { if bd.Gate.BearerToken.Impersonate() || bktOwner.Equals(bearer.ResolveIssuer(*bd.Gate.BearerToken)) { prm.BearerToken = bd.Gate.BearerToken diff --git a/api/layer/object.go b/api/layer/object.go index b8625b3..f25727f 100644 --- a/api/layer/object.go +++ b/api/layer/object.go @@ -151,7 +151,17 @@ func (n *Layer) initFrostFSObjectPayloadReader(ctx context.Context, p getFrostFS // objectGet returns an object with payload in the object. func (n *Layer) objectGet(ctx context.Context, bktInfo *data.BucketInfo, objID oid.ID) (*object.Object, error) { + return n.objectGetBase(ctx, bktInfo, objID, PrmAuth{}) +} + +// objectGetWithAuth returns an object with payload in the object. Uses provided PrmAuth. +func (n *Layer) objectGetWithAuth(ctx context.Context, bktInfo *data.BucketInfo, objID oid.ID, auth PrmAuth) (*object.Object, error) { + return n.objectGetBase(ctx, bktInfo, objID, auth) +} + +func (n *Layer) objectGetBase(ctx context.Context, bktInfo *data.BucketInfo, objID oid.ID, auth PrmAuth) (*object.Object, error) { prm := PrmObjectRead{ + PrmAuth: auth, Container: bktInfo.CID, Object: objID, WithHeader: true, @@ -460,7 +470,17 @@ func (n *Layer) headVersion(ctx context.Context, bkt *data.BucketInfo, p *HeadOb // objectDelete puts tombstone object into frostfs. func (n *Layer) objectDelete(ctx context.Context, bktInfo *data.BucketInfo, idObj oid.ID) error { + return n.objectDeleteBase(ctx, bktInfo, idObj, PrmAuth{}) +} + +// objectDeleteWithAuth puts tombstone object into frostfs. Uses provided PrmAuth. +func (n *Layer) objectDeleteWithAuth(ctx context.Context, bktInfo *data.BucketInfo, idObj oid.ID, auth PrmAuth) error { + return n.objectDeleteBase(ctx, bktInfo, idObj, auth) +} + +func (n *Layer) objectDeleteBase(ctx context.Context, bktInfo *data.BucketInfo, idObj oid.ID, auth PrmAuth) error { prm := PrmObjectDelete{ + PrmAuth: auth, Container: bktInfo.CID, Object: idObj, } diff --git a/api/layer/system_object.go b/api/layer/system_object.go index aa5fa9c..3558a09 100644 --- a/api/layer/system_object.go +++ b/api/layer/system_object.go @@ -12,6 +12,7 @@ import ( "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/object" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/data" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/errors" + sdkObject "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object" oid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id" ) @@ -169,9 +170,15 @@ func (n *Layer) getCORS(ctx context.Context, bkt *data.BucketInfo) (*data.CORSCo return nil, fmt.Errorf("%w: %s", errors.GetAPIError(errors.ErrNoSuchCORSConfiguration), err.Error()) } - obj, err := n.objectGet(ctx, bkt, objID) - if err != nil { - return nil, err + var obj *sdkObject.Object + if n.corsCnrInfo == nil { + if obj, err = n.objectGet(ctx, bkt, objID); err != nil { + return nil, err + } + } else { + if obj, err = n.objectGetWithAuth(ctx, n.corsCnrInfo, objID, PrmAuth{PrivateKey: &n.gateKey.PrivateKey}); err != nil { + return nil, err + } } cors := &data.CORSConfiguration{} diff --git a/cmd/s3-gw/app.go b/cmd/s3-gw/app.go index f46c39d..2fe349d 100644 --- a/cmd/s3-gw/app.go +++ b/cmd/s3-gw/app.go @@ -21,6 +21,7 @@ import ( "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/auth" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/cache" + "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/data" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/handler" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/layer" s3middleware "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/api/middleware" @@ -37,6 +38,8 @@ import ( "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/internal/wallet" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/metrics" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/pkg/service/tree" + "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container" + cid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/id" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/netmap" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/pool" treepool "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/pool/tree" @@ -153,13 +156,13 @@ func (a *App) init(ctx context.Context) { a.setRuntimeParameters() a.initFrostfsID(ctx) a.initPolicyStorage(ctx) - a.initAPI() + a.initAPI(ctx) a.initMetrics() a.initServers(ctx) a.initTracing(ctx) } -func (a *App) initLayer() { +func (a *App) initLayer(ctx context.Context) { a.initResolver() // prepare random key for anonymous requests @@ -171,6 +174,14 @@ func (a *App) initLayer() { var gateOwner user.ID user.IDFromKey(&gateOwner, a.key.PrivateKey.PublicKey) + var corsCnrInfo *data.BucketInfo + if a.cfg.IsSet(cfgContainersCORS) { + corsCnrInfo, err = a.fetchContainerInfo(ctx, cfgContainersCORS) + if err != nil { + a.log.Fatal(logs.CouldNotFetchCORSContainerInfo, zap.Error(err)) + } + } + layerCfg := &layer.Config{ Cache: layer.NewCache(getCacheOptions(a.cfg, a.log)), AnonKey: layer.AnonymousKey{ @@ -180,6 +191,8 @@ func (a *App) initLayer() { Resolver: a.bucketResolver, TreeService: tree.NewTree(services.NewPoolWrapper(a.treePool), a.log), Features: a.settings, + GateKey: a.key, + CORSCnrInfo: corsCnrInfo, } // prepare object layer @@ -434,8 +447,8 @@ func (s *appSettings) RetryStrategy() handler.RetryStrategy { return s.retryStrategy } -func (a *App) initAPI() { - a.initLayer() +func (a *App) initAPI(ctx context.Context) { + a.initLayer(ctx) a.initHandler() } @@ -1034,3 +1047,32 @@ func (a *App) tryReconnect(ctx context.Context, sr *http.Server) bool { return len(a.unbindServers) == 0 } + +func (a *App) fetchContainerInfo(ctx context.Context, cfgKey string) (info *data.BucketInfo, err error) { + containerString := a.cfg.GetString(cfgKey) + + var id cid.ID + if err = id.DecodeString(containerString); err != nil { + if id, err = a.bucketResolver.Resolve(ctx, containerString); err != nil { + return nil, fmt.Errorf("resolve container name %s: %w", containerString, err) + } + } + + return getContainerInfo(ctx, id, a.pool) +} + +func getContainerInfo(ctx context.Context, id cid.ID, frostFSPool *pool.Pool) (*data.BucketInfo, error) { + prm := pool.PrmContainerGet{ + ContainerID: id, + } + + res, err := frostFSPool.GetContainer(ctx, prm) + if err != nil { + return nil, err + } + + return &data.BucketInfo{ + CID: id, + HomomorphicHashDisabled: container.IsHomomorphicHashingDisabled(res), + }, nil +} diff --git a/cmd/s3-gw/app_settings.go b/cmd/s3-gw/app_settings.go index 18ad39e..3aacea4 100644 --- a/cmd/s3-gw/app_settings.go +++ b/cmd/s3-gw/app_settings.go @@ -176,6 +176,9 @@ const ( // Settings. cfgSourceIPHeader = "source_ip_header" + // Containers. + cfgContainersCORS = "containers.cors" + // Command line args. cmdHelp = "help" cmdVersion = "version" diff --git a/config/config.env b/config/config.env index 69e12f5..dd4438a 100644 --- a/config/config.env +++ b/config/config.env @@ -216,3 +216,5 @@ S3_GW_RETRY_MAX_BACKOFF=30s # Backoff strategy. `exponential` and `constant` are allowed. S3_GW_RETRY_STRATEGY=exponential +# Containers properties +S3_GW_CONTAINERS_CORS=AZjLTXfK4vs4ovxMic2xEJKSymMNLqdwq9JT64ASFCRj diff --git a/config/config.yaml b/config/config.yaml index 4ed6be3..aae9e0b 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -252,3 +252,7 @@ retry: max_backoff: 30s # Backoff strategy. `exponential` and `constant` are allowed. strategy: exponential + +# Containers properties +containers: + cors: AZjLTXfK4vs4ovxMic2xEJKSymMNLqdwq9JT64ASFCRj diff --git a/docs/configuration.md b/docs/configuration.md index 524f91b..23ba071 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -192,6 +192,7 @@ There are some custom types used for brevity: | `proxy` | [Proxy contract configuration](#proxy-section) | | `namespaces` | [Namespaces configuration](#namespaces-section) | | `retry` | [Retry configuration](#retry-section) | +| `containers` | [Containers configuration](#containers-section) | ### General section @@ -708,3 +709,15 @@ retry: | `max_backoff` | `duration` | yes | `30s` | Max delay before next attempt. | | `strategy` | `string` | yes | `exponential` | Backoff strategy. `exponential` and `constant` are allowed. | +# `containers` section + +Section for well-known containers to store s3-related data and settings. + +```yaml +containers: + cors: AZjLTXfK4vs4ovxMic2xEJKSymMNLqdwq9JT64ASFCRj +``` + +| Parameter | Type | SIGHUP reload | Default value | Description | +|-----------|----------|---------------|---------------|--------------------------------------------------------------------------------------| +| `cors` | `string` | no | | Container name for CORS configurations. If not set, container of the bucket is used. | diff --git a/internal/logs/logs.go b/internal/logs/logs.go index 9e1d836..d08a0c4 100644 --- a/internal/logs/logs.go +++ b/internal/logs/logs.go @@ -142,4 +142,5 @@ const ( CouldntCacheSubject = "couldn't cache subject info" UserGroupsListIsEmpty = "user groups list is empty, subject not found" CouldntCacheUserKey = "couldn't cache user key" + CouldNotFetchCORSContainerInfo = "couldn't fetch CORS container info" )