package client import ( "context" "crypto/ecdsa" "fmt" aclgrpc "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/acl/grpc" objectgrpc "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/object/grpc" refsgrpc "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/refs/grpc" rpcapi "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/rpc" "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/rpc/client" sessiongrpc "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/session/grpc" "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/signature" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/bearer" apistatus "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/client/status" cid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/id" oid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/session" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/util/slices" ) // PrmObjectHash groups parameters of ObjectHash operation. type PrmObjectHash struct { meta *sessiongrpc.RequestMetaHeader body *objectgrpc.GetRangeHashRequest_Body csAlgo refsgrpc.ChecksumType addr *refsgrpc.Address keySet bool key *ecdsa.PrivateKey } func NewPrmObjectHash() PrmObjectHash { return PrmObjectHash{ meta: &sessiongrpc.RequestMetaHeader{}, body: &objectgrpc.GetRangeHashRequest_Body{}, addr: &refsgrpc.Address{}, } } // UseKey specifies private key to sign the requests. // If key is not provided, then Client default key is used. func (x *PrmObjectHash) UseKey(key *ecdsa.PrivateKey) { x.keySet = true x.key = key } // MarkLocal tells the server to execute the operation locally. func (x *PrmObjectHash) MarkLocal() { x.meta.SetTtl(1) } // WithinSession specifies session within which object should be read. // // Creator of the session acquires the authorship of the request. // This may affect the execution of an operation (e.g. access control). // // Must be signed. func (x *PrmObjectHash) WithinSession(t session.Object) { var tv2 sessiongrpc.SessionToken t.WriteToV2(&tv2) x.meta.SetSessionToken(&tv2) } // WithBearerToken attaches bearer token to be used for the operation. // // If set, underlying eACL rules will be used in access control. // // Must be signed. func (x *PrmObjectHash) WithBearerToken(t bearer.Token) { var v2token aclgrpc.BearerToken t.WriteToV2(&v2token) x.meta.SetBearerToken(&v2token) } // FromContainer specifies FrostFS container of the object. // Required parameter. func (x *PrmObjectHash) FromContainer(id cid.ID) { var cidV2 refsgrpc.ContainerID id.WriteToV2(&cidV2) x.addr.SetContainerId(&cidV2) } // ByID specifies identifier of the requested object. // Required parameter. func (x *PrmObjectHash) ByID(id oid.ID) { var idV2 refsgrpc.ObjectID id.WriteToV2(&idV2) x.addr.SetObjectId(&idV2) } // SetRangeList sets list of ranges in (offset, length) pair format. // Required parameter. // // If passed as slice, then it must not be mutated before the operation completes. func (x *PrmObjectHash) SetRangeList(r ...uint64) { ln := len(r) if ln%2 != 0 { panic("odd number of range parameters") } rs := slices.MakePreallocPointerSlice[objectgrpc.Range](ln / 2) for i := 0; i < ln/2; i++ { rs[i].SetOffset(r[2*i]) rs[i].SetLength(r[2*i+1]) } x.body.SetRanges(rs) } // TillichZemorAlgo changes the hash function to Tillich-Zemor // (https://link.springer.com/content/pdf/10.1007/3-540-48658-5_5.pdf). // // By default, SHA256 hash function is used. func (x *PrmObjectHash) TillichZemorAlgo() { x.csAlgo = refsgrpc.ChecksumType_TZ } // UseSalt sets the salt to XOR the data range before hashing. // // Must not be mutated before the operation completes. func (x *PrmObjectHash) UseSalt(salt []byte) { x.body.SetSalt(salt) } // WithXHeaders specifies list of extended headers (string key-value pairs) // to be attached to the request. Must have an even length. // // Slice must not be mutated until the operation completes. func (x *PrmObjectHash) WithXHeaders(hs ...string) { writeXHeadersToMeta(hs, x.meta) } // ResObjectHash groups resulting values of ObjectHash operation. type ResObjectHash struct { statusRes checksums [][]byte } // Checksums returns a list of calculated checksums in range order. func (x ResObjectHash) Checksums() [][]byte { return x.checksums } // ObjectHash requests checksum of the range list of the object payload using // FrostFS API protocol. // // Returns a list of checksums in raw form: the format of hashes and their number // is left for the caller to check. Client preserves the order of the server's response. // // Exactly one return value is non-nil. By default, server status is returned in res structure. // Any client's internal or transport errors are returned as `error`, // If PrmInit.ResolveFrostFSFailures has been called, unsuccessful // FrostFS status codes are returned as `error`, otherwise, are included // in the returned result structure. // // Returns an error if parameters are set incorrectly (see PrmObjectHash docs). // Context is required and must not be nil. It is used for network communication. // // Return statuses: // - global (see Client docs); // - *apistatus.ContainerNotFound; // - *apistatus.ObjectNotFound; // - *apistatus.ObjectAccessDenied; // - *apistatus.ObjectOutOfRange; // - *apistatus.SessionTokenExpired. func (c *Client) ObjectHash(ctx context.Context, prm PrmObjectHash) (*ResObjectHash, error) { switch { case prm.addr.GetContainerId() == nil: return nil, errorMissingContainer case prm.addr.GetObjectId() == nil: return nil, errorMissingObject case len(prm.body.GetRanges()) == 0: return nil, errorMissingRanges } prm.body.SetAddress(prm.addr) if prm.csAlgo == refsgrpc.ChecksumType_CHECKSUM_TYPE_UNSPECIFIED { prm.body.SetType(refsgrpc.ChecksumType_SHA256) } else { prm.body.SetType(prm.csAlgo) } var req objectgrpc.GetRangeHashRequest c.prepareRequest(&req, prm.meta) req.SetBody(prm.body) key := &c.prm.key if prm.keySet { key = prm.key } err := signature.SignServiceMessage(key, &req) if err != nil { return nil, fmt.Errorf("sign request: %w", err) } resp, err := rpcapi.HashObjectRange(&c.c, &req, client.WithContext(ctx)) if err != nil { return nil, fmt.Errorf("write request: %w", err) } var res ResObjectHash res.st, err = c.processResponse(resp) if err != nil { return nil, err } if !apistatus.IsSuccessful(res.st) { return &res, nil } res.checksums = resp.GetBody().GetHashList() if len(res.checksums) == 0 { return nil, newErrMissingResponseField("hash list") } return &res, nil }