trezor-agent/README.md

47 lines
2.0 KiB
Markdown
Raw Normal View History

2016-06-20 19:38:30 +00:00
# Using TREZOR as a hardware SSH/GPG 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-06-23 19:23:08 +00:00
See SatoshiLabs' blog posts about this feature:
2015-09-19 11:31:40 +00:00
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.6GPG Signing, SSH Login Updates and Advanced Transaction Features for Segwit](https://medium.com/@satoshilabs/trezor-firmware-1-3-6-20a7df6e692)
2015-09-19 11:14:50 +00:00
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
$ 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://mytrezor.com/data/firmware/releases.json) version (at least v1.4.0):
$ trezorctl get_features
vendor: "bitcointrezor.com"
major_version: 1
minor_version: 4
patch_version: 0
...
## Usage
2016-07-22 20:11:33 +00:00
For usage with SSH, see the [following instructions](README-SSH.md).
2016-06-20 19:38:30 +00:00
2016-07-22 20:11:33 +00:00
For usage with GPG, see the [following instructions](README-GPG.md).
2016-09-01 19:02:32 +00:00
Questions, suggestions and discussions are welcome: [![Chat](https://badges.gitter.im/romanz/trezor-agent.svg)](https://gitter.im/romanz/trezor-agent)
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.