go.temporal.io/server/common/checksum/crc.go

67 LOC · 19 covered · 48 uncovered · 6 ranges · 1 concepts · 1 introducers · 1 tests

File neighbourhood

The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.

Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.

Graph controls are ready.

Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.

1 package checksum
2
3 import (
4 "bytes"
5 "encoding/binary"
6 "errors"
7 "fmt"
8 "hash/crc32"
9
10 enumsspb "go.temporal.io/server/api/enums/v1"
11 persistencespb "go.temporal.io/server/api/persistence/v1"
12 )
13
14 // ErrMismatch indicates a checksum verification failure due to
15 // a derived checksum not being equal to expected checksum
16 var ErrMismatch = errors.New("checksum mismatch error")
17
18 type Marshaler interface {
19 Marshal() ([]byte, error)
20 }
21
22 // GenerateCRC32 generates an IEEE crc32 checksum on the
23 // serilized byte array of the given thrift object. The
24 // serialization proto used will be of type thriftRW
25 func GenerateCRC32(
26 payload Marshaler,
27 payloadVersion int32,
28 > ) (*persistencespb.Checksum, error) { crc.go ×6
29 >
30 > payloadBytes, err := payload.Marshal()
31 > if err != nil {
32 return nil, err
33 }
34
35 > crc := crc32.ChecksumIEEE(payloadBytes) crc.go ×6
36 > checksum := make([]byte, 4)
37 > binary.BigEndian.PutUint32(checksum, crc)
38 > return &persistencespb.Checksum{
39 > Value: checksum,
40 > Version: payloadVersion,
41 > Flavor: enumsspb.CHECKSUM_FLAVOR_IEEE_CRC32_OVER_PROTO3_BINARY,
42 > }, nil
43 }
44
45 // Verify verifies that the checksum generated from the
46 // given thrift object matches the specified expected checksum
47 // Return ErrMismatch when checksums mismatch
48 func Verify(
49 payload Marshaler,
50 checksum *persistencespb.Checksum,
51 > ) error { crc.go ×6
52 >
53 > if checksum.Flavor != enumsspb.CHECKSUM_FLAVOR_IEEE_CRC32_OVER_PROTO3_BINARY {
54 return fmt.Errorf("unknown checksum flavor %v", checksum.Flavor)
55 }
56
57 > expected, err := GenerateCRC32(payload, checksum.Version) crc.go ×6
58 > if err != nil {
59 return err
60 }
61
62 > if !bytes.Equal(expected.GetValue(), checksum.GetValue()) { crc.go ×6
63 return ErrMismatch
64 }
65
66 > return nil crc.go ×6
67 }