LBRYCommunity/wallet-sync-server
1
0
Fork 0
Code Issues 11 Pull requests Packages Projects Releases 2 Wiki Activity

Protocol changes

Browse source 
* Regress from `lastSynced` to just `sequence` to start with something simpler
* Simplified payload: separate metadata, assume canonical way to hmac it together
  * No more "wallet state" except as a simple wrapper on the front end
* Version number in wallet payloads
This commit is contained in:
Daniel Krol 2022-06-09 17:04:49 -04:00
parent 197e228d32
commit 512ebe3e95
17 changed files with 505 additions and 621 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
auth/auth.go
View file

@ -11,13 +11,13 @@ import (
// TODO - Learn how to use https://github.com/golang/oauth2 instead // TODO - Learn how to use https://github.com/golang/oauth2 instead
// TODO - Look into jwt, etc. // TODO - Look into jwt, etc.
// For now I just want a process that's shaped like what I'm looking for. // For now I just want a process that's shaped like what I'm looking for.
// (email/password, encrypted wallets, hmac, lastSynced, etc) // (email/password, encrypted wallets, hmac, sequence (eventually lastSynced), etc)
type UserId int32 type UserId int32
type Email string type Email string
type DeviceId string type DeviceId string
type Password string type Password string
type AuthTokenString string type TokenString string
type AuthScope string type AuthScope string
const ScopeFull = AuthScope("*") const ScopeFull = AuthScope("*")
@ -34,11 +34,11 @@ type Auth struct{}
// downloadKey and associated email. Currently these fields are safe to give // downloadKey and associated email. Currently these fields are safe to give
// at that low security level, but keep this in mind as we change this struct. // at that low security level, but keep this in mind as we change this struct.
type AuthToken struct { type AuthToken struct {
Token AuthTokenString `json:"token"` Token TokenString `json:"token"`
DeviceId DeviceId `json:"deviceId"` DeviceId DeviceId `json:"deviceId"`
Scope AuthScope `json:"scope"` Scope AuthScope `json:"scope"`
UserId UserId `json:"userId"` UserId UserId `json:"userId"`
Expiration *time.Time `json:"expiration"` Expiration *time.Time `json:"expiration"`
} }
const AuthTokenLength = 32 const AuthTokenLength = 32
@ -51,7 +51,7 @@ func (a *Auth) NewToken(userId UserId, deviceId DeviceId, scope AuthScope) (*Aut
} }
return &AuthToken{ return &AuthToken{
Token: AuthTokenString(hex.EncodeToString(b)), Token: TokenString(hex.EncodeToString(b)),
DeviceId: deviceId, DeviceId: deviceId,
Scope: scope, Scope: scope,
UserId: userId, UserId: userId,

3
main.go
View file

@ -5,7 +5,6 @@ import (
"orblivion/lbry-id/auth" "orblivion/lbry-id/auth"
"orblivion/lbry-id/server" "orblivion/lbry-id/server"
"orblivion/lbry-id/store" "orblivion/lbry-id/store"
"orblivion/lbry-id/wallet"
) )
func storeInit() (s store.Store) { func storeInit() (s store.Store) {
@ -23,6 +22,6 @@ func storeInit() (s store.Store) {
func main() { func main() {
store := storeInit() store := storeInit()
srv := server.Init(&auth.Auth{}, &store, &wallet.WalletUtil{}) srv := server.Init(&auth.Auth{}, &store)
srv.Serve() srv.Serve()
} }

11
server/auth_test.go
View file

@ -8,15 +8,14 @@ import (
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
"orblivion/lbry-id/auth" "orblivion/lbry-id/auth"
"orblivion/lbry-id/wallet"
"strings" "strings"
"testing" "testing"
) )
func TestServerAuthHandlerSuccess(t *testing.T) { func TestServerAuthHandlerSuccess(t *testing.T) {
testAuth := TestAuth{TestToken: auth.AuthTokenString("seekrit")} testAuth := TestAuth{TestToken: auth.TokenString("seekrit")}
testStore := TestStore{} testStore := TestStore{}
s := Server{&testAuth, &testStore, &wallet.WalletUtil{}} s := Server{&testAuth, &testStore}
requestBody := []byte(`{"deviceId": "dev-1", "email": "abc@example.com", "password": "123"}`) requestBody := []byte(`{"deviceId": "dev-1", "email": "abc@example.com", "password": "123"}`)
@ -116,7 +115,7 @@ func TestServerAuthHandlerErrors(t *testing.T) {
t.Run(tc.name, func(t *testing.T) { t.Run(tc.name, func(t *testing.T) {
// Set this up to fail according to specification // Set this up to fail according to specification
testAuth := TestAuth{TestToken: auth.AuthTokenString("seekrit")} testAuth := TestAuth{TestToken: auth.TokenString("seekrit")}
testStore := TestStore{} testStore := TestStore{}
if tc.authFailLogin { if tc.authFailLogin {
testStore.FailLogin = true testStore.FailLogin = true
@ -125,9 +124,9 @@ func TestServerAuthHandlerErrors(t *testing.T) {
} else if tc.storeFailSave { } else if tc.storeFailSave {
testStore.FailSave = true testStore.FailSave = true
} else { } else {
testAuth.TestToken = auth.AuthTokenString("seekrit") testAuth.TestToken = auth.TokenString("seekrit")
} }
server := Server{&testAuth, &testStore, &wallet.WalletUtil{}} server := Server{&testAuth, &testStore}
// Make request // Make request
req := httptest.NewRequest(tc.method, PathAuthToken, bytes.NewBuffer([]byte(tc.requestBody))) req := httptest.NewRequest(tc.method, PathAuthToken, bytes.NewBuffer([]byte(tc.requestBody)))

106
server/integration_test.go
View file

@ -10,6 +10,7 @@ import (
"orblivion/lbry-id/auth" "orblivion/lbry-id/auth"
"orblivion/lbry-id/store" "orblivion/lbry-id/store"
"orblivion/lbry-id/wallet" "orblivion/lbry-id/wallet"
"reflect"
"testing" "testing"
) )
@ -30,9 +31,9 @@ func checkStatusCode(t *testing.T, statusCode int, responseBody []byte, expected
var errorResponse ErrorResponse var errorResponse ErrorResponse
err := json.Unmarshal(responseBody, &errorResponse) err := json.Unmarshal(responseBody, &errorResponse)
if err == nil { if err == nil {
t.Fatalf("http response: %+v", errorResponse) t.Errorf("http response: %+v", errorResponse)
} else { } else {
t.Fatalf("%s", err) t.Errorf("%s", err)
} }
} }
} }
@ -61,11 +62,7 @@ func TestIntegrationWalletUpdates(t *testing.T) {
st, tmpFile := store.StoreTestInit(t) st, tmpFile := store.StoreTestInit(t)
defer store.StoreTestCleanup(tmpFile) defer store.StoreTestCleanup(tmpFile)
s := Init( s := Init(&auth.Auth{}, &st)
&auth.Auth{},
&st,
&wallet.WalletUtil{},
)
//////////////////// ////////////////////
// Register email address - any device // Register email address - any device
@ -130,116 +127,107 @@ func TestIntegrationWalletUpdates(t *testing.T) {
} }
//////////////////// ////////////////////
// Put first wallet state - device 1 // Put first wallet - device 1
//////////////////// ////////////////////
var walletStateResponse WalletStateResponse var walletResponse WalletResponse
responseBody, statusCode = request( responseBody, statusCode = request(
t, t,
http.MethodPost, http.MethodPost,
s.postWalletState, s.postWallet,
PathWalletState, PathWallet,
&walletStateResponse, &walletResponse,
fmt.Sprintf(`{ fmt.Sprintf(`{
"version": 1,
"token": "%s", "token": "%s",
"walletStateJson": "{\"encryptedWallet\": \"blah\", \"lastSynced\":{\"dev-1\": 1}, \"deviceId\": \"dev-1\" }", "encryptedWallet": "my-encrypted-wallet-1",
"sequence": 1,
"hmac": "my-hmac-1" "hmac": "my-hmac-1"
}`, authToken1.Token), }`, authToken1.Token),
) )
checkStatusCode(t, statusCode, responseBody) checkStatusCode(t, statusCode, responseBody)
var walletState wallet.WalletStateMetadata expectedResponse := WalletResponse{
err := json.Unmarshal([]byte(walletStateResponse.WalletStateJson), &walletState) Version: 1,
EncryptedWallet: wallet.EncryptedWallet("my-encrypted-wallet-1"),
if err != nil { Sequence: wallet.Sequence(1),
t.Fatalf("Unexpected error: %+v", err) Hmac: wallet.WalletHmac("my-hmac-1"),
} }
sequence := walletState.Sequence() if !reflect.DeepEqual(walletResponse, expectedResponse) {
if sequence != 1 { t.Fatalf("Unexpected response values. want: %+v got: %+v", expectedResponse, walletResponse)
t.Fatalf("Unexpected response Sequence(). want: %+v got: %+v", 1, sequence)
} }
//////////////////// ////////////////////
// Get wallet state - device 2 // Get wallet - device 2
//////////////////// ////////////////////
responseBody, statusCode = request( responseBody, statusCode = request(
t, t,
http.MethodGet, http.MethodGet,
s.getWalletState, s.getWallet,
fmt.Sprintf("%s?token=%s", PathWalletState, authToken2.Token), fmt.Sprintf("%s?token=%s", PathWallet, authToken2.Token),
&walletStateResponse, &walletResponse,
"", "",
) )
checkStatusCode(t, statusCode, responseBody) checkStatusCode(t, statusCode, responseBody)
err = json.Unmarshal([]byte(walletStateResponse.WalletStateJson), &walletState) // Expect the same response getting from device 2 as when posting from device 1
if !reflect.DeepEqual(walletResponse, expectedResponse) {
if err != nil { t.Fatalf("Unexpected response values. want: %+v got: %+v", expectedResponse, walletResponse)
t.Fatalf("Unexpected error: %+v", err)
}
sequence = walletState.Sequence()
if sequence != 1 {
t.Fatalf("Unexpected response Sequence(). want: %+v got: %+v", 1, sequence)
} }
//////////////////// ////////////////////
// Put second wallet state - device 2 // Put second wallet - device 2
//////////////////// ////////////////////
responseBody, statusCode = request( responseBody, statusCode = request(
t, t,
http.MethodPost, http.MethodPost,
s.postWalletState, s.postWallet,
PathWalletState, PathWallet,
&walletStateResponse, &walletResponse,
fmt.Sprintf(`{ fmt.Sprintf(`{
"version": 1,
"token": "%s", "token": "%s",
"walletStateJson": "{\"encryptedWallet\": \"blah2\", \"lastSynced\":{\"dev-1\": 1, \"dev-2\": 2}, \"deviceId\": \"dev-2\" }", "encryptedWallet": "my-encrypted-wallet-2",
"sequence": 2,
"hmac": "my-hmac-2" "hmac": "my-hmac-2"
}`, authToken2.Token), }`, authToken2.Token),
) )
checkStatusCode(t, statusCode, responseBody) checkStatusCode(t, statusCode, responseBody)
err = json.Unmarshal([]byte(walletStateResponse.WalletStateJson), &walletState) expectedResponse = WalletResponse{
Version: 1,
if err != nil { EncryptedWallet: wallet.EncryptedWallet("my-encrypted-wallet-2"),
t.Fatalf("Unexpected error: %+v", err) Sequence: wallet.Sequence(2),
Hmac: wallet.WalletHmac("my-hmac-2"),
} }
sequence = walletState.Sequence() if !reflect.DeepEqual(walletResponse, expectedResponse) {
if sequence != 2 { t.Fatalf("Unexpected response values. want: %+v got: %+v", expectedResponse, walletResponse)
t.Fatalf("Unexpected response Sequence(). want: %+v got: %+v", 2, sequence)
} }
//////////////////// ////////////////////
// Get wallet state - device 1 // Get wallet - device 1
//////////////////// ////////////////////
responseBody, statusCode = request( responseBody, statusCode = request(
t, t,
http.MethodGet, http.MethodGet,
s.getWalletState, s.getWallet,
fmt.Sprintf("%s?token=%s", PathWalletState, authToken1.Token), fmt.Sprintf("%s?token=%s", PathWallet, authToken1.Token),
&walletStateResponse, &walletResponse,
"", "",
) )
checkStatusCode(t, statusCode, responseBody) checkStatusCode(t, statusCode, responseBody)
err = json.Unmarshal([]byte(walletStateResponse.WalletStateJson), &walletState) // Expect the same response getting from device 2 as when posting from device 1
if !reflect.DeepEqual(walletResponse, expectedResponse) {
if err != nil { t.Fatalf("Unexpected response values. want: %+v got: %+v", expectedResponse, walletResponse)
t.Fatalf("Unexpected error: %+v", err)
}
sequence = walletState.Sequence()
if sequence != 2 {
t.Fatalf("Unexpected response Sequence(). want: %+v got: %+v", 2, sequence)
} }
} }

2
server/register.go
View file

@ -47,7 +47,7 @@ func (s *Server) register(w http.ResponseWriter, req *http.Request) {
return return
} }
// TODO StatusCreated also for first walletState and/or for get auth token? // TODO StatusCreated also for first wallet and/or for get auth token?
w.WriteHeader(http.StatusCreated) w.WriteHeader(http.StatusCreated)
fmt.Fprintf(w, string(response)) fmt.Fprintf(w, string(response))
} }

18
server/server.go
View file

@ -7,30 +7,26 @@ import (
"net/http" "net/http"
"orblivion/lbry-id/auth" "orblivion/lbry-id/auth"
"orblivion/lbry-id/store" "orblivion/lbry-id/store"
"orblivion/lbry-id/wallet"
) )
// TODO proper doc comments! // TODO proper doc comments!
const PathAuthToken = "/auth/full" const PathAuthToken = "/auth/full"
const PathRegister = "/signup" const PathRegister = "/signup"
const PathWalletState = "/wallet-state" const PathWallet = "/wallet"
type Server struct { type Server struct {
auth auth.AuthInterface auth auth.AuthInterface
store store.StoreInterface store store.StoreInterface
walletUtil wallet.WalletUtilInterface
} }
func Init( func Init(
auth auth.AuthInterface, auth auth.AuthInterface,
store store.StoreInterface, store store.StoreInterface,
walletUtil wallet.WalletUtilInterface,
) *Server { ) *Server {
return &Server{ return &Server{
auth: auth, auth: auth,
store: store, store: store,
walletUtil: walletUtil,
} }
} }
@ -129,7 +125,7 @@ func getGetData(w http.ResponseWriter, req *http.Request) bool {
// deviceId. Also this is apparently not idiomatic go error handling. // deviceId. Also this is apparently not idiomatic go error handling.
func (s *Server) checkAuth( func (s *Server) checkAuth(
w http.ResponseWriter, w http.ResponseWriter,
token auth.AuthTokenString, token auth.TokenString,
scope auth.AuthScope, scope auth.AuthScope,
) *auth.AuthToken { ) *auth.AuthToken {
authToken, err := s.store.GetToken(token) authToken, err := s.store.GetToken(token)
@ -155,7 +151,7 @@ func (s *Server) checkAuth(
func (s *Server) Serve() { func (s *Server) Serve() {
http.HandleFunc(PathAuthToken, s.getAuthToken) http.HandleFunc(PathAuthToken, s.getAuthToken)
http.HandleFunc(PathWalletState, s.handleWalletState) http.HandleFunc(PathWallet, s.handleWallet)
http.HandleFunc(PathRegister, s.register) http.HandleFunc(PathRegister, s.register)
fmt.Println("Serving at :8090") fmt.Println("Serving at :8090")

16
server/server_test.go
View file

@ -11,7 +11,7 @@ import (
// Implementing interfaces for stubbed out packages // Implementing interfaces for stubbed out packages
type TestAuth struct { type TestAuth struct {
TestToken auth.AuthTokenString TestToken auth.TokenString
FailGenToken bool FailGenToken bool
} }
@ -37,7 +37,7 @@ func (s *TestStore) SaveToken(token *auth.AuthToken) error {
return nil return nil
} }
func (s *TestStore) GetToken(auth.AuthTokenString) (*auth.AuthToken, error) { func (s *TestStore) GetToken(auth.TokenString) (*auth.AuthToken, error) {
return nil, nil return nil, nil
} }
@ -52,16 +52,16 @@ func (s *TestStore) CreateAccount(auth.Email, auth.Password) error {
return nil return nil
} }
func (s *TestStore) SetWalletState( func (s *TestStore) SetWallet(
UserId auth.UserId, UserId auth.UserId,
walletStateJson string, encryptedWallet wallet.EncryptedWallet,
sequence int, sequence wallet.Sequence,
hmac wallet.WalletStateHmac, hmac wallet.WalletHmac,
) (latestWalletStateJson string, latestHmac wallet.WalletStateHmac, updated bool, err error) { ) (latestEncryptedWallet wallet.EncryptedWallet, latestSequence wallet.Sequence, latestHmac wallet.WalletHmac, sequenceCorrect bool, err error) {
return return
} }
func (s *TestStore) GetWalletState(UserId auth.UserId) (walletStateJson string, hmac wallet.WalletStateHmac, err error) { func (s *TestStore) GetWallet(userId auth.UserId) (encryptedWallet wallet.EncryptedWallet, sequence wallet.Sequence, hmac wallet.WalletHmac, err error) {
return return
} }

177
server/wallet.go Normal file
View file

@ -0,0 +1,177 @@
package server
import (
"encoding/json"
"fmt"
"net/http"
"orblivion/lbry-id/auth"
"orblivion/lbry-id/store"
"orblivion/lbry-id/wallet"
)
const CURRENT_VERSION = 1
type WalletRequest struct {
Version int `json:"version"`
Token auth.TokenString `json:"token"`
EncryptedWallet wallet.EncryptedWallet `json:"encryptedWallet"`
Sequence wallet.Sequence `json:"sequence"`
Hmac wallet.WalletHmac `json:"hmac"`
}
func (r *WalletRequest) validate() bool {
return (r.Version == CURRENT_VERSION &&
r.Token != auth.TokenString("") &&
r.EncryptedWallet != wallet.EncryptedWallet("") &&
r.Hmac != wallet.WalletHmac("") &&
r.Sequence >= wallet.Sequence(1))
}
type WalletResponse struct {
Version int `json:"version"`
EncryptedWallet wallet.EncryptedWallet `json:"encryptedWallet"`
Sequence wallet.Sequence `json:"sequence"`
Hmac wallet.WalletHmac `json:"hmac"`
Error string `json:"error"` // in case of 409 Conflict responses. TODO - make field not show up if it's empty, to avoid confusion
}
func (s *Server) handleWallet(w http.ResponseWriter, req *http.Request) {
if req.Method == http.MethodGet {
s.getWallet(w, req)
} else if req.Method == http.MethodPost {
s.postWallet(w, req)
} else {
errorJson(w, http.StatusMethodNotAllowed, "")
}
}
// TODO - There's probably a struct-based solution here like with POST/PUT.
// We could put that struct up top as well.
func getWalletParams(req *http.Request) (token auth.TokenString, err error) {
tokenSlice, hasTokenSlice := req.URL.Query()["token"]
if !hasTokenSlice {
err = fmt.Errorf("Missing token parameter")
}
if err == nil {
token = auth.TokenString(tokenSlice[0])
}
return
}
func (s *Server) getWallet(w http.ResponseWriter, req *http.Request) {
if !getGetData(w, req) {
return
}
token, paramsErr := getWalletParams(req)
if paramsErr != nil {
// In this specific case, the error is limited to values that are safe to
// give to the user.
errorJson(w, http.StatusBadRequest, paramsErr.Error())
return
}
authToken := s.checkAuth(w, token, auth.ScopeFull)
if authToken == nil {
return
}
latestEncryptedWallet, latestSequence, latestHmac, err := s.store.GetWallet(authToken.UserId)
if err == store.ErrNoWallet {
errorJson(w, http.StatusNotFound, "No wallet")
return
} else if err != nil {
internalServiceErrorJson(w, err, "Error retrieving wallet")
return
}
walletResponse := WalletResponse{
Version: CURRENT_VERSION,
EncryptedWallet: latestEncryptedWallet,
Sequence: latestSequence,
Hmac: latestHmac,
}
var response []byte
response, err = json.Marshal(walletResponse)
if err != nil {
internalServiceErrorJson(w, err, "Error generating wallet response")
return
}
fmt.Fprintf(w, string(response))
}
func (s *Server) postWallet(w http.ResponseWriter, req *http.Request) {
var walletRequest WalletRequest
if !getPostData(w, req, &walletRequest) {
return
}
authToken := s.checkAuth(w, walletRequest.Token, auth.ScopeFull)
if authToken == nil {
return
}
latestEncryptedWallet, latestSequence, latestHmac, sequenceCorrect, err := s.store.SetWallet(
authToken.UserId,
walletRequest.EncryptedWallet,
walletRequest.Sequence,
walletRequest.Hmac,
)
var response []byte
if err == store.ErrNoWallet {
// We failed to update, and when we tried pulling the latest wallet,
// there was nothing there. This should only happen if the client sets
// sequence != 1 for the first wallet, which would be a bug.
// TODO - figure out better error messages and/or document this
errorJson(w, http.StatusConflict, "Bad sequence number (No existing wallet)")
return
} else if err != nil {
// Something other than sequence error
internalServiceErrorJson(w, err, "Error saving wallet")
return
}
walletResponse := WalletResponse{
Version: CURRENT_VERSION,
EncryptedWallet: latestEncryptedWallet,
Sequence: latestSequence,
Hmac: latestHmac,
}
if !sequenceCorrect {
// TODO - should we even call this an error?
walletResponse.Error = "Bad sequence number"
}
response, err = json.Marshal(walletResponse)
if err != nil {
internalServiceErrorJson(w, err, "Error generating walletResponse")
return
}
// Response Code:
// 200: Update successful
// 409: Update unsuccessful, probably due to new wallet's
// sequence not being 1 + current wallet's sequence
//
// Response Body:
// Current wallet (if it exists). If update successful, we just return
// the same one passed in. If update not successful, return the latest one
// from the db for the client to merge.
if sequenceCorrect {
fmt.Fprintf(w, string(response))
} else {
http.Error(w, string(response), http.StatusConflict)
}
}

181
server/wallet_state.go
View file

@ -1,181 +0,0 @@
package server
import (
"encoding/json"
"fmt"
"net/http"
"orblivion/lbry-id/auth"
"orblivion/lbry-id/store"
"orblivion/lbry-id/wallet"
)
type WalletStateRequest struct {
Token auth.AuthTokenString `json:"token"`
WalletStateJson string `json:"walletStateJson"`
Hmac wallet.WalletStateHmac `json:"hmac"`
}
func (r *WalletStateRequest) validate() bool {
return (r.Token != auth.AuthTokenString("") &&
r.WalletStateJson != "" &&
r.Hmac != wallet.WalletStateHmac(""))
}
type WalletStateResponse struct {
WalletStateJson string `json:"walletStateJson"`
Hmac wallet.WalletStateHmac `json:"hmac"`
Error string `json:"error"` // in case of 409 Conflict responses. TODO - make field not show up if it's empty, to avoid confusion
}
func (s *Server) handleWalletState(w http.ResponseWriter, req *http.Request) {
if req.Method == http.MethodGet {
s.getWalletState(w, req)
} else if req.Method == http.MethodPost {
s.postWalletState(w, req)
} else {
errorJson(w, http.StatusMethodNotAllowed, "")
}
}
// TODO - There's probably a struct-based solution here like with POST/PUT.
// We could put that struct up top as well.
func getWalletStateParams(req *http.Request) (token auth.AuthTokenString, err error) {
tokenSlice, hasTokenSlice := req.URL.Query()["token"]
if !hasTokenSlice {
err = fmt.Errorf("Missing token parameter")
}
if err == nil {
token = auth.AuthTokenString(tokenSlice[0])
}
return
}
func (s *Server) getWalletState(w http.ResponseWriter, req *http.Request) {
if !getGetData(w, req) {
return
}
token, paramsErr := getWalletStateParams(req)
if paramsErr != nil {
// In this specific case, the error is limited to values that are safe to
// give to the user.
errorJson(w, http.StatusBadRequest, paramsErr.Error())
return
}
authToken := s.checkAuth(w, token, auth.ScopeFull)
if authToken == nil {
return
}
latestWalletStateJson, latestHmac, err := s.store.GetWalletState(authToken.UserId)
var response []byte
if err == store.ErrNoWalletState {
errorJson(w, http.StatusNotFound, "No wallet state")
return
} else if err != nil {
internalServiceErrorJson(w, err, "Error retrieving walletState")
return
}
walletStateResponse := WalletStateResponse{
WalletStateJson: latestWalletStateJson,
Hmac: latestHmac,
}
response, err = json.Marshal(walletStateResponse)
if err != nil {
internalServiceErrorJson(w, err, "Error generating latestWalletState response")
return
}
fmt.Fprintf(w, string(response))
}
func (s *Server) postWalletState(w http.ResponseWriter, req *http.Request) {
var walletStateRequest WalletStateRequest
if !getPostData(w, req, &walletStateRequest) {
return
}
var walletStateMetadata wallet.WalletStateMetadata
if err := json.Unmarshal([]byte(walletStateRequest.WalletStateJson), &walletStateMetadata); err != nil {
errorJson(w, http.StatusBadRequest, "Malformed walletStateJson")
return
}
if s.walletUtil.ValidateWalletStateMetadata(&walletStateMetadata) {
// TODO
}
authToken := s.checkAuth(w, walletStateRequest.Token, auth.ScopeFull)
if authToken == nil {
return
}
// TODO - We could do an extra check - pull from db, make sure the new
// walletStateMetadata doesn't regress lastSynced for any given device.
// This is primarily the responsibility of the clients, but we may want to
// trade a db call here for a double-check against bugs in the client.
// We do already do some validation checks here, but those doesn't require
// new database calls.
latestWalletStateJson, latestHmac, updated, err := s.store.SetWalletState(
authToken.UserId,
walletStateRequest.WalletStateJson,
walletStateMetadata.Sequence(),
walletStateRequest.Hmac,
)
var response []byte
if err == store.ErrNoWalletState {
// We failed to update, and when we tried pulling the latest wallet state,
// there was nothing there. This should only happen if the client sets
// sequence != 1 for the first walletState, which would be a bug.
// TODO - figure out better error messages and/or document this
errorJson(w, http.StatusConflict, "Bad sequence number (No existing wallet state)")
return
} else if err != nil {
// Something other than sequence error
internalServiceErrorJson(w, err, "Error saving walletState")
return
}
walletStateResponse := WalletStateResponse{
WalletStateJson: latestWalletStateJson,
Hmac: latestHmac,
}
if !updated {
// TODO - should we even call this an error?
walletStateResponse.Error = "Bad sequence number"
}
response, err = json.Marshal(walletStateResponse)
if err != nil {
internalServiceErrorJson(w, err, "Error generating walletStateResponse")
return
}
// Response Code:
// 200: Update successful
// 409: Update unsuccessful, probably due to new walletState's
// sequence not being 1 + current walletState's sequence
//
// Response Body:
// Current walletState (if it exists). If update successful, we just return
// the same one passed in. If update not successful, return the latest one
// from the db for the client to merge.
if updated {
fmt.Fprintf(w, string(response))
} else {
http.Error(w, string(response), http.StatusConflict)
}
}

14
server/wallet_state_test.go → server/wallet_test.go
View file

@ -12,8 +12,8 @@ func TestServerGetWalletErrors(t *testing.T) {
t.Fatalf("Test me: GetWallet fails for various reasons (malformed, auth, db fail)") t.Fatalf("Test me: GetWallet fails for various reasons (malformed, auth, db fail)")
} }
func TestServerGetWalletStateParams(t *testing.T) { func TestServerGetWalletParams(t *testing.T) {
t.Fatalf("Test me: getWalletStateParams") t.Fatalf("Test me: getWalletParams")
} }
func TestServerPostWalletSuccess(t *testing.T) { func TestServerPostWalletSuccess(t *testing.T) {
@ -25,17 +25,17 @@ func TestServerPostWalletTooLate(t *testing.T) {
} }
func TestServerPostWalletErrors(t *testing.T) { func TestServerPostWalletErrors(t *testing.T) {
// (malformed json, db fail, auth token not found, walletstate invalid (via stub, make sure the validation function is even called), sequence too high, device id doesn't match token device id) // (malformed json, db fail, auth token not found, wallet metadata invalid (via stub, make sure the validation function is even called), sequence too high, device id doesn't match token device id)
// Client sends sequence != 1 for first entry // Client sends sequence != 1 for first entry
// Client sends sequence == x + 10 for xth entry or whatever // Client sends sequence == x + 10 for xth entry or whatever
t.Fatalf("Test me: PostWallet fails for various reasons") t.Fatalf("Test me: PostWallet fails for various reasons")
} }
func TestServerValidateWalletStateRequest(t *testing.T) { func TestServerValidateWalletRequest(t *testing.T) {
// also add a basic test case for this in TestServerAuthHandlerSuccess to make sure it's called at all // also add a basic test case for this in TestServerAuthHandlerSuccess to make sure it's called at all
t.Fatalf("Test me: Implement and test WalletStateRequest.validate()") t.Fatalf("Test me: Implement and test WalletRequest.validate()")
} }
func TestServerHandleWalletState(t *testing.T) { func TestServerHandleWallet(t *testing.T) {
t.Fatalf("Test me: Call the get or post function as appropriate. Alternately: call handleWalletState for the existing tests.") t.Fatalf("Test me: Call the get or post function as appropriate. Alternately: call handleWallet for the existing tests.")
} }

137
store/store.go
View file

@ -18,8 +18,8 @@ var (
ErrDuplicateToken = fmt.Errorf("Token already exists for this user and device") ErrDuplicateToken = fmt.Errorf("Token already exists for this user and device")
ErrNoToken = fmt.Errorf("Token does not exist for this user and device") ErrNoToken = fmt.Errorf("Token does not exist for this user and device")
ErrDuplicateWalletState = fmt.Errorf("WalletState already exists for this user") ErrDuplicateWallet = fmt.Errorf("Wallet already exists for this user")
ErrNoWalletState = fmt.Errorf("WalletState does not exist for this user at this sequence") ErrNoWallet = fmt.Errorf("Wallet does not exist for this user at this sequence")
ErrDuplicateEmail = fmt.Errorf("Email already exists for this user") ErrDuplicateEmail = fmt.Errorf("Email already exists for this user")
ErrDuplicateAccount = fmt.Errorf("User already has an account") ErrDuplicateAccount = fmt.Errorf("User already has an account")
@ -30,9 +30,9 @@ var (
// For test stubs // For test stubs
type StoreInterface interface { type StoreInterface interface {
SaveToken(*auth.AuthToken) error SaveToken(*auth.AuthToken) error
GetToken(auth.AuthTokenString) (*auth.AuthToken, error) GetToken(auth.TokenString) (*auth.AuthToken, error)
SetWalletState(auth.UserId, string, int, wallet.WalletStateHmac) (string, wallet.WalletStateHmac, bool, error) SetWallet(auth.UserId, wallet.EncryptedWallet, wallet.Sequence, wallet.WalletHmac) (wallet.EncryptedWallet, wallet.Sequence, wallet.WalletHmac, bool, error)
GetWalletState(auth.UserId) (string, wallet.WalletStateHmac, error) GetWallet(auth.UserId) (wallet.EncryptedWallet, wallet.Sequence, wallet.WalletHmac, error)
GetUserId(auth.Email, auth.Password) (auth.UserId, error) GetUserId(auth.Email, auth.Password) (auth.UserId, error)
CreateAccount(auth.Email, auth.Password) (err error) CreateAccount(auth.Email, auth.Password) (err error)
} }
@ -50,12 +50,10 @@ func (s *Store) Init(fileName string) {
} }
func (s *Store) Migrate() error { func (s *Store) Migrate() error {
// We store `sequence` as a seprate field in the `wallet_state` table, even // We use the `sequence` field for transaction safety. For instance, let's
// though it's also saved as part of the `walle_state_blob` column. We do // say two different clients are trying to update the sequence from 5 to 6.
// this for transaction safety. For instance, let's say two different clients // The update command will specify "WHERE sequence=5". Only one of these
// are trying to update the sequence from 5 to 6. The update command will // commands will succeed, and the other will get back an error.
// specify "WHERE sequence=5". Only one of these commands will succeed, and
// the other will get back an error.
// We use AUTOINCREMENT against the protestations of people on the Internet // We use AUTOINCREMENT against the protestations of people on the Internet
// who claim that INTEGER PRIMARY KEY automatically has autoincrment, and // who claim that INTEGER PRIMARY KEY automatically has autoincrment, and
@ -80,9 +78,9 @@ func (s *Store) Migrate() error {
expiration DATETIME NOT NULL, expiration DATETIME NOT NULL,
PRIMARY KEY (user_id, device_id) PRIMARY KEY (user_id, device_id)
); );
CREATE TABLE IF NOT EXISTS wallet_states( CREATE TABLE IF NOT EXISTS wallets(
user_id INTEGER NOT NULL, user_id INTEGER NOT NULL,
wallet_state_blob TEXT NOT NULL, encrypted_wallet TEXT NOT NULL,
sequence INTEGER NOT NULL, sequence INTEGER NOT NULL,
hmac TEXT NOT NULL, hmac TEXT NOT NULL,
PRIMARY KEY (user_id) PRIMARY KEY (user_id)
@ -108,7 +106,7 @@ func (s *Store) Migrate() error {
// (which I did previously)? // (which I did previously)?
// //
// TODO Put the timestamp in the token to avoid duplicates over time. And/or just use a library! Someone solved this already. // TODO Put the timestamp in the token to avoid duplicates over time. And/or just use a library! Someone solved this already.
func (s *Store) GetToken(token auth.AuthTokenString) (*auth.AuthToken, error) { func (s *Store) GetToken(token auth.TokenString) (*auth.AuthToken, error) {
expirationCutoff := time.Now().UTC() expirationCutoff := time.Now().UTC()
rows, err := s.db.Query( rows, err := s.db.Query(
@ -204,13 +202,13 @@ func (s *Store) SaveToken(token *auth.AuthToken) (err error) {
return return
} }
////////////////// ////////////
// Wallet State // // Wallet //
////////////////// ////////////
func (s *Store) GetWalletState(userId auth.UserId) (walletStateJson string, hmac wallet.WalletStateHmac, err error) { func (s *Store) GetWallet(userId auth.UserId) (encryptedWallet wallet.EncryptedWallet, sequence wallet.Sequence, hmac wallet.WalletHmac, err error) {
rows, err := s.db.Query( rows, err := s.db.Query(
"SELECT wallet_state_blob, hmac FROM wallet_states WHERE user_id=?", "SELECT encrypted_wallet, sequence, hmac FROM wallets WHERE user_id=?",
userId, userId,
) )
if err != nil { if err != nil {
@ -220,26 +218,27 @@ func (s *Store) GetWalletState(userId auth.UserId) (walletStateJson string, hmac
for rows.Next() { for rows.Next() {
err = rows.Scan( err = rows.Scan(
&walletStateJson, &encryptedWallet,
&sequence,
&hmac, &hmac,
) )
return return
} }
err = ErrNoWalletState err = ErrNoWallet
return return
} }
func (s *Store) insertFirstWalletState( func (s *Store) insertFirstWallet(
userId auth.UserId, userId auth.UserId,
walletStateJson string, encryptedWallet wallet.EncryptedWallet,
hmac wallet.WalletStateHmac, hmac wallet.WalletHmac,
) (err error) { ) (err error) {
// This will only be used to attempt to insert the first wallet state // This will only be used to attempt to insert the first wallet (sequence=1).
// (sequence=1). The database will enforce that this will not be set // The database will enforce that this will not be set if this user already
// if this user already has a walletState. // has a wallet.
_, err = s.db.Exec( _, err = s.db.Exec(
"INSERT INTO wallet_states (user_id, wallet_state_blob, sequence, hmac) values(?,?,?,?)", "INSERT INTO wallets (user_id, encrypted_wallet, sequence, hmac) values(?,?,?,?)",
userId, walletStateJson, 1, hmac, userId, encryptedWallet, 1, hmac,
) )
var sqliteErr sqlite3.Error var sqliteErr sqlite3.Error
@ -247,26 +246,26 @@ func (s *Store) insertFirstWalletState(
// I initially expected to need to check for ErrConstraintUnique. // I initially expected to need to check for ErrConstraintUnique.
// Maybe for psql it will be? // Maybe for psql it will be?
if errors.Is(sqliteErr.ExtendedCode, sqlite3.ErrConstraintPrimaryKey) { if errors.Is(sqliteErr.ExtendedCode, sqlite3.ErrConstraintPrimaryKey) {
err = ErrDuplicateWalletState err = ErrDuplicateWallet
} }
} }
return return
} }
func (s *Store) updateWalletStateToSequence( func (s *Store) updateWalletToSequence(
userId auth.UserId, userId auth.UserId,
walletStateJson string, encryptedWallet wallet.EncryptedWallet,
sequence int, sequence wallet.Sequence,
hmac wallet.WalletStateHmac, hmac wallet.WalletHmac,
) (err error) { ) (err error) {
// This will be used for wallet states with sequence > 1. // This will be used for wallets with sequence > 1.
// Use the database to enforce that we only update if we are incrementing the sequence. // Use the database to enforce that we only update if we are incrementing the sequence.
// This way, if two clients attempt to update at the same time, it will return // This way, if two clients attempt to update at the same time, it will return
// ErrNoWalletState for the second one. // ErrNoWallet for the second one.
res, err := s.db.Exec( res, err := s.db.Exec(
"UPDATE wallet_states SET wallet_state_blob=?, sequence=?, hmac=? WHERE user_id=? AND sequence=?", "UPDATE wallets SET encrypted_wallet=?, sequence=?, hmac=? WHERE user_id=? AND sequence=?",
walletStateJson, sequence, hmac, userId, sequence-1, encryptedWallet, sequence, hmac, userId, sequence-1,
) )
if err != nil { if err != nil {
return return
@ -277,49 +276,59 @@ func (s *Store) updateWalletStateToSequence(
return return
} }
if numRows == 0 { if numRows == 0 {
err = ErrNoWalletState err = ErrNoWallet
} }
return return
} }
// Assumption: walletState has been validated (sequence >=1, etc) // Assumption: Sequence has been validated (>=1)
// Assumption: Sequence matches walletState.Sequence() func (s *Store) SetWallet(
// Sequence is only passed in here to avoid deserializing walletStateJson again
// WalletState *struct* is not passed in because the clients need the exact string to match the hmac
func (s *Store) SetWalletState(
userId auth.UserId, userId auth.UserId,
walletStateJson string, encryptedWallet wallet.EncryptedWallet,
sequence int, sequence wallet.Sequence,
hmac wallet.WalletStateHmac, hmac wallet.WalletHmac,
) (latestWalletStateJson string, latestHmac wallet.WalletStateHmac, updated bool, err error) { // TODO `sequenceCorrect` should probably be replaced with `status`, that can
// equal `Updated` or `SequenceMismatch`. Maybe with a message for the API.
// Like an error, but not, because the function still returns a value.
// Right now, we have:
// `sequenceCorrect==true` and `err==nil` implies it updated.
// We could also have:
// `sequenceMismatch==true` or `err!=nil` implying it didn't update.
// Or:
// `updated==false` and `err=nil` implying the sequence mismatched.
// I don't like this implication stuff, the "status" should be explicit so
// we don't make bugs.
) (latestEncryptedWallet wallet.EncryptedWallet, latestSequence wallet.Sequence, latestHmac wallet.WalletHmac, sequenceCorrect bool, err error) {
if sequence == 1 { if sequence == 1 {
// If sequence == 1, the client assumed that this is our first // If sequence == 1, the client assumed that this is our first
// walletState. Try to insert. If we get a conflict, the client // wallet. Try to insert. If we get a conflict, the client
// assumed incorrectly and we proceed below to return the latest // assumed incorrectly and we proceed below to return the latest
// walletState from the db. // wallet from the db.
err = s.insertFirstWalletState(userId, walletStateJson, hmac) err = s.insertFirstWallet(userId, encryptedWallet, hmac)
if err == nil { if err == nil {
// Successful update // Successful update
latestWalletStateJson = walletStateJson latestEncryptedWallet = encryptedWallet
latestSequence = sequence
latestHmac = hmac latestHmac = hmac
updated = true sequenceCorrect = true
return return
} else if err != ErrDuplicateWalletState { } else if err != ErrDuplicateWallet {
// Unsuccessful update for reasons other than sequence conflict // Unsuccessful update for reasons other than sequence conflict
return return
} }
} else { } else {
// If sequence > 1, the client assumed that it is replacing walletState // If sequence > 1, the client assumed that it is replacing wallet
// with sequence - 1. Explicitly try to update the walletState with // with sequence - 1. Explicitly try to update the wallet with
// sequence - 1. If we updated no rows, the client assumed incorrectly // sequence - 1. If we updated no rows, the client assumed incorrectly
// and we proceed below to return the latest walletState from the db. // and we proceed below to return the latest wallet from the db.
err = s.updateWalletStateToSequence(userId, walletStateJson, sequence, hmac) err = s.updateWalletToSequence(userId, encryptedWallet, sequence, hmac)
if err == nil { if err == nil {
latestWalletStateJson = walletStateJson latestEncryptedWallet = encryptedWallet
latestSequence = sequence
latestHmac = hmac latestHmac = hmac
updated = true sequenceCorrect = true
return return
} else if err != ErrNoWalletState { } else if err != ErrNoWallet {
return return
} }
} }
@ -329,9 +338,9 @@ func (s *Store) SetWalletState(
// version right away so the requesting client can take care of it. // version right away so the requesting client can take care of it.
// //
// Note that this means that `err` will not be `nil` at this point, but we // Note that this means that `err` will not be `nil` at this point, but we
// already accounted for it with `updated=false`. Instead, we'll pass on any // already accounted for it with `sequenceCorrect=false`. Instead, we'll pass
// errors from calling `GetWalletState`. // on any errors from calling `GetWallet`.
latestWalletStateJson, latestHmac, err = s.GetWalletState(userId) latestEncryptedWallet, latestSequence, latestHmac, err = s.GetWallet(userId)
return return
} }

32
store/store_test.go
View file

@ -305,16 +305,16 @@ func TestStoreTimeZones(t *testing.T) {
t.Fatalf("Test me") t.Fatalf("Test me")
} }
func TestStoreSetWalletStateSuccess(t *testing.T) { func TestStoreSetWalletSuccess(t *testing.T) {
/* /*
Sequence 1 - works via insert Sequence 1 - works via insert
Sequence 2 - works via update Sequence 2 - works via update
Sequence 3 - works via update Sequence 3 - works via update
*/ */
t.Fatalf("Test me: WalletState Set successes") t.Fatalf("Test me: Wallet Set successes")
} }
func TestStoreSetWalletStateFail(t *testing.T) { func TestStoreSetWalletFail(t *testing.T) {
/* /*
Sequence 1 - fails via insert - fail by having something there already Sequence 1 - fails via insert - fail by having something there already
Sequence 2 - fails via update - fail by not having something there already Sequence 2 - fails via update - fail by not having something there already
@ -323,31 +323,31 @@ func TestStoreSetWalletStateFail(t *testing.T) {
Maybe some of the above gets put off to wallet util Maybe some of the above gets put off to wallet util
*/ */
t.Fatalf("Test me: WalletState Set failures") t.Fatalf("Test me: Wallet Set failures")
} }
func TestStoreInsertWalletStateSuccess(t *testing.T) { func TestStoreInsertWalletSuccess(t *testing.T) {
t.Fatalf("Test me: WalletState insert successes") t.Fatalf("Test me: Wallet insert successes")
} }
func TestStoreInsertWalletStateFail(t *testing.T) { func TestStoreInsertWalletFail(t *testing.T) {
t.Fatalf("Test me: WalletState insert failures") t.Fatalf("Test me: Wallet insert failures")
} }
func TestStoreUpdateWalletStateSuccess(t *testing.T) { func TestStoreUpdateWalletSuccess(t *testing.T) {
t.Fatalf("Test me: WalletState update successes") t.Fatalf("Test me: Wallet update successes")
} }
func TestStoreUpdateWalletStateFail(t *testing.T) { func TestStoreUpdateWalletFail(t *testing.T) {
t.Fatalf("Test me: WalletState update failures") t.Fatalf("Test me: Wallet update failures")
} }
func TestStoreGetWalletStateSuccess(t *testing.T) { func TestStoreGetWalletSuccess(t *testing.T) {
t.Fatalf("Test me: WalletState get success") t.Fatalf("Test me: Wallet get success")
} }
func TestStoreGetWalletStateFail(t *testing.T) { func TestStoreGetWalletFail(t *testing.T) {
t.Fatalf("Test me: WalletState get failures") t.Fatalf("Test me: Wallet get failures")
} }
func TestStoreSetEmailSuccess(t *testing.T) { func TestStoreSetEmailSuccess(t *testing.T) {

149
test_client/README.md
View file

@ -14,15 +14,6 @@ Set up two clients with the same account (which won't exist on the server yet).
>>> c2.set_account("joe2@example.com", "123abc2") >>> c2.set_account("joe2@example.com", "123abc2")
``` ```
Each device will have a device_id which will be used in the wallet state metadata to mark which device created a given version. This is used in the `lastSynced` field (see below).
```
>>> c1.device_id
'974690df-85a6-481d-9015-6293226db8c9'
>>> c2.device_id
'545643c9-ee47-443d-b260-cb9178b8646c'
```
Register the account on the server with one of the clients. Register the account on the server with one of the clients.
``` ```
@ -34,59 +25,45 @@ Now that the account exists, grab an auth token with both clients.
``` ```
>>> c1.get_auth_token() >>> c1.get_auth_token()
Got auth token: 941e5159a2caff15f0bdc1c0e6da92691d3073543dbfae810cfe57d51c35f0e0 Got auth token: a489d5cacc0a3db4811c34d203683482d90c605b03ae007fa5ae32ef17252bd9
>>> c2.get_auth_token() >>> c2.get_auth_token()
Got auth token: b323a18e51263ac052777ca68de716c1f3b4983bf4c918477e355f637c8ea2d4 Got auth token: 1fe687db8ab493ed260f499b674cfa49edefd3c03a718905c62d3f850dc50567
``` ```
## Syncing ## Syncing
Create a new wallet state (wallet + metadata) and post it to the server. Note that after posting, it says it "got" a new wallet state. This is because the post endpoint also returns the latest version. The purpose of this will be explained in "Conflicts" below. Create a new wallet + metadata (we'll wrap it in a struct we'll call `WalletState` in this client) and POST them to the server. The metadata (as of now) in the walletstate is only `sequence`. This increments for every POSTed wallet. This is bookkeeping to prevent certain syncing errors.
The fields in the walletstate are: Note that after POSTing, it says it "got" a new wallet. This is because the POST endpoint also returns the latest version. The purpose of this will be explained in "Conflicts" below.
* `encryptedWallet` - the actual encrypted wallet data
* `lastSynced` - a mapping between deviceId and the latest sequence number that it _created_. This is bookkeeping to prevent certain syncing errors.
* `deviceId` - the device that made _this_ wallet state version (NOTE this admittedly seems redundant with `lastSynced` and may be removed)
``` ```
>>> c1.new_wallet_state() >>> c1.new_wallet_state()
>>> c1.post_wallet_state() >>> c1.post_wallet()
Successfully updated wallet state on server Successfully updated wallet state on server
Got new walletState: Got new walletState:
{'deviceId': '974690df-85a6-481d-9015-6293226db8c9', WalletState(sequence=1, encrypted_wallet='-')
'encryptedWallet': '',
'lastSynced': {'974690df-85a6-481d-9015-6293226db8c9': 1}}
``` ```
With the other client, get it from the server. Note that both clients have the same data now. With the other client, GET it from the server. Note that both clients have the same data now.
``` ```
>>> c2.get_wallet_state() >>> c2.get_wallet()
Got latest walletState: Got latest walletState:
{'deviceId': '974690df-85a6-481d-9015-6293226db8c9', WalletState(sequence=1, encrypted_wallet='-')
'encryptedWallet': '',
'lastSynced': {'974690df-85a6-481d-9015-6293226db8c9': 1}}
``` ```
## Updating ## Updating
Push a new version, get it with the other client. Even though we haven't edited the encrypted wallet yet, each version of a wallet _state_ has an incremented sequence number, and the deviceId that created it. Push a new version, GET it with the other client. Even though we haven't edited the encrypted wallet yet, we can still increment the sequence number.
``` ```
>>> c2.post_wallet_state() >>> c2.post_wallet()
Successfully updated wallet state on server Successfully updated wallet state on server
Got new walletState: Got new walletState:
{'deviceId': '545643c9-ee47-443d-b260-cb9178b8646c', WalletState(sequence=2, encrypted_wallet='-')
'encryptedWallet': '', >>> c1.get_wallet()
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 2,
'974690df-85a6-481d-9015-6293226db8c9': 1}}
>>> c1.get_wallet_state()
Got latest walletState: Got latest walletState:
{'deviceId': '545643c9-ee47-443d-b260-cb9178b8646c', WalletState(sequence=2, encrypted_wallet='-')
'encryptedWallet': '',
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 2,
'974690df-85a6-481d-9015-6293226db8c9': 1}}
``` ```
## Wallet Changes ## Wallet Changes
@ -95,30 +72,24 @@ For demo purposes, this test client represents each change to the wallet by appe
``` ```
>>> c1.cur_encrypted_wallet() >>> c1.cur_encrypted_wallet()
'' '-'
>>> c1.change_encrypted_wallet() >>> c1.change_encrypted_wallet()
>>> c1.cur_encrypted_wallet() >>> c1.cur_encrypted_wallet()
':2fbE' '-:cfF6'
``` ```
The wallet is synced between the clients. The wallet is synced between the clients.
``` ```
>>> c1.post_wallet_state() >>> c1.post_wallet()
Successfully updated wallet state on server Successfully updated wallet state on server
Got new walletState: Got new walletState:
{'deviceId': '974690df-85a6-481d-9015-6293226db8c9', WalletState(sequence=3, encrypted_wallet='-:cfF6')
'encryptedWallet': ':2fbE', >>> c2.get_wallet()
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 2,
'974690df-85a6-481d-9015-6293226db8c9': 3}}
>>> c2.get_wallet_state()
Got latest walletState: Got latest walletState:
{'deviceId': '974690df-85a6-481d-9015-6293226db8c9', WalletState(sequence=3, encrypted_wallet='-:cfF6')
'encryptedWallet': ':2fbE',
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 2,
'974690df-85a6-481d-9015-6293226db8c9': 3}}
>>> c2.cur_encrypted_wallet() >>> c2.cur_encrypted_wallet()
':2fbE' '-:cfF6'
``` ```
## Merging Changes ## Merging Changes
@ -129,86 +100,70 @@ Both clients create changes. They now have diverging wallets.
>>> c1.change_encrypted_wallet() >>> c1.change_encrypted_wallet()
>>> c2.change_encrypted_wallet() >>> c2.change_encrypted_wallet()
>>> c1.cur_encrypted_wallet() >>> c1.cur_encrypted_wallet()
':2fbE:BD62' '-:cfF6:565b'
>>> c2.cur_encrypted_wallet() >>> c2.cur_encrypted_wallet()
':2fbE:e7ac' '-:cfF6:6De1'
``` ```
One client posts its change first. The other client pulls that change, and _merges_ those changes on top of the changes it had saved locally. One client POSTs its change first.
The _merge base_ that a given client uses is the last version that it successfully got from or posted to the server. You can see the merge base here: the first part of the wallet which does not change from this merge.
``` ```
>>> c1.post_wallet_state() >>> c1.post_wallet()
Successfully updated wallet state on server Successfully updated wallet state on server
Got new walletState: Got new walletState:
{'deviceId': '974690df-85a6-481d-9015-6293226db8c9', WalletState(sequence=4, encrypted_wallet='-:cfF6:565b')
'encryptedWallet': ':2fbE:BD62', ```
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 2,
'974690df-85a6-481d-9015-6293226db8c9': 4}} The other client pulls that change, and _merges_ those changes on top of the changes it had saved locally.
>>> c2.get_wallet_state()
The _merge base_ that a given client uses is the last version that it successfully got from or POSTed to the server. You can see the merge base here: `"-:cfF6"`, the first part of the wallet which both clients had in common before the merge.
```
>>> c2.get_wallet()
Got latest walletState: Got latest walletState:
{'deviceId': '974690df-85a6-481d-9015-6293226db8c9', WalletState(sequence=4, encrypted_wallet='-:cfF6:565b')
'encryptedWallet': ':2fbE:BD62',
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 2,
'974690df-85a6-481d-9015-6293226db8c9': 4}}
>>> c2.cur_encrypted_wallet() >>> c2.cur_encrypted_wallet()
':2fbE:BD62:e7ac' '-:cfF6:565b:6De1'
``` ```
Finally, the client with the merged wallet pushes it to the server, and the other client gets the update. Finally, the client with the merged wallet pushes it to the server, and the other client GETs the update.
``` ```
>>> c2.post_wallet_state() >>> c2.post_wallet()
Successfully updated wallet state on server Successfully updated wallet state on server
Got new walletState: Got new walletState:
{'deviceId': '545643c9-ee47-443d-b260-cb9178b8646c', WalletState(sequence=5, encrypted_wallet='-:cfF6:565b:6De1')
'encryptedWallet': ':2fbE:BD62:e7ac', >>> c1.get_wallet()
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 5,
'974690df-85a6-481d-9015-6293226db8c9': 4}}
>>> c1.get_wallet_state()
Got latest walletState: Got latest walletState:
{'deviceId': '545643c9-ee47-443d-b260-cb9178b8646c', WalletState(sequence=5, encrypted_wallet='-:cfF6:565b:6De1')
'encryptedWallet': ':2fbE:BD62:e7ac',
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 5,
'974690df-85a6-481d-9015-6293226db8c9': 4}}
>>> c1.cur_encrypted_wallet() >>> c1.cur_encrypted_wallet()
':2fbE:BD62:e7ac' '-:cfF6:565b:6De1'
``` ```
## Conflicts ## Conflicts
A client cannot post if it is not up to date. It needs to merge in any new changes on the server before posting its own changes. For convenience, if a conflicting post request is made, the server responds with the latest version of the wallet state (just like a GET request). This way the client doesn't need to make a second request to perform the merge. A client cannot POST if it is not up to date. It needs to merge in any new changes on the server before POSTing its own changes. For convenience, if a conflicting POST request is made, the server responds with the latest version of the wallet state (just like a GET request). This way the client doesn't need to make a second request to perform the merge.
(If a non-conflicting post request is made, it responds with the same wallet state that the client just posted, as it is now the server's current wallet state) (If a non-conflicting POST request is made, it responds with the same wallet state that the client just POSTed, as it is now the server's current wallet state)
``` ```
>>> c2.change_encrypted_wallet() >>> c2.change_encrypted_wallet()
>>> c2.post_wallet_state() >>> c2.post_wallet()
Successfully updated wallet state on server Successfully updated wallet state on server
Got new walletState: Got new walletState:
{'deviceId': '545643c9-ee47-443d-b260-cb9178b8646c', WalletState(sequence=6, encrypted_wallet='-:cfF6:565b:6De1:053a')
'encryptedWallet': ':2fbE:BD62:e7ac:4EEf',
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 6,
'974690df-85a6-481d-9015-6293226db8c9': 4}}
>>> c1.change_encrypted_wallet() >>> c1.change_encrypted_wallet()
>>> c1.post_wallet_state() >>> c1.post_wallet()
Wallet state out of date. Getting updated wallet state. Try again. Wallet state out of date. Getting updated wallet state. Try posting again after this.
Got new walletState: Got new walletState:
{'deviceId': '545643c9-ee47-443d-b260-cb9178b8646c', WalletState(sequence=6, encrypted_wallet='-:cfF6:565b:6De1:053a')
'encryptedWallet': ':2fbE:BD62:e7ac:4EEf',
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 6,
'974690df-85a6-481d-9015-6293226db8c9': 4}}
``` ```
Now the merge is complete, and the client can make a second post request containing the merged wallet. Now the merge is complete, and the client can make a second POST request containing the merged wallet.
``` ```
>>> c1.post_wallet_state() >>> c1.post_wallet()
Successfully updated wallet state on server Successfully updated wallet state on server
Got new walletState: Got new walletState:
{'deviceId': '974690df-85a6-481d-9015-6293226db8c9', WalletState(sequence=7, encrypted_wallet='-:cfF6:565b:6De1:053a:6774')
'encryptedWallet': ':2fbE:BD62:e7ac:4EEf:DC86',
'lastSynced': {'545643c9-ee47-443d-b260-cb9178b8646c': 6,
'974690df-85a6-481d-9015-6293226db8c9': 7}}
``` ```

72
test_client/gen-readme.py
View file

@ -32,15 +32,6 @@ c1.set_account("joe2@example.com", "123abc2")
c2.set_account("joe2@example.com", "123abc2") c2.set_account("joe2@example.com", "123abc2")
""") """)
print("""
Each device will have a device_id which will be used in the wallet state metadata to mark which device created a given version. This is used in the `lastSynced` field (see below).
""")
code_block("""
c1.device_id
c2.device_id
""")
print(""" print("""
Register the account on the server with one of the clients. Register the account on the server with one of the clients.
""") """)
@ -58,42 +49,36 @@ c1.get_auth_token()
c2.get_auth_token() c2.get_auth_token()
""") """)
# TODO - wait isn't it redundant to have the `deviceId` field, for the same reason it's redundant to have the `sequence` field?
print(""" print("""
## Syncing ## Syncing
Create a new wallet state (wallet + metadata) and post it to the server. Note that after posting, it says it "got" a new wallet state. This is because the post endpoint also returns the latest version. The purpose of this will be explained in "Conflicts" below. Create a new wallet + metadata (we'll wrap it in a struct we'll call `WalletState` in this client) and POST them to the server. The metadata (as of now) in the walletstate is only `sequence`. This increments for every POSTed wallet. This is bookkeeping to prevent certain syncing errors.
The fields in the walletstate are: Note that after POSTing, it says it "got" a new wallet. This is because the POST endpoint also returns the latest version. The purpose of this will be explained in "Conflicts" below.
* `encryptedWallet` - the actual encrypted wallet data
* `lastSynced` - a mapping between deviceId and the latest sequence number that it _created_. This is bookkeeping to prevent certain syncing errors.
* `deviceId` - the device that made _this_ wallet state version (NOTE this admittedly seems redundant with `lastSynced` and may be removed)
""") """)
code_block(""" code_block("""
c1.new_wallet_state() c1.new_wallet_state()
c1.post_wallet_state() c1.post_wallet()
""") """)
print(""" print("""
With the other client, get it from the server. Note that both clients have the same data now. With the other client, GET it from the server. Note that both clients have the same data now.
""") """)
code_block(""" code_block("""
c2.get_wallet_state() c2.get_wallet()
""") """)
print(""" print("""
## Updating ## Updating
Push a new version, get it with the other client. Even though we haven't edited the encrypted wallet yet, each version of a wallet _state_ has an incremented sequence number, and the deviceId that created it. Push a new version, GET it with the other client. Even though we haven't edited the encrypted wallet yet, we can still increment the sequence number.
""") """)
code_block(""" code_block("""
c2.post_wallet_state() c2.post_wallet()
c1.get_wallet_state() c1.get_wallet()
""") """)
print(""" print("""
@ -113,8 +98,8 @@ The wallet is synced between the clients.
""") """)
code_block(""" code_block("""
c1.post_wallet_state() c1.post_wallet()
c2.get_wallet_state() c2.get_wallet()
c2.cur_encrypted_wallet() c2.cur_encrypted_wallet()
""") """)
@ -124,6 +109,8 @@ print("""
Both clients create changes. They now have diverging wallets. Both clients create changes. They now have diverging wallets.
""") """)
merge_base = c2.cur_encrypted_wallet()
code_block(""" code_block("""
c1.change_encrypted_wallet() c1.change_encrypted_wallet()
c2.change_encrypted_wallet() c2.change_encrypted_wallet()
@ -132,46 +119,53 @@ c2.cur_encrypted_wallet()
""") """)
print(""" print("""
One client posts its change first. The other client pulls that change, and _merges_ those changes on top of the changes it had saved locally. One client POSTs its change first.
The _merge base_ that a given client uses is the last version that it successfully got from or posted to the server. You can see the merge base here: the first part of the wallet which does not change from this merge.
""") """)
code_block(""" code_block("""
c1.post_wallet_state() c1.post_wallet()
c2.get_wallet_state() """)
print("""
The other client pulls that change, and _merges_ those changes on top of the changes it had saved locally.
The _merge base_ that a given client uses is the last version that it successfully got from or POSTed to the server. You can see the merge base here: `"%s"`, the first part of the wallet which both clients had in common before the merge.
""" % merge_base)
code_block("""
c2.get_wallet()
c2.cur_encrypted_wallet() c2.cur_encrypted_wallet()
""") """)
print(""" print("""
Finally, the client with the merged wallet pushes it to the server, and the other client gets the update. Finally, the client with the merged wallet pushes it to the server, and the other client GETs the update.
""") """)
code_block(""" code_block("""
c2.post_wallet_state() c2.post_wallet()
c1.get_wallet_state() c1.get_wallet()
c1.cur_encrypted_wallet() c1.cur_encrypted_wallet()
""") """)
print(""" print("""
## Conflicts ## Conflicts
A client cannot post if it is not up to date. It needs to merge in any new changes on the server before posting its own changes. For convenience, if a conflicting post request is made, the server responds with the latest version of the wallet state (just like a GET request). This way the client doesn't need to make a second request to perform the merge. A client cannot POST if it is not up to date. It needs to merge in any new changes on the server before POSTing its own changes. For convenience, if a conflicting POST request is made, the server responds with the latest version of the wallet state (just like a GET request). This way the client doesn't need to make a second request to perform the merge.
(If a non-conflicting post request is made, it responds with the same wallet state that the client just posted, as it is now the server's current wallet state) (If a non-conflicting POST request is made, it responds with the same wallet state that the client just POSTed, as it is now the server's current wallet state)
""") """)
code_block(""" code_block("""
c2.change_encrypted_wallet() c2.change_encrypted_wallet()
c2.post_wallet_state() c2.post_wallet()
c1.change_encrypted_wallet() c1.change_encrypted_wallet()
c1.post_wallet_state() c1.post_wallet()
""") """)
print(""" print("""
Now the merge is complete, and the client can make a second post request containing the merged wallet. Now the merge is complete, and the client can make a second POST request containing the merged wallet.
""") """)
code_block(""" code_block("""
c1.post_wallet_state() c1.post_wallet()
""") """)

133
test_client/test_client.py
View file

@ -1,32 +1,41 @@
#!/bin/python3 #!/bin/python3
from collections import namedtuple
import random, string, json, uuid, requests, hashlib import random, string, json, uuid, requests, hashlib
from pprint import pprint from pprint import pprint
CURRENT_VERSION = 1
BASE_URL = 'http://localhost:8090' BASE_URL = 'http://localhost:8090'
AUTH_URL = BASE_URL + '/auth/full' AUTH_URL = BASE_URL + '/auth/full'
REGISTER_URL = BASE_URL + '/signup' REGISTER_URL = BASE_URL + '/signup'
WALLET_STATE_URL = BASE_URL + '/wallet-state' WALLET_URL = BASE_URL + '/wallet'
def wallet_state_sequence(wallet_state): # TODO - We should have:
if 'deviceId' not in wallet_state: # * self.last_synced_wallet_state - as described
return 0 # * self.current_wallet_state - WalletState(cur_encrypted_wallet(), sequence + 1) - and current_wallet_state
return wallet_state['lastSynced'][wallet_state['deviceId']] # We don't need it yet but we'd be avoiding the entire point of the syncing system. At least keep it around in this demo.
# TODO - do this correctly WalletState = namedtuple('WalletState', ['sequence', 'encrypted_wallet'])
def create_login_password(root_password):
return hashlib.sha256(root_password.encode('utf-8')).hexdigest()[:32]
# TODO - actually the SDK will do this for now # TODO - do this correctly. This is a hack example.
def create_encryption_key(root_password): def derive_login_password(root_password):
return hashlib.sha256(root_password.encode('utf-8')).hexdigest()[32:] return hashlib.sha256(root_password.encode('utf-8')).hexdigest()[:10]
# TODO - do this correctly # TODO - do this correctly. This is a hack example.
def check_hmac(wallet_state, encryption_key, hmac): def derive_sdk_password(root_password):
return hmac == 'Good HMAC' return hashlib.sha256(root_password.encode('utf-8')).hexdigest()[10:20]
# TODO - do this correctly # TODO - do this correctly. This is a hack example.
def create_hmac(wallet_state, encryption_key): def derive_hmac_key(root_password):
return 'Good HMAC' return hashlib.sha256(root_password.encode('utf-8')).hexdigest()[20:]
# TODO - do this correctly. This is a hack example.
def create_hmac(wallet_state, hmac_key):
input_str = hmac_key + ':' + str(wallet_state.sequence) + ':' + wallet_state.encrypted_wallet
return hashlib.sha256(input_str.encode('utf-8')).hexdigest()
def check_hmac(wallet_state, hmac_key, hmac):
return hmac == create_hmac(wallet_state, hmac_key)
class Client(): class Client():
def _validate_new_wallet_state(self, new_wallet_state): def _validate_new_wallet_state(self, new_wallet_state):
@ -37,20 +46,9 @@ class Client():
return True return True
# Make sure that the new sequence is overall later. # Make sure that the new sequence is overall later.
if wallet_state_sequence(new_wallet_state) <= wallet_state_sequence(self.wallet_state): if new_wallet_state.sequence <= self.wallet_state.sequence:
return False return False
for dev_id in self.wallet_state['lastSynced']:
if dev_id == self.device_id:
# Check if the new wallet has the latest changes from this device
if new_wallet_state['lastSynced'][dev_id] != self.wallet_state['lastSynced'][dev_id]:
return False
else:
# Check if the new wallet somehow regressed on any of the other devices
# This most likely means a bug in another client
if new_wallet_state['lastSynced'][dev_id] < self.wallet_state['lastSynced'][dev_id]:
return False
return True return True
def __init__(self): def __init__(self):
@ -76,9 +74,9 @@ class Client():
# on the server. # on the server.
def new_wallet_state(self): def new_wallet_state(self):
# camel-cased to ease json interop # camel-cased to ease json interop
self.wallet_state = {'lastSynced': {}, 'encryptedWallet': ''} self.wallet_state = WalletState(sequence=0, encrypted_wallet='-')
# TODO - actual encryption with encryption_key # TODO - actual encryption with encryption_key - or maybe not.
self._encrypted_wallet_local_changes = '' self._encrypted_wallet_local_changes = ''
def set_account(self, email, root_password): def set_account(self, email, root_password):
@ -88,7 +86,7 @@ class Client():
def register(self): def register(self):
body = json.dumps({ body = json.dumps({
'email': self.email, 'email': self.email,
'password': create_login_password(self.root_password), 'password': derive_login_password(self.root_password),
}) })
response = requests.post(REGISTER_URL, body) response = requests.post(REGISTER_URL, body)
if response.status_code != 201: if response.status_code != 201:
@ -100,7 +98,7 @@ class Client():
def get_auth_token(self): def get_auth_token(self):
body = json.dumps({ body = json.dumps({
'email': self.email, 'email': self.email,
'password': create_login_password(self.root_password), 'password': derive_login_password(self.root_password),
'deviceId': self.device_id, 'deviceId': self.device_id,
}) })
response = requests.post(AUTH_URL, body) response = requests.post(AUTH_URL, body)
@ -116,26 +114,29 @@ class Client():
# you might end up overwriting one with a lower sequence entirely. Maybe we # you might end up overwriting one with a lower sequence entirely. Maybe we
# want to annotate them with which account we're talking about. Again, we # want to annotate them with which account we're talking about. Again, we
# should see how LBRY Desktop/SDK deal with it. # should see how LBRY Desktop/SDK deal with it.
def get_wallet_state(self): def get_wallet(self):
params = { params = {
'token': self.auth_token, 'token': self.auth_token,
} }
response = requests.get(WALLET_STATE_URL, params=params) response = requests.get(WALLET_URL, params=params)
if response.status_code != 200: if response.status_code != 200:
# TODO check response version on client side now
print ('Error', response.status_code) print ('Error', response.status_code)
print (response.content) print (response.content)
return return
new_wallet_state_str = json.loads(response.content)['walletStateJson'] hmac_key = derive_hmac_key(self.root_password)
new_wallet_state = json.loads(new_wallet_state_str)
encryption_key = create_encryption_key(self.root_password) new_wallet_state = WalletState(
hmac = json.loads(response.content)['hmac'] encrypted_wallet=response.json()['encryptedWallet'],
if not check_hmac(new_wallet_state_str, encryption_key, hmac): sequence=response.json()['sequence'],
)
hmac = response.json()['hmac']
if not check_hmac(new_wallet_state, hmac_key, hmac):
print ('Error - bad hmac on new wallet') print ('Error - bad hmac on new wallet')
print (response.content) print (response.content)
return return
# In reality, we'd examine, merge, verify, validate etc this new wallet state.
if self.wallet_state != new_wallet_state and not self._validate_new_wallet_state(new_wallet_state): if self.wallet_state != new_wallet_state and not self._validate_new_wallet_state(new_wallet_state):
print ('Error - new wallet does not validate') print ('Error - new wallet does not validate')
print (response.content) print (response.content)
@ -151,7 +152,7 @@ class Client():
print ("Got latest walletState:") print ("Got latest walletState:")
pprint(self.wallet_state) pprint(self.wallet_state)
def post_wallet_state(self): def post_wallet(self):
# Create a *new* wallet state, indicating that it was last updated by this # Create a *new* wallet state, indicating that it was last updated by this
# device, with the updated sequence, and include our local encrypted wallet changes. # device, with the updated sequence, and include our local encrypted wallet changes.
# Don't set self.wallet_state to this until we know that it's accepted by # Don't set self.wallet_state to this until we know that it's accepted by
@ -160,48 +161,48 @@ class Client():
print ("No wallet state to post.") print ("No wallet state to post.")
return return
submitted_wallet_state = { hmac_key = derive_hmac_key(self.root_password)
"deviceId": self.device_id,
"lastSynced": dict(self.wallet_state['lastSynced']),
"encryptedWallet": self.cur_encrypted_wallet(),
}
submitted_wallet_state['lastSynced'][self.device_id] = wallet_state_sequence(self.wallet_state) + 1
encryption_key = create_encryption_key(self.root_password) submitted_wallet_state = WalletState(
encrypted_wallet=self.cur_encrypted_wallet(),
submitted_wallet_state_str = json.dumps(submitted_wallet_state) sequence=self.wallet_state.sequence + 1
submitted_wallet_state_hmac = create_hmac(submitted_wallet_state_str, encryption_key) )
body = json.dumps({ wallet_request = {
'version': CURRENT_VERSION,
'token': self.auth_token, 'token': self.auth_token,
'walletStateJson': submitted_wallet_state_str, "encryptedWallet": submitted_wallet_state.encrypted_wallet,
'hmac': submitted_wallet_state_hmac "sequence": submitted_wallet_state.sequence,
}) "hmac": create_hmac(submitted_wallet_state, hmac_key),
response = requests.post(WALLET_STATE_URL, body) }
response = requests.post(WALLET_URL, json.dumps(wallet_request))
if response.status_code == 200: if response.status_code == 200:
# TODO check response version on client side now
# Our local changes are no longer local, so we reset them # Our local changes are no longer local, so we reset them
self._encrypted_wallet_local_changes = '' self._encrypted_wallet_local_changes = ''
print ('Successfully updated wallet state on server') print ('Successfully updated wallet state on server')
elif response.status_code == 409: elif response.status_code == 409:
print ('Wallet state out of date. Getting updated wallet state. Try again.') print ('Wallet state out of date. Getting updated wallet state. Try posting again after this.')
# Don't return yet! We got the updated state here, so we still process it below. # Don't return yet! We got the updated state here, so we still process it below.
else: else:
print ('Error', response.status_code) print ('Error', response.status_code)
print (response.content) print (response.content)
return return
# Now we get a new wallet state back as a response # Now we get a new wallet back as a response
# TODO - factor this into the same thing as the get_wallet_state function # TODO - factor this code into the same thing as the get_wallet function
new_wallet_state_str = json.loads(response.content)['walletStateJson'] new_wallet_state = WalletState(
new_wallet_state_hmac = json.loads(response.content)['hmac'] encrypted_wallet=response.json()['encryptedWallet'],
new_wallet_state = json.loads(new_wallet_state_str) sequence=response.json()['sequence'],
if not check_hmac(new_wallet_state_str, encryption_key, new_wallet_state_hmac): )
hmac = response.json()['hmac']
if not check_hmac(new_wallet_state, hmac_key, hmac):
print ('Error - bad hmac on new wallet') print ('Error - bad hmac on new wallet')
print (response.content) print (response.content)
return return
# In reality, we'd examine, merge, verify, validate etc this new wallet state.
if submitted_wallet_state != new_wallet_state and not self._validate_new_wallet_state(new_wallet_state): if submitted_wallet_state != new_wallet_state and not self._validate_new_wallet_state(new_wallet_state):
print ('Error - new wallet does not validate') print ('Error - new wallet does not validate')
print (response.content) print (response.content)
@ -227,4 +228,4 @@ class Client():
# The local changes on top of whatever came from the server # The local changes on top of whatever came from the server
# If we pull new changes from server, we "rebase" these on top of it # If we pull new changes from server, we "rebase" these on top of it
# If we push changes, the full "rebased" version gets committed to the server # If we push changes, the full "rebased" version gets committed to the server
return self.wallet_state['encryptedWallet'] + self._encrypted_wallet_local_changes return self.wallet_state.encrypted_wallet + self._encrypted_wallet_local_changes

40
wallet/wallet.go
View file

@ -1,39 +1,5 @@
package wallet package wallet
import "orblivion/lbry-id/auth" type EncryptedWallet string
type WalletHmac string
// Currently a small package but given other packages it makes imports easier. type Sequence uint32
// Also this might grow substantially over time
// For test stubs
type WalletUtilInterface interface {
ValidateWalletStateMetadata(walletState *WalletStateMetadata) bool
}
type WalletUtil struct{}
// This is a subset of the WalletState structure, only the metadata fields. We
// don't need access to the encrypted wallet.
type WalletStateMetadata struct {
DeviceId auth.DeviceId `json:"deviceId"`
LastSynced map[auth.DeviceId]int `json:"lastSynced"`
}
type WalletStateHmac string
// TODO - These "validate" functions could/should be methods. Though I think
// we'd lose mockability for testing, since the method isn't the
// WalletUtilInterface.
// Mainly the job of the clients but we may as well short-circuit problems
// here before saving them.
func (wu *WalletUtil) ValidateWalletStateMetadata(walletState *WalletStateMetadata) bool {
// TODO - nonempty fields, up to date, etc
return true
}
// Assumptions: `ws` has been validated
// Avoid having to check for error
func (ws *WalletStateMetadata) Sequence() int {
return ws.LastSynced[ws.DeviceId]
}

19
wallet/wallet_test.go
View file

@ -1,19 +0,0 @@
package wallet
import (
"testing"
)
// Test stubs for now
func TestWalletSequence(t *testing.T) {
t.Fatalf("Test me: test that walletState.Sequence() == walletState.lastSynced[wallet.DeviceId]")
}
func TestWalletValidateWalletState(t *testing.T) {
// walletState.DeviceId in walletState.lastSynced
// Sequence for lastSynced all > 1
t.Fatalf("Test me: Implement and test validateWalletState.")
}
// TODO - other wallet integrity stuff? particularly related to sequence?