-
Notifications
You must be signed in to change notification settings - Fork 32
/
entry.go
628 lines (513 loc) · 13.8 KB
/
entry.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
// Package entry defines the Entry structure for IPFS Log and its associated methods.
package entry // import "berty.tech/go-ipfs-log/entry"
import (
"context"
"encoding/hex"
"encoding/json"
"math"
"sort"
"github.com/ipfs/go-cid"
cbornode "github.com/ipfs/go-ipld-cbor"
core_iface "github.com/ipfs/interface-go-ipfs-core"
"github.com/multiformats/go-multibase"
"github.com/polydawn/refmt/obj/atlas"
"berty.tech/go-ipfs-log/errmsg"
"berty.tech/go-ipfs-log/identityprovider"
"berty.tech/go-ipfs-log/iface"
"berty.tech/go-ipfs-log/io"
)
type Entry struct {
Payload []byte `json:"payload,omitempty"`
LogID string `json:"id,omitempty"`
Next []cid.Cid `json:"next,omitempty"`
Refs []cid.Cid `json:"refs,omitempty"`
V uint64 `json:"v,omitempty"`
Key []byte `json:"key,omitempty"`
Sig []byte `json:"sig,omitempty"`
Identity *identityprovider.Identity `json:"identity,omitempty"`
Hash cid.Cid `json:"hash,omitempty"`
Clock *LamportClock `json:"clock,omitempty"`
}
func (e *Entry) GetRefs() []cid.Cid {
return e.Refs
}
func (e *Entry) SetRefs(refs []cid.Cid) {
e.Refs = refs
}
func (e *Entry) GetPayload() []byte {
return e.Payload
}
func (e *Entry) GetLogID() string {
return e.LogID
}
func (e *Entry) GetNext() []cid.Cid {
return e.Next
}
func (e *Entry) GetV() uint64 {
return e.V
}
func (e *Entry) GetKey() []byte {
return e.Key
}
func (e *Entry) GetSig() []byte {
return e.Sig
}
func (e *Entry) GetIdentity() *identityprovider.Identity {
return e.Identity
}
func (e *Entry) GetHash() cid.Cid {
return e.Hash
}
func (e *Entry) GetClock() iface.IPFSLogLamportClock {
return e.Clock
}
func (e *Entry) SetPayload(payload []byte) {
e.Payload = payload
}
func (e *Entry) SetLogID(logID string) {
e.LogID = logID
}
func (e *Entry) SetNext(next []cid.Cid) {
e.Next = next
}
func (e *Entry) SetV(v uint64) {
e.V = v
}
func (e *Entry) SetKey(key []byte) {
e.Key = key
}
func (e *Entry) SetSig(sig []byte) {
e.Sig = sig
}
func (e *Entry) SetIdentity(identity *identityprovider.Identity) {
e.Identity = identity
}
func (e *Entry) SetHash(hash cid.Cid) {
e.Hash = hash
}
func (e *Entry) SetClock(clock iface.IPFSLogLamportClock) {
e.Clock = &LamportClock{
ID: clock.GetID(),
Time: clock.GetTime(),
}
}
type Hashable struct {
Hash interface{}
ID string
Payload []byte
Next []string
Refs []string
V uint64
Clock iface.IPFSLogLamportClock
Key []byte
}
var _ = atlas.BuildEntry(Hashable{}).
StructMap().
AddField("Hash", atlas.StructMapEntry{SerialName: "hash"}).
AddField("ID", atlas.StructMapEntry{SerialName: "id"}).
AddField("Payload", atlas.StructMapEntry{SerialName: "payload"}).
AddField("Next", atlas.StructMapEntry{SerialName: "next"}).
AddField("Refs", atlas.StructMapEntry{SerialName: "refs"}).
AddField("V", atlas.StructMapEntry{SerialName: "v"}).
AddField("Clock", atlas.StructMapEntry{SerialName: "clock"}).
Complete()
// CborEntry CBOR representable version of Entry
type CborEntry struct {
V uint64
LogID string
Key string
Sig string
Hash interface{}
Next []cid.Cid
Refs []cid.Cid
Clock *CborLamportClock
Payload string
Identity *identityprovider.CborIdentity
}
// CborEntryV1 CBOR representable version of Entry v1
type CborEntryV1 struct {
V uint64
LogID string
Key string
Sig string
Hash interface{}
Next []cid.Cid
Clock *CborLamportClock
Payload string
Identity *identityprovider.CborIdentity
}
// CborEntryV2 CBOR representable version of Entry v2
type CborEntryV2 = CborEntry
// ToEntry returns a plain Entry from a CBOR serialized version
func (c *CborEntry) ToEntry(provider identityprovider.Interface) (*Entry, error) {
key, err := hex.DecodeString(c.Key)
if err != nil {
return nil, errmsg.ErrKeyDeserialization.Wrap(err)
}
sig, err := hex.DecodeString(c.Sig)
if err != nil {
return nil, errmsg.ErrSigDeserialization.Wrap(err)
}
clock, err := ToLamportClock(c.Clock)
if err != nil {
return nil, errmsg.ErrClockDeserialization.Wrap(err)
}
identity, err := c.Identity.ToIdentity(provider)
if err != nil {
return nil, errmsg.ErrIdentityDeserialization.Wrap(err)
}
return &Entry{
V: c.V,
LogID: c.LogID,
Key: key,
Sig: sig,
Next: c.Next,
Refs: c.Refs,
Clock: clock,
Payload: []byte(c.Payload),
Identity: identity,
}, nil
}
// ToCborEntry creates a CBOR serializable version of an entry
func (e *Entry) ToCborEntry() interface{} {
if e.V == 1 {
return &CborEntryV1{
V: e.V,
LogID: e.LogID,
Key: hex.EncodeToString(e.Key),
Sig: hex.EncodeToString(e.Sig),
Hash: nil,
Next: e.Next,
Clock: e.Clock.ToCborLamportClock(),
Payload: string(e.Payload),
Identity: e.Identity.ToCborIdentity(),
}
}
return &CborEntry{
V: e.V,
LogID: e.LogID,
Key: hex.EncodeToString(e.Key),
Sig: hex.EncodeToString(e.Sig),
Hash: nil,
Next: e.Next,
Refs: e.Refs,
Clock: e.Clock.ToCborLamportClock(),
Payload: string(e.Payload),
Identity: e.Identity.ToCborIdentity(),
}
}
func init() {
AtlasEntry := atlas.BuildEntry(CborEntry{}).
StructMap().
AddField("V", atlas.StructMapEntry{SerialName: "v"}).
AddField("LogID", atlas.StructMapEntry{SerialName: "id"}).
AddField("Key", atlas.StructMapEntry{SerialName: "key"}).
AddField("Sig", atlas.StructMapEntry{SerialName: "sig"}).
AddField("Hash", atlas.StructMapEntry{SerialName: "hash"}).
AddField("Next", atlas.StructMapEntry{SerialName: "next"}).
AddField("Refs", atlas.StructMapEntry{SerialName: "refs"}).
AddField("Clock", atlas.StructMapEntry{SerialName: "clock"}).
AddField("Payload", atlas.StructMapEntry{SerialName: "payload"}).
AddField("Identity", atlas.StructMapEntry{SerialName: "identity"}).
Complete()
cbornode.RegisterCborType(AtlasEntry)
AtlasEntryV1 := atlas.BuildEntry(CborEntryV1{}).
StructMap().
AddField("V", atlas.StructMapEntry{SerialName: "v"}).
AddField("LogID", atlas.StructMapEntry{SerialName: "id"}).
AddField("Key", atlas.StructMapEntry{SerialName: "key"}).
AddField("Sig", atlas.StructMapEntry{SerialName: "sig"}).
AddField("Hash", atlas.StructMapEntry{SerialName: "hash"}).
AddField("Next", atlas.StructMapEntry{SerialName: "next"}).
AddField("Clock", atlas.StructMapEntry{SerialName: "clock"}).
AddField("Payload", atlas.StructMapEntry{SerialName: "payload"}).
AddField("Identity", atlas.StructMapEntry{SerialName: "identity"}).
Complete()
cbornode.RegisterCborType(AtlasEntryV1)
}
// CreateEntry creates an Entry.
func CreateEntry(ctx context.Context, ipfsInstance core_iface.CoreAPI, identity *identityprovider.Identity, data *Entry, opts *iface.CreateEntryOptions) (*Entry, error) {
if ipfsInstance == nil {
return nil, errmsg.ErrIPFSNotDefined
}
if identity == nil {
return nil, errmsg.ErrIdentityNotDefined
}
if data == nil {
return nil, errmsg.ErrPayloadNotDefined
}
if data.LogID == "" {
return nil, errmsg.ErrLogIDNotDefined
}
data = data.copy()
if data.Clock != nil {
data.Clock = CopyLamportClock(data.GetClock())
} else {
data.Clock = NewLamportClock(identity.PublicKey, 0)
}
data.V = 2
hashable, err := data.toHashable()
if err != nil {
return nil, errmsg.ErrEntryNotHashable.Wrap(err)
}
jsonBytes, err := toBuffer(hashable)
if err != nil {
return nil, errmsg.ErrEntryNotHashable.Wrap(err)
}
signature, err := identity.Provider.Sign(identity, jsonBytes)
if err != nil {
return nil, errmsg.ErrSigSign.Wrap(err)
}
data.Key = identity.PublicKey
data.Sig = signature
data.Identity = identity.Filtered()
data.Hash, err = data.ToMultihash(ctx, ipfsInstance, opts)
if err != nil {
return nil, errmsg.ErrIPFSOperationFailed.Wrap(err)
}
nd, err := cbornode.WrapObject(data.ToCborEntry(), math.MaxUint64, -1)
if err != nil {
return nil, errmsg.ErrCBOROperationFailed.Wrap(err)
}
err = ipfsInstance.Dag().Add(ctx, nd)
if err != nil {
return nil, errmsg.ErrIPFSOperationFailed.Wrap(err)
}
return data, nil
}
// copy creates a copy of an entry.
func (e *Entry) copy() *Entry {
return &Entry{
Payload: e.Payload,
LogID: e.LogID,
Next: uniqueCIDs(e.Next),
Refs: uniqueCIDs(e.Refs),
V: e.V,
Key: e.Key,
Sig: e.Sig,
Identity: e.Identity,
Hash: e.Hash,
Clock: e.Clock,
}
}
// uniqueCIDs returns uniques CIDs from a given list.
func uniqueCIDs(cids []cid.Cid) []cid.Cid {
foundCids := map[string]bool{}
out := []cid.Cid{}
for _, c := range cids {
if _, ok := foundCids[c.String()]; ok {
continue
}
foundCids[c.String()] = true
out = append(out, c)
}
return out
}
func cidB58(c cid.Cid) (string, error) {
e, err := multibase.NewEncoder(multibase.Base58BTC)
if err != nil {
return "", errmsg.ErrMultibaseOperationFailed.Wrap(err)
}
return c.Encode(e), nil
}
// toBuffer converts a hashable entry to bytes.
func toBuffer(e *Hashable) ([]byte, error) {
if e == nil {
return nil, errmsg.ErrEntryNotDefined
}
jsonBytes, err := json.Marshal(map[string]interface{}{
"hash": nil,
"id": e.ID,
"payload": string(e.Payload),
"next": e.Next,
"refs": e.Refs,
"v": e.V,
"clock": map[string]interface{}{
"id": hex.EncodeToString(e.Clock.GetID()),
"time": e.Clock.GetTime(),
},
})
if err != nil {
return nil, errmsg.ErrJSONSerializationFailed.Wrap(err)
}
return jsonBytes, nil
}
// toHashable Converts an entry to hashable.
func (e *Entry) toHashable() (*Hashable, error) {
nexts := make([]string, len(e.Next))
refs := make([]string, len(e.Refs))
for i, n := range e.Next {
c, err := cidB58(n)
if err != nil {
return nil, errmsg.ErrCIDSerializationFailed.Wrap(err)
}
nexts[i] = c
}
for i, r := range e.Refs {
c, err := cidB58(r)
if err != nil {
return nil, errmsg.ErrCIDSerializationFailed.Wrap(err)
}
refs[i] = c
}
return &Hashable{
Hash: nil,
ID: e.LogID,
Payload: e.Payload,
Next: nexts,
Refs: refs,
V: e.V,
Clock: e.Clock,
Key: e.Key,
}, nil
}
// isValid checks that an entry is valid.
func (e *Entry) IsValid() bool {
ok := e.LogID != "" && len(e.Payload) > 0 && e.V <= 2
return ok
}
// Verify checks the entry's signature.
func (e *Entry) Verify(identity identityprovider.Interface) error {
if e == nil {
return errmsg.ErrEntryNotDefined
}
if len(e.Key) == 0 {
return errmsg.ErrKeyNotDefined
}
if len(e.Sig) == 0 {
return errmsg.ErrSigNotDefined
}
// TODO: Check against trusted keys
hashable, err := e.toHashable()
if err != nil {
return errmsg.ErrEntryNotHashable.Wrap(err)
}
jsonBytes, err := toBuffer(hashable)
if err != nil {
return errmsg.ErrEntryNotHashable.Wrap(err)
}
pubKey, err := identity.UnmarshalPublicKey(e.Key)
if err != nil {
return errmsg.ErrInvalidPubKeyFormat.Wrap(err)
}
ok, err := pubKey.Verify(jsonBytes, e.Sig)
if err != nil {
return errmsg.ErrSigNotVerified.Wrap(err)
}
if !ok {
return errmsg.ErrSigNotVerified
}
return nil
}
// ToMultihash gets the multihash of an Entry.
func (e *Entry) ToMultihash(ctx context.Context, ipfsInstance core_iface.CoreAPI, opts *iface.CreateEntryOptions) (cid.Cid, error) {
if opts == nil {
opts = &iface.CreateEntryOptions{}
}
if e == nil {
return cid.Undef, errmsg.ErrEntryNotDefined
}
if ipfsInstance == nil {
return cid.Undef, errmsg.ErrIPFSNotDefined
}
data := e.copyNormalizedEntry(&normalizeEntryOpts{
preSigned: opts.PreSigned,
})
return io.WriteCBOR(ctx, ipfsInstance, data.ToCborEntry(), &io.WriteOpts{
Pin: opts.Pin,
})
}
type normalizeEntryOpts struct {
preSigned bool
includeHash bool
}
func (e *Entry) copyNormalizedEntry(opts *normalizeEntryOpts) *Entry {
if opts == nil {
opts = &normalizeEntryOpts{}
}
data := &Entry{
LogID: e.LogID,
Payload: e.Payload,
Next: e.Next,
V: e.V,
Clock: CopyLamportClock(e.GetClock()),
}
if opts.includeHash {
data.Hash = e.Hash
}
if e.V > 1 {
data.Refs = e.Refs
}
data.Key = e.Key
data.Identity = e.Identity
if opts.preSigned {
return data
}
if len(e.Sig) > 0 {
data.Sig = e.Sig
}
return data
}
// FromMultihash creates an Entry from a hash.
func FromMultihash(ctx context.Context, ipfs core_iface.CoreAPI, hash cid.Cid, provider identityprovider.Interface) (*Entry, error) {
if ipfs == nil {
return nil, errmsg.ErrIPFSNotDefined
}
result, err := io.ReadCBOR(ctx, ipfs, hash)
if err != nil {
return nil, errmsg.ErrCBOROperationFailed.Wrap(err)
}
obj := &CborEntry{}
err = cbornode.DecodeInto(result.RawData(), obj)
if err != nil {
return nil, errmsg.ErrCBOROperationFailed.Wrap(err)
}
obj.Hash = hash
entry, err := obj.ToEntry(provider)
if err != nil {
return nil, errmsg.ErrEntryDeserializationFailed.Wrap(err)
}
entry.Hash = hash
return entry, nil
}
// Equals checks that two entries are identical.
func (e *Entry) Equals(b *Entry) bool {
return e.Hash.String() == b.Hash.String()
}
func (e *Entry) IsParent(b iface.IPFSLogEntry) bool {
for _, next := range b.GetNext() {
if next.String() == e.Hash.String() {
return true
}
}
return false
}
// FindChildren finds an entry's children from an Array of entries.
//
// Returns entry's children as an Array up to the last know child.
func FindChildren(entry iface.IPFSLogEntry, values []iface.IPFSLogEntry) []iface.IPFSLogEntry {
var stack []iface.IPFSLogEntry
var parent iface.IPFSLogEntry
for _, e := range values {
if entry.IsParent(e) {
parent = e
break
}
}
for parent != nil {
stack = append(stack, parent)
prev := parent
for _, e := range values {
if prev.IsParent(e) {
parent = e
break
}
parent = nil
}
}
sort.SliceStable(stack, func(i, j int) bool {
return stack[i].GetClock().GetTime() <= stack[j].GetClock().GetTime()
})
return stack
}
var _ iface.IPFSLogEntry = (*Entry)(nil)