Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
119 lines (86 sloc) 3.26 KB
title tags keywords last_updated summary sidebar permalink folder
OnlyKey SSH/GPG agent
OnlyKey
Agent
Python
OnlyKey, Agent
Sep, 26, 2017
The OnlyKey agent is essentially middleware that lets you use OnlyKey as a hardware SSH/GPG device (GPG not supported yet).
mydoc_sidebar
onlykey-agent.html
mydoc

onlykey-agent

SSH agent for the OnlyKey.

SSH is a popular remote access tool that is often used by administrators. Thanks to the OnlyKey SSH Agent remote access can be passwordless and more secure.

SSH Agent Quickstart Guide

  1. Install OnlyKey agent on your client machine:
$ sudo pip install onlykey
$ sudo pip install onlykey-agent
  1. Generate your First SSH Key on the OnlyKey Plug and unlock your OnlyKey and then run:
$ onlykey-agent user@host

Where user is your usual SSH user and host the host you want to connect to.

  1. You now have the SSH public key for the user and the host you previously selected.

i.e.

ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBFwsFGFI7px8toa38FVeBIKcYdBvWzYXAiVcbB2d1o3zEsRB6Lm/ZuCzQjaLwQdcpT1aF8tycqt4K6AGI1o+qFk= user@host

Cut and paste the whole string into your server ~/.ssh/authorized_keys file, you're now ready to use SSH with your newly generated key.

  1. From now on you can log in to your server using OnlyKey using the following command:
$ onlykey-agent -c user@host

You will be prompted for a challenge code, type this on your OnlyKey to complete log in.

Note: This method can also be used for git push or other mechanisms that are using SSH as their communication protocol:

$ onlykey-agent user@host git push

Installation

MacOS Install with dependencies

Brew is required. To install visit https://brew.sh/

$ brew update && brew upgrade
$ brew install python
$ pip2 install onlykey onlykey-agent

Ubuntu Install with dependencies

$ apt update && apt upgrade
$ apt install python-pip python-dev libusb-1.0-0-dev libudev-dev
$ pip2 install onlykey
$ pip2 install onlykey-agent

Debian Install with dependencies

$ apt update && apt upgrade
$ apt install python-pip python-dev libusb-1.0-0-dev libudev-dev
$ pip2 install onlykey onlykey-agent

Fedora/RedHat/CentOS Install with dependencies

$ yum update
$ yum install python-pip python-devel libusb-devel libudev-devel \
              gcc redhat-rpm-config
$ pip2 install onlykey onlykey-agent

OpenSUSE Install with dependencies

$ zypper install python-pip python-devel libusb-1_0-devel libudev-devel
$ pip2 install onlykey onlykey-agent

Linux UDEV Rule

In order for non-root users in Linux to be able to communicate with OnlyKey a udev rule must be created as described here.

Advanced Options

Supported curves

Keys are generated unique for each user / host combination. By default OnlyKey agent uses NIST P256 but also supports ED25519 keys. ED25519 can be used as follows:

  1. Generate ED25519 public key using onlykey-agent
$ onlykey-agent user@host -e ed25519
  1. Log in using ED25519 public key
$ onlykey-agent -c user@host -e ed25519

You can also just type -e e instead of typing out the full -e ed25519

The project started from a fork trezor-agent (thanks!).