Skip to content

backend: protect devices registry #4161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benma wants to merge 1 commit into
base: master
Choose a base branch
from
Open

backend: protect devices registry #4161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions backend/backend.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package backend
import (
"encoding/hex"
"fmt"
"maps"
"math/big"
"net/http"
"net/url"
Expand Down Expand Up @@ -213,7 +214,8 @@ type Backend struct {

notifier *Notifier

devices map[string]device.Interface
devices map[string]device.Interface
devicesLock locker.Locker

usbManager *usb.Manager
bluetooth *bluetooth.Bluetooth
Expand Down Expand Up @@ -717,7 +719,8 @@ func (backend *Backend) UsbUpdate() {

// DevicesRegistered returns a map of device IDs to device of registered devices.
func (backend *Backend) DevicesRegistered() map[string]device.Interface {
return backend.devices
defer backend.devicesLock.RLock()()
return maps.Clone(backend.devices)
}

// HTTPClient is a getter method for the HTTPClient instance.
Expand Down Expand Up @@ -843,9 +846,11 @@ func (backend *Backend) DeregisterKeystore() {

// Register registers the given device at this backend.
func (backend *Backend) Register(theDevice device.Interface) error {
unlock := backend.devicesLock.Lock()
backend.devices[theDevice.Identifier()] = theDevice

mainKeystore := len(backend.devices) == 1
unlock()

theDevice.SetOnEvent(func(event deviceevent.Event, data interface{}) {
backend.events <- deviceEvent{
DeviceID: theDevice.Identifier(),
Expand Down Expand Up @@ -899,9 +904,15 @@ func (backend *Backend) Register(theDevice device.Interface) error {

// Deregister deregisters the device with the given ID from this backend.
func (backend *Backend) Deregister(deviceID string) {
if device, ok := backend.devices[deviceID]; ok {
backend.onDeviceUninit(deviceID)
unlock := backend.devicesLock.Lock()
device, ok := backend.devices[deviceID]
if ok {
delete(backend.devices, deviceID)
}
unlock()

if ok {
backend.onDeviceUninit(deviceID)
backend.DeregisterKeystore()

backend.Notify(observable.Event{
Expand Down
14 changes: 14 additions & 0 deletions backend/backend_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,20 @@ func newBackend(t *testing.T, testing, regtest bool) *Backend {
return b
}

func TestDevicesRegisteredReturnsSnapshot(t *testing.T) {
b := newBackend(t, testnetDisabled, regtestDisabled)
defer b.Close()

unlock := b.devicesLock.Lock()
b.devices["device-id"] = nil
unlock()

devices := b.DevicesRegistered()
delete(devices, "device-id")

require.Contains(t, b.DevicesRegistered(), "device-id")
}

func TestRegisterKeystore(t *testing.T) {
// From mnemonic: wisdom minute home employ west tail liquid mad deal catalog narrow mistake
rootKey1 := test.TstMustXKey("xprv9s21ZrQH143K3gie3VFLgx8JcmqZNsBcBc6vAdJrsf4bPRhx69U8qZe3EYAyvRWyQdEfz7ZpyYtL8jW2d2Lfkfh6g2zivq8JdZPQqxoxLwB")
Expand Down