package frostfsapiclient import ( "context" "crypto/ecdsa" "errors" "fmt" "io" clientcore "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/core/client" "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/services/object_manager/storagegroup" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/client" apistatus "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/client/status" cid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/id" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object" oid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id" ) // Client represents FrostFS API client cut down to the needs of a purely IR application. type Client struct { key *ecdsa.PrivateKey c clientcore.Client } // WrapBasicClient wraps a client.Client instance to use it for FrostFS API RPC. func (x *Client) WrapBasicClient(c clientcore.Client) { x.c = c } // SetPrivateKey sets a private key to sign RPC requests. func (x *Client) SetPrivateKey(key *ecdsa.PrivateKey) { x.key = key } // SearchSGPrm groups parameters of SearchSG operation. type SearchSGPrm struct { cnrID cid.ID } // SetContainerID sets the ID of the container to search for storage groups. func (x *SearchSGPrm) SetContainerID(id cid.ID) { x.cnrID = id } // SearchSGRes groups the resulting values of SearchSG operation. type SearchSGRes struct { cliRes []oid.ID } // IDList returns a list of IDs of storage groups in the container. func (x SearchSGRes) IDList() []oid.ID { return x.cliRes } var sgFilter = storagegroup.SearchQuery() // SearchSG lists objects of storage group type in the container. // // Returns any error which prevented the operation from completing correctly in error return. func (x Client) SearchSG(ctx context.Context, prm SearchSGPrm) (*SearchSGRes, error) { var cliPrm client.PrmObjectSearch cliPrm.InContainer(prm.cnrID) cliPrm.SetFilters(sgFilter) cliPrm.UseKey(*x.key) rdr, err := x.c.ObjectSearchInit(ctx, cliPrm) if err != nil { return nil, fmt.Errorf("init object search: %w", err) } buf := make([]oid.ID, 10) var list []oid.ID var n int var ok bool for { n, ok = rdr.Read(buf) for i := 0; i < n; i++ { list = append(list, buf[i]) } if !ok { break } } res, err := rdr.Close() if err == nil { // pull out an error from status err = apistatus.ErrFromStatus(res.Status()) } if err != nil { return nil, fmt.Errorf("read object list: %w", err) } return &SearchSGRes{ cliRes: list, }, nil } // GetObjectPrm groups parameters of GetObject operation. type GetObjectPrm struct { getObjectPrm } // GetObjectRes groups the resulting values of GetObject operation. type GetObjectRes struct { obj *object.Object } // Object returns the received object. func (x GetObjectRes) Object() *object.Object { return x.obj } // GetObject reads the object by address. // // Returns any error which prevented the operation from completing correctly in error return. func (x Client) GetObject(ctx context.Context, prm GetObjectPrm) (*GetObjectRes, error) { var cliPrm client.PrmObjectGet cliPrm.FromContainer(prm.objAddr.Container()) cliPrm.ByID(prm.objAddr.Object()) cliPrm.UseKey(*x.key) rdr, err := x.c.ObjectGetInit(ctx, cliPrm) if err != nil { return nil, fmt.Errorf("init object search: %w", err) } var obj object.Object if !rdr.ReadHeader(&obj) { res, err := rdr.Close() if err == nil { // pull out an error from status err = apistatus.ErrFromStatus(res.Status()) } return nil, fmt.Errorf("read object header: %w", err) } buf := make([]byte, obj.PayloadSize()) _, err = rdr.Read(buf) if err != nil && !errors.Is(err, io.EOF) { return nil, fmt.Errorf("read payload: %w", err) } obj.SetPayload(buf) return &GetObjectRes{ obj: &obj, }, nil } // HeadObjectPrm groups parameters of HeadObject operation. type HeadObjectPrm struct { getObjectPrm raw bool local bool } // SetRawFlag sets flag of raw request. func (x *HeadObjectPrm) SetRawFlag() { x.raw = true } // SetTTL sets request TTL value. func (x *HeadObjectPrm) SetTTL(ttl uint32) { x.local = ttl < 2 } // HeadObjectRes groups the resulting values of HeadObject operation. type HeadObjectRes struct { hdr *object.Object } // Header returns the received object header. func (x HeadObjectRes) Header() *object.Object { return x.hdr } // HeadObject reads short object header by address. // // Returns any error which prevented the operation from completing correctly in error return. // For raw requests, returns *object.SplitInfoError error if the requested object is virtual. func (x Client) HeadObject(ctx context.Context, prm HeadObjectPrm) (*HeadObjectRes, error) { var cliPrm client.PrmObjectHead if prm.raw { cliPrm.MarkRaw() } if prm.local { cliPrm.MarkLocal() } cliPrm.FromContainer(prm.objAddr.Container()) cliPrm.ByID(prm.objAddr.Object()) cliPrm.UseKey(*x.key) cliRes, err := x.c.ObjectHead(ctx, cliPrm) if err == nil { // pull out an error from status err = apistatus.ErrFromStatus(cliRes.Status()) } if err != nil { return nil, fmt.Errorf("read object header from FrostFS: %w", err) } var hdr object.Object if !cliRes.ReadHeader(&hdr) { return nil, errors.New("missing object header in the response") } return &HeadObjectRes{ hdr: &hdr, }, nil } // GetObjectPayload reads an object by address from FrostFS via Client and returns its payload. // // Returns any error which prevented the operation from completing correctly in error return. func GetObjectPayload(ctx context.Context, c Client, addr oid.Address) ([]byte, error) { var prm GetObjectPrm prm.SetAddress(addr) obj, err := c.GetObject(ctx, prm) if err != nil { return nil, err } return obj.Object().Payload(), nil } func headObject(ctx context.Context, c Client, addr oid.Address, raw bool, ttl uint32) (*object.Object, error) { var prm HeadObjectPrm prm.SetAddress(addr) prm.SetTTL(ttl) if raw { prm.SetRawFlag() } obj, err := c.HeadObject(ctx, prm) if err != nil { return nil, err } return obj.Header(), nil } // GetRawObjectHeaderLocally reads the raw short object header from the server's local storage by address via Client. func GetRawObjectHeaderLocally(ctx context.Context, c Client, addr oid.Address) (*object.Object, error) { return headObject(ctx, c, addr, true, 1) } // GetObjectHeaderFromContainer reads the short object header by address via Client with TTL = 10 // for deep traversal of the container. func GetObjectHeaderFromContainer(ctx context.Context, c Client, addr oid.Address) (*object.Object, error) { return headObject(ctx, c, addr, false, 10) } // HashPayloadRangePrm groups parameters of HashPayloadRange operation. type HashPayloadRangePrm struct { getObjectPrm rng *object.Range } // SetRange sets payload range to calculate the hash. func (x *HashPayloadRangePrm) SetRange(rng *object.Range) { x.rng = rng } // HashPayloadRangeRes groups the resulting values of HashPayloadRange operation. type HashPayloadRangeRes struct { h []byte } // Hash returns the hash of the object payload range. func (x HashPayloadRangeRes) Hash() []byte { return x.h } // HashPayloadRange requests to calculate Tillich-Zemor hash of the payload range of the object // from the remote server's local storage. // // Returns any error which prevented the operation from completing correctly in error return. func (x Client) HashPayloadRange(ctx context.Context, prm HashPayloadRangePrm) (res HashPayloadRangeRes, err error) { var cliPrm client.PrmObjectHash cliPrm.FromContainer(prm.objAddr.Container()) cliPrm.ByID(prm.objAddr.Object()) cliPrm.SetRangeList(prm.rng.GetOffset(), prm.rng.GetLength()) cliPrm.TillichZemorAlgo() cliRes, err := x.c.ObjectHash(ctx, cliPrm) if err == nil { // pull out an error from status err = apistatus.ErrFromStatus(cliRes.Status()) if err != nil { return } hs := cliRes.Checksums() if ln := len(hs); ln != 1 { err = fmt.Errorf("wrong number of checksums %d", ln) } else { res.h = hs[0] } } return } // HashObjectRange reads Tillich-Zemor hash of the object payload range by address // from the remote server's local storage via Client. // // Returns any error which prevented the operation from completing correctly in error return. func HashObjectRange(ctx context.Context, c Client, addr oid.Address, rng *object.Range) ([]byte, error) { var prm HashPayloadRangePrm prm.SetAddress(addr) prm.SetRange(rng) res, err := c.HashPayloadRange(ctx, prm) if err != nil { return nil, err } return res.Hash(), nil }