#otp #piv

yubirs

A library for interacting with YubiKeys (OTP and PIV functionality)

16 unstable releases (6 breaking)

✓ Uses Rust 2018 edition

0.7.0 Apr 19, 2020
0.6.0 Mar 15, 2020
0.5.7 Feb 26, 2020
0.5.4 Mar 3, 2019
0.1.0 Feb 5, 2017

#7 in Authentication

Download history 19/week @ 2020-03-10 57/week @ 2020-03-17 286/week @ 2020-03-24 171/week @ 2020-03-31 241/week @ 2020-04-07 88/week @ 2020-04-14 18/week @ 2020-04-21 38/week @ 2020-04-28 32/week @ 2020-05-05 177/week @ 2020-05-12 113/week @ 2020-05-19 114/week @ 2020-05-26 65/week @ 2020-06-02 21/week @ 2020-06-09 19/week @ 2020-06-16 20/week @ 2020-06-23

332 downloads per month
Used in yubirs-tools

Apache-2.0

240KB
5.5K SLoC

yubirs

Build Status

A library for interacting with YubiKeys in Rust.

Currently, this library supports OTP and PIV functionality.

Using Yubikeys on Linux

Here are some helpful resources on how to use the Yubikey:

In particular, a few pieces of setup are necessary in order to fully use the Yubikey. OTP mode generally works without any additional setup (since we only rely on the Yubikey's USB keyboard functionality), but for PIV / smartcard features some additional setup is needed.

Arch Linux

  • libu2f-host provides udev rules for using the Yubikey as a non-root user.
  • yubikey-manager provides some utilities for managing the Yubikey.
  • pcsclite is a dependency of yubirs; this is the PC/SC library we use to interact with the Yubikey programmatically.
  • pcsc-tools provides some utilities for interacting with smartcards in general.
  • ccid provides a generic USB Chip/Smart Card Interface Devices driver.
  • libusb-compat provides a library for userspace applications to communicate with USB devices.
sudo pacman -S libu2f-host yubikey-manager pcsclite pcsc-tools ccid libusb-compat

# For pcsclite to work, we need to start the pcscd daemon.
sudo systemctl start pcscd.service
sudo systemctl enable pcscd.service

Gentoo Linux

The process on Gentoo is very similar:

# Install necessary packages.
emerge -av libu2f-host yubikey-manager pcsc-lite pcsc-tools ccid libusb-compat

# Add your user to the right group to be able to access the device. Replace
# $MY_USER with your username.
gpasswd -a $MY_USER pcscd plugdev usb

# Configure hotplugging by setting rc_hotplug="pcscd" in this file:
vim /etc/rc.conf

# Start pcscd, and configure it to start on boot.
rc-update add pcscd default
/etc/init.d/pcscd start

polkit

If your system is configured to use polkit (for example, if you're running KDE), then you additionally need to modify polkit's rules to allow non-root users to access PC/SC devices. In /usr/share/polkit-1/rules.d/02-pcsc.rules:

polkit.addRule(function(action, subject) {
    if (action.id == "org.debian.pcsc-lite.access_card" &&
        subject.user == "< YOUR USER HERE >") {
            return polkit.Result.YES;
    }
});

polkit.addRule(function(action, subject) {
    if (action.id == "org.debian.pcsc-lite.access_pcsc" &&
        subject.user == "< YOUR USER HERE >") {
            return polkit.Result.YES;
    }
});

Testing

To verify that everything is setup right, the following commands should both work and print out information about the Yubikey:

gpg --card-status
pcsc_scan

Command-line tools

Whereas yubirs is a library, yubirs-tools provides command-line tools for working with YubiKeys. Currently, the following binaries are available:

piv-tool

piv-tool is analogous to upstream's yubico-piv-tool, but built on top of yubirs instead of using upstream's C library. It has close to feature pairty with upstream's tool, but there may be some gaps. The official upstream documentation provides a good overview of the concepts involved.

Development

This repository includes some extra Git configuration which makes development easier. To use this configuration, run git config --local include.path ../.gitconfig from the repository root. NOTE: including arbitrary Git configurations is a security vulnerability, so you should audit this custom configuration before including it.

Dependencies

~2.3–9MB
~176K SLoC