Merge pull request #16 from cfromknecht/sphinx-replay

Strong Replay Protection and Batched Processing

Author: Roasbeef

batch.go

@@ -0,0 +1,89 @@
+package sphinx
+
+import "errors"
+
+// ErrAlreadyCommitted signals that an entry could not be added to the
+// batch because it has already been persisted.
+var ErrAlreadyCommitted = errors.New("cannot add to batch after committing")
+
+// Batch is an object used to incrementally construct a set of entries to add to
+// the replay log. After construction is completed, it can be added to the log
+// using the PutBatch method.
+type Batch struct {
+	// isCommitted denotes whether or not this batch has been successfully
+	// written to disk.
+	isCommitted bool
+
+	// id is a unique, caller chosen identifier for this batch.
+	id []byte
+
+	// entries stores the set of all potential entries that might get
+	// written to the replay log. Some entries may be skipped after
+	// examining the on-disk content at the time of commit..
+	entries map[uint16]batchEntry
+
+	// replayCache is an in memory lookup-table, which stores the hash
+	// prefix of entries already added to this batch. This allows a quick
+	// mechanism for intra-batch duplicate detection.
+	replayCache map[HashPrefix]struct{}
+
+	// replaySet contains the sequence numbers of all entries that were
+	// detected as replays. The set is finalized upon writing the batch to
+	// disk, and merges replays detected by the replay cache and on-disk
+	// replay log.
+	replaySet *ReplaySet
+}
+
+// NewBatch initializes an object for constructing a set of entries to
+// atomically add to a replay log. Batches are identified by byte slice, which
+// allows the caller to safely process the same batch twice and get an
+// idempotent result.
+func NewBatch(id []byte) *Batch {
+	return &Batch{
+		id:          id,
+		entries:     make(map[uint16]batchEntry),
+		replayCache: make(map[HashPrefix]struct{}),
+		replaySet:   NewReplaySet(),
+	}
+}
+
+// Put inserts a hash-prefix/CLTV pair into the current batch. This method only
+// returns an error in the event that the batch was already committed to disk.
+// Decisions regarding whether or not a particular sequence number is a replay
+// is ultimately reported via the batch's ReplaySet after committing to disk.
+func (b *Batch) Put(seqNum uint16, hashPrefix *HashPrefix, cltv uint32) error {
+	// Abort if this batch was already written to disk.
+	if b.isCommitted {
+		return ErrAlreadyCommitted
+	}
+
+	// Check to see if this hash prefix is already included in this batch.
+	// If so, we will opportunistically mark this index as replayed.
+	if _, ok := b.replayCache[*hashPrefix]; ok {
+		b.replaySet.Add(seqNum)
+		return nil
+	}
+
+	// Otherwise, this is a distinct hash prefix for this batch. Add it to
+	// our list of entries that we will try to write to disk. Each of these
+	// entries will be checked again during the commit to see if any other
+	// on-disk entries contain the same hash prefix.
+	b.entries[seqNum] = batchEntry{
+		hashPrefix: *hashPrefix,
+		cltv:       cltv,
+	}
+
+	// Finally, add this hash prefix to our in-memory replay cache, this
+	// will be consulted upon further adds to check for duplicates in the
+	// same batch.
+	b.replayCache[*hashPrefix] = struct{}{}
+
+	return nil
+}
+
+// batchEntry is a tuple of a secret's hash prefix and the corresponding CLTV at
+// which the onion blob from which the secret was derived expires.
+type batchEntry struct {
+	hashPrefix HashPrefix
+	cltv       uint32
+}

bench_test.go

@@ -60,19 +60,29 @@ func BenchmarkProcessPacket(b *testing.B) {
 		b.Fatalf("unable to create test route: %v", err)
 	}
 	b.ReportAllocs()
+	path[0].log.Start()
+	defer shutdown("0", path[0].log)
 	b.StartTimer()
 
 	var (
 		pkt *ProcessedPacket
 	)
 	for i := 0; i < b.N; i++ {
-		pkt, err = path[0].ProcessOnionPacket(sphinxPacket, nil)
+		pkt, err = path[0].ProcessOnionPacket(sphinxPacket, nil, uint32(i))
 		if err != nil {
-			b.Fatalf("unable to process packet: %v", err)
+			b.Fatalf("unable to process packet %d: %v", i, err)
 		}
 
 		b.StopTimer()
-		path[0].seenSecrets = make(map[[sharedSecretSize]byte]struct{})
+		router := path[0]
+		shutdown("0", router.log)
+		path[0] = &Router{
+			nodeID:   router.nodeID,
+			nodeAddr: router.nodeAddr,
+			onionKey: router.onionKey,
+			log:      NewDecayedLog("0", nil),
+		}
+		path[0].log.Start()
 		b.StartTimer()
 	}
 

cmd/main.go

@@ -76,7 +76,7 @@ func main() {
 		}
 
 		privkey, _ := btcec.PrivKeyFromBytes(btcec.S256(), binKey)
-		s := sphinx.NewRouter(privkey, &chaincfg.TestNet3Params)
+		s := sphinx.NewRouter(privkey, &chaincfg.TestNet3Params, nil)
 
 		var packet sphinx.OnionPacket
 		err = packet.Decode(bytes.NewBuffer(binMsg))