// Copyright (C) 2018 Storj Labs, Inc. // See LICENSE for copying information. package audit import ( "bytes" "context" "io" "github.com/vivint/infectious" monkit "gopkg.in/spacemonkeygo/monkit.v2" "storj.io/storj/pkg/dht" "storj.io/storj/pkg/node" "storj.io/storj/pkg/overlay" "storj.io/storj/pkg/pb" "storj.io/storj/pkg/piecestore/rpc/client" "storj.io/storj/pkg/provider" proto "storj.io/storj/pkg/statdb/proto" "storj.io/storj/pkg/transport" ) var mon = monkit.Package() type share struct { Error error PieceNumber int Data []byte } // Verifier helps verify the correctness of a given stripe type Verifier struct { downloader downloader } type downloader interface { DownloadShares(ctx context.Context, pointer *pb.Pointer, stripeIndex int) (shares []share, nodes []*pb.Node, err error) } // defaultDownloader downloads shares from networked storage nodes type defaultDownloader struct { transport transport.Client overlay overlay.Client identity provider.FullIdentity reporter } // newDefaultDownloader creates a defaultDownloader func newDefaultDownloader(transport transport.Client, overlay overlay.Client, id provider.FullIdentity) *defaultDownloader { return &defaultDownloader{transport: transport, overlay: overlay, identity: id} } // NewVerifier creates a Verifier func NewVerifier(transport transport.Client, overlay overlay.Client, id provider.FullIdentity) *Verifier { return &Verifier{downloader: newDefaultDownloader(transport, overlay, id)} } func (d *defaultDownloader) dial(ctx context.Context, node *pb.Node) (ps client.PSClient, err error) { defer mon.Task()(&ctx)(&err) c, err := d.transport.DialNode(ctx, node) if err != nil { return nil, err } return client.NewPSClient(c, 0, d.identity.Key) } // getShare use piece store clients to download shares from a given node func (d *defaultDownloader) getShare(ctx context.Context, stripeIndex, shareSize, pieceNumber int, id client.PieceID, pieceSize int64, node *pb.Node) (s share, err error) { defer mon.Task()(&ctx)(&err) ps, err := d.dial(ctx, node) if err != nil { return s, err } derivedPieceID, err := id.Derive([]byte(node.GetId())) if err != nil { return s, err } rr, err := ps.Get(ctx, derivedPieceID, pieceSize, &pb.PayerBandwidthAllocation{}) if err != nil { return s, err } offset := shareSize * stripeIndex rc, err := rr.Range(ctx, int64(offset), int64(shareSize)) if err != nil { return s, err } buf := make([]byte, shareSize) _, err = io.ReadFull(rc, buf) if err != nil { return s, err } s = share{ Error: nil, PieceNumber: pieceNumber, Data: buf, } return s, nil } // Download Shares downloads shares from the nodes where remote pieces are located func (d *defaultDownloader) DownloadShares(ctx context.Context, pointer *pb.Pointer, stripeIndex int) (shares []share, nodes []*pb.Node, err error) { defer mon.Task()(&ctx)(&err) var nodeIds []dht.NodeID pieces := pointer.Remote.GetRemotePieces() for _, p := range pieces { nodeIds = append(nodeIds, node.IDFromString(p.GetNodeId())) } nodes, err = d.overlay.BulkLookup(ctx, nodeIds) if err != nil { return nil, nodes, err } shareSize := int(pointer.Remote.Redundancy.GetErasureShareSize()) pieceID := client.PieceID(pointer.Remote.GetPieceId()) // this downloads shares from nodes at the given stripe index for i, node := range nodes { paddedSize := calcPadded(pointer.GetSize(), shareSize) pieceSize := paddedSize / int64(pointer.Remote.Redundancy.GetMinReq()) s, err := d.getShare(ctx, stripeIndex, shareSize, i, pieceID, pieceSize, node) if err != nil { s = share{ Error: err, PieceNumber: i, Data: nil, } } shares = append(shares, s) } return shares, nodes, nil } func makeCopies(ctx context.Context, originals []share) (copies []infectious.Share, err error) { defer mon.Task()(&ctx)(&err) // Have to use []infectious.Share instead of []audit.Share // in order to run the infectious Correct function. copies = make([]infectious.Share, len(originals)) for i, original := range originals { // If there was an error downloading a share before, // this line makes it so that there will be an empty // infectious.Share at the copies' index (same index // as in the original slice). if original.Error != nil { continue } copies[i].Data = append([]byte(nil), original.Data...) copies[i].Number = original.PieceNumber } return copies, nil } // auditShares takes the downloaded shares and uses infectious's Correct function to check that they // haven't been altered. auditShares returns a slice containing the piece numbers of altered shares. func auditShares(ctx context.Context, required, total int, originals []share) (pieceNums []int, err error) { defer mon.Task()(&ctx)(&err) f, err := infectious.NewFEC(required, total) if err != nil { return nil, err } copies, err := makeCopies(ctx, originals) if err != nil { return nil, err } err = f.Correct(copies) if err != nil { return nil, err } for i, share := range copies { if !bytes.Equal(originals[i].Data, share.Data) { pieceNums = append(pieceNums, share.Number) } } return pieceNums, nil } func calcPadded(size int64, blockSize int) int64 { mod := size % int64(blockSize) if mod == 0 { return size } return size + int64(blockSize) - mod } // verify downloads shares then verifies the data correctness at the given stripe func (verifier *Verifier) verify(ctx context.Context, stripeIndex int, pointer *pb.Pointer) (verifiedNodes []*proto.Node, err error) { defer mon.Task()(&ctx)(&err) shares, nodes, err := verifier.downloader.DownloadShares(ctx, pointer, stripeIndex) if err != nil { return nil, err } var offlineNodes []string for i, share := range shares { if shares[i].Error != nil { offlineNodes = append(offlineNodes, nodes[share.PieceNumber].GetId()) } } required := int(pointer.Remote.Redundancy.GetMinReq()) total := int(pointer.Remote.Redundancy.GetTotal()) pieceNums, err := auditShares(ctx, required, total, shares) if err != nil { return nil, err } var failedNodes []string for _, pieceNum := range pieceNums { failedNodes = append(failedNodes, nodes[pieceNum].GetId()) } successNodes := getSuccessNodes(ctx, nodes, failedNodes, offlineNodes) verifiedNodes = setVerifiedNodes(ctx, nodes, offlineNodes, failedNodes, successNodes) return verifiedNodes, nil } // getSuccessNodes uses the failed nodes and offline nodes arrays to determine which nodes passed the audit func getSuccessNodes(ctx context.Context, nodes []*pb.Node, failedNodes, offlineNodes []string) (successNodes []string) { fails := make(map[string]bool) for _, fail := range failedNodes { fails[fail] = true } for _, offline := range offlineNodes { fails[offline] = true } for _, node := range nodes { if !fails[node.GetId()] { successNodes = append(successNodes, node.GetId()) } } return successNodes } // setVerifiedNodes creates a combined array of offline nodes, failed audit nodes, and success nodes with their stats set to the statdb proto Node type func setVerifiedNodes(ctx context.Context, nodes []*pb.Node, offlineNodes, failedNodes, successNodes []string) (verifiedNodes []*proto.Node) { offlineStatusNodes := setOfflineStatus(ctx, offlineNodes) failStatusNodes := setAuditFailStatus(ctx, failedNodes) successStatusNodes := setSuccessStatus(ctx, successNodes) verifiedNodes = append(verifiedNodes, offlineStatusNodes...) verifiedNodes = append(verifiedNodes, failStatusNodes...) verifiedNodes = append(verifiedNodes, successStatusNodes...) return verifiedNodes }