trezor-agent/README.md

77 lines
3.1 KiB
Markdown
Raw Normal View History

2015-09-19 11:14:50 +00:00
# Using TREZOR as a hardware SSH agent
2015-07-04 12:10:29 +00:00
2015-08-24 12:14:46 +00:00
[![Build Status](https://travis-ci.org/romanz/trezor-agent.svg?branch=master)](https://travis-ci.org/romanz/trezor-agent)
2015-09-19 11:14:50 +00:00
[![Python Versions](https://img.shields.io/pypi/pyversions/trezor_agent.svg)](https://pypi.python.org/pypi/trezor_agent/)
[![Package Version](https://img.shields.io/pypi/v/trezor_agent.svg)](https://pypi.python.org/pypi/trezor_agent/)
[![Development Status](https://img.shields.io/pypi/status/trezor_agent.svg)](https://pypi.python.org/pypi/trezor_agent/)
[![Downloads](https://img.shields.io/pypi/dm/trezor_agent.svg)](https://pypi.python.org/pypi/trezor_agent/)
2016-01-09 10:14:29 +00:00
[![Chat](https://badges.gitter.im/romanz/trezor-agent.svg)](https://gitter.im/romanz/trezor-agent)
2016-01-09 09:19:33 +00:00
[![License](https://img.shields.io/github/license/romanz/trezor-agent.svg)](https://github.com/romanz/trezor-agent/blob/master/LICENSE)
2015-09-19 11:14:50 +00:00
See SatoshiLabs' blog post about this feature:
2015-09-19 11:31:40 +00:00
- https://medium.com/@satoshilabs/trezor-firmware-1-3-4-enables-ssh-login-86a622d7e609
2015-09-19 11:14:50 +00:00
2015-08-24 11:49:05 +00:00
## Screencast demo usage
2015-07-04 12:10:29 +00:00
2016-01-08 14:05:16 +00:00
### Simple usage (single SSH session)
2015-07-04 12:10:29 +00:00
[![Demo](https://asciinema.org/a/22959.png)](https://asciinema.org/a/22959)
2015-08-24 11:49:05 +00:00
2016-01-08 14:05:16 +00:00
### Advanced usage (multiple SSH sessions from a sub-shell)
[![Subshell](https://asciinema.org/a/33240.png)](https://asciinema.org/a/33240)
2015-08-24 11:49:05 +00:00
## Installation
First, make sure that the latest `trezorlib` Python package
2015-09-06 08:50:45 +00:00
is installed correctly (at least v0.6.6):
2015-08-24 11:49:05 +00:00
$ pip install Cython trezor
2015-08-24 11:49:51 +00:00
Then, install the latest `trezor_agent` package:
2015-08-24 11:49:05 +00:00
$ pip install trezor_agent
2015-09-04 19:20:33 +00:00
Finally, verify that you are running the latest TREZOR firmware version (at least v1.3.4):
$ trezorctl get_features
vendor: "bitcointrezor.com"
major_version: 1
minor_version: 3
patch_version: 4
...
2015-08-24 11:49:05 +00:00
## Public key generation
Run:
2015-09-02 12:12:33 +00:00
/tmp $ trezor-agent ssh.hostname.com -v > hostname.pub
2015-09-02 15:03:18,929 INFO getting "ssh://ssh.hostname.com" public key from Trezor...
2015-09-02 15:03:23,342 INFO disconnected from Trezor
/tmp $ cat hostname.pub
ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBGSevcDwmT+QaZPUEWUUjTeZRBICChxMKuJ7dRpBSF8+qt+8S1GBK5Zj8Xicc8SHG/SE/EXKUL2UU3kcUzE7ADQ= ssh://ssh.hostname.com
2015-08-24 11:49:05 +00:00
Append `hostname.pub` contents to `~/.ssh/authorized_keys`
configuration file at `ssh.hostname.com`, so the remote server
would allow you to login using the corresponding private key signature.
## Usage
Run:
2015-09-02 12:12:33 +00:00
/tmp $ trezor-agent ssh.hostname.com -v -c
2015-09-02 12:16:21 +00:00
2015-09-02 15:09:39,782 INFO getting "ssh://ssh.hostname.com" public key from Trezor...
2015-09-02 15:09:44,430 INFO please confirm user "roman" login to "ssh://ssh.hostname.com" using Trezor...
2015-09-02 12:12:33 +00:00
2015-09-02 15:09:46,152 INFO signature status: OK
Linux lmde 3.16.0-4-amd64 #1 SMP Debian 3.16.7-ckt11-1+deb8u3 (2015-08-04) x86_64
The programs included with the Debian GNU/Linux system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.
Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law.
Last login: Tue Sep 1 15:57:05 2015 from localhost
~ $
2015-08-24 11:49:05 +00:00
Make sure to confirm SSH signature on the Trezor device when requested.