Follow key -> Service key and a single public API Thread key (#272)

* keys: (wip) follow -> service and consolidation Signed-off-by: Sander Pick <[email protected]> * keys: more updates for new keys Signed-off-by: Sander Pick <[email protected]> * keys: fix up thread key to bytes Signed-off-by: Sander Pick <[email protected]> * android: fix up client Signed-off-by: Sander Pick <[email protected]> * nit: remove uneeded keys in test Signed-off-by: Sander Pick <[email protected]> * review: address comments Signed-off-by: Sander Pick <[email protected]>
textileio · Mar 19, 2020 · 4399371 · 4399371
1 parent 2a96a5a
commit 4399371
Show file tree

Hide file tree

Showing 44 changed files with 828 additions and 768 deletions.
diff --git a/api/client/client.go b/api/client/client.go
@@ -9,7 +9,6 @@ import (
 	ma "github.com/multiformats/go-multiaddr"
 	pb "github.com/textileio/go-threads/api/pb"
 	"github.com/textileio/go-threads/core/thread"
-	"github.com/textileio/go-threads/crypto/symmetric"
 	"github.com/textileio/go-threads/db"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/codes"
@@ -95,15 +94,14 @@ func (c *Client) NewDB(ctx context.Context, id thread.ID) error {
 }
 
 // NewDBFromAddr creates a new DB with address and keys.
-func (c *Client) NewDBFromAddr(ctx context.Context, addr ma.Multiaddr, followKey, readKey *symmetric.Key, collections ...db.CollectionConfig) error {
+func (c *Client) NewDBFromAddr(ctx context.Context, addr ma.Multiaddr, key thread.Key, collections ...db.CollectionConfig) error {
 	pbcollections := make([]*pb.CollectionConfig, len(collections))
 	for i, c := range collections {
 		pbcollections[i] = collectionConfigToPb(c)
 	}
 	_, err := c.c.NewDBFromAddr(ctx, &pb.NewDBFromAddrRequest{
 		DbAddr:      addr.String(),
-		FollowKey:   followKey.Bytes(),
-		ReadKey:     readKey.Bytes(),
+		DbKey:       key.Bytes(),
 		Collections: pbcollections,
 	})
 	return err

diff --git a/api/client/client_test.go b/api/client/client_test.go
@@ -20,7 +20,6 @@ import (
 	. "github.com/textileio/go-threads/api/client"
 	pb "github.com/textileio/go-threads/api/pb"
 	"github.com/textileio/go-threads/core/thread"
-	sym "github.com/textileio/go-threads/crypto/symmetric"
 	"github.com/textileio/go-threads/db"
 	"github.com/textileio/go-threads/util"
 	"google.golang.org/grpc"
@@ -54,11 +53,8 @@ func TestNewDBFromAddr(t *testing.T) {
 	t.Run("test new db from address", func(t *testing.T) {
 		addr, err := ma.NewMultiaddr(info.Addresses[0])
 		checkErr(t, err)
-		fk, err := sym.FromBytes(info.FollowKey)
-		checkErr(t, err)
-		rk, err := sym.FromBytes(info.FollowKey)
-		checkErr(t, err)
-		if err := client2.NewDBFromAddr(context.Background(), addr, fk, rk); err != nil {
+		key, err := thread.KeyFromBytes(info.DbKey)
+		if err := client2.NewDBFromAddr(context.Background(), addr, key); err != nil {
 			t.Fatalf("failed to create new db from address: %v", err)
 		}
 	})
@@ -113,11 +109,8 @@ func TestGetDBInfo(t *testing.T) {
 		if err != nil {
 			t.Fatalf("failed to create collection: %v", err)
 		}
-		if info.FollowKey == nil {
-			t.Fatal("got nil follow key")
-		}
-		if info.ReadKey == nil {
-			t.Fatal("got nil read key")
+		if info.DbKey == nil {
+			t.Fatal("got nil db key")
 		}
 		if len(info.Addresses) == 0 {
 			t.Fatal("got empty addresses")

diff --git a/api/pb/android/threads/src/main/java/io/textile/threads/Client.java b/api/pb/android/threads/src/main/java/io/textile/threads/Client.java
@@ -85,22 +85,20 @@ public void NewDB (String dbID, StreamObserver<NewDBReply> responseObserver) {
         asyncStub.newDB(request.build(), responseObserver);
     }
 
-    public void NewDBFromAddrSync (String address, ByteString followKey, ByteString readKey, List<CollectionConfig> collections) {
+    public void NewDBFromAddrSync (String address, ByteString key, List<CollectionConfig> collections) {
         NewDBFromAddrRequest.Builder request = NewDBFromAddrRequest.newBuilder();
         request.setDbAddr(address);
-        request.setFollowKey(followKey);
-        request.setReadKey(readKey);
+        request.setDbKey(key);
         for (int i = 0; i < collections.size(); i++) {
             request.setCollections(i, collections.get(i));
         }
         blockingStub.newDBFromAddr(request.build());
     }
 
-    public void NewDBFromAddr (String address, ByteString followKey, ByteString readKey, List<CollectionConfig> collections, StreamObserver<NewDBReply> responseObserver) {
+    public void NewDBFromAddr (String address, ByteString key, List<CollectionConfig> collections, StreamObserver<NewDBReply> responseObserver) {
         NewDBFromAddrRequest.Builder request = NewDBFromAddrRequest.newBuilder();
         request.setDbAddr(address);
-        request.setFollowKey(followKey);
-        request.setReadKey(readKey);
+        request.setDbKey(key);
         for (int i = 0; i < collections.size(); i++) {
             request.setCollections(i, collections.get(i));
         }

diff --git a/api/pb/api.pb.go b/api/pb/api.pb.go
diff --git a/api/pb/api.proto b/api/pb/api.proto
@@ -23,8 +23,7 @@ message CollectionConfig {
 
 message NewDBFromAddrRequest {
     string dbAddr = 1;
-    bytes followKey = 2;
-    bytes readKey = 3;
+    bytes dbKey = 2;
     repeated CollectionConfig collections = 4;
 }
 
@@ -36,8 +35,7 @@ message GetDBInfoRequest {
 
 message GetDBInfoReply {
     repeated string addresses = 1;
-    bytes followKey = 2;
-    bytes readKey = 3;
+    bytes dbKey = 2;
 }
 
 message NewCollectionRequest {

diff --git a/api/service.go b/api/service.go
@@ -12,7 +12,6 @@ import (
 	coredb "github.com/textileio/go-threads/core/db"
 	"github.com/textileio/go-threads/core/net"
 	"github.com/textileio/go-threads/core/thread"
-	sym "github.com/textileio/go-threads/crypto/symmetric"
 	"github.com/textileio/go-threads/db"
 	"github.com/textileio/go-threads/util"
 	"google.golang.org/grpc/codes"
@@ -51,7 +50,7 @@ func NewService(network net.Net, conf Config) (*Service, error) {
 		network,
 		db.WithJsonMode(true),
 		db.WithRepoPath(conf.RepoPath),
-		db.WithDebug(true))
+		db.WithDebug(conf.Debug))
 	if err != nil {
 		return nil, err
 	}
@@ -85,11 +84,7 @@ func (s *Service) NewDBFromAddr(ctx context.Context, req *pb.NewDBFromAddrReques
 	if err != nil {
 		return nil, err
 	}
-	rk, err := sym.FromBytes(req.ReadKey)
-	if err != nil {
-		return nil, err
-	}
-	fk, err := sym.FromBytes(req.FollowKey)
+	key, err := thread.KeyFromBytes(req.DbKey)
 	if err != nil {
 		return nil, err
 	}
@@ -98,7 +93,7 @@ func (s *Service) NewDBFromAddr(ctx context.Context, req *pb.NewDBFromAddrReques
 	for i, c := range req.Collections {
 		collections[i] = collectionConfigFromPb(c)
 	}
-	if _, err = s.manager.NewDBFromAddr(ctx, addr, fk, rk, collections...); err != nil {
+	if _, err = s.manager.NewDBFromAddr(ctx, addr, key, collections...); err != nil {
 		return nil, err
 	}
 	return &pb.NewDBReply{}, nil
@@ -139,8 +134,7 @@ func (s *Service) GetDBInfo(ctx context.Context, req *pb.GetDBInfoRequest) (*pb.
 	}
 	reply := &pb.GetDBInfoReply{
 		Addresses: res,
-		FollowKey: tinfo.FollowKey.Bytes(),
-		ReadKey:   tinfo.ReadKey.Bytes(),
+		DbKey:     tinfo.Key.Bytes(),
 	}
 	return reply, nil
 }

diff --git a/cbor/event.go b/cbor/event.go
@@ -41,7 +41,7 @@ func CreateEvent(ctx context.Context, dag format.DAGService, body format.Node, r
 	if err != nil {
 		return nil, err
 	}
-	keyb, err := key.Marshal()
+	keyb, err := key.MarshalBinary()
 	if err != nil {
 		return nil, err
 	}

diff --git a/cbor/record.go b/cbor/record.go
@@ -26,14 +26,7 @@ type record struct {
 }
 
 // CreateRecord returns a new record from the given block and log private key.
-func CreateRecord(
-	ctx context.Context,
-	dag format.DAGService,
-	block format.Node,
-	prev cid.Cid,
-	sk ic.PrivKey,
-	key crypto.EncryptionKey,
-) (net.Record, error) {
+func CreateRecord(ctx context.Context, dag format.DAGService, block format.Node, prev cid.Cid, sk ic.PrivKey, key crypto.EncryptionKey) (net.Record, error) {
 	payload := block.Cid().Bytes()
 	if prev.Defined() {
 		payload = append(payload, prev.Bytes()...)

diff --git a/core/logstore/logstore.go b/core/logstore/logstore.go
@@ -79,17 +79,17 @@ type KeyBook interface {
 	// AddPrivKey adds a private key under a log.
 	AddPrivKey(thread.ID, peer.ID, ic.PrivKey) error
 
-	// ReadKey retrieves the read key of a log.
+	// ReadKey retrieves the read key of a thread.
 	ReadKey(thread.ID) (*sym.Key, error)
 
-	// AddReadKey adds a read key under a log.
+	// AddReadKey adds a read key under a thread.
 	AddReadKey(thread.ID, *sym.Key) error
 
-	// FollowKey retrieves the follow key of a log.
-	FollowKey(thread.ID) (*sym.Key, error)
+	// ServiceKey retrieves the service key of a thread.
+	ServiceKey(thread.ID) (*sym.Key, error)
 
-	// AddFollowKey adds a follow key under a log.
-	AddFollowKey(thread.ID, *sym.Key) error
+	// AddServiceKey adds a service key under a thread.
+	AddServiceKey(thread.ID, *sym.Key) error
 
 	// LogsWithKeys returns a list of log IDs for a service.
 	LogsWithKeys(thread.ID) (peer.IDSlice, error)

diff --git a/core/net/service.go → core/net/net.go b/core/net/service.go → core/net/net.go
@@ -40,13 +40,16 @@ type API interface {
 	GetThread(ctx context.Context, id thread.ID) (thread.Info, error)
 
 	// PullThread for new records.
+	// Logs owned by this host are traversed locally.
+	// Remotely addressed logs are pulled from the network.
+	// Is thread-safe.
 	PullThread(ctx context.Context, id thread.ID) error
 
 	// DeleteThread with id.
 	DeleteThread(ctx context.Context, id thread.ID) error
 
-	// AddFollower to a thread.
-	AddFollower(ctx context.Context, id thread.ID, paddr ma.Multiaddr) (peer.ID, error)
+	// AddReplicator sends the service key and all logs to another peer.
+	AddReplicator(ctx context.Context, id thread.ID, paddr ma.Multiaddr) (peer.ID, error)
 
 	// CreateRecord with body.
 	CreateRecord(ctx context.Context, id thread.ID, body format.Node) (ThreadRecord, error)

diff --git a/core/net/options.go b/core/net/options.go
@@ -3,30 +3,21 @@ package net
 import (
 	"github.com/libp2p/go-libp2p-core/crypto"
 	"github.com/textileio/go-threads/core/thread"
-	"github.com/textileio/go-threads/crypto/symmetric"
 )
 
 // KeyOptions defines options for keys when creating / adding a thread.
 type KeyOptions struct {
-	FollowKey *symmetric.Key
-	ReadKey   *symmetric.Key
+	ThreadKey thread.Key
 	LogKey    crypto.Key
 }
 
 // KeyOption specifies encryption keys.
 type KeyOption func(*KeyOptions)
 
-// FollowKey allows thread record traversal.
-func FollowKey(key *symmetric.Key) KeyOption {
+// ThreadKey handles log encryption.
+func ThreadKey(key thread.Key) KeyOption {
 	return func(args *KeyOptions) {
-		args.FollowKey = key
-	}
-}
-
-// ReadKey allows for thread record decryption.
-func ReadKey(key *symmetric.Key) KeyOption {
-	return func(args *KeyOptions) {
-		args.ReadKey = key
+		args.ThreadKey = key
 	}
 }
 

diff --git a/core/thread/id.go b/core/thread/id.go
@@ -10,7 +10,6 @@ import (
 	"github.com/libp2p/go-libp2p-core/peer"
 	ma "github.com/multiformats/go-multiaddr"
 	mbase "github.com/multiformats/go-multibase"
-	sym "github.com/textileio/go-threads/crypto/symmetric"
 )
 
 var (
@@ -304,10 +303,9 @@ func (s IDSlice) Less(i, j int) bool { return s[i].str < s[j].str }
 
 // Info holds thread logs and keys.
 type Info struct {
-	ID        ID
-	Logs      []LogInfo
-	FollowKey *sym.Key
-	ReadKey   *sym.Key
+	ID   ID
+	Key  Key
+	Logs []LogInfo
 }
 
 // GetOwnLog returns the first log found with a private key.