/
store.go
926 lines (796 loc) · 28.1 KB
/
store.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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
package streams
import (
"context"
"crypto/rand"
"io"
mathrand "math/rand" // Using mathrand here because crypto-graphic randomness is not required.
"sort"
"sync"
"time"
"github.com/spacemonkeygo/monkit/v3"
"github.com/zeebo/errs"
"storj.io/common/context2"
"storj.io/common/encryption"
"storj.io/common/paths"
"storj.io/common/pb"
"storj.io/common/ranger"
"storj.io/common/storj"
"storj.io/uplink/private/ecclient"
"storj.io/uplink/private/eestream"
"storj.io/uplink/private/metaclient"
"storj.io/uplink/private/testuplink"
)
// DisableDeleteOnCancel is now a no-op.
func DisableDeleteOnCancel(ctx context.Context) context.Context {
return ctx
}
var mon = monkit.Package()
// Meta info about a stream.
type Meta struct {
Modified time.Time
Expiration time.Time
Size int64
Data []byte
}
// Part info about a part.
type Part struct {
PartNumber uint32
Size int64
Modified time.Time
ETag []byte
}
// Metadata interface returns the latest metadata for an object.
type Metadata interface {
Metadata() ([]byte, error)
}
// ETag interface returns the latest ETag for a part.
type ETag interface {
ETag() []byte
}
// Store is a store for streams. It implements typedStore as part of an ongoing migration
// to use typed paths. See the shim for the store that the rest of the world interacts with.
type Store struct {
metainfo *metaclient.Client
ec ecclient.Client
segmentSize int64
encStore *encryption.Store
encryptionParameters storj.EncryptionParameters
inlineThreshold int
rngMu sync.Mutex
rng *mathrand.Rand
}
// NewStreamStore constructs a stream store.
func NewStreamStore(metainfo *metaclient.Client, ec ecclient.Client, segmentSize int64, encStore *encryption.Store, encryptionParameters storj.EncryptionParameters, inlineThreshold int) (*Store, error) {
if segmentSize <= 0 {
return nil, errs.New("segment size must be larger than 0")
}
if encryptionParameters.BlockSize <= 0 {
return nil, errs.New("encryption block size must be larger than 0")
}
return &Store{
metainfo: metainfo,
ec: ec,
segmentSize: segmentSize,
encStore: encStore,
encryptionParameters: encryptionParameters,
inlineThreshold: inlineThreshold,
rng: mathrand.New(mathrand.NewSource(time.Now().UnixNano())),
}, nil
}
// Close closes the underlying resources passed to the metainfo DB.
func (s *Store) Close() error {
return s.metainfo.Close()
}
// Put breaks up data as it comes in into s.segmentSize length pieces, then
// store the first piece at s0/<key>, second piece at s1/<key>, and the
// *last* piece at l/<key>. Store the given metadata, along with the number
// of segments, in a new protobuf, in the metadata of l/<key>.
//
// If there is an error, it cleans up any uploaded segment before returning.
func (s *Store) Put(ctx context.Context, bucket, unencryptedKey string, data io.Reader, metadata Metadata, expiration time.Time) (_ Meta, err error) {
defer mon.Task()(&ctx)(&err)
derivedKey, err := encryption.DeriveContentKey(bucket, paths.NewUnencrypted(unencryptedKey), s.encStore)
if err != nil {
return Meta{}, errs.Wrap(err)
}
encPath, err := encryption.EncryptPathWithStoreCipher(bucket, paths.NewUnencrypted(unencryptedKey), s.encStore)
if err != nil {
return Meta{}, errs.Wrap(err)
}
beginObjectReq := &metaclient.BeginObjectParams{
Bucket: []byte(bucket),
EncryptedObjectKey: []byte(encPath.Raw()),
ExpiresAt: expiration,
EncryptionParameters: s.encryptionParameters,
}
var streamID storj.StreamID
defer func() {
if err != nil && !streamID.IsZero() {
s.deleteCancelledObject(context2.WithoutCancellation(ctx), bucket, encPath.Raw(), streamID)
return
}
}()
var (
currentSegment uint32
contentKey storj.Key
streamSize int64
lastSegmentSize int64
encryptedKey []byte
encryptedKeyNonce storj.Nonce
segmentRS eestream.RedundancyStrategy
requestsToBatch = make([]metaclient.BatchItem, 0, 2)
)
maxEncryptedSegmentSize, err := encryption.CalcEncryptedSize(s.segmentSize, s.encryptionParameters)
if err != nil {
return Meta{}, errs.Wrap(err)
}
eofReader := NewEOFReader(data)
for !eofReader.IsEOF() && !eofReader.HasError() {
// generate random key for encrypting the segment's content
_, err := rand.Read(contentKey[:])
if err != nil {
return Meta{}, errs.Wrap(err)
}
// Initialize the content nonce with the current total segment incremented
// by 1 because at this moment the next segment has not been already
// uploaded.
// The increment by 1 is to avoid nonce reuse with the metadata encryption,
// which is encrypted with the zero nonce.
contentNonce := storj.Nonce{}
_, err = encryption.Increment(&contentNonce, int64(currentSegment)+1)
if err != nil {
return Meta{}, errs.Wrap(err)
}
// generate random nonce for encrypting the content key
_, err = rand.Read(encryptedKeyNonce[:])
if err != nil {
return Meta{}, errs.Wrap(err)
}
encryptedKey, err = encryption.EncryptKey(&contentKey, s.encryptionParameters.CipherSuite, derivedKey, &encryptedKeyNonce)
if err != nil {
return Meta{}, errs.Wrap(err)
}
sizeReader := SizeReader(eofReader)
peekReader := NewPeekThresholdReader(io.LimitReader(sizeReader, s.segmentSize))
// If the data is larger than the inline threshold size, then it will be a remote segment
isRemote, err := peekReader.IsLargerThan(s.inlineThreshold)
if err != nil {
return Meta{}, errs.Wrap(err)
}
segmentEncryption := metaclient.SegmentEncryption{}
if s.encryptionParameters.CipherSuite != storj.EncNull {
segmentEncryption = metaclient.SegmentEncryption{
EncryptedKey: encryptedKey,
EncryptedKeyNonce: encryptedKeyNonce,
}
}
if isRemote {
encrypter, err := encryption.NewEncrypter(s.encryptionParameters.CipherSuite, &contentKey, &contentNonce, int(s.encryptionParameters.BlockSize))
if err != nil {
return Meta{}, errs.Wrap(err)
}
paddedReader := encryption.PadReader(io.NopCloser(peekReader), encrypter.InBlockSize())
transformedReader := encryption.TransformReader(paddedReader, encrypter, 0)
beginSegment := &metaclient.BeginSegmentParams{
MaxOrderLimit: maxEncryptedSegmentSize,
Position: metaclient.SegmentPosition{
Index: int32(currentSegment),
},
}
var responses []metaclient.BatchResponse
if currentSegment == 0 {
responses, err = s.metainfo.Batch(ctx, beginObjectReq, beginSegment)
if err != nil {
return Meta{}, errs.Wrap(err)
}
objResponse, err := responses[0].BeginObject()
if err != nil {
return Meta{}, errs.Wrap(err)
}
streamID = objResponse.StreamID
} else {
beginSegment.StreamID = streamID
responses, err = s.metainfo.Batch(ctx, append(requestsToBatch, beginSegment)...)
requestsToBatch = requestsToBatch[:0]
if err != nil {
return Meta{}, errs.Wrap(err)
}
}
segResponse, err := responses[1].BeginSegment()
if err != nil {
return Meta{}, errs.Wrap(err)
}
segmentID := segResponse.SegmentID
limits := segResponse.Limits
piecePrivateKey := segResponse.PiecePrivateKey
segmentRS = segResponse.RedundancyStrategy
encSizedReader := SizeReader(transformedReader)
uploadResults, err := s.ec.PutSingleResult(ctx, limits, piecePrivateKey, segmentRS, encSizedReader)
if err != nil {
return Meta{}, errs.Wrap(err)
}
plainSize := sizeReader.Size()
if testuplink.IsWithoutPlainSize(ctx) {
plainSize = 0
}
requestsToBatch = append(requestsToBatch, &metaclient.CommitSegmentParams{
SegmentID: segmentID,
SizeEncryptedData: encSizedReader.Size(),
PlainSize: plainSize,
Encryption: segmentEncryption,
UploadResult: uploadResults,
})
} else {
data, err := io.ReadAll(peekReader)
if err != nil {
return Meta{}, errs.Wrap(err)
}
cipherData, err := encryption.Encrypt(data, s.encryptionParameters.CipherSuite, &contentKey, &contentNonce)
if err != nil {
return Meta{}, errs.Wrap(err)
}
plainSize := int64(len(data))
if testuplink.IsWithoutPlainSize(ctx) {
plainSize = 0
}
makeInlineSegment := &metaclient.MakeInlineSegmentParams{
Position: metaclient.SegmentPosition{
Index: int32(currentSegment),
},
Encryption: segmentEncryption,
EncryptedInlineData: cipherData,
PlainSize: plainSize,
}
if currentSegment == 0 {
responses, err := s.metainfo.Batch(ctx, beginObjectReq, makeInlineSegment)
if err != nil {
return Meta{}, errs.Wrap(err)
}
objResponse, err := responses[0].BeginObject()
if err != nil {
return Meta{}, errs.Wrap(err)
}
streamID = objResponse.StreamID
} else {
makeInlineSegment.StreamID = streamID
requestsToBatch = append(requestsToBatch, makeInlineSegment)
}
}
lastSegmentSize = sizeReader.Size()
streamSize += lastSegmentSize
currentSegment++
}
if eofReader.HasError() {
return Meta{}, errs.Wrap(eofReader.err)
}
metadataBytes, err := metadata.Metadata()
if err != nil {
return Meta{}, errs.Wrap(err)
}
// TODO: Do we still need to set SegmentsSize and LastSegmentSize
// for backward compatibility with old uplinks?
streamInfo, err := pb.Marshal(&pb.StreamInfo{
SegmentsSize: s.segmentSize,
LastSegmentSize: lastSegmentSize,
Metadata: metadataBytes,
})
if err != nil {
return Meta{}, errs.Wrap(err)
}
// encrypt metadata with the content encryption key and zero nonce.
encryptedStreamInfo, err := encryption.Encrypt(streamInfo, s.encryptionParameters.CipherSuite, &contentKey, &storj.Nonce{})
if err != nil {
return Meta{}, errs.Wrap(err)
}
streamMeta := pb.StreamMeta{
EncryptedStreamInfo: encryptedStreamInfo,
}
objectMetadata, err := pb.Marshal(&streamMeta)
if err != nil {
return Meta{}, errs.Wrap(err)
}
commitObject := metaclient.CommitObjectParams{
StreamID: streamID,
EncryptedMetadata: objectMetadata,
}
if s.encryptionParameters.CipherSuite != storj.EncNull {
commitObject.EncryptedMetadataEncryptedKey = encryptedKey
commitObject.EncryptedMetadataNonce = encryptedKeyNonce
}
if len(requestsToBatch) > 0 {
_, err = s.metainfo.Batch(ctx, append(requestsToBatch, &commitObject)...)
} else {
err = s.metainfo.CommitObject(ctx, commitObject)
}
if err != nil {
return Meta{}, errs.Wrap(err)
}
satStreamID := &pb.SatStreamID{}
if err := pb.Unmarshal(streamID, satStreamID); err != nil {
return Meta{}, errs.Wrap(err)
}
resultMeta := Meta{
Modified: satStreamID.CreationDate,
Expiration: expiration,
Size: streamSize,
Data: metadataBytes,
}
return resultMeta, nil
}
// PutPart uploads single part.
func (s *Store) PutPart(ctx context.Context, bucket, unencryptedKey string, streamID storj.StreamID, partNumber uint32, eTag ETag, data io.Reader) (_ Part, err error) {
defer mon.Task()(&ctx)(&err)
var (
currentSegment uint32
streamSize int64
lastSegmentContentKey storj.Key
// requests to send in a single call, in this case it will be always CommitSegment or MakeInlineSegment
requestsToBatch []metaclient.BatchItem
)
maxEncryptedSegmentSize, err := encryption.CalcEncryptedSize(s.segmentSize, s.encryptionParameters)
if err != nil {
return Part{}, errs.Wrap(err)
}
derivedKey, err := encryption.DeriveContentKey(bucket, paths.NewUnencrypted(unencryptedKey), s.encStore)
if err != nil {
return Part{}, errs.Wrap(err)
}
eofReader := NewEOFReader(data)
for !eofReader.IsEOF() && !eofReader.HasError() {
// generate random key for encrypting the segment's content
var contentKey storj.Key
_, err := rand.Read(contentKey[:])
if err != nil {
return Part{}, errs.Wrap(err)
}
// Initialize the content nonce with the current total segment incremented
// by 1 because at this moment the next segment has not been already
// uploaded.
// The increment by 1 is to avoid nonce reuse with the metadata encryption,
// which is encrypted with the zero nonce.
contentNonce := storj.Nonce{}
_, err = encryption.Increment(&contentNonce, (int64(partNumber)<<32)|(int64(currentSegment)+1))
if err != nil {
return Part{}, errs.Wrap(err)
}
var encryptedKeyNonce storj.Nonce
// generate random nonce for encrypting the content key
_, err = rand.Read(encryptedKeyNonce[:])
if err != nil {
return Part{}, errs.Wrap(err)
}
encryptedKey, err := encryption.EncryptKey(&contentKey, s.encryptionParameters.CipherSuite, derivedKey, &encryptedKeyNonce)
if err != nil {
return Part{}, errs.Wrap(err)
}
sizeReader := SizeReader(eofReader)
segmentReader := io.LimitReader(sizeReader, s.segmentSize)
peekReader := NewPeekThresholdReader(segmentReader)
// If the data is larger than the inline threshold size, then it will be a remote segment
isRemote, err := peekReader.IsLargerThan(s.inlineThreshold)
if err != nil {
return Part{}, errs.Wrap(err)
}
segmentEncryption := metaclient.SegmentEncryption{}
if s.encryptionParameters.CipherSuite != storj.EncNull {
segmentEncryption = metaclient.SegmentEncryption{
EncryptedKey: encryptedKey,
EncryptedKeyNonce: encryptedKeyNonce,
}
}
if isRemote {
encrypter, err := encryption.NewEncrypter(s.encryptionParameters.CipherSuite, &contentKey, &contentNonce, int(s.encryptionParameters.BlockSize))
if err != nil {
return Part{}, errs.Wrap(err)
}
paddedReader := encryption.PadReader(io.NopCloser(peekReader), encrypter.InBlockSize())
transformedReader := encryption.TransformReader(paddedReader, encrypter, 0)
beginSegment := metaclient.BeginSegmentParams{
StreamID: streamID,
MaxOrderLimit: maxEncryptedSegmentSize,
Position: metaclient.SegmentPosition{
PartNumber: int32(partNumber),
Index: int32(currentSegment),
},
}
var beginResponse metaclient.BeginSegmentResponse
if len(requestsToBatch) == 0 {
beginResponse, err = s.metainfo.BeginSegment(ctx, beginSegment)
if err != nil {
return Part{}, errs.Wrap(err)
}
} else {
responses, err := s.metainfo.Batch(ctx, append(requestsToBatch, &beginSegment)...)
if err != nil {
return Part{}, errs.Wrap(err)
}
requestsToBatch = requestsToBatch[:0]
beginResponse, err = responses[1].BeginSegment()
if err != nil {
return Part{}, errs.Wrap(err)
}
}
encSizedReader := SizeReader(transformedReader)
uploadResults, err := s.ec.PutSingleResult(ctx, beginResponse.Limits, beginResponse.PiecePrivateKey,
beginResponse.RedundancyStrategy, encSizedReader)
if err != nil {
return Part{}, errs.Wrap(err)
}
lastSegmentContentKey = contentKey
requestsToBatch = append(requestsToBatch, &metaclient.CommitSegmentParams{
SegmentID: beginResponse.SegmentID,
SizeEncryptedData: encSizedReader.Size(),
PlainSize: sizeReader.Size(),
Encryption: segmentEncryption,
UploadResult: uploadResults,
})
} else {
data, err := io.ReadAll(peekReader)
if err != nil {
return Part{}, errs.Wrap(err)
}
// if it's first segment then we still need to create is even
// if it's zero size because it can be last part while upload
// and we need to allow it for S3 compatibility
if len(data) > 0 || currentSegment == 0 {
lastSegmentContentKey = contentKey
cipherData, err := encryption.Encrypt(data, s.encryptionParameters.CipherSuite, &contentKey, &contentNonce)
if err != nil {
return Part{}, errs.Wrap(err)
}
requestsToBatch = append(requestsToBatch, &metaclient.MakeInlineSegmentParams{
StreamID: streamID,
Position: metaclient.SegmentPosition{
PartNumber: int32(partNumber),
Index: int32(currentSegment),
},
Encryption: segmentEncryption,
EncryptedInlineData: cipherData,
PlainSize: int64(len(data)),
})
}
}
streamSize += sizeReader.Size()
currentSegment++
}
// store ETag only for last segment in a part
encryptedTag, err := encryptETag(eTag.ETag(), s.encryptionParameters, &lastSegmentContentKey)
if err != nil {
return Part{}, errs.Wrap(err)
}
if len(requestsToBatch) > 0 {
// take last segment in a part and set ETag
switch singleRequest := requestsToBatch[len(requestsToBatch)-1].(type) {
case *metaclient.MakeInlineSegmentParams:
singleRequest.EncryptedTag = encryptedTag
case *metaclient.CommitSegmentParams:
singleRequest.EncryptedTag = encryptedTag
default:
return Part{}, errs.New("unsupported request type")
}
_, err = s.metainfo.Batch(ctx, requestsToBatch...)
if err != nil {
return Part{}, errs.Wrap(err)
}
}
return Part{
PartNumber: partNumber,
Size: streamSize,
ETag: eTag.ETag(), // return plain ETag
}, nil
}
// TODO move it to separate package?
func encryptETag(etag []byte, encryptionParameters storj.EncryptionParameters, contentKey *storj.Key) ([]byte, error) {
// Derive another key from the randomly generated content key to encrypt
// the segment's ETag.
etagKey, err := deriveETagKey(contentKey)
if err != nil {
return nil, err
}
encryptedETag, err := encryption.Encrypt(etag, encryptionParameters.CipherSuite, etagKey, &storj.Nonce{})
if err != nil {
return nil, err
}
return encryptedETag, nil
}
// TODO move it to separate package?
func deriveETagKey(key *storj.Key) (*storj.Key, error) {
return encryption.DeriveKey(key, "storj-etag-v1")
}
// Get returns a ranger that knows what the overall size is (from l/<key>)
// and then returns the appropriate data from segments s0/<key>, s1/<key>,
// ..., l/<key>.
func (s *Store) Get(ctx context.Context, bucket, unencryptedKey string, info metaclient.DownloadInfo) (rr ranger.Ranger, err error) {
defer mon.Task()(&ctx)(&err)
object := info.Object
if object.Size == 0 {
return ranger.ByteRanger(nil), nil
}
derivedKey, err := encryption.DeriveContentKey(bucket, paths.NewUnencrypted(unencryptedKey), s.encStore)
if err != nil {
return nil, errs.Wrap(err)
}
// download all missing segments
if info.ListSegments.More {
for info.ListSegments.More {
var cursor metaclient.SegmentPosition
if len(info.ListSegments.Items) > 0 {
last := info.ListSegments.Items[len(info.ListSegments.Items)-1]
cursor = last.Position
}
result, err := s.metainfo.ListSegments(ctx, metaclient.ListSegmentsParams{
StreamID: object.ID,
Cursor: cursor,
Range: info.Range,
})
if err != nil {
return nil, errs.Wrap(err)
}
info.ListSegments.Items = append(info.ListSegments.Items, result.Items...)
info.ListSegments.More = result.More
}
}
downloaded := info.DownloadedSegments
listed := info.ListSegments.Items
// calculate plain offset and plain size for migrated objects.
for i := 0; i < len(info.DownloadedSegments); i++ {
seg := &info.DownloadedSegments[i].Info
seg.PlainOffset, seg.PlainSize = calculatePlain(*seg.Position, seg.PlainOffset, seg.PlainSize, object)
}
for i := 0; i < len(info.ListSegments.Items); i++ {
seg := &info.ListSegments.Items[i]
seg.PlainOffset, seg.PlainSize = calculatePlain(seg.Position, seg.PlainOffset, seg.PlainSize, object)
}
// ensure that the items are correctly sorted
sort.Slice(downloaded, func(i, k int) bool {
return downloaded[i].Info.PlainOffset < downloaded[k].Info.PlainOffset
})
sort.Slice(listed, func(i, k int) bool {
return listed[i].PlainOffset < listed[k].PlainOffset
})
// calculate the offset for the range listed / downloaded
var offset int64
switch {
case len(downloaded) > 0 && len(listed) > 0:
if listed[0].PlainOffset < downloaded[0].Info.PlainOffset {
offset = listed[0].PlainOffset
} else {
offset = downloaded[0].Info.PlainOffset
}
case len(downloaded) > 0:
offset = downloaded[0].Info.PlainOffset
case len(listed) > 0:
offset = listed[0].PlainOffset
}
rangers := make([]ranger.Ranger, 0, len(downloaded)+len(listed)+2)
if offset > 0 {
rangers = append(rangers, &invalidRanger{size: offset})
}
for len(downloaded) > 0 || len(listed) > 0 {
switch {
case len(downloaded) > 0 && downloaded[0].Info.PlainOffset == offset:
segment := downloaded[0]
downloaded = downloaded[1:]
// drop any duplicate segment info in listing
for len(listed) > 0 && listed[0].PlainOffset == offset {
if listed[0].Position != *segment.Info.Position {
return nil, errs.New("segment info for download and list does not match: %v != %v", listed[0].Position, *segment.Info.Position)
}
listed = listed[1:]
}
encryptedRanger, err := s.Ranger(ctx, segment)
if err != nil {
return nil, errs.Wrap(err)
}
contentNonce, err := deriveContentNonce(*segment.Info.Position)
if err != nil {
return nil, errs.Wrap(err)
}
enc := segment.Info.SegmentEncryption
decrypted, err := decryptRanger(ctx, encryptedRanger, segment.Info.PlainSize, object.EncryptionParameters, derivedKey, enc.EncryptedKey, &enc.EncryptedKeyNonce, &contentNonce)
if err != nil {
return nil, errs.Wrap(err)
}
rangers = append(rangers, decrypted)
offset += segment.Info.PlainSize
case len(listed) > 0 && listed[0].PlainOffset == offset:
segment := listed[0]
listed = listed[1:]
contentNonce, err := deriveContentNonce(segment.Position)
if err != nil {
return nil, errs.Wrap(err)
}
rangers = append(rangers, &lazySegmentRanger{
metainfo: s.metainfo,
streams: s,
streamID: object.ID,
position: segment.Position,
plainSize: segment.PlainSize,
derivedKey: derivedKey,
startingNonce: &contentNonce,
encryptionParameters: object.EncryptionParameters,
})
offset += segment.PlainSize
default:
return nil, errs.New("missing segment for offset %d", offset)
}
}
if offset < object.Size {
rangers = append(rangers, &invalidRanger{size: object.Size - offset})
}
if offset > object.Size {
return nil, errs.New("invalid final offset %d; expected %d", offset, object.Size)
}
return ranger.Concat(rangers...), nil
}
func deriveContentNonce(pos metaclient.SegmentPosition) (storj.Nonce, error) {
// The increment by 1 is to avoid nonce reuse with the metadata encryption,
// which is encrypted with the zero nonce.
var n storj.Nonce
_, err := encryption.Increment(&n, int64(pos.PartNumber)<<32|(int64(pos.Index)+1))
return n, err
}
// calculatePlain calculates segment plain size, taking into account migrated objects.
func calculatePlain(pos metaclient.SegmentPosition, rawOffset, rawSize int64, object metaclient.Object) (plainOffset, plainSize int64) {
switch {
case object.FixedSegmentSize <= 0:
// this is a multipart object and has correct offset and size.
return rawOffset, rawSize
case pos.PartNumber > 0:
// this case should be impossible, however let's return the initial values.
return rawOffset, rawSize
case pos.Index == int32(object.SegmentCount-1):
// this is a last segment
return int64(pos.Index) * object.FixedSegmentSize, object.LastSegment.Size
default:
// this is a fixed size segment
return int64(pos.Index) * object.FixedSegmentSize, object.FixedSegmentSize
}
}
type lazySegmentRanger struct {
ranger ranger.Ranger
metainfo *metaclient.Client
streams *Store
streamID storj.StreamID
position metaclient.SegmentPosition
plainSize int64
derivedKey *storj.Key
startingNonce *storj.Nonce
encryptionParameters storj.EncryptionParameters
}
// Size implements Ranger.Size.
func (lr *lazySegmentRanger) Size() int64 {
return lr.plainSize
}
// Range implements Ranger.Range to be lazily connected.
func (lr *lazySegmentRanger) Range(ctx context.Context, offset, length int64) (_ io.ReadCloser, err error) {
defer mon.Task()(&ctx)(&err)
if lr.ranger == nil {
downloadResponse, err := lr.metainfo.DownloadSegmentWithRS(ctx, metaclient.DownloadSegmentParams{
StreamID: lr.streamID,
Position: metaclient.SegmentPosition{
PartNumber: lr.position.PartNumber,
Index: lr.position.Index,
},
})
if err != nil {
return nil, err
}
rr, err := lr.streams.Ranger(ctx, downloadResponse)
if err != nil {
return nil, err
}
encryptedKey, keyNonce := downloadResponse.Info.SegmentEncryption.EncryptedKey, downloadResponse.Info.SegmentEncryption.EncryptedKeyNonce
lr.ranger, err = decryptRanger(ctx, rr, lr.plainSize, lr.encryptionParameters, lr.derivedKey, encryptedKey, &keyNonce, lr.startingNonce)
if err != nil {
return nil, err
}
}
return lr.ranger.Range(ctx, offset, length)
}
// decryptRanger returns a decrypted ranger of the given rr ranger.
func decryptRanger(ctx context.Context, rr ranger.Ranger, plainSize int64, encryptionParameters storj.EncryptionParameters, derivedKey *storj.Key, encryptedKey storj.EncryptedPrivateKey, encryptedKeyNonce, startingNonce *storj.Nonce) (decrypted ranger.Ranger, err error) {
defer mon.Task()(&ctx)(&err)
contentKey, err := encryption.DecryptKey(encryptedKey, encryptionParameters.CipherSuite, derivedKey, encryptedKeyNonce)
if err != nil {
return nil, err
}
decrypter, err := encryption.NewDecrypter(encryptionParameters.CipherSuite, contentKey, startingNonce, int(encryptionParameters.BlockSize))
if err != nil {
return nil, err
}
var rd ranger.Ranger
if rr.Size()%int64(decrypter.InBlockSize()) != 0 {
reader, err := rr.Range(ctx, 0, rr.Size())
if err != nil {
return nil, err
}
defer func() { err = errs.Combine(err, reader.Close()) }()
cipherData, err := io.ReadAll(reader)
if err != nil {
return nil, err
}
data, err := encryption.Decrypt(cipherData, encryptionParameters.CipherSuite, contentKey, startingNonce)
if err != nil {
return nil, err
}
return ranger.ByteRanger(data), nil
}
rd, err = encryption.Transform(rr, decrypter)
if err != nil {
return nil, err
}
return encryption.Unpad(rd, int(rd.Size()-plainSize))
}
// deleteCancelledObject handles clean up of segments on receiving CTRL+C or context cancellation.
func (s *Store) deleteCancelledObject(ctx context.Context, bucketName, encryptedObjectKey string, streamID storj.StreamID) {
var err error
defer mon.Task()(&ctx)(&err)
_, err = s.metainfo.BeginDeleteObject(ctx, metaclient.BeginDeleteObjectParams{
Bucket: []byte(bucketName),
EncryptedObjectKey: []byte(encryptedObjectKey),
// TODO remove it or set to 0 when satellite side will be fixed
Version: 1,
StreamID: streamID,
Status: int32(pb.Object_UPLOADING),
})
if err != nil {
mon.Event("failed to delete cancelled object")
}
}
// Ranger creates a ranger for downloading erasure codes from piece store nodes.
func (s *Store) Ranger(ctx context.Context, response metaclient.DownloadSegmentWithRSResponse) (rr ranger.Ranger, err error) {
info := response.Info
limits := response.Limits
defer mon.Task()(&ctx, info, limits, info.RedundancyScheme)(&err)
// no order limits also means its inline segment
if len(info.EncryptedInlineData) != 0 || len(limits) == 0 {
return ranger.ByteRanger(info.EncryptedInlineData), nil
}
needed := info.RedundancyScheme.DownloadNodes()
selected := make([]*pb.AddressedOrderLimit, len(limits))
s.rngMu.Lock()
perm := s.rng.Perm(len(limits))
s.rngMu.Unlock()
for _, i := range perm {
limit := limits[i]
if limit == nil {
continue
}
selected[i] = limit
needed--
if needed <= 0 {
break
}
}
redundancy, err := eestream.NewRedundancyStrategyFromStorj(info.RedundancyScheme)
if err != nil {
return nil, err
}
rr, err = s.ec.Get(ctx, selected, info.PiecePrivateKey, redundancy, info.EncryptedSize)
return rr, err
}
// invalidRanger is used to mark a range as invalid.
type invalidRanger struct {
size int64
}
func (d *invalidRanger) Size() int64 { return d.size }
func (d *invalidRanger) Range(ctx context.Context, offset, length int64) (io.ReadCloser, error) {
if offset < 0 {
return nil, errs.New("negative offset")
}
if length < 0 {
return nil, errs.New("negative length")
}
// allow reading zero bytes from an invalid range.
if 0 <= offset && offset <= d.size && length == 0 {
return emptyReader{}, nil
}
return nil, errs.New("invalid range %d:%d (size:%d)", offset, length, d.size)
}
// emptyReader is used to read no data.
type emptyReader struct{}
func (emptyReader) Read(data []byte) (n int, err error) { return 0, io.EOF }
func (emptyReader) Close() error { return nil }