feat(pairing)_: Fallback pairing seed (#5614)

* feat(pairing)!: Add extra parameters and remove v2 compatibility

This commit includes the following changes:

I have added a flag to maintain 2.29 compatibility.

Breaking change in connection string

The local pairing code that was parsing the connection string had a few non-upgradable features:

It was strictly checking the number of parameters, throwing an error if the number was different. This made it impossible to add parameters to it without breaking.
It was strictly checking the version number. This made increasing the version number impossible as older client would just refuse to connect.
The code has been changed so that:

Two parameters have been added, installation-id and key-uid. Those are needed for the fallback flow.
I have also removed version from the payload, since it wasn't used.

This means that we don't support v1 anymore. V2 parsing is supported . Going forward there's a clear strategy on how to update the protocol (append parameters, don't change existing one).

https://www.youtube.com/watch?v=oyLBGkS5ICk Is a must watch video for understanding the strategy

Changed MessengerResponse to use internally a map of installations rather than an array (minor)
Just moving towards maps as arrays tend to lead to subtle bugs.

Moved pairing methods to messenger_pairing.go
Just moved some methods

Added 2 new methods for the fallback flow
FinishPairingThroughSeedPhraseProcess
https://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R29

EnableAndSyncInstallation

https://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R18

Flow for clients
Client A1 is logged in
Client A2 is logged out

Client A1 shows a QR code
Client A2 scans a QR code
If connection fails on A2, the user will be prompted to enter a seed phrase.
If the generated account matches the key-uid from the QR code, A2 should call FinishPairingThroughSeedPhraseProcess with the installation id passed in the QR code. This will send installation information over waku. The user should be shown its own installation id and prompted to check the other device.
Client A1 will receive new installation data through waku, if they are still on the qr code page, they should show a popup to the user showing the received installation id, and a way to Enable and Sync, which should call the EnableAndSyncInstallation endpoint. This should finish the fallback syncing flow.
Current issues
Currently I haven't tested that all the data is synced after finishing the flow. I see that the two devices are paired correctly, but for example the DisplayName is not changed on the receiving device. I haven't had time to look into it further.

* test_: add more test for connection string parser

* fix_: fix panic when parse old connection string

* test_: add comments for TestMessengerPairAfterSeedPhrase

* fix_: correct error description

* feat_:rename FinishPairingThroughSeedPhraseProcess to EnableInstallationAndPair

* fix_: delete leftover

* fix_: add UniqueKey method

* fix_: unify the response for InputConnectionStringForBootstrapping

* fix_: remove fields installationID and keyUID in GethStatusBackend

* fix_: rename messenger_pairing to messenger_pairing_and_syncing

---------

Co-authored-by: Andrea Maria Piana <[email protected]>

api/backend_test.go

@@ -6,6 +6,7 @@ import (
 	"database/sql"
 	"encoding/hex"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"math/rand"
@@ -17,6 +18,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/status-im/status-go/protocol/tt"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
@@ -880,6 +883,107 @@ func TestLoginAccount(t *testing.T) {
 	require.Equal(t, nameserver, b.config.WakuV2Config.Nameserver)
 }
 
+func TestEnableInstallationAndPair(t *testing.T) {
+	// create account acc
+	utils.Init()
+	displayName := "some-display-name"
+	password := "some-password"
+	tmpdir := t.TempDir()
+	nameserver := "8.8.8.8"
+	b := NewGethStatusBackend()
+	createAccountRequest := &requests.CreateAccount{
+		DisplayName:        displayName,
+		CustomizationColor: "#ffffff",
+		Emoji:              "some",
+		Password:           password,
+		RootDataDir:        tmpdir,
+		LogFilePath:        tmpdir + "/log",
+		WakuV2Nameserver:   &nameserver,
+		WakuV2Fleet:        "status.staging",
+	}
+	acc, err := b.CreateAccountAndLogin(createAccountRequest)
+	require.NoError(t, err)
+	require.NotNil(t, acc)
+	_, err = b.Messenger().Start()
+	require.NoError(t, err)
+	s, err := b.GetSettings()
+	require.NoError(t, err)
+	mn := *s.Mnemonic
+	db, err := accounts.NewDB(b.appDB)
+	require.NoError(t, err)
+	n, err := db.GetSettingLastSynced(settings.DisplayName)
+	require.NoError(t, err)
+	require.True(t, n > 0)
+
+	// restore account acc as acc2 use Mnemonic from acc
+	restoreRequest := &requests.RestoreAccount{
+		Mnemonic:    mn,
+		FetchBackup: true,
+		CreateAccount: requests.CreateAccount{
+			Password:           password,
+			CustomizationColor: "0x000000",
+			RootDataDir:        t.TempDir(),
+		},
+	}
+	b2 := NewGethStatusBackend()
+	acc2, err := b2.RestoreAccountAndLogin(restoreRequest)
+	require.NoError(t, err)
+	require.NotNil(t, acc2)
+	_, err = b2.Messenger().Start()
+	require.NoError(t, err)
+	s2, err := b2.GetSettings()
+	require.NoError(t, err)
+
+	t.Logf("acc2 settings.name: %s", s2.Name)
+	// should be 3 words random name
+	require.Len(t, strings.Split(s2.Name, " "), 3)
+	require.Empty(t, acc2.Name)
+	require.Empty(t, s2.DisplayName)
+	db2, err := accounts.NewDB(b2.appDB)
+	require.NoError(t, err)
+	n, err = db2.GetSettingLastSynced(settings.DisplayName)
+	require.NoError(t, err)
+	require.True(t, n == 0)
+
+	// pair installation
+	_, err = b2.Messenger().EnableInstallationAndPair(&requests.EnableInstallationAndPair{InstallationID: s.InstallationID})
+	require.NoError(t, err)
+	// ensure acc received the installation from acc2
+	err = tt.RetryWithBackOff(func() error {
+		r, err := b.Messenger().RetrieveAll()
+		require.NoError(t, err)
+		if len(r.Installations()) > 0 {
+			return nil
+		}
+		return errors.New("new installation not received yet")
+	})
+	require.NoError(t, err)
+
+	// sync data from acc to acc2
+	err = b.Messenger().EnableAndSyncInstallation(&requests.EnableAndSyncInstallation{InstallationID: s2.InstallationID})
+	require.NoError(t, err)
+	// ensure acc2's display name get synced
+	err = tt.RetryWithBackOff(func() error {
+		r, err := b2.Messenger().RetrieveAll()
+		require.NoError(t, err)
+		for _, ss := range r.Settings {
+			if ss.GetDBName() == "display_name" {
+				return nil
+			}
+		}
+		return errors.New("display name setting not received yet")
+	})
+	require.NoError(t, err)
+
+	// check display name for acc2
+	s2, err = b2.GetSettings()
+	require.NoError(t, err)
+	require.Equal(t, displayName, s2.DisplayName)
+	acc2, err = b2.GetActiveAccount()
+	require.NoError(t, err)
+	require.Equal(t, displayName, acc2.Name)
+}
+
 func TestVerifyDatabasePassword(t *testing.T) {
 	utils.Init()
 

api/geth_backend.go

@@ -2663,6 +2663,22 @@ func (b *GethStatusBackend) injectAccountsIntoWakuService(w types.WakuKeyManager
 	return nil
 }
 
+func (b *GethStatusBackend) InstallationID() string {
+	m := b.Messenger()
+	if m != nil {
+		return m.InstallationID()
+	}
+	return ""
+}
+
+func (b *GethStatusBackend) KeyUID() string {
+	m := b.Messenger()
+	if m != nil {
+		return m.KeyUID()
+	}
+	return ""
+}
+
 func (b *GethStatusBackend) injectAccountsIntoServices() error {
 	if b.statusNode.WakuService() != nil {
 		return b.injectAccountsIntoWakuService(b.statusNode.WakuService(), func() *ext.Service {

mobile/status.go

@@ -1188,6 +1188,18 @@ func GetConnectionStringForBootstrappingAnotherDevice(configJSON string) string
 	return cs
 }
 
+type inputConnectionStringForBootstrappingResponse struct {
+	InstallationID string `json:"installationId"`
+	KeyUID         string `json:"keyUID"`
+	Error          error  `json:"error"`
+}
+
+func (i *inputConnectionStringForBootstrappingResponse) toJSON(err error) string {
+	i.Error = err
+	j, _ := json.Marshal(i)
+	return string(j)
+}
+
 // InputConnectionStringForBootstrapping starts a pairing.ReceiverClient
 // The given server.ConnectionParams string will determine the server.Mode
 //
@@ -1202,18 +1214,30 @@ func InputConnectionStringForBootstrapping(cs, configJSON string) string {
 		return makeJSONResponse(fmt.Errorf("no config given, ReceiverClientConfig is expected"))
 	}
 
+	params := &pairing.ConnectionParams{}
+	err = params.FromString(cs)
+	if err != nil {
+		response := &inputConnectionStringForBootstrappingResponse{}
+		return response.toJSON(fmt.Errorf("could not parse connection string"))
+	}
+	response := &inputConnectionStringForBootstrappingResponse{
+		InstallationID: params.InstallationID(),
+		KeyUID:         params.KeyUID(),
+	}
+
 	err = statusBackend.LocalPairingStateManager.StartPairing(cs)
 	defer func() { statusBackend.LocalPairingStateManager.StopPairing(cs, err) }()
 	if err != nil {
-		return makeJSONResponse(err)
+		return response.toJSON(err)
 	}
 
 	err = pairing.StartUpReceivingClient(statusBackend, cs, configJSON)
 	if err != nil {
-		return makeJSONResponse(err)
+		return response.toJSON(err)
+
 	}
 
-	return makeJSONResponse(statusBackend.Logout())
+	return response.toJSON(statusBackend.Logout())
 }
 
 // InputConnectionStringForBootstrappingAnotherDevice starts a pairing.SendingClient

protocol/encryption/multidevice/multidevice.go

@@ -31,6 +31,10 @@ type Installation struct {
 	InstallationMetadata *InstallationMetadata `json:"metadata"`
 }
 
+func (i *Installation) UniqueKey() string {
+	return i.ID + i.Identity
+}
+
 type Config struct {
 	MaxInstallations int
 	ProtocolVersion  uint32

protocol/encryption/protocol.go

@@ -540,6 +540,10 @@ func (p *Protocol) ProcessPublicBundle(myIdentityKey *ecdsa.PrivateKey, bundle *
 	return p.multidevice.AddInstallations(bundle.GetIdentity(), bundle.GetTimestamp(), installations, enabled)
 }
 
+func (p *Protocol) AddInstallation(identity []byte, timestamp int64, installation *multidevice.Installation, enabled bool) ([]*multidevice.Installation, error) {
+	return p.multidevice.AddInstallations(identity, timestamp, []*multidevice.Installation{installation}, enabled)
+}
+
 func (p *Protocol) GetMultiDevice() *multidevice.Multidevice {
 	return p.multidevice
 }