Emulator and keepkeyctl

[yura-pakhuchiy]

Hi,

I'm trying to use keepkeyctl with emulator. It seems to work for requests which do not require confirmation, but how can I send confirmation when neccesary?

I start emulator using docker-compose up. Non-interactive commands work. Eg:

$ keepkeyctl -t udp -p 127.0.0.1:21324 -v get_features
b'SENDING <Initialize> (0 bytes):\n'
b'RECEIVED <Features> (209 bytes):\nvendor: "keepkey.com"\nmajor_version: 6\nminor_version: 0\npatch_version: 4\ndevice_id: "202A11146CF37E63EC570A21"\npin_protection: false\npassphrase_protection: false\nlanguage: "english"\nlabel: ""\ninitialized: false\nrevision: "44bee958c7ff4cc30b633a8c557d4e92116e636c"\nimported: false\npin_cached: true\npassphrase_cached: false\npolicies {\n  policy_name: "ShapeShift"\n  enabled: true\n}\npolicies {\n  policy_name: "Pin Caching"\n  enabled: false\n}\npolicies {\n  policy_name: "Experimental"\n  enabled: false\n}\npolicies {\n  policy_name: "AdvancedMode"\n  enabled: false\n}\nmodel: "K1-14AM"\nfirmware_variant: "Emulator"\nno_backup: false\n'
vendor: "keepkey.com"
major_version: 6
minor_version: 0
patch_version: 4
device_id: "202A11146CF37E63EC570A21"
pin_protection: false
passphrase_protection: false
language: "english"
label: ""
initialized: false
revision: "44bee958c7ff4cc30b633a8c557d4e92116e636c"
imported: false
pin_cached: true
passphrase_cached: false
policies {
  policy_name: "ShapeShift"
  enabled: true
}
policies {
  policy_name: "Pin Caching"
  enabled: false
}
policies {
  policy_name: "Experimental"
  enabled: false
}
policies {
  policy_name: "AdvancedMode"
  enabled: false
}
model: "K1-14AM"
firmware_variant: "Emulator"
no_backup: false

However I'm get stuck when I try to initialize device:

$ keepkeyctl -t udp -p 127.0.0.1:21324 -v load_device -m 'all all all all all all all all all all all all'
b'SENDING <Initialize> (0 bytes):\n'
b'RECEIVED <Features> (209 bytes):\nvendor: "keepkey.com"\nmajor_version: 6\nminor_version: 0\npatch_version: 4\ndevice_id: "202A11146CF37E63EC570A21"\npin_protection: false\npassphrase_protection: false\nlanguage: "english"\nlabel: ""\ninitialized: false\nrevision: "44bee958c7ff4cc30b633a8c557d4e92116e636c"\nimported: false\npin_cached: true\npassphrase_cached: false\npolicies {\n  policy_name: "ShapeShift"\n  enabled: true\n}\npolicies {\n  policy_name: "Pin Caching"\n  enabled: false\n}\npolicies {\n  policy_name: "Experimental"\n  enabled: false\n}\npolicies {\n  policy_name: "AdvancedMode"\n  enabled: false\n}\nmodel: "K1-14AM"\nfirmware_variant: "Emulator"\nno_backup: false\n'
b'SENDING <LoadDevice> (72 bytes):\nmnemonic: "all all all all all all all all all all all all"\npin: ""\npassphrase_protection: false\nlanguage: "english"\nlabel: "slip14"\nskip_checksum: false\n'
b'RECEIVED <ButtonRequest> (2 bytes):\ncode: ButtonRequest_ImportRecoverySentence\n'
b'SENDING <ButtonAck> (0 bytes):\n'

List command do not show emulator. Is it normal?

$ keepkeyctl -t udp -p 127.0.0.1:21324 -v list
$

Is it possbile to use electrum with emulator somehow?

[keepkeyjon]

We've only been using it for the testsuite so far. Something @solipsis did in go-keepkey, which would be very useful here, was to wire up an --autoButton flag that causes the command-line client to automatically press the button on DebugLink-enabled devices.

List command do not show emulator. Is it normal?

Turns out that list is just broken. It only enumerates HID devices, and misses WebUSB/UDP ones... thanks for the report.

Is it possbile to use electrum with emulator somehow?

To trigger it through electrum, you'd have to wire up DebugLink.press_{button, yes, no}(), and fire them off after sending back ButtonAcks.

[keepkeyjon]

diff --git a/keepkeyctl b/keepkeyctl
index cd3d0aa..1d11ddc 100755
--- a/keepkeyctl
+++ b/keepkeyctl
@@ -31,7 +31,7 @@ import base64
 import urllib
 import tempfile
 
-from keepkeylib.client import KeepKeyClient, KeepKeyClientDebug
+from keepkeylib.client import KeepKeyClient, KeepKeyClientDebug, KeepKeyDebugClient
 import keepkeylib.types_pb2 as types
 
 def parse_args(commands):
@@ -39,10 +39,11 @@ def parse_args(commands):
     parser.add_argument('-v', '--verbose', dest='verbose', action='store_true', help='Prints communication to device')
     parser.add_argument('-t', '--transport', dest='transport',  choices=['usb', 'serial', 'pipe', 'socket', 'bridge', 'udp', 'webusb'], help="Transport used for talking with the device")
     parser.add_argument('-p', '--path', dest='path', default='', help="Path used by the transport (usually serial port)")
-#    parser.add_argument('-dt', '--debuglink-transport', dest='debuglink_transport', choices=['usb', 'serial', 'pipe', 'socket'], default='usb', help="Debuglink transport")
-#    parser.add_argument('-dp', '--debuglink-path', dest='debuglink_path', default='', help="Path used by the transport (usually serial port)")
+    parser.add_argument('-Dt', '--debuglink-transport', dest='debuglink_transport', choices=['usb', 'serial', 'pipe', 'socket', 'bridge', 'udp', 'webusb'], default='usb', help="Debuglink transport")
+    parser.add_argument('-Dp', '--debuglink-path', dest='debuglink_path', default='', help="Path used by the transport (usually serial port)")
     parser.add_argument('-j', '--json', dest='json', action='store_true', help="Prints result as json object")
 #    parser.add_argument('-d', '--debug', dest='debug', action='store_true', help='Enable low-level debugging')
+    parser.add_argument('--auto_button', dest='auto_button', action='store_true', help='Automatically press the button on Debuglink devices')
 
     cmdparser = parser.add_subparsers(title='Available commands')
     cmdparser.required = True
@@ -616,7 +617,15 @@ def main():
         return
 
     transport = get_transport(args.transport, args.path)
-    if args.verbose:
+    if args.debuglink_transport and args.debuglink_path:
+        debuglink_transport = get_transport(
+            args.debuglink_transport,
+            args.debuglink_path)
+
+    if args.auto_button:
+        client = KeepKeyDebugClient(transport)
+        client.set_debuglink(debuglink_transport)
+    elif args.verbose:
         client = KeepKeyClientDebug(transport)
     else:
         client = KeepKeyClient(transport)

$ ./keepkeyctl -t udp -p 127.0.0.1:21324 -Dt udp -Dp 127.0.0.1:21325 --auto_button get_address -d 2>&1 | tail -n1
1EfKbQupktEMXf4gujJ9kCFo83k1iMqwqK

[yura-pakhuchiy]

@keepkeyjon thank you, works great!

[yura-pakhuchiy]

I would have also added this:

diff --git a/keepkeyctl-emu.sh b/keepkeyctl-emu.sh
index a0cf23c..04c5780 100755
--- a/keepkeyctl-emu.sh
+++ b/keepkeyctl-emu.sh
@@ -1,2 +1,2 @@
 #!/bin/sh
-./keepkeyctl -t pipe -p /tmp/pipe.keepkey $*
+./keepkeyctl -t udp -p 127.0.0.1:21324 -Dt udp -Dp 127.0.0.1:21325 --auto_button "$@"

[keepkeyjon]

good call!