trezor-agent/README.md

# Using TREZOR as a hardware SSH/GPG agent

[![Build Status](https://travis-ci.org/romanz/trezor-agent.svg?branch=master)](https://travis-ci.org/romanz/trezor-agent)
[![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/)

See SatoshiLabs' blog posts about this feature:

- [TREZOR Firmware 1.3.4 enables SSH login](https://medium.com/@satoshilabs/trezor-firmware-1-3-4-enables-ssh-login-86a622d7e609)
- [TREZOR Firmware 1.3.6 — GPG Signing, SSH Login Updates and Advanced Transaction Features for Segwit](https://medium.com/@satoshilabs/trezor-firmware-1-3-6-20a7df6e692)

## Installation

First, make sure that the latest [trezorlib](https://pypi.python.org/pypi/trezor) Python package
is installed correctly (at least v0.6.6):

	$ apt-get install python-dev libusb-1.0-0-dev libudev-dev
	$ pip install -U setuptools
	$ pip install Cython trezor

Then, install the latest [trezor_agent](https://pypi.python.org/pypi/trezor_agent) package:

	$ pip install trezor_agent

Finally, verify that you are running the latest [TREZOR firmware](https://wallet.mytrezor.com/data/firmware/releases.json) version (at least v1.4.0):

	$ trezorctl get_features | head
	vendor: "bitcointrezor.com"
	major_version: 1
	minor_version: 4
	patch_version: 0
	...

If you have an error regarding `protobuf` imports (after installing it), please see [this issue](https://github.com/romanz/trezor-agent/issues/28).

## Usage

For SSH, see the [following instructions](README-SSH.md).

For GPG, see the [following instructions](README-GPG.md).

See [here](https://github.com/romanz/python-trezor#pin-entering) for PIN entering instructions.

## Troubleshooting

If there is an import problem with the installed `protobuf` package,
see [this issue](https://github.com/romanz/trezor-agent/issues/28) for fixing it.

### Gitter

Questions, suggestions and discussions are welcome: [![Chat](https://badges.gitter.im/romanz/trezor-agent.svg)](https://gitter.im/romanz/trezor-agent)
-												README: add GPG part

											
										
										
											2016-06-20 19:38:30 +00:00
+								# Using TREZOR as a hardware SSH/GPG agent
-												README: add demo ASCII cast

											
										
										
											2015-07-04 12:10:29 +00:00
-												README: add travis badge

											
										
										
											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)
-												README: update badges and blog post

											
										
										
											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/)
-												README: update posts

											
										
										
											2016-06-23 19:23:08 +00:00
+								See SatoshiLabs' blog posts about this feature:
-												README: fix URL

											
										
										
											2015-09-19 11:31:40 +00:00
-												README: update posts

											
										
										
											2016-06-23 19:23:08 +00:00
+								- [TREZOR Firmware 1.3.4 enables SSH login](https://medium.com/@satoshilabs/trezor-firmware-1-3-4-enables-ssh-login-86a622d7e609)
 								- [TREZOR Firmware 1.3.6 — GPG Signing, SSH Login Updates and Advanced Transaction Features for Segwit](https://medium.com/@satoshilabs/trezor-firmware-1-3-6-20a7df6e692)
-												README: update badges and blog post

											
										
										
											2015-09-19 11:14:50 +00:00
-												update README about protobuf issueOF

											
										
										
											2016-09-11 20:21:58 +00:00
+								## Installation
 								First, make sure that the latest [trezorlib](https://pypi.python.org/pypi/trezor) Python package
 								is installed correctly (at least v0.6.6):
 									$ apt-get install python-dev libusb-1.0-0-dev libudev-dev
-												README: update setuptools to the latest version

											
										
										
											2016-09-28 15:08:09 +00:00
+									$ pip install -U setuptools
-												README: correct pip commands order

											
										
										
											2016-10-17 15:01:38 +00:00
+									$ pip install Cython trezor
-												update README about protobuf issueOF

											
										
										
											2016-09-11 20:21:58 +00:00
 								Then, install the latest [trezor_agent](https://pypi.python.org/pypi/trezor_agent) package:
 									$ pip install trezor_agent
-												Fix the URL for the TREZOR firmware
											
										
										
											2016-09-30 10:18:30 +00:00
+								Finally, verify that you are running the latest [TREZOR firmware](https://wallet.mytrezor.com/data/firmware/releases.json) version (at least v1.4.0):
-												update README about protobuf issueOF

											
										
										
											2016-09-11 20:21:58 +00:00
-												README: get only the first lines of 'trezorctl get_features'

											
										
										
											2016-09-11 20:35:10 +00:00
+									$ trezorctl get_features | head
-												update README about protobuf issueOF

											
										
										
											2016-09-11 20:21:58 +00:00
+									vendor: "bitcointrezor.com"
 									major_version: 1
 									minor_version: 4
 									patch_version: 0
 									...
-												README: add note about protobuf permissions issue

											
										
										
											2016-10-04 08:24:39 +00:00
+								If you have an error regarding `protobuf` imports (after installing it), please see [this issue](https://github.com/romanz/trezor-agent/issues/28).
-												update README about protobuf issueOF

											
										
										
											2016-09-11 20:21:58 +00:00
+								## Usage
-												README: update usage section

											
										
										
											2016-09-11 20:38:21 +00:00
+								For SSH, see the [following instructions](README-SSH.md).
-												README: add GPG part

											
										
										
											2016-06-20 19:38:30 +00:00
-												README: update usage section

											
										
										
											2016-09-11 20:38:21 +00:00
+								For GPG, see the [following instructions](README-GPG.md).
-												README: update gitter badge position

											
										
										
											2016-09-01 19:02:32 +00:00
-												README: link to PIN entering instructions
											
										
										
											2016-10-17 14:54:59 +00:00
+								See [here](https://github.com/romanz/python-trezor#pin-entering) for PIN entering instructions.
-												update README about protobuf issueOF

											
										
										
											2016-09-11 20:21:58 +00:00
 								## Troubleshooting
 								If there is an import problem with the installed `protobuf` package,
 								see [this issue](https://github.com/romanz/trezor-agent/issues/28) for fixing it.
-												Add explanation about entering PIN (#47)

[ci skip]
											
										
										
											2016-10-11 18:31:25 +00:00
 								### Gitter
 								Questions, suggestions and discussions are welcome: [![Chat](https://badges.gitter.im/romanz/trezor-agent.svg)](https://gitter.im/romanz/trezor-agent)