/
meta.go
328 lines (289 loc) · 8.6 KB
/
meta.go
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
/*
Copyright 2016 The Perkeep Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package encrypt
import (
"bytes"
"container/heap"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"sort"
"strconv"
"strings"
"sync"
"perkeep.org/internal/pools"
"perkeep.org/pkg/blob"
"perkeep.org/pkg/blobserver"
"perkeep.org/pkg/sorted"
)
// Encrypted meta format:
// #camlistore/encmeta=2
// Then sorted lines, each ending in a newline, like:
// sha1-plain/<plain size>/sha1-encrypted
const (
// FullMetaBlobSize is the number of lines at which we stop compacting a meta blob.
FullMetaBlobSize = 10 * 1000 // ~ 512kB
// SmallMetaCountLimit is the number of small meta that triggers compaction.
SmallMetaCountLimit = 100 // 100 rounds to make a full = ~ 26MB bw waste
)
type metaBlob struct {
br blob.Ref // of meta blob
plains []blob.Ref
}
// metaBlobHeap is a heap of metaBlobs.
// heap.Pop returns the metaBlob with the LEAST entries.
type metaBlobHeap struct {
sync.Mutex
s []*metaBlob
}
var _ heap.Interface = (*metaBlobHeap)(nil)
func (h *metaBlobHeap) Push(x interface{}) {
h.s = append(h.s, x.(*metaBlob))
}
func (h *metaBlobHeap) Pop() interface{} {
l := len(h.s)
v := h.s[l-1]
h.s = h.s[:l-1]
return v
}
func (h *metaBlobHeap) Less(i, j int) bool {
return len(h.s[i].plains) < len(h.s[j].plains)
}
func (h *metaBlobHeap) Len() int { return len(h.s) }
func (h *metaBlobHeap) Swap(i, j int) { h.s[i], h.s[j] = h.s[j], h.s[i] }
func (s *storage) recordMeta(b *metaBlob) {
if len(b.plains) > FullMetaBlobSize {
return
}
s.smallMeta.Lock()
defer s.smallMeta.Unlock()
heap.Push(s.smallMeta, b)
// If the heap is full, pop and group the entries under the lock,
// then schedule upload, deletion and reinserion in parallel.
if s.smallMeta.Len() > SmallMetaCountLimit {
var plains, toDelete []blob.Ref
for s.smallMeta.Len() > 0 {
meta := heap.Pop(s.smallMeta).(*metaBlob)
plains = append(plains, meta.plains...)
toDelete = append(toDelete, meta.br)
if len(plains) > FullMetaBlobSize {
go s.makePackedMetaBlob(plains, toDelete)
plains, toDelete = nil, nil
}
}
if len(toDelete) == 1 {
heap.Push(s.smallMeta, &metaBlob{br: toDelete[0], plains: plains})
} else if len(toDelete) > 1 {
go s.makePackedMetaBlob(plains, toDelete)
}
}
}
func (s *storage) makePackedMetaBlob(plains, toDelete []blob.Ref) {
ctx := context.Background() // TODO
// We lose track of the small blobs in case of error, but they will be packed at next start.
sort.Sort(blob.ByRef(plains))
metaBytes := pools.BytesBuffer()
defer pools.PutBuffer(metaBytes)
metaBytes.WriteString("#camlistore/encmeta=2\n")
metaBytes.Grow(len(plains[0].String()) * len(plains) * 2)
for _, plain := range plains {
p := plain.String()
metaBytes.WriteString(p)
metaBytes.WriteString("/")
v, err := s.index.Get(p)
if err != nil {
log.Printf("encrypt: failed to find the index entry for %s while packing: %v", p, err)
return
}
metaBytes.WriteString(v)
metaBytes.WriteString("\n")
}
encBytes := pools.BytesBuffer()
defer pools.PutBuffer(encBytes)
if err := s.encryptBlob(encBytes, metaBytes); err != nil {
log.Printf("encrypt: failed to encrypt meta: %v", err)
return
}
metaBR := blob.RefFromBytes(encBytes.Bytes())
metaSB, err := blobserver.ReceiveNoHash(ctx, s.meta, metaBR, encBytes)
if err != nil {
log.Printf("encrypt: failed to upload a packed meta: %v", err)
return
}
if len(plains) < FullMetaBlobSize {
s.recordMeta(&metaBlob{br: metaSB.Ref, plains: plains})
}
if err := s.meta.RemoveBlobs(ctx, toDelete); err != nil {
log.Printf("encrypt: failed to delete small meta blobs: %v", err)
}
log.Printf("encrypt: packed %d small meta blobs into one (%d refs)", len(toDelete), len(plains))
}
// makeSingleMetaBlob makes and encrypts a metaBlob with one entry.
func (s *storage) makeSingleMetaBlob(plainBR, encBR blob.Ref, plainSize uint32) ([]byte, error) {
// would be racy to use the pool and return Bytes() here, just use a fresh buffer
encBytes := bytes.NewBuffer(nil)
plain := fmt.Sprintf("#camlistore/encmeta=2\n%s/%d/%s\n", plainBR, plainSize, encBR)
if err := s.encryptBlob(encBytes, bytes.NewBufferString(plain)); err != nil {
return nil, err
}
return encBytes.Bytes(), nil
}
func packIndexEntry(plainSize uint32, encBR blob.Ref) string {
return fmt.Sprintf("%d/%s", plainSize, encBR)
}
func unpackIndexEntry(s string) (plainSize uint32, encBR blob.Ref, err error) {
parts := strings.Split(s, "/")
if len(parts) != 2 {
err = fmt.Errorf("malformed index entry %q", s)
return
}
size, err := strconv.ParseUint(parts[0], 10, 32)
if err != nil {
err = fmt.Errorf("malformed index entry %q: %s", s, err)
return
}
plainSize = uint32(size)
encBR = blob.ParseOrZero(parts[1])
if !encBR.Valid() {
err = fmt.Errorf("malformed index entry %q: %s", s, err)
}
return
}
// fetchMeta returns os.ErrNotExist if the plaintext blob is not in the index.
func (s *storage) fetchMeta(ctx context.Context, b blob.Ref) (plainSize uint32, encBR blob.Ref, err error) {
v, err := s.index.Get(b.String())
if err == sorted.ErrNotFound {
err = os.ErrNotExist
}
if err != nil {
return 0, blob.Ref{}, err
}
return unpackIndexEntry(v)
}
// processEncryptedMetaBlob decrypts dat (the data for the br meta blob) and parses
// its meta lines, updating the index.
//
// processEncryptedMetaBlob is not thread-safe.
func (s *storage) processEncryptedMetaBlob(br blob.Ref, dat []byte) error {
plainBytes := pools.BytesBuffer()
defer pools.PutBuffer(plainBytes)
if err := s.decryptBlob(plainBytes, bytes.NewBuffer(dat)); err != nil {
return err
}
header, err := plainBytes.ReadString('\n')
if err != nil {
return errors.New("No first line")
}
if header != "#camlistore/encmeta=2\n" {
if len(header) > 80 {
header = header[:80]
}
return fmt.Errorf("unsupported first line %q", header)
}
var plains []blob.Ref
for {
line, err := plainBytes.ReadString('\n')
if err != nil && len(line) != 0 {
return io.ErrUnexpectedEOF
} else if err != nil {
break
}
parts := strings.Split(strings.TrimRight(line, "\n"), "/")
if len(parts) != 3 {
if len(line) > 80 {
line = line[:80]
}
return fmt.Errorf("malformed line %q", line)
}
// We do very limited checking here, as we signed the blob and we check
// the value anyway on s.index.Get.
plainBR, ok := blob.ParseKnown(parts[0])
if !ok {
if len(line) > 80 {
line = line[:80]
}
return fmt.Errorf("malformed line %q", line)
}
plains = append(plains, plainBR)
if err := s.index.Set(parts[0], parts[1]+"/"+parts[2]); err != nil {
return err
}
}
s.recordMeta(&metaBlob{br: br, plains: plains})
return nil
}
func (s *storage) readAllMetaBlobs() error {
type encMB struct {
br blob.Ref
dat []byte // encrypted blob
err error
}
metac := make(chan encMB, 16)
const maxInFlight = 5 // arbitrary
var gate = make(chan bool, maxInFlight)
var stopEnumerate = make(chan bool) // closed on error
enumErrc := make(chan error, 1)
go func() {
var wg sync.WaitGroup
ctx := context.TODO()
enumErrc <- blobserver.EnumerateAll(ctx, s.meta, func(sb blob.SizedRef) error {
select {
case <-stopEnumerate:
return errors.New("enumeration stopped")
default:
}
wg.Add(1)
gate <- true
go func() {
defer wg.Done()
defer func() { <-gate }()
rc, _, err := s.meta.Fetch(ctx, sb.Ref)
if err != nil {
metac <- encMB{sb.Ref, nil, fmt.Errorf("fetch failed: %v", err)}
return
}
defer rc.Close()
all, err := io.ReadAll(rc)
if err != nil {
metac <- encMB{sb.Ref, nil, fmt.Errorf("read failed: %v", err)}
return
}
metac <- encMB{sb.Ref, all, nil}
}()
return nil
})
wg.Wait()
close(metac)
}()
for mi := range metac {
err := mi.err
if err == nil {
err = s.processEncryptedMetaBlob(mi.br, mi.dat)
}
if err != nil {
close(stopEnumerate)
go func() {
for range metac {
}
}()
// TODO: advertise in this error message a new option or environment variable
// to skip a certain or all meta blobs, to allow partial recovery, if some
// are corrupt. For now, require all to be correct.
return fmt.Errorf("error with meta blob %v: %v", mi.br, err)
}
}
return <-enumErrc
}