Merge commit '3b735dd9330e0989f51a76771c3303031154154e' into 21158-wf-page-list
[arvados.git] / sdk / go / keepclient / hashcheck.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: Apache-2.0
4
5 package keepclient
6
7 import (
8         "errors"
9         "fmt"
10         "hash"
11         "io"
12 )
13
14 var BadChecksum = errors.New("Reader failed checksum")
15
16 // HashCheckingReader is an io.ReadCloser that checks the contents
17 // read from the underlying io.Reader against the provided hash.
18 type HashCheckingReader struct {
19         // The underlying data source
20         io.Reader
21
22         // The hash function to use
23         hash.Hash
24
25         // The hash value to check against.  Must be a hex-encoded lowercase string.
26         Check string
27 }
28
29 // Reads from the underlying reader, update the hashing function, and
30 // pass the results through. Returns BadChecksum (instead of EOF) on
31 // the last read if the checksum doesn't match.
32 func (hcr HashCheckingReader) Read(p []byte) (n int, err error) {
33         n, err = hcr.Reader.Read(p)
34         if n > 0 {
35                 hcr.Hash.Write(p[:n])
36         }
37         if err == io.EOF {
38                 sum := hcr.Hash.Sum(nil)
39                 if fmt.Sprintf("%x", sum) != hcr.Check {
40                         err = BadChecksum
41                 }
42         }
43         return n, err
44 }
45
46 // WriteTo writes the entire contents of hcr.Reader to dest. Returns
47 // BadChecksum if writing is successful but the checksum doesn't
48 // match.
49 func (hcr HashCheckingReader) WriteTo(dest io.Writer) (written int64, err error) {
50         written, err = io.Copy(io.MultiWriter(dest, hcr.Hash), hcr.Reader)
51         if err != nil {
52                 return written, err
53         }
54
55         sum := hcr.Hash.Sum(nil)
56         if fmt.Sprintf("%x", sum) != hcr.Check {
57                 return written, BadChecksum
58         }
59
60         return written, nil
61 }
62
63 // Close reads all remaining data from the underlying Reader and
64 // returns BadChecksum if the checksum doesn't match. It also closes
65 // the underlying Reader if it implements io.ReadCloser.
66 func (hcr HashCheckingReader) Close() (err error) {
67         _, err = io.Copy(hcr.Hash, hcr.Reader)
68
69         if closer, ok := hcr.Reader.(io.Closer); ok {
70                 closeErr := closer.Close()
71                 if err == nil {
72                         err = closeErr
73                 }
74         }
75         if err != nil {
76                 return err
77         }
78         if fmt.Sprintf("%x", hcr.Hash.Sum(nil)) != hcr.Check {
79                 return BadChecksum
80         }
81         return nil
82 }