File: filehash.go

package info (click to toggle)
golang-pault-go-debian 0.16.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 412 kB
  • sloc: makefile: 2
file content (211 lines) | stat: -rw-r--r-- 5,125 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/* {{{ Copyright (c) Paul R. Tagliamonte <paultag@debian.org>, 2015
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE. }}} */

package control // import "pault.ag/go/debian/control"

import (
	"bytes"
	"crypto/sha256"
	"crypto/sha512"
	"encoding/hex"
	"fmt"
	"hash"
	"io"
	"log"
	"path/filepath"
	"strconv"
	"strings"

	"pault.ag/go/debian/hashio"
)

// A FileHash is an entry as found in the Files, Checksum-Sha1, and
// Checksum-Sha256 entry for the .dsc or .changes files.
type FileHash struct {
	// cb136f28a8c971d4299cc68e8fdad93a8ca7daf3 1131 dput-ng_1.9.dsc
	Algorithm string
	Hash      string
	Size      int64
	Filename  string
	ByHash    string
}

func FileHashFromHasher(path string, hasher hashio.Hasher) FileHash {
	return FileHash{
		Algorithm: hasher.Name(),
		Hash:      fmt.Sprintf("%x", hasher.Sum(nil)),
		Size:      hasher.Size(),
		Filename:  path,
	}
}

type FileHashes []FileHash

type verifier struct {
	h      hash.Hash
	want   []byte
	closed bool
}

func (v *verifier) Write(p []byte) (n int, err error) {
	return v.h.Write(p)
}

func (v *verifier) Close() error {
	if v.closed {
		return nil
	}
	v.closed = true
	got := v.h.Sum(nil)
	if !bytes.Equal(got, v.want) {
		return fmt.Errorf("invalid hash: got %x, want %x", got, v.want)
	}
	return nil
}

// Verifier returns an io.WriteCloser which verifies the hash of the data being
// written to it and fails Close() upon hash mismatch.
//
// Example:
//     verifier := fh.Verifier()
//     r = io.TeeReader(r, verifier)
//     if _, err := io.Copy(f, r); err != nil {
//         return err
//     }
//     if err := verifier.Close(); err != nil {
//         return err
//     }
func (c *FileHash) Verifier() (io.WriteCloser, error) {
	var h hash.Hash
	switch c.Algorithm {
	case "sha256":
		h = sha256.New()
	case "sha512":
		h = sha512.New()
	default:
		log.Fatalf("BUG: FileHash.Verifier not updated after release.Indices()")
	}
	sum, err := hex.DecodeString(c.Hash)
	if err != nil {
		return nil, err
	}
	return &verifier{h: h, want: sum}, nil
}

// {{{ Hash File implementations

// ByHashPath returns the corresponding /by-hash/<algorithm>/<hash> path.
// This function must only be used if the release supports AcquireByHash.
func (c *FileHash) ByHashPath(path string) string {
	return filepath.Dir(path) + "/by-hash/" + c.ByHash + "/" + c.Hash
}

func (c *FileHash) marshalControl() (string, error) {
	return fmt.Sprintf("%s %d %s", c.Hash, c.Size, c.Filename), nil
}

func (c *FileHash) unmarshalControl(algorithm, data string) error {
	var err error
	c.Algorithm = algorithm
	vals := strings.Fields(data)

	switch len(vals) {
	case 3:
		c.Hash = vals[0]
		c.Size, err = strconv.ParseInt(vals[1], 10, 64)
		if err != nil {
			return err
		}
		c.Filename = vals[2]
		switch algorithm {
		case "sha256":
			c.ByHash = "SHA256"
		case "sha512":
			c.ByHash = "SHA512"
		}
		return nil
	case 2:
		c.Filename = vals[0]
		c.Hash = vals[1]
		return nil
	default:
		return fmt.Errorf("Error: Unknown Debian Hash line: '%s'", data)
	}
}

// {{{ MD5 FileHash

type MD5FileHash struct{ FileHash }

func (c *MD5FileHash) UnmarshalControl(data string) error {
	return c.unmarshalControl("md5", data)
}

func (c MD5FileHash) MarshalControl() (string, error) {
	return c.marshalControl()
}

// }}}

// {{{ SHA1 FileHash

type SHA1FileHash struct{ FileHash }

func (c *SHA1FileHash) UnmarshalControl(data string) error {
	return c.unmarshalControl("sha1", data)
}

func (c SHA1FileHash) MarshalControl() (string, error) {
	return c.marshalControl()
}

// }}}

// {{{ SHA256 FileHash

type SHA256FileHash struct{ FileHash }

func (c *SHA256FileHash) UnmarshalControl(data string) error {
	return c.unmarshalControl("sha256", data)
}

func (c SHA256FileHash) MarshalControl() (string, error) {
	return c.marshalControl()
}

// }}}

// {{{ SHA512 FileHash

type SHA512FileHash struct{ FileHash }

func (c *SHA512FileHash) UnmarshalControl(data string) error {
	return c.unmarshalControl("sha512", data)
}

func (c SHA512FileHash) MarshalControl() (string, error) {
	return c.marshalControl()
}

// }}}

// }}}

// vim: foldmethod=marker