accounts, console, internal: support trezor hardware wallet #14885

karalabe · 2017-08-01T15:46:54Z

This PR adds support for the Trezor hardware wallet. Plain message signing is not yet supported as each wallet has a different spec for the signatures (#14794). I'll add that when an EIP is opened and a consensus is reached on how to sign arbitrary messages.

Opposed to the Ledger, the Trezor is a bit more complicated as it requires a PIN-unlock sent from the communicating machine instead of directly input by the user. As such, when a user plugs in a Trezor, Geth will print the following warning:

WARN [08-10|11:55:19] New wallet appeared, failed to open url=trezor://0003:0007:00 err="trezor: pin needed"

Opening the Trezor from Geth

The Geth console can be used to unlock the Trezor by invoking personal.openWallet(url), which will request the user to enter the shuffled PIN code and send that over to the Trezor for verification:

> personal.openWallet("trezor://0003:0007:00")

Look at the device for number positions

7 | 8 | 9
--+---+--
4 | 5 | 6
--+---+--
1 | 2 | 3

Please enter current PIN: <enter pin>

INFO [08-10|11:58:06] New wallet appeared   url=trezor://0003:0007:00 status="Trezor v1.5.0 'Quack' online"

Opening the Trezor from RPC

The Trezor can also be unlocked via remote RPC methods (to support external UI wallets) by calling personal_openWallet with the parameters [url, pin].

If pin == "", the Trezor is attempted to be opened without a PIN, which will either succeed (if it was already opened before), or it will display a PIN pad on the device and return a trezor: pin needed error. The UI doing the opening should react to this error by displaying a PIN entry UI element, and after reading the code from the user, call personal_openWallet again, with pin set to the user's input corresponding to a keyboard numpad layout (7-8-9 / 4-5-6 / 1-2-3).

Listing the Trezor wallets

The available Trezor (and other) wallets can be listed via personal_listWallets, which will also auto-derive Ethereum accounts which have non-zero balances or nonces:

> personal.listWallets

INFO [08-10|12:07:35] USB wallet discovered new account   url=trezor://0003:0007:00 address=0x7Bf042272737121236dcBC078A218646C94730f4 path=m/44'/60'/0'/0/0 balance=88999999999876 nonce=4
INFO [08-10|12:07:35] USB wallet discovered new account   url=trezor://0003:0007:00 address=0x89B613B665E9EA122EB1D54f3B54195160cAB8fb path=m/44'/60'/0'/0/1 balance=124            nonce=0
INFO [08-10|12:07:35] USB wallet discovered new account   url=trezor://0003:0007:00 address=0x6742064c46Ccc179C877Ea8782b5d5Fe5b033378 path=m/44'/60'/0'/0/2 balance=0              nonce=0

[{
    accounts: [{
        address: "0x7bf042272737121236dcbc078a218646c94730f4",
        url: "trezor://0003:0007:00/m/44'/60'/0'/0/0"
    }, {
        address: "0x89b613b665e9ea122eb1d54f3b54195160cab8fb",
        url: "trezor://0003:0007:00/m/44'/60'/0'/0/1"
    }, {
        address: "0x6742064c46ccc179c877ea8782b5d5fe5b033378",
        url: "trezor://0003:0007:00/m/44'/60'/0'/0/2"
    }],
    status: "Trezor v1.5.0 'Quack' online",
    url: "trezor://0003:0007:00"
}]

prusnak · 2017-08-10T19:26:28Z

console/bridge.go

+		throwJSException(err.Error())
+	} else {
+		// Transform the alphabetical input to numbers
+		mapping := map[string]string{"a": "7", "b": "8", "c": "9", "d": "4", "e": "5", "f": "6", "g": "1", "h": "2", "i": "3"}


Why not use

+ fmt.Fprintf(b.printer, "7 | 8 | 9\n") + fmt.Fprintf(b.printer, "--+---+--\n") + fmt.Fprintf(b.printer, "4 | 5 | 6\n") + fmt.Fprintf(b.printer, "--+---+--\n") + fmt.Fprintf(b.printer, "1 | 2 | 3\n\n")

above and skip this step?

This is exactly the scheme used in python-trezor and most of the CLI users are already used to that.

That was my original code but @nagydani suggested we use something else to ensure users don't type in their real PINs accidentally. Though after using both schemes, the a-b-c one in indeed annoying, whereas the keypad version can be typed in without looking at the keyboard. So it may indeed be a better approach.

@Gustav-Simonsson Do you have an opinion on this one? (Pinging you since you explicitly reacted to the PIN pad on twitter :D)

Because using numerics for both unencrypted and encrypted PIN might confuse users into entering the unencrypted PIN on the console or making some other mistake. It is good to keep the distinction by using a different alphabet, I think.

@nagydani @prusnak Given that multiple people already requested the classical keypad pinpad, I've added a new commit to revert to that. My main reasoning was that with the keypad, it's simple to look at the device pinpad and enter your pin, whereas with the alphabetical one it's a PITA to map the numbers to letters.

I've also tried to look into mapping to q-w-e / a-s-d / z-x-c but that requires keyboard layout detection, which I couldn't do meaningfully easily. All in all I think the keypad should be fine too.

nagydani · 2017-08-10T20:49:32Z

Question: What are the events that should trigger adding new addresses to eth.accounts array? Since it is not specified, I do not know whether this implementation is correct or not, but I have my doubts.

Otherwise, the code is tidy and readable and none of the implemented functionality showed any erroneous behavior with the possible exception of adding accounts from the Trezor.

karalabe · 2017-08-11T08:35:29Z

I'm unsure what you mean by not correct. Accounts are auto-derived from the base path:

// DefaultBaseDerivationPath is the base path from which custom derivation endpoints
// are incremented. As such, the first account will be at m/44'/60'/0'/0, the second
// at m/44'/60'/0'/1, etc.

If an account has a non zero balance or non zero nonce, it will be added to the list of tracked accounts, and the next one is derived too. The account list is refreshed whenever balance changes are detected.

karalabe · 2017-08-11T08:38:14Z

@nagydani You can also see the logic in the log I posted in the PR description:

INFO [08-10|12:07:35] USB wallet discovered new account   url=trezor://0003:0007:00 address=0x7Bf042272737121236dcBC078A218646C94730f4 path=m/44'/60'/0'/0/0 balance=88999999999876 nonce=4
INFO [08-10|12:07:35] USB wallet discovered new account   url=trezor://0003:0007:00 address=0x89B613B665E9EA122EB1D54f3B54195160cAB8fb path=m/44'/60'/0'/0/1 balance=124            nonce=0
INFO [08-10|12:07:35] USB wallet discovered new account   url=trezor://0003:0007:00 address=0x6742064c46Ccc179C877Ea8782b5d5Fe5b033378 path=m/44'/60'/0'/0/2 balance=0              nonce=0

karalabe · 2017-08-11T08:39:37Z

Also note, there's a personal.deriveAccount(url, path, keep) method which can derive arbitrary derivation paths on a hardware device identified by the URL and can optionally keep it as a member of the accounts array.

nagydani

The PR in its present form works with Trezor correctly and I am satisfied with the implementation. Could not verify Ledger support regressions, as I do not have that HW.

prusnak · 2017-08-14T15:58:53Z

Thank you, Péter!

carver · 2017-08-15T17:52:44Z

Just to be clear, any "gap" in activity in your accounts will prevent discovery of later accounts, right? Like:

m/44'/60'/0'/0 - activity - discovered
m/44'/60'/0'/1 - activity - discovered
m/44'/60'/0'/2 - no activity - not discovered
m/44'/60'/0'/3 - activity - not discovered

(where "activity" is a nonzero balance or nonce)

This seems reasonable, just wanted to be sure I understood.

prusnak · 2017-08-15T18:34:35Z

Yes, that is correct according to BIP44.

woodydeck · 2017-12-27T01:38:24Z

On OSX, how do you find the URL? It's not documented anywhere, but maybe it is a bug. The url shown is not correct and/or truncated.

WARN [12-26|20:37:23] New wallet appeared, failed to open url=trezor://IOService:/AppleACPIPl… err="trezor: pin needed"

personal.openWallet("trezor://IOServiceAppleACPIPl") gets you a 'Error: unknown wallet' error.

karalabe · 2017-12-27T12:17:39Z

You can list all the details with personal.listWallets()

woodydeck · 2017-12-27T18:26:45Z

> personal.openWallet("trezor://1111:1111:11")
Error: unknown wallet
> personal.listWallets()
TypeError: 'listWallets' is not a function
    at <anonymous>:1:1

I'm on geth 1.8/go 1.9.2, running latest High Sierra.

iinstances · 2018-01-07T02:42:22Z

$ geth version
Geth
Version: 1.7.3-stable
Architecture: amd64
Protocol Versions: [63 62]
Network Id: 1
Go Version: go1.9
Operating System: linux

$ geth attach 

> personal.openWallet("trezor://0001:000f:00")
TypeError: 'openWallet' is not a function

> personal.listWallets
undefined
> personal.listWallets()
TypeError: 'listWallets' is not a function
    at <anonymous>:1:1

Checked in console mode instead of attach and work fine now.

woodydeck · 2018-01-07T02:45:31Z

Also, geth automatically hijacks the process, so you can't use it with MEW or the Chrome plugin with geth running, which is annoying because I want to keep Swarm and geth running 24/7.

tomjohn1028 · 2018-01-29T05:29:42Z

@woodydeck I'm experiencing the same thing. I'm trying to use a locally running MEW with my local node but because Geth instantly tries to connect no other process can connect with the Trezor. Is there any way around this?

ngutman · 2018-04-11T07:20:35Z

@karalabe I dug around a bit on the geth/trezor integration and I wonder if it's still working (specifically I'm trying to get ethsign to work with trezor which relies on it being accessible in geth). I manage to enter the pin in geth console but I don't understand where and how to enter the passphrase (which is required after entering the pin)

karalabe · 2018-04-11T07:49:05Z

I have not implemented passwords for the Trezor. Didn't know that that was a generally desired use case. Will do when I get to integrating the Trezor T.

ncsolar · 2018-05-02T01:57:28Z

@karalabe Excellent to know the plan to implement passwords for the Trezor, thanks!

fjrojasgarcia · 2018-05-02T17:29:56Z

Any plan to implement local Hardware Wallets (Trezor/Ledger) recognition from an attached ws/rpc geth instance?

Is this functionality already implemented?
Would it break some security policy?

IMHO It seems an interesting use case. You could attach to a remote node via ws/rpc (avoiding the consumption of local resources) without losing the ability to continue using your local USB connected Ledger or Trezor from the awesome geth console.

fjrojasgarcia · 2018-05-02T23:00:46Z

Added Hardware Wallets support wiki entry at forked repo.

accounts, console, internal: support trezor hardware wallet

db568a6

karalabe force-pushed the trezor-boom branch 2 times, most recently from 673bc6e to e4e7111 Compare August 9, 2017 09:53

karalabe added this to the 1.7.0 milestone Aug 9, 2017

accounts: refactor API for generalized USB wallets

5d9ac49

karalabe force-pushed the trezor-boom branch from e4e7111 to 5d9ac49 Compare August 9, 2017 10:26

prusnak reviewed Aug 10, 2017

View reviewed changes

nagydani self-requested a review August 14, 2017 08:50

nagydani approved these changes Aug 14, 2017

View reviewed changes

console: use keypad based pinpad (Trezor request)

02656f9

prusnak approved these changes Aug 14, 2017

View reviewed changes

karalabe merged commit ef0edc6 into ethereum:master Aug 14, 2017

prusnak mentioned this pull request Aug 14, 2017

mist compatibility with hardware wallets? ethereum/mist#222

Closed

csillag mentioned this pull request Aug 22, 2017

Trezor hardware wallet support openethereum/parity-ethereum#4500

Closed

ronaldmannak mentioned this pull request Oct 14, 2017

[MacOS] Trezor not recognized when plugged in to USB #15296

Closed

prusnak mentioned this pull request Jan 22, 2018

Add Trezor hardware wallet support MetaMask/metamask-extension#605

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

accounts, console, internal: support trezor hardware wallet #14885

accounts, console, internal: support trezor hardware wallet #14885

karalabe commented Aug 1, 2017 •

edited

Loading

prusnak Aug 10, 2017

karalabe Aug 11, 2017

karalabe Aug 11, 2017

nagydani Aug 14, 2017

karalabe Aug 14, 2017 •

edited

Loading

nagydani commented Aug 10, 2017

karalabe commented Aug 11, 2017

karalabe commented Aug 11, 2017

karalabe commented Aug 11, 2017 •

edited

Loading

nagydani left a comment

prusnak commented Aug 14, 2017

carver commented Aug 15, 2017

prusnak commented Aug 15, 2017 via email

woodydeck commented Dec 27, 2017 •

edited

Loading

karalabe commented Dec 27, 2017

woodydeck commented Dec 27, 2017

iinstances commented Jan 7, 2018 •

edited

Loading

woodydeck commented Jan 7, 2018

tomjohn1028 commented Jan 29, 2018

ngutman commented Apr 11, 2018

karalabe commented Apr 11, 2018

ncsolar commented May 2, 2018

fjrojasgarcia commented May 2, 2018 •

edited

Loading

fjrojasgarcia commented May 2, 2018

accounts, console, internal: support trezor hardware wallet #14885

accounts, console, internal: support trezor hardware wallet #14885

Conversation

karalabe commented Aug 1, 2017 • edited Loading

Opening the Trezor from Geth

Opening the Trezor from RPC

Listing the Trezor wallets

prusnak Aug 10, 2017

Choose a reason for hiding this comment

karalabe Aug 11, 2017

Choose a reason for hiding this comment

karalabe Aug 11, 2017

Choose a reason for hiding this comment

nagydani Aug 14, 2017

Choose a reason for hiding this comment

karalabe Aug 14, 2017 • edited Loading

Choose a reason for hiding this comment

nagydani commented Aug 10, 2017

karalabe commented Aug 11, 2017

karalabe commented Aug 11, 2017

karalabe commented Aug 11, 2017 • edited Loading

nagydani left a comment

Choose a reason for hiding this comment

prusnak commented Aug 14, 2017

carver commented Aug 15, 2017

prusnak commented Aug 15, 2017 via email

woodydeck commented Dec 27, 2017 • edited Loading

karalabe commented Dec 27, 2017

woodydeck commented Dec 27, 2017

iinstances commented Jan 7, 2018 • edited Loading

woodydeck commented Jan 7, 2018

tomjohn1028 commented Jan 29, 2018

ngutman commented Apr 11, 2018

karalabe commented Apr 11, 2018

ncsolar commented May 2, 2018

fjrojasgarcia commented May 2, 2018 • edited Loading

fjrojasgarcia commented May 2, 2018

karalabe commented Aug 1, 2017 •

edited

Loading

karalabe Aug 14, 2017 •

edited

Loading

karalabe commented Aug 11, 2017 •

edited

Loading

woodydeck commented Dec 27, 2017 •

edited

Loading

iinstances commented Jan 7, 2018 •

edited

Loading

fjrojasgarcia commented May 2, 2018 •

edited

Loading